OMomnistack-sh
Batch

Cancel batch

Changed on

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/batches/{batch_id}/cancel

Request

  • Base URL
    https://api.openai.com/v1
  • URL
    https://api.openai.com/v1/batches/{batch_id}/cancel
  • Auth
    HTTP bearer

Path parameters

batch_idstring required

The ID of the batch to cancel.

Response

Batch is cancelling. Returns the cancelling batch's details.

idstring required
object'batch' required

The object type, which is always batch.

endpointstring required

The OpenAI API endpoint used by the batch.

modelstring

Model ID used to process the batch, like gpt-6-astra. OpenAI offers a wide range of models with different capabilities, performance characteristics, and price points. Refer to the model guide to browse and compare available models.

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.

status'validating' | 'failed' | 'in_progress' | 'finalizing' | 'completed' | 'expired' | 'cancelling' | 'cancelled' required

The current status of the batch.

output_file_idstring nullable

The ID of the file containing the outputs of successfully executed requests.

error_file_idstring nullable

The ID of the file containing the outputs of requests with errors.

created_atinteger required

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

in_progress_atinteger nullable

The Unix timestamp (in seconds) for when the batch started processing.

expires_atinteger nullable

The Unix timestamp (in seconds) for when the batch will expire.

finalizing_atinteger nullable

The Unix timestamp (in seconds) for when the batch started finalizing.

completed_atinteger nullable

The Unix timestamp (in seconds) for when the batch was completed.

failed_atinteger nullable

The Unix timestamp (in seconds) for when the batch failed.

expired_atinteger nullable

The Unix timestamp (in seconds) for when the batch expired.

cancelling_atinteger nullable

The Unix timestamp (in seconds) for when the batch started cancelling.

cancelled_atinteger nullable

The Unix timestamp (in seconds) for when the batch was cancelled.

metadataMetadata nullable

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.

Changes

  • 487892d3954eRevision changes
    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

    • info

      added the optional property // to the response with the status

  • 7f654af7f94fRevision changes
    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      response property errors/data/items/line list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property errors/data/items/param list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      response property metadata list-of-types was widened by adding types null to media type application/json of response 200

    • breaking

      the response's property type changed from integer to integer null, and format from no format to unixtime for status

    • breaking

      the response's property type changed from integer to integer null, and format from no format to unixtime for status

    • breaking

      the response's property type changed from integer to integer null, and format from no format to unixtime for status

    • breaking

      the response's property type changed from integer to integer null, and format from no format to unixtime for status

    • breaking

      the response's property type changed from integer to integer null, and format from no format to unixtime for status

    • breaking

      the response's property type changed from integer to integer null, and format from no format to unixtime for status

    • breaking

      the response's property type changed from integer to integer null, and format from no format to unixtime for status

    • breaking

      the response's property type changed from integer to integer null, and format from no format to unixtime for status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the non-success response with the status

    • info

      added the optional property to the response with the status

    • info

      added the optional property to the response with the status