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

Request

Base URL
http://localhost:8080
Auth
- HTTP bearer
- or HTTP basic
- or API key in header x-bf-vk
- or API key in header x-api-key
TypeScript
https://skmtc.dev/getbifrost/apis/bifrost-api/docs/openai/v1/batches/:batch_id/cancel/post.ts
A function with typed inputs. Its response is checked against the schema.

batch_idstring required

Batch job ID to cancel

providerstring

Provider for the batch

Successful response

idstring

objectstring

cancelling_atinteger

cancelled_atinteger

No recorded changes to this operation across all 1 revision of this API.