Files
List files
GET/files
Upload file
POST/files
Delete file
DELETE/files/{file_id}
Retrieve file
GET/files/{file_id}
Retrieve file content
GET/files/{file_id}/content
ModelsExpand Collapse
FileContent = string
FileDeleted = object { id, deleted, object }
FileDeleted = object { id, deleted, object }
id: string
deleted: boolean
object: "file"
FileObject = object { id, bytes, created_at, 6 more } The File object represents a document that has been uploaded to OpenAI.
FileObject = object { id, bytes, created_at, 6 more }
The File object represents a document that has been uploaded to OpenAI.
id: string
The file identifier, which can be referenced in the API endpoints.
bytes: number
The size of the file, in bytes.
created_at: number
The Unix timestamp (in seconds) for when the file was created.
filename: string
The name of the file.
object: "file"
The object type, which is always file.
purpose: "assistants" or "assistants_output" or "batch" or 5 moreThe intended purpose of the file. Supported values are assistants, assistants_output, batch, batch_output, fine-tune, fine-tune-results, vision, and user_data.
purpose: "assistants" or "assistants_output" or "batch" or 5 more
The intended purpose of the file. Supported values are assistants, assistants_output, batch, batch_output, fine-tune, fine-tune-results, vision, and user_data.
Accepts one of the following:
"assistants"
"assistants_output"
"batch"
"batch_output"
"fine-tune"
"fine-tune-results"
"vision"
"user_data"
Deprecatedstatus: "uploaded" or "processed" or "error"Deprecated. The current status of the file, which can be either uploaded, processed, or error.
Deprecatedstatus: "uploaded" or "processed" or "error"
Deprecated. The current status of the file, which can be either uploaded, processed, or error.
Accepts one of the following:
"uploaded"
"processed"
"error"
expires_at: optional number
The Unix timestamp (in seconds) for when the file will expire.
Deprecatedstatus_details: optional string
Deprecated. For details on why a fine-tuning training file failed validation, see the error field on fine_tuning.job.