Get logs

Retrieves logs with filtering, search, and pagination via query parameters.

GET /api/logs

Error

A valid request URL is required to generate request examples

200

{
  "logs": [
    {
      "id": "<string>",
      "project_id": "<string>",
      "project_name": "<string>",
      "parent_request_id": "<string>",
      "provider": "<string>",
      "model": "<string>",
      "status": "processing",
      "object": "<string>",
      "timestamp": "2023-11-07T05:31:56Z",
      "number_of_retries": 123,
      "fallback_index": 123,
      "latency": 123,
      "cost": 123,
      "selected_key_id": "<string>",
      "selected_key_name": "<string>",
      "virtual_key_id": "<string>",
      "virtual_key_name": "<string>",
      "routing_engines_used": [
        "<string>"
      ],
      "tool_call_names": [
        "<string>"
      ],
      "routing_rule_id": "<string>",
      "routing_rule_name": "<string>",
      "complexity_tier": "SIMPLE",
      "complexity_mechanism": "semantic",
      "complexity_score": 123,
      "session_id": "<string>",
      "child_count": 123,
      "children_cost": 123,
      "children_tokens": 123,
      "session_child_count": 123,
      "session_total_cost": 123,
      "session_total_tokens": 123,
      "stream": true,
      "raw_request": "<string>",
      "raw_response": "<string>",
      "redaction_mapping": {
        "input": {},
        "output": {}
      },
      "created_at": "2023-11-07T05:31:56Z",
      "token_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
        }
      },
      "error_details": {
        "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": {
          "provider": "anthropic",
          "model_requested": "<string>",
          "request_type": "<string>",
          "error_type": "<string>",
          "retry_after_ms": 150500
        }
      },
      "input_history": [
        {
          "role": "assistant",
          "name": "<string>",
          "content": "<string>",
          "tool_call_id": "<string>",
          "refusal": "<string>",
          "audio": {
            "id": "<string>",
            "data": "<string>",
            "expires_at": 123,
            "transcript": "<string>"
          },
          "reasoning": "<string>",
          "reasoning_details": [
            {
              "id": "<string>",
              "index": 123,
              "type": "reasoning.summary",
              "summary": "<string>",
              "text": "<string>",
              "signature": "<string>",
              "data": "<string>"
            }
          ],
          "annotations": [
            {
              "type": "<string>",
              "url_citation": {
                "start_index": 123,
                "end_index": 123,
                "title": "<string>",
                "url": "<string>",
                "sources": {},
                "type": "<string>"
              }
            }
          ],
          "tool_calls": [
            {
              "function": {
                "name": "<string>",
                "arguments": "<string>"
              },
              "index": 123,
              "type": "<string>",
              "id": "<string>"
            }
          ]
        }
      ],
      "responses_input_history": [
        {
          "id": "<string>",
          "type": "message",
          "status": "in_progress",
          "role": "assistant",
          "content": "<string>",
          "call_id": "<string>",
          "name": "<string>",
          "arguments": "<string>",
          "output": "<string>",
          "async": true,
          "action": {},
          "error": "<string>",
          "queries": [
            "<string>"
          ],
          "results": [
            {}
          ],
          "summary": [
            {
              "type": "summary_text",
              "text": "<string>"
            }
          ],
          "encrypted_content": "<string>"
        }
      ],
      "output_message": {
        "role": "assistant",
        "name": "<string>",
        "content": "<string>",
        "tool_call_id": "<string>",
        "refusal": "<string>",
        "audio": {
          "id": "<string>",
          "data": "<string>",
          "expires_at": 123,
          "transcript": "<string>"
        },
        "reasoning": "<string>",
        "reasoning_details": [
          {
            "id": "<string>",
            "index": 123,
            "type": "reasoning.summary",
            "summary": "<string>",
            "text": "<string>",
            "signature": "<string>",
            "data": "<string>"
          }
        ],
        "annotations": [
          {
            "type": "<string>",
            "url_citation": {
              "start_index": 123,
              "end_index": 123,
              "title": "<string>",
              "url": "<string>",
              "sources": {},
              "type": "<string>"
            }
          }
        ],
        "tool_calls": [
          {
            "function": {
              "name": "<string>",
              "arguments": "<string>"
            },
            "index": 123,
            "type": "<string>",
            "id": "<string>"
          }
        ]
      },
      "responses_output": [
        {
          "id": "<string>",
          "type": "message",
          "status": "in_progress",
          "role": "assistant",
          "content": "<string>",
          "call_id": "<string>",
          "name": "<string>",
          "arguments": "<string>",
          "output": "<string>",
          "async": true,
          "action": {},
          "error": "<string>",
          "queries": [
            "<string>"
          ],
          "results": [
            {}
          ],
          "summary": [
            {
              "type": "summary_text",
              "text": "<string>"
            }
          ],
          "encrypted_content": "<string>"
        }
      ],
      "embedding_output": [
        [
          123
        ]
      ],
      "params": {},
      "tools": [
        {
          "type": "function",
          "function": {
            "name": "<string>",
            "description": "<string>",
            "parameters": {
              "type": "<string>",
              "description": "<string>",
              "required": [
                "<string>"
              ],
              "properties": {},
              "enum": [
                "<string>"
              ],
              "additionalProperties": true
            },
            "strict": true
          },
          "custom": {
            "format": {
              "type": "<string>",
              "grammar": {
                "definition": "<string>",
                "syntax": "lark"
              }
            }
          },
          "cache_control": {
            "type": "ephemeral",
            "ttl": "<string>"
          }
        }
      ],
      "tool_calls": [
        {
          "function": {
            "name": "<string>",
            "arguments": "<string>"
          },
          "index": 123,
          "type": "<string>",
          "id": "<string>"
        }
      ],
      "speech_input": {},
      "transcription_input": {},
      "image_generation_input": {},
      "speech_output": {},
      "transcription_output": {},
      "image_generation_output": {},
      "cache_debug": {},
      "metadata": {},
      "selected_key": {},
      "virtual_key": {},
      "passthrough_request_body": "<string>",
      "passthrough_response_body": "<string>",
      "routing_engine_logs": {},
      "is_large_payload_request": true,
      "is_large_payload_response": true,
      "rerank_output": {},
      "video_generation_input": {},
      "video_generation_output": {},
      "video_retrieve_output": {},
      "video_list_output": {},
      "video_delete_output": {},
      "video_download_output": {},
      "list_models_output": {}
    }
  ],
  "pagination": {
    "limit": 123,
    "offset": 123,
    "sort_by": "timestamp",
    "order": "asc",
    "total_count": 123
  },
  "stats": {
    "total_requests": 123,
    "total_tokens": 123,
    "total_cost": 123,
    "average_latency": 123,
    "success_rate": 123,
    "user_facing_success_rate": 123,
    "user_facing_total_requests": 123,
    "cache_hit_rate_total_requests": 123,
    "direct_cache_hits": 123,
    "semantic_cache_hits": 123
  },
  "has_logs": true
}

Required Permissions

Permission	Granted via
Logs:View	RBAC role or API key scope

How permissions work

Authorizations

ManagementBearerAuthBasicAuth

Authorization · string · header · required

Management API authentication for /api/* endpoints. Use the Authorization header with Bearer <token>, where <token> is one of:

• a Bifrost management API key,
• a dashboard session token issued by POST /api/session/login,
• base64 of <admin-username>:<admin-password> (legacy equivalent of BasicAuth).

Virtual keys (sk-bf-*) and the x-api-key header are not accepted on management APIs - the sole exception is GET /api/governance/virtual-keys/quota, which is virtual-key-only.

Authentication alone is not sufficient in Bifrost Enterprise: each operation page shows a Required Permissions table (Resource:Operation, for example Dashboard:View) above its Authorizations section, and the caller's RBAC role or management API key scopes must include what it lists, otherwise the request is rejected with 403 Forbidden.

A local admin — authenticated with the admin password, or any caller on a deployment with dashboard auth disabled — bypasses these checks and can call every management endpoint.

OSS setup lock. On Bifrost OSS, while dashboard auth is not active (no admin account, or auth disabled), every management endpoint except the public ones (/health, /api/version, /api/session/is-auth-enabled, /api/session/login, ...) requires the operator's setup token in the X-Bifrost-Setup-Token header, in place of Authorization. The token is set with setup_token in config.json or the BIFROST_SETUP_TOKEN environment variable. A missing header returns 401, a wrong token 403. The header stops working once dashboard auth is enabled. The dashboard instead trades the token once for an HttpOnly bifrost_setup_session cookie via POST /api/session/setup. See Required permissions for how permissions are derived and which endpoints are exempt.

Query Parameters

providers · string

Comma-separated list of providers to filter by

models · string

Comma-separated list of models to filter by

status · string

Comma-separated list of statuses to filter by

objects · string

Comma-separated list of object types to filter by

selected_key_ids · string

Comma-separated list of selected key IDs to filter by

virtual_key_ids · string

Comma-separated list of virtual key IDs to filter by

project_ids · string

Comma-separated list of project IDs to filter by

routing_rule_ids · string

Comma-separated list of routing rule IDs to filter by

routing_engine_used · string

Comma-separated list of routing engines to filter by (routing-rule, governance, or loadbalancing)

tool_call_names · string

Comma-separated list of function names. Matches requests whose response called any of them, using the persisted tool_call_names metadata on the log row. Names are recorded even when content logging is disabled and stay on the row in hybrid storage mode; the call arguments are not.

complexity_tiers · string

Comma-separated list of routing complexity tiers to filter by (SIMPLE, MEDIUM, COMPLEX, or the legacy REASONING tier recorded on historical rows before it was merged into COMPLEX)

complexity_mechanisms · string

Comma-separated list of complexity decision mechanisms to filter by (semantic, decision, llm, session, or skipped)

session_id · string

Exact Bifrost session ID used for key stickiness and request correlation

start_time · string<date-time>

Start time filter (RFC3339 format)

end_time · string<date-time>

End time filter (RFC3339 format)

min_latency · number

Minimum latency filter

max_latency · number

Maximum latency filter

min_tokens · integer

Minimum tokens filter

max_tokens · integer

Maximum tokens filter

min_cost · number

Minimum cost filter

max_cost · number

Maximum cost filter

missing_cost_only · boolean

Only show logs with missing cost

content_search · string

Search in request/response content

request_id · string

Exact lookup on a log ID (which is the request ID). Takes precedence over the time range — start_time/end_time/period are ignored when it is set. roots_only is ignored too, so an ID naming a fallback child returns that child rather than collapsing it into its root.

roots_only · boolean · default: false

Hide rows whose parent_request_id points at another row matching the same filters, so each fallback chain lists as its root request. The root carries child_count, children_cost and children_tokens for the rows it hides. Ignored when parent_request_id or request_id is set.

group_sessions · boolean · default: false

Collapse every row sharing a session_id onto that session's earliest root request, which carries session_child_count, session_total_cost and session_total_tokens. Requires roots_only=true, and is ignored when session_id, parent_request_id or request_id is set. Sorting orders the collapsed rows by the root row's own value, not by the session total.

limit · integer · default: 50

Number of logs to return (default 50, max 1000)

Required range: x <= 1000

offset · integer · default: 0

Number of logs to skip

sort_by · enum<string> · default: timestamp

Field to sort by

Available options: timestamp, latency, tokens, cost

order · enum<string> · default: desc

Sort order

Available options: asc, desc

Response

200

application/json

Successful response

Search logs response

logs · object[]

Show child attributes

pagination · object

Pagination metadata for list responses

Show child attributes

stats · object

Log statistics

Show child attributes

has_logs · boolean

Whether any logs exist in the system