Files
Retrieve File
GET
/
files
/
{file_id}
Authorizations
x-portkey-api-key
string
headerrequiredx-portkey-virtual-key
string
headerrequiredPath Parameters
file_id
string
requiredThe ID of the file to use for this request.
Response
200 - application/json
The File
object represents a document that has been uploaded to OpenAI.
id
string
requiredThe file identifier, which can be referenced in the API endpoints.
bytes
integer
requiredThe size of the file, in bytes.
created_at
integer
requiredThe Unix timestamp (in seconds) for when the file was created.
filename
string
requiredThe name of the file.
object
enum<string>
requiredThe object type, which is always file
.
Available options:
file
purpose
enum<string>
requiredThe intended purpose of the file. Supported values are assistants
, assistants_output
, batch
, batch_output
, fine-tune
, fine-tune-results
and vision
.
Available options:
assistants
, assistants_output
, batch
, batch_output
, fine-tune
, fine-tune-results
, vision
status
enum<string>
requireddeprecatedDeprecated. The current status of the file, which can be either uploaded
, processed
, or error
.
Available options:
uploaded
, processed
, error
status_details
string
deprecatedDeprecated. For details on why a fine-tuning training file failed validation, see the error
field on fine_tuning.job
.
Was this page helpful?