latestOpenAPI 3.1.02026-08-236994571.1 MB
79928a3d37d3
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/batches/{batch_id}/cancel
Path parameters
batch_idstring required
Query parameters
providerstring nullable
Response
Successful Response
{"stackTrail":"paths:/batches/{batch_id}/cancel:post:responses:200:content:application/json:schema","oasType":"schema","type":"unknown"}