Skip to content
API Reference

Files

List files
files.list(FileListParams**kwargs) -> SyncCursorPage[FileObject]
GET/files
Upload file
files.create(FileCreateParams**kwargs) -> FileObject
POST/files
Delete file
files.delete(strfile_id) -> FileDeleted
DELETE/files/{file_id}
Retrieve file
files.retrieve(strfile_id) -> FileObject
GET/files/{file_id}
Retrieve file content
files.content(strfile_id) -> BinaryResponseContent
GET/files/{file_id}/content
Retrieve file content
Deprecated
files.retrieve_content(strfile_id) -> FileContent
GET/files/{file_id}/content
ModelsExpand Collapse
str
class FileDeleted: …
id: str
deleted: bool
object: Literal["file"]
class FileObject: …

The File object represents a document that has been uploaded to OpenAI.

id: str

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

bytes: int

The size of the file, in bytes.

created_at: int

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

filename: str

The name of the file.

object: Literal["file"]

The object type, which is always file.

purpose: Literal["assistants", "assistants_output", "batch", 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: Literal["uploaded", "processed", "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[int]

The Unix timestamp (in seconds) for when the file will expire.

Deprecatedstatus_details: Optional[str]

Deprecated. For details on why a fine-tuning training file failed validation, see the error field on fine_tuning.job.

Literal["assistants", "batch", "fine-tune", 3 more]

The intended purpose of the uploaded file. One of:

  • assistants: Used in the Assistants API
  • batch: Used in the Batch API
  • fine-tune: Used for fine-tuning
  • vision: Images used for vision fine-tuning
  • user_data: Flexible file type for any purpose
  • evals: Used for eval data sets
Accepts one of the following:
"assistants"
"batch"
"fine-tune"
"vision"
"user_data"
"evals"