Skip to content
For the complete documentation index, see llms.txt. Markdown versions of documentation pages are available by appending .md to the page URL.
Primary navigation

Suggested
Overview Models Agents Tools Audio & voice Production API reference

Files

Files are used to upload documents that can be used with features like Assistants and Fine-tuning.

Retrieve file content
GET
/files/{file_id}/content
Upload file
POST
/files
Delete file
DELETE
/files/{file_id}
List files
GET
/files
Retrieve file
GET
/files/{file_id}
Models
FileContent = string
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.

id: string

The file identifier, which can be referenced in the API endpoints.

bytes: number or null

The size of the file, in bytes. In a completed file upload response, this can be null when the file size is not yet available.

created_at: number

The Unix timestamp (in seconds) for when the file was created.

formatunixtime
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 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.

One of the following:
"assistants"
"assistants_output"
"batch"
"batch_output"
"fine-tune"
"fine-tune-results"
"vision"
"user_data"
status: "uploaded" or "processed" or "error"

Deprecated.

Deprecated. The current status of the file, which can be either uploaded, processed, or error.

One of the following:
"uploaded"
"processed"
"error"
expires_at: optional number

The Unix timestamp (in seconds) for when the file will expire. In a completed file upload response, this can be null when no expiry is set.

formatunixtime
status_details: optional string

Deprecated.

Deprecated. For details on why a fine-tuning training file failed validation, see the error field on fine_tuning.job. Completed file upload responses can return null when these details are unset.