OpenAI API

Returns a list of files.

get
https://api.openai.com/v1/files

Query Parameters

purposestring

Only return files with the given purpose.

limitinteger

A limit on the number of objects to be returned. Limit can range between 1 and 10,000, and the default is 10,000.

Default:10000

orderstring

Sort order by the created_at timestamp of the objects. asc for ascending order and desc for descending order.

Allowed values:ascdesc

Default:desc

afterstring

A cursor for use in pagination. after is an object ID that defines your place in the list. For instance, if you make a list request and receive 100 objects, ending with obj_foo, your subsequent call can include after=obj_foo in order to fetch the next page of the list.

Response

200 application/json

OK

ListFilesResponse

objectstringrequired

Example:list

dataarrayrequired

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

Show Child Parameters
first_idstringrequired

Example:file-abc123

last_idstringrequired

Example:file-abc456

has_morebooleanrequired

Example:false

get/files
 
200 application/json

Upload a file that can be used across various endpoints. Individual files can be up to 512 MB, and the size of all files uploaded by one organization can be up to 100 GB. The Assistants API supports files up to 2 million tokens and of specific file types. See the [Assistants Tools guide](/docs/assistants/tools) for details. The Fine-tuning API only supports `.jsonl` files. The input also has certain required formats for fine-tuning [chat](/docs/api-reference/fine-tuning/chat-input) or [completions](/docs/api-reference/fine-tuning/completions-input) models. The Batch API only supports `.jsonl` files up to 200 MB in size. The input also has a specific required [format](/docs/api-reference/batch/request-input). Please [contact us](https://help.openai.com/) if you need to increase these storage limits.

post
https://api.openai.com/v1/files

Body

multipart/form-data

CreateFileRequest

* Additional properties are NOT allowed.
filestringrequired

The File object (not file name) to be uploaded.

purposestringrequired

The intended purpose of the uploaded file.

Use “assistants” for Assistants and Message files, “vision” for Assistants image file inputs, “batch” for Batch API, and “fine-tune” for Fine-tuning.

Allowed values:assistantsbatchfine-tunevision

Response

200 application/json

OK

OpenAIFile

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

idstringrequired

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

bytesintegerrequired

The size of the file, in bytes.

created_atintegerrequired

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

filenamestringrequired

The name of the file.

objectstringrequired

The object type, which is always file.

Allowed values:file

purposestringrequired

The intended purpose of the file. Supported values are assistants, assistants_output, batch, batch_output, fine-tune, fine-tune-results and vision.

Allowed values:assistantsassistants_outputbatchbatch_outputfine-tunefine-tune-resultsvision

statusstringrequiredDEPRECATED

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

Allowed values:uploadedprocessederror

status_detailsstringDEPRECATED

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

post/files

Body

{ "file": "file", "purpose": "assistants" }
 
200 application/json

Delete a file.

delete
https://api.openai.com/v1/files/{file_id}

Path Parameters

file_idstringrequired

The ID of the file to use for this request.

Response

200 application/json

OK

DeleteFileResponse

idstringrequired
objectstringrequired

Allowed values:file

deletedbooleanrequired
delete/files/{file_id}
 
200 application/json

Returns information about a specific file.

get
https://api.openai.com/v1/files/{file_id}

Path Parameters

file_idstringrequired

The ID of the file to use for this request.

Response

200 application/json

OK

OpenAIFile

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

idstringrequired

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

bytesintegerrequired

The size of the file, in bytes.

created_atintegerrequired

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

filenamestringrequired

The name of the file.

objectstringrequired

The object type, which is always file.

Allowed values:file

purposestringrequired

The intended purpose of the file. Supported values are assistants, assistants_output, batch, batch_output, fine-tune, fine-tune-results and vision.

Allowed values:assistantsassistants_outputbatchbatch_outputfine-tunefine-tune-resultsvision

statusstringrequiredDEPRECATED

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

Allowed values:uploadedprocessederror

status_detailsstringDEPRECATED

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

get/files/{file_id}
 
200 application/json

Returns the contents of the specified file.

get
https://api.openai.com/v1/files/{file_id}/content

Path Parameters

file_idstringrequired

The ID of the file to use for this request.

Response

200 application/json

OK

string
get/files/{file_id}/content
 
200 application/json