v1

latestOpenAPI 3.1.0Apache 2.02026-07-264001921002.3 KB
OpenAI Integration

Cancel batch job (OpenAI format)

Cancels a batch processing job.

Note: This endpoint also works without the /v1 prefix (e.g., /openai/batches/{batch_id}/cancel).

post/openai/v1/batches/{batch_id}/cancel

Path parameters

batch_idstring required

Batch job ID to cancel

Query parameters

providerstring

Provider for the batch

Response

Successful response

idstring
objectstring
status'validating' | 'failed' | 'in_progress' | 'finalizing' | 'completed' | 'expired' | 'cancelling' | 'canceled' | 'ended'
cancelling_atinteger
cancelled_atinteger