Error
A valid request URL is required to generate request examples{
"session_id": "<string>",
"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,
"order": "asc",
"total_count": 123
},
"count": 123,
"returned_count": 123,
"has_more": true
}{
"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
}
}{
"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
}
}Logging
Get logs for a session
Returns the paginated logs belonging to a single parent-request session
(grouped by parent_request_id). Sorted ascending by timestamp by default.
GET
/
api
/
logs
/
sessions
/
{session_id}
Error
A valid request URL is required to generate request examples{
"session_id": "<string>",
"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,
"order": "asc",
"total_count": 123
},
"count": 123,
"returned_count": 123,
"has_more": true
}{
"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
}
}{
"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
}
}Required Permissions
How permissions work
| Permission | Granted via |
|---|---|
Logs:View | RBAC role or API key scope |
Authorizations
ManagementBearerAuthBasicAuth
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 ofBasicAuth).
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.
Path Parameters
Parent request ID identifying the session
Query Parameters
Number of logs to return (default 200, max 200)
Required range:
x <= 200Number of logs to skip
Sort order (default asc)
Available options:
asc, desc Response
Session logs retrieved successfully
Paginated logs for a single parent-request session
Show child attributes
Show child attributes
Pagination metadata. Session logs are always sorted by timestamp; the sort_by field is not configurable.
Show child attributes
Show child attributes
Total log count for this session
Number of logs returned in this response
Was this page helpful?