Openai integration

Cancel batch job (OpenAI format)

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

Cancels a batch processing job.

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

Path Parameters

batch_id*string

Batch job ID to cancel

Query Parameters

provider?string

Provider for the batch

Response Body

application/json

application/json

application/json

curl -X POST "http://localhost:8080/openai/v1/batches/string/cancel"
{
  "id": "string",
  "object": "string",
  "status": "validating",
  "request_counts": {
    "total": 0,
    "completed": 0,
    "failed": 0,
    "succeeded": 0,
    "expired": 0,
    "canceled": 0,
    "pending": 0
  },
  "cancelling_at": 0,
  "cancelled_at": 0,
  "extra_fields": {
    "request_type": "string",
    "provider": "openai",
    "model_requested": "string",
    "model_deployment": "string",
    "latency": 0,
    "chunk_index": 0,
    "raw_request": {},
    "raw_response": {},
    "cache_debug": {
      "cache_hit": true,
      "cache_id": "string",
      "hit_type": "string",
      "requested_provider": "string",
      "requested_model": "string",
      "provider_used": "string",
      "model_used": "string",
      "input_tokens": 0,
      "threshold": 0,
      "similarity": 0
    }
  }
}
{
  "event_id": "string",
  "type": "string",
  "is_bifrost_error": true,
  "status_code": 0,
  "error": {
    "type": "string",
    "code": "string",
    "message": "string",
    "param": "string",
    "event_id": "string"
  },
  "extra_fields": {
    "provider": "openai",
    "model_requested": "string",
    "request_type": "string"
  }
}
{
  "event_id": "string",
  "type": "string",
  "is_bifrost_error": true,
  "status_code": 0,
  "error": {
    "type": "string",
    "code": "string",
    "message": "string",
    "param": "string",
    "event_id": "string"
  },
  "extra_fields": {
    "provider": "openai",
    "model_requested": "string",
    "request_type": "string"
  }
}