OpenAPI 3.1.02026-08-11156219299.2 KB

79ff347d29e2

Files & Batches

Cancel Openai Batch

post/v1/batches/{batch_id}/cancel

Path parameters

batch_idstring required

Headers

xi-api-keystring nullable

x-api-keystring nullable

Response

Successful Response

idstring required

The batch ID.

object'batch'

The object type, which is always batch.

endpointstring required

The API endpoint used for the batch.

input_file_idstring required

The ID of the input file for the batch.

completion_windowstring required

The time frame within which the batch should be processed.

statusstring required

The current status of the batch.

output_file_idstring nullable

The ID of the output file.

error_file_idstring nullable

The ID of the error file.

created_atinteger required

The Unix timestamp of when the batch was created.

in_progress_atinteger nullable

The Unix timestamp of when the batch started processing.

expires_atinteger required

The Unix timestamp of when the batch will expire.

finalizing_atinteger nullable

The Unix timestamp of when the batch started finalizing.

completed_atinteger nullable

The Unix timestamp of when the batch completed.

failed_atinteger nullable

The Unix timestamp of when the batch failed.

expired_atinteger nullable

The Unix timestamp of when the batch expired.

cancelling_atinteger nullable

The Unix timestamp of when the batch started cancelling.

cancelled_atinteger nullable

The Unix timestamp of when the batch was cancelled.

metadataobject nullable

Metadata associated with the batch.

modelstring nullable

The model used for the batch.