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.

Retrieve file content

HttpResponse files().content(FileContentParamsparams = FileContentParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/files/{file_id}/content

Upload file

FileObject files().create(FileCreateParamsparams, RequestOptionsrequestOptions = RequestOptions.none())

POST/files

Delete file

FileDeleted files().delete(FileDeleteParamsparams = FileDeleteParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

DELETE/files/{file_id}

List files

FileListPage files().list(FileListParamsparams = FileListParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/files

Retrieve file

FileObject files().retrieve(FileRetrieveParamsparams = FileRetrieveParams.none(), RequestOptionsrequestOptions = RequestOptions.none())

GET/files/{file_id}

ModelsExpand Collapse

class FileDeleted:

class FileObject:

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

enum FilePurpose:

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