API Reference

Copy Markdown

Open in Claude

Open in ChatGPT

Open in Cursor

---

Copy Markdown

View as Markdown

Files

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

List files

files.list(**kwargs) -> CursorPage<FileObject { id, bytes, created_at, 6 more } >

GET/files

Upload file

files.create(**kwargs) -> FileObject { id, bytes, created_at, 6 more }

POST/files

Delete file

files.delete(file_id) -> FileDeleted { id, deleted, object }

DELETE/files/{file_id}

Retrieve file

files.retrieve(file_id) -> FileObject { id, bytes, created_at, 6 more }

GET/files/{file_id}

Retrieve file content

files.content(file_id) -> StringIO

GET/files/{file_id}/content

ModelsExpand Collapse

String

class FileDeleted { id, deleted, object }

id: String

deleted: bool

object: :file

class FileObject { 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: Integer

The size of the file, in bytes.

created_at: Integer

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

One of the following:

:assistants

:assistants_output

:batch

:batch_output

:"fine-tune"

:"fine-tune-results"

:vision

:user_data

Deprecatedstatus: :uploaded | :processed | :error

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

One of the following:

:uploaded

:processed

:error

expires_at: Integer

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

Deprecatedstatus_details: String

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

FilePurpose = :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

One of the following:

:assistants

:batch

:"fine-tune"

:vision

:user_data

:evals