Health check - Bifrost

Authentication

Inference

Integrations

Platform

Governance

Routing

Deprecated

Error

A valid request URL is required to generate request examples

{
  "status": "ok",
  "components": {}
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_bifrost_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "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>",
    "request_type": "<string>",
    "mcp_request_type": "<string>",
    "a2a_request_type": "<string>",
    "a2a_agent_name": "<string>",
    "error_type": "<string>",
    "retry_after_ms": 150500,
    "raw_request": "<unknown>",
    "raw_response": "<unknown>",
    "converted_request_type": "<string>",
    "dropped_compat_plugin_params": [
      "<string>"
    ],
    "latency": 123,
    "key_statuses": [
      {
        "key_id": "<string>",
        "status": "success",
        "provider": "anthropic",
        "error": "<unknown>"
      }
    ],
    "mcp_auth_required": {
      "kind": "<string>",
      "mcp_client_id": "<string>",
      "mcp_client_name": "<string>",
      "message": "<string>",
      "authorize_url": "<string>",
      "session_id": "<string>"
    },
    "billed_usage": {
      "prompt_tokens": 123,
      "prompt_tokens_details": {
        "text_tokens": 123,
        "audio_tokens": 123,
        "image_tokens": 123,
        "cached_read_tokens": 123,
        "cached_write_tokens": 123
      },
      "completion_tokens": 123,
      "completion_tokens_details": {
        "text_tokens": 123,
        "accepted_prediction_tokens": 123,
        "audio_tokens": 123,
        "citation_tokens": 123,
        "num_search_queries": 123,
        "reasoning_tokens": 123,
        "image_tokens": 123,
        "rejected_prediction_tokens": 123
      },
      "total_tokens": 123,
      "tool_usage": {
        "web_search": {
          "num_requests": 123
        }
      },
      "cost": {
        "input_tokens_cost": 123,
        "output_tokens_cost": 123,
        "reasoning_tokens_cost": 123,
        "citation_tokens_cost": 123,
        "search_queries_cost": 123,
        "request_cost": 123,
        "total_cost": 123
      }
    }
  }
}

GET

health

Error

A valid request URL is required to generate request examples

{
  "status": "ok",
  "components": {}
}

{
  "event_id": "<string>",
  "type": "<string>",
  "is_bifrost_error": true,
  "status_code": 123,
  "error": {
    "type": "<string>",
    "code": "<string>",
    "message": "<string>",
    "param": "<string>",
    "event_id": "<string>"
  },
  "extra_fields": {
    "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>",
    "request_type": "<string>",
    "mcp_request_type": "<string>",
    "a2a_request_type": "<string>",
    "a2a_agent_name": "<string>",
    "error_type": "<string>",
    "retry_after_ms": 150500,
    "raw_request": "<unknown>",
    "raw_response": "<unknown>",
    "converted_request_type": "<string>",
    "dropped_compat_plugin_params": [
      "<string>"
    ],
    "latency": 123,
    "key_statuses": [
      {
        "key_id": "<string>",
        "status": "success",
        "provider": "anthropic",
        "error": "<unknown>"
      }
    ],
    "mcp_auth_required": {
      "kind": "<string>",
      "mcp_client_id": "<string>",
      "mcp_client_name": "<string>",
      "message": "<string>",
      "authorize_url": "<string>",
      "session_id": "<string>"
    },
    "billed_usage": {
      "prompt_tokens": 123,
      "prompt_tokens_details": {
        "text_tokens": 123,
        "audio_tokens": 123,
        "image_tokens": 123,
        "cached_read_tokens": 123,
        "cached_write_tokens": 123
      },
      "completion_tokens": 123,
      "completion_tokens_details": {
        "text_tokens": 123,
        "accepted_prediction_tokens": 123,
        "audio_tokens": 123,
        "citation_tokens": 123,
        "num_search_queries": 123,
        "reasoning_tokens": 123,
        "image_tokens": 123,
        "rejected_prediction_tokens": 123
      },
      "total_tokens": 123,
      "tool_usage": {
        "web_search": {
          "num_requests": 123
        }
      },
      "cost": {
        "input_tokens_cost": 123,
        "output_tokens_cost": 123,
        "reasoning_tokens_cost": 123,
        "citation_tokens_cost": 123,
        "search_queries_cost": 123,
        "request_cost": 123,
        "total_cost": 123
      }
    }
  }
}

Required Permissions

Permission	Granted via
None	Public endpoint - no authentication required

How permissions work

Response

Server is healthy

Health check response

status

enum<string>

Available options:

ok

Example:

"ok"

components

object

Health status of individual components (config_store, log_store, vector_store)

Show child attributes