batch_idstringrequired
The ID of the batch to cancel.
Cancels an in-progress batch. The batch will be in status `cancelling` for up to 10 minutes, before changing to `cancelled`, where it will have partial results (if any) available in the output file.
post
https://api.openai.com/v1/batches/{batch_id}/cancel
Path Parameters
Response
200 application/json
Response
200 application/json
Batch is cancelling. Returns the cancelling batch’s details.
Batch
idstringrequired
objectstringrequired
The object type, which is always batch.
Allowed values:batch
endpointstringrequired
The OpenAI API endpoint used by the batch.
errorsobject
Show Child Parameters
input_file_idstringrequired
The ID of the input file for the batch.
completion_windowstringrequired
The time frame within which the batch should be processed.
statusstringrequired
The current status of the batch.
Allowed values:validatingfailedin_progressfinalizingcompletedexpiredcancellingcancelled
output_file_idstring
The ID of the file containing the outputs of successfully executed requests.
error_file_idstring
The ID of the file containing the outputs of requests with errors.
created_atintegerrequired
The Unix timestamp (in seconds) for when the batch was created.
in_progress_atinteger
The Unix timestamp (in seconds) for when the batch started processing.
expires_atinteger
The Unix timestamp (in seconds) for when the batch will expire.
finalizing_atinteger
The Unix timestamp (in seconds) for when the batch started finalizing.
completed_atinteger
The Unix timestamp (in seconds) for when the batch was completed.
failed_atinteger
The Unix timestamp (in seconds) for when the batch failed.
expired_atinteger
The Unix timestamp (in seconds) for when the batch expired.
cancelling_atinteger
The Unix timestamp (in seconds) for when the batch started cancelling.
cancelled_atinteger
The Unix timestamp (in seconds) for when the batch was cancelled.
request_countsobject
The request counts for different statuses within the batch.
Show Child Parameters
metadataobject | null
Set of 16 key-value pairs that can be attached to an object. This can be
useful for storing additional information about the object in a structured
format, and querying for objects via API or the dashboard.
Keys are strings with a maximum length of 64 characters. Values are strings
with a maximum length of 512 characters.
post/batches/{batch_id}/cancel
Authentication
Path Parameters
200 application/json
Files
Files are used to upload documents that can be used with features like Assistants and Fine-tuning.
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
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
Authentication
Query Parameters
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
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
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
Authentication
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
Response
200 application/json
OK
DeleteFileResponse
idstringrequired
objectstringrequired
Allowed values:file
deletedbooleanrequired
delete/files/{file_id}
Authentication
Path Parameters
200 application/json