List relays

Error

A valid request URL is required to generate request examples

{
  "relays": [
    {
      "name": "textract",
      "description": "Amazon Textract",
      "base_url": "https://textract.us-east-1.amazonaws.com",
      "auth": {
        "type": "aws_sigv4",
        "aws": {
          "service": "textract"
        }
      },
      "credential": {
        "aws": {
          "access_key": "env.AWS_ACCESS_KEY_ID",
          "secret_key": "env.AWS_SECRET_ACCESS_KEY",
          "region": "us-east-1"
        }
      },
      "usage": {
        "units_path": "DocumentMetadata.Pages",
        "cost_per_unit": 0.0015
      },
      "routes": [
        {
          "method": "POST",
          "path": "/",
          "headers": {
            "X-Amz-Target": "Textract.AnalyzeDocument"
          }
        }
      ]
    }
  ],
  "count": 123,
  "total_count": 123
}

{
  "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>",
      "subject_token_missing": true,
      "exchange_error": "<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
      }
    }
  }
}

{
  "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>",
      "subject_token_missing": true,
      "exchange_error": "<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
      }
    }
  }
}

{
  "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>",
      "subject_token_missing": true,
      "exchange_error": "<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
      }
    }
  }
}

{
  "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>",
      "subject_token_missing": true,
      "exchange_error": "<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
      }
    }
  }
}

{
  "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>",
      "subject_token_missing": true,
      "exchange_error": "<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

api

relays

Error

A valid request URL is required to generate request examples

{
  "relays": [
    {
      "name": "textract",
      "description": "Amazon Textract",
      "base_url": "https://textract.us-east-1.amazonaws.com",
      "auth": {
        "type": "aws_sigv4",
        "aws": {
          "service": "textract"
        }
      },
      "credential": {
        "aws": {
          "access_key": "env.AWS_ACCESS_KEY_ID",
          "secret_key": "env.AWS_SECRET_ACCESS_KEY",
          "region": "us-east-1"
        }
      },
      "usage": {
        "units_path": "DocumentMetadata.Pages",
        "cost_per_unit": 0.0015
      },
      "routes": [
        {
          "method": "POST",
          "path": "/",
          "headers": {
            "X-Amz-Target": "Textract.AnalyzeDocument"
          }
        }
      ]
    }
  ],
  "count": 123,
  "total_count": 123
}

{
  "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>",
      "subject_token_missing": true,
      "exchange_error": "<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
      }
    }
  }
}

{
  "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>",
      "subject_token_missing": true,
      "exchange_error": "<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
      }
    }
  }
}

{
  "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>",
      "subject_token_missing": true,
      "exchange_error": "<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
      }
    }
  }
}

{
  "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>",
      "subject_token_missing": true,
      "exchange_error": "<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
      }
    }
  }
}

{
  "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>",
      "subject_token_missing": true,
      "exchange_error": "<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
`Relays:View`	RBAC role or API key scope

How permissions work

Authorizations

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

string

Case-insensitive substring of the name or description.

limit

integer

Page size, 1 to 1000. Omit to return every match.

Required range: 1 <= x <= 1000

offset

integer

default:0

Number of matches to skip.

Required range: x >= 0

Response

Relays matching the query

relays

object[]

required

Show child attributes

count

integer

required

Number of relays in this page.

total_count

integer

required

Number of relays matching search, across all pages.

Authentication

Inference

Integrations

Platform

Governance

Routing

Deprecated

Authorizations

Query Parameters

Response