Sign in
batch

Cancel Batch

Cancel a batch. This is the equivalent of POST https://api.openai.com/v1/batches/{batch_id}/cancel

Supports Identical Params as: https://platform.openai.com/docs/api-reference/batch/cancel

Example Curl

curl http://localhost:4000/v1/batches/batch_abc123/cancel         -H "Authorization: Bearer sk-1234"         -H "Content-Type: application/json"         -X POST
post/v1/batches/{batch_id}/cancel

Path parameters

batch_idstring required

Query parameters

providerstring nullable

Response

Successful Response

{"stackTrail":"paths:/v1/batches/{batch_id}/cancel:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}

Changes

Changed in 1 of the 42 revisions of this API.2

  • 082b5fabd9092See the full diff
    • ○

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

      response-optional-property-added

    • ○

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

      response-optional-property-added

    This revision also has 5 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog