AI Gateway

Changed on
post/ai/v1/batches/{batch_id}/cancel

Request

  • Base URL: /api (relative, and the document was published on a file host, not at the API’s origin)
  • URL: /api/ai/v1/batches/{batch_id}/cancel
  • Auth: HTTP bearer

Path parameters

batch_idstring required

Provider batch id, e.g. batch_abc123

Response

Batch is cancelling

completion_windowstring
created_atinteger
endpointstring
error_file_idstring nullable

Results of the failed requests.

idstring required
input_file_idstring
modelstring nullable
objectstring required

Always batch

output_file_idstring nullable

Results of the successful requests; download with GET /ai/v1/files/{file_id}/content.

statusstring required

validating, in_progress, finalizing, completed, failed, expired, cancelling or cancelled

Changes