Create a batch job

Creates a batch job for asynchronous processing.

POST /v1/batches

Error

A valid request URL is required to generate request examples

200

{
  "id": "<string>",
  "object": "<string>",
  "endpoint": "<string>",
  "input_file_id": "<string>",
  "completion_window": "<string>",
  "status": "validating",
  "request_counts": {
    "total": 123,
    "completed": 123,
    "failed": 123,
    "succeeded": 123,
    "expired": 123,
    "canceled": 123,
    "pending": 123
  },
  "metadata": {},
  "created_at": 123,
  "expires_at": 123,
  "output_file_id": "<string>",
  "error_file_id": "<string>",
  "processing_status": "<string>",
  "results_url": "<string>",
  "operation_name": "<string>",
  "extra_fields": {
    "request_type": "<string>",
    "pricing_request_type": "<string>",
    "routing_info": {
      "provider": "anthropic",
      "model": "<string>",
      "key": "<string>",
      "resolved_key_alias": {
        "model_id": "<string>",
        "model_name": "<string>",
        "model_family": "<string>"
      },
      "is_fallback": true,
      "primary_provider": "anthropic",
      "primary_model": "<string>",
      "requested_provider": "anthropic",
      "requested_model": "<string>",
      "server_side_fallback_model": "<string>"
    },
    "provider": "anthropic",
    "original_model_requested": "<string>",
    "resolved_model_used": "<string>",
    "latency": 123,
    "upstream_latency": 123,
    "chunk_index": 123,
    "raw_request": "<unknown>",
    "raw_response": "<unknown>",
    "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": 123,
      "threshold": 123,
      "similarity": 123,
      "cache_hit_latency": 123
    },
    "routing_metadata": {
      "calls": [
        {
          "request_type": "<string>",
          "provider_used": "<string>",
          "model_used": "<string>",
          "input_tokens": 123,
          "output_tokens": 123,
          "count_toward_budgets": true
        }
      ]
    },
    "guardrail_debug": {},
    "parse_errors": [
      {
        "code": "<string>",
        "message": "<string>",
        "param": "<string>",
        "line": 123
      }
    ],
    "converted_request_type": "<string>",
    "dropped_compat_plugin_params": [
      "<string>"
    ],
    "dropped_unsupported_tools": [
      "<string>"
    ],
    "provider_response_headers": {},
    "passthrough_path": "<string>"
  }
}

Authorizations

BearerAuthVirtualKeyAuthApiKeyAuth

Authorization · string · header · required

Bearer token authentication. Use your provider API key or Bifrost authentication token. Virtual keys (prefixed with sk-bf-) can also be passed here.

Body

application/json

model · string · required

Model in provider/model format

input_file_id · string

OpenAI-style file ID

requests · object[]

Anthropic-style inline requests

Show child attributes

endpoint · enum<string>

Available options: /v1/chat/completions, /v1/embeddings, /v1/completions, /v1/responses, /v1/messages

completion_window · string

e.g., "24h"

metadata · object

Show child attributes

Response

200

application/json

Successful response

id · string

object · string

endpoint · string

input_file_id · string

completion_window · string

status · enum<string>

Available options: validating, failed, in_progress, finalizing, completed, expired, cancelling, canceled, ended

request_counts · object

Show child attributes

metadata · object

Show child attributes

created_at · integer<int64>

expires_at · integer<int64>

output_file_id · string

error_file_id · string

processing_status · string

results_url · string

operation_name · string

extra_fields · object

Additional fields included in responses

Show child attributes