The Perl and Raku Conference 2025: Greenville, South Carolina - June 27-29 Learn more

OVID / OpenAPI-Client-OpenAI-0.21 / lib / OpenAPI / Client / OpenAI / Path / files-file_id.pod 

            

              
—
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127

              
=encoding utf8
=head1 NAME
OpenAPI::Client::OpenAI::Path::files-file_id - Documentation for the /files/{file_id} path.
=head1 DESCRIPTION
This document describes the API endpoint at C</files/{file_id}>.
=head1 PATHS
=head2 C<DELETE /files/{file_id}>
Delete a file.
=head3 Operation ID
C<deleteFile>
    $client->deleteFile( ... );
=head3 Parameters
=over 4
=item * C<file_id> (in path) (Required) - The ID of the file to use for this request.
Type: C<string>
=back
=head3 Responses
=head4 Status Code: C<200>
OK
=head4 Content Types:
=over 4
=item * C<application/json>
Example (See the L<OpenAI spec for more detail|https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):
=back
=head2 C<GET /files/{file_id}>
Returns information about a specific file.
=head3 Operation ID
C<retrieveFile>
    $client->retrieveFile( ... );
=head3 Parameters
=over 4
=item * C<file_id> (in path) (Required) - The ID of the file to use for this request.
Type: C<string>
=back
=head3 Responses
=head4 Status Code: C<200>
OK
=head4 Content Types:
=over 4
=item * C<application/json>
Example (See the L<OpenAI spec for more detail|https://github.com/openai/openai-openapi/blob/master/openapi.yaml>):
    {
      "id": "file-abc123",
      "object": "file",
      "bytes": 120000,
      "created_at": 1677610602,
      "expires_at": 1680202602,
      "filename": "salesOverview.pdf",
      "purpose": "assistants",
    }
=back
=head1 SEE ALSO
L<OpenAPI::Client::OpenAI::Path>
=head1 COPYRIGHT AND LICENSE
Copyright (C) 2023-2025 by Nelson Ferraz
This library is free software; you can redistribute it and/or modify
it under the same terms as Perl itself, either Perl version 5.14.0 or,
at your option, any later version of Perl 5 you may have available.
=cut