Search
K
OpenAI API

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

Uploads

Use Uploads to upload large files in multiple parts.

Creates an intermediate [Upload](/docs/api-reference/uploads/object) object that you can add [Parts](/docs/api-reference/uploads/part-object) to. Currently, an Upload can accept at most 8 GB in total and expires after an hour after you create it. Once you complete the Upload, we will create a [File](/docs/api-reference/files/object) object that contains all the parts you uploaded. This File is usable in the rest of our platform as a regular File object. For certain `purpose`s, the correct `mime_type` must be specified. Please refer to documentation for the supported MIME types for your use case: - [Assistants](/docs/assistants/tools/file-search#supported-files) For guidance on the proper filename extensions for each purpose, please follow the documentation on [creating a File](/docs/api-reference/files/create).

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

Body

application/json

CreateUploadRequest

* Additional properties are NOT allowed.
filenamestringrequired

The name of the file to upload.

purposestringrequired

The intended purpose of the uploaded file.

See the documentation on File purposes.

Allowed values:assistantsbatchfine-tunevision

bytesintegerrequired

The number of bytes in the file you are uploading.

mime_typestringrequired

The MIME type of the file.

This must fall within the supported MIME types for your file purpose. See the supported MIME types for assistants and vision.

Response

200 application/json

OK

Upload

The Upload object can accept byte chunks in the form of Parts.

idstringrequired

The Upload unique identifier, which can be referenced in API endpoints.

created_atintegerrequired

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

filenamestringrequired

The name of the file to be uploaded.

bytesintegerrequired

The intended number of bytes to be uploaded.

purposestringrequired

The intended purpose of the file. Please refer here for acceptable values.

statusstringrequired

The status of the Upload.

Allowed values:pendingcompletedcancelledexpired

expires_atintegerrequired

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

objectstring

The object type, which is always “upload”.

Allowed values:upload

file

The ready File object after the Upload is completed.

Show Child Parameters
post/uploads

Body

{ "filename": "filename", "purpose": "assistants", "bytes": 0, "mime_type": "mime_type" }
 
200 application/json