Cancel Batch

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.

Options

Batch Id

The ID of the batch to cancel.

Result Format

Specify how the response should be mapped to the table output. The following formats are available:

Structured Table: Returns a parsed table with data split into rows and columns.

• Id:
• Object: The object type, which is always batch.
• Endpoint: The OpenAI API endpoint used by the batch.
• Errors:
• Input File Id: The ID of the input file for the batch.
• Completion Window: The time frame within which the batch should be processed.
• Status: The current status of the batch.
• Output File Id: The ID of the file containing the outputs of successfully executed requests.
• Error File Id: The ID of the file containing the outputs of requests with errors.
• Created At: The Unix timestamp (in seconds) for when the batch was created.
• In Progress At: The Unix timestamp (in seconds) for when the batch started processing.
• Expires At: The Unix timestamp (in seconds) for when the batch will expire.
• Finalizing At: The Unix timestamp (in seconds) for when the batch started finalizing.
• Completed At: The Unix timestamp (in seconds) for when the batch was completed.
• Failed At: The Unix timestamp (in seconds) for when the batch failed.
• Expired At: The Unix timestamp (in seconds) for when the batch expired.
• Cancelling At: The Unix timestamp (in seconds) for when the batch started cancelling.
• Cancelled At: The Unix timestamp (in seconds) for when the batch was cancelled.
• Request Counts: The request counts for different statuses within the batch.
• Metadata:

  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.

Raw Response: Returns the raw response in a single row with the following columns:

• body: Response body
• status: HTTP status code

Views

This node has no views

Workflows

• No workflows found

Links

• No links available

Developers