Adds a new MCP client with the specified configuration.
Note: tool_pricing is not available when creating a new client; tool
pricing can only be set once the tool list is known. For shared-connection
clients tools are fetched after client creation; for per-user auth types
they are discovered during the create/verify flow itself.
Two cases require a genuinely authenticated admin session and are refused
with 403 when dashboard authentication is disabled or unconfigured, even
though other management endpoints stay reachable in that state:
connection_type “stdio” (which runs the supplied command as a gateway
subprocess), and connection_type “http”/“sse” whose connection_string
resolves to a loopback, private-network, link-local, or CGNAT address.
Public http/sse targets are unaffected.
For auth_type “token_exchange”, verification and tool discovery run
during the create as the signed-in admin: Bifrost exchanges the
identity-provider token on the request or, when it carries none, the
access token from the admin’s own Bifrost sign-in. A request with
neither (for example one made with an API key) creates the client in
pending_verification; finish it with
POST /api/mcp/client//verify-exchange.
For auth_type “oauth” and “per_user_oauth”, the name and endpoint slug
are checked before the OAuth flow starts, so a conflict returns 409 at
create rather than when the flow is completed, and endpoint_slug is kept
for the client the completion creates. OAuth discovery against a private
address that mcp_oauth_private_allowlist does not permit returns 400.
auth_type must be one of the MCPAuthType values; any other value returns
400. per_user_oauth and token_exchange need connection_type “http”, and
per_user_headers needs “http” or “openapi”: each call opens its own
connection, so all three return 400 on “sse” and “stdio”. An omitted
auth_type is “headers”.
POST
/
api
/
mcp
/
client
Error
A valid request URL is required to generate request examples
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.
Body
application/json
Option 1
Option 2
Option 3
Option 4
MCP client configuration for creating a new client (tool_pricing not available at creation).
The schema varies based on connection_type:
HTTP/SSE: connection_string is required
STDIO: stdio_config is required
OpenAPI: openapi_config is required (spec or spec_url); connection_string must be omitted
InProcess: server instance must be provided programmatically (Go package only)
name
string
required
Display name for the MCP client
connection_type
enum<string>
required
Connection type for MCP client. openapi synthesizes an in-process MCP
server from an OpenAPI/Swagger document (see openapi_config): every
supported operation becomes a tool whose call is proxied as an HTTP
request to the described API.
Available options:
http
connection_string
string
required
HTTP URL (required for HTTP connection type)
client_id
string
Unique identifier for the MCP client (optional, auto-generated if not provided)
is_code_mode_client
boolean
server_type_on_slug
enum<string>
default:inherit
Code mode on this client's own /mcp/ endpoint only. "inherit" follows
is_code_mode_client, "enabled" turns code mode on there, "disabled" serves the
client's tools directly there. /mcp, Virtual MCP endpoints and LLM requests
always follow is_code_mode_client.
Available options:
inherit,
enabled,
disabled
is_ping_available
boolean
default:true
Whether the MCP server supports ping for health checks.
If true, uses lightweight ping method for health checks.
If false, uses listTools method for health checks instead.
needs_session_stickiness
boolean
default:false
HTTP-only. Only meaningful for auth_type "oauth", "headers", or "none"
(a server-level connection) — per-user auth types are always per-call
regardless of this field. When true, Bifrost holds one persistent
upstream connection, reused for every tool call. When false or
omitted (the default), a fresh connection is dialed per tool call.
Cannot be set to false for connection_type "sse" or "stdio" — both
are always sticky.
tool_sync_interval
integer
Per-client tool-list sync interval in minutes. 0 (or omitted) falls back
to the global mcp_tool_sync_interval client config.
Required range: x >= 0
max_protocol_version
enum<string>
Newest MCP protocol version Bifrost offers this server; the server can
still negotiate an older one. "auto" uses the newest version Bifrost
supports. Omitted or "" follows the global mcp_max_protocol_version. Ignored for
openapi servers.
Available options:
,
auto,
2026-07-28,
2025-11-25,
2025-06-18
tool_execution_timeout
integer
Per-client tool execution timeout in seconds. 0 (or omitted) falls back
to the global mcp_tool_execution_timeout client config.
Required range: x >= 0
max_instructions_length
integer
Per-client cap on forwarded instructions, in bytes. 0 (or omitted) falls
back to the global mcp_max_instructions_per_client client config. The
aggregate across servers is still bounded by mcp_max_instructions_total.
Required range: x >= 0
allowed_extra_headers
string[]
Allowlist of request-level headers callers may forward to this MCP
server at execution time.
["*"] => any header may be forwarded
[] or omitted => no extra headers are forwarded
["header1", "header2"] => only the specified headers
auth_type
enum<string>
requiredifper_user_discovery=true
Authentication type for the MCP connection
Available options:
none,
headers,
oauth,
per_user_oauth,
per_user_headers,
token_exchange
oauth_config_id
string
OAuth config ID for OAuth authentication.
Set after OAuth flow is completed. References the oauth_configs table.
Only relevant when auth_type is "oauth".
headers
object
Custom headers to include in requests.
Only used when auth_type is "headers".
Show child attributes
oauth_config
object
OAuth configuration for initiating OAuth flow.
Required when creating a client with auth_type "oauth" or "per_user_oauth".
This will trigger the OAuth flow and return an authorization URL
(see the pending_oauth response variant).
Show child attributes
tools_to_execute
string[]
Include-only list for tools.
["*"] => all tools are included
[] => no tools are included
["tool1", "tool2"] => include only the specified tools
tools_to_auto_execute
string[]
List of tools that can be auto-executed without user approval.
Must be a subset of tools_to_execute.
["*"] => all executable tools can be auto-executed
[] => no tools are auto-executed
["tool1", "tool2"] => only specified tools can be auto-executed
prompts_to_expose
string[] | null
Prompts (by the server's own name) served through Bifrost's MCP gateway.
Omitted, null or ["*"] => all prompts; [] => none.
resources_to_expose
string[] | null
Resource URIs and URI templates served through Bifrost's MCP gateway.
Omitted, null or ["*"] => all; [] => none.
endpoint_slug
string
URL-safe path segment this client is served at (/mcp/). Derived from the name
when omitted; rejected with 400 if no slug can be derived and 409 if it is taken.
Immutable after creation.
tool_pricing
object
Per-tool cost in USD for execution.
Key is the tool name, value is the cost per execution.
Show child attributes
allow_by_default
boolean
default:false
When true, this MCP client's tools are available to all virtual keys by default,
without requiring an explicit virtual key assignment.
An explicit virtual key config always overrides this setting for that key.
allow_on_all_virtual_keys
boolean
deprecated
Deprecated earlier name of allow_by_default, still accepted. allow_by_default
decides when both are sent.
tls_config
object
TLS configuration for HTTP and SSE connections.
Not applicable to stdio or inprocess connection types.
Show child attributes
per_user_header_keys
string[]
requiredifauth_type=per_user_headers
Required when auth_type is per_user_headers. List of header names each
end-user must supply the first time they hit this MCP server. Values are
submitted per user via the inline-401 flow — never persisted on the MCP
client config.
token_exchange
object
requiredifauth_type=token_exchange
Required when creating a client with auth_type "token_exchange".
Verification runs automatically as the signed-in admin, exchanging the
identity-provider token on the request or, when it carries none, the
access token from the admin's own Bifrost sign-in (see
POST /api/mcp/client/{id}/verify-exchange). A request with neither,
such as one made with an API key, creates the client in
pending_verification. There is no sample-token field on this request.
Show child attributes
per_user_discovery
boolean
default:false
Per-user auth types only (per_user_oauth, per_user_headers,
token_exchange), and not for connection_type "openapi". When true,
each caller's tools, prompts and resources are discovered with their
own credential when they connect, and the client keeps no admin
credential or discovery of its own: the admin's verification only
checks the server. Every caller is served their own tools, prompts,
resources and resource templates, the MCP gateway (/mcp) included, and a caller who has not
connected yet is offered the client's <name>-connect tool. When false
or omitted, every caller is served what was discovered with the admin
credential.
user_headers
object
Used only at create time when auth_type is per_user_headers. A sample
set of header values the admin supplies so Bifrost can run a one-time
upstream verify and discover the tool list. The create call also keeps
them as the client's admin discovery credential, as
POST /api/mcp/client/{id}/verify-headers does, used only for periodic
and on-demand (POST /api/mcp/client/{id}/refresh-tools) tool-list
refresh. Keeping them is best effort: if storing the credential fails,
the client is still created. Each end-user submits their own values at
runtime.
Show child attributes
Response
MCP client added successfully. For auth_type "oauth" and
"per_user_oauth" the client is not created yet — the response is the
pending_oauth variant carrying authorize_url plus status_url /
complete_url / next_steps hints; the client is created when the flow
is completed via complete_url.
Option 1
Option 2
Generic success response
status
string
Example:
"success"
message
string
Example:
"Operation completed successfully"
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/schema.json","name":"Bifrost","colors":{"primary":"#0C3B43","light":"#07C983"},"logo":{"light":"https://mintcdn.com/bifrost/qFMmk8bNSnvgFYDI/media/bifrost-logo.png?fit=max\u0026auto=format\u0026n=qFMmk8bNSnvgFYDI\u0026q=85\u0026s=6af701a560aee4103444fa017b226cf0","dark":"https://mintcdn.com/bifrost/qFMmk8bNSnvgFYDI/media/bifrost-logo-dark.png?fit=max\u0026auto=format\u0026n=qFMmk8bNSnvgFYDI\u0026q=85\u0026s=84d264aad5f421c526dd17893e7c5739"},"favicon":"https://mintcdn.com/bifrost/qFMmk8bNSnvgFYDI/favicon.ico?fit=max\u0026auto=format\u0026n=qFMmk8bNSnvgFYDI\u0026q=85\u0026s=a57bad8c37d798efcb53dca5d96d8b45","navbar":{"links":[{"href":"https://www.getmaxim.ai/enterprise?utm_source=bifrost_docs\u0026utm_medium=Bifrost_Navbar#free-license","label":"Request License"}],"primary":{"type":"button","label":"Book a Demo","href":"https://www.getmaxim.ai/book-a-demo?utm_source=bifrost_docs\u0026utm_medium=Bifrost_Navbar"}},"footer":{"socials":{"x":"https://x.com/getbifrost","linkedin":"https://linkedin.com/company/maxim-ai","github":"https://github.com/maximhq/bifrost"},"links":[{"header":"Company","items":[{"label":"Book a Demo","href":"https://www.getmaxim.ai/book-a-demo?utm_source=bifrost_docs\u0026utm_medium=Bifrost_Footer"},{"label":"Partner Program","href":"https://www.getmaxim.ai/partners-program?utm_source=bifrost_docs\u0026utm_medium=Bifrost_Footer"},{"label":"Careers","href":"https://www.getmaxim.ai/careers?utm_source=bifrost_docs\u0026utm_medium=Bifrost_Footer"},{"label":"Contact Us","href":"mailto:[email protected]"},{"label":"Security","href":"https://docs.getbifrost.ai/security"},{"label":"Trust Center","href":"https://trust.getmaxim.ai/"},{"label":"Terms of Service","href":"https://www.getmaxim.ai/terms-of-service?utm_source=bifrost_docs\u0026utm_medium=Bifrost_Footer"},{"label":"Privacy Policy","href":"https://www.getmaxim.ai/privacy-policy?utm_source=bifrost_docs\u0026utm_medium=Bifrost_Footer"}]},{"header":"Products","items":[{"label":"LLM Gateway","href":"https://www.getmaxim.ai/llm-gateway?utm_source=bifrost_docs\u0026utm_medium=Bifrost_Footer"},{"label":"MCP Gateway","href":"https://www.getmaxim.ai/mcp-gateway?utm_source=bifrost_docs\u0026utm_medium=Bifrost_Footer"},{"label":"Governance","href":"https://www.getmaxim.ai/ai-governance?utm_source=bifrost_docs\u0026utm_medium=Bifrost_Footer"},{"label":"Guardrails","href":"https://www.getmaxim.ai/ai-guardrails?utm_source=bifrost_docs\u0026utm_medium=Bifrost_Footer"},{"label":"Observability","href":"https://www.getmaxim.ai/ai-observability?utm_source=bifrost_docs\u0026utm_medium=Bifrost_Footer"},{"label":"Bifrost Edge","href":"https://www.getmaxim.ai/edge?utm_source=bifrost_docs\u0026utm_medium=Bifrost_Footer"}]},{"header":"Resources","items":[{"label":"Bifrost Enterprise","href":"https://www.getmaxim.ai/enterprise?utm_source=bifrost_docs\u0026utm_medium=Bifrost_Footer"},{"label":"Performance Benchmarks","href":"https://www.getmaxim.ai/bifrost/resources/benchmarks?utm_source=bifrost_docs\u0026utm_medium=Bifrost_Footer"},{"label":"LLM Gateway Buyer's Guide","href":"https://www.getmaxim.ai/bifrost/resources/buyers-guide?utm_source=bifrost_docs\u0026utm_medium=Bifrost_Footer"},{"label":"Claude Code Integration","href":"https://www.getmaxim.ai/bifrost/resources/claude-code?utm_source=bifrost_docs\u0026utm_medium=Bifrost_Footer"},{"label":"Migrating from LiteLLM","href":"https://www.getmaxim.ai/bifrost/resources/migrating-from-litellm?utm_source=bifrost_docs\u0026utm_medium=Bifrost_Footer"},{"label":"Blogs","href":"https://www.getmaxim.ai/bifrost/blog?utm_source=bifrost_docs\u0026utm_medium=Bifrost_Footer"}]},{"header":"For LLMs","items":[{"label":"llms-full.txt","href":"https://docs.getbifrost.ai/llms-full.txt"},{"label":"llms.txt","href":"https://docs.getbifrost.ai/llms.txt"},{"label":"llm-info","href":"https://www.getmaxim.ai/llm-info?utm_source=bifrost_docs\u0026utm_medium=Bifrost_Footer"}]}]},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Discord","icon":"discord","href":"https://discord.gg/exN5KAydbU"},{"anchor":"GitHub","icon":"github","href":"https://github.com/maximhq/bifrost"},{"anchor":"Try Enterprise","icon":"building","href":"https://www.getmaxim.ai/bifrost/enterprise"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"bifrost","hasAudioNarration":false,"actualSubdomain":"bifrost","customDomains":["docs.getbifrost.ai"],"gitSource":{"type":"github","owner":"maximhq","repo":"bifrost","deployBranch":"main","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aff35c61c16aa85135ff531","clientVersion":"0.0.4227","searchFilterCounts":[{"language":"default","tag":"API","count":718},{"language":"default","tag":"Changelogs","count":329},{"language":"default","tag":"Integrations","count":253},{"language":"default","tag":"Platform","count":246},{"language":"default","tag":"Open Source","count":167},{"language":"default","tag":"OSS","count":161},{"language":"default","tag":"Governance","count":129},{"language":"default","tag":"Enterprise","count":108},{"language":"default","tag":"Helm","count":78},{"language":"default","tag":"Inference","count":71}]},"assistantConfig":{},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":".nav-logo{height:1.50rem}div:has(>nav[aria-label=\"Main\"]){gap:1.5rem}nav[aria-label=\"Main\"]>ul{gap:1rem}nav[aria-label=\"Main\"] a[href*=\"book-a-demo\"]{padding:0.4375rem 0.625rem}nav[aria-label=\"Main\"] a[href*=\"book-a-demo\"] svg{display:none}div:has(>nav[aria-label=\"Main\"])>*,nav[aria-label=\"Main\"]>ul>*{margin-inline:0}nav[aria-label=\"Main\"] .navbar-link a[href*=\"#free-license\"]{display:inline-flex;align-items:center;border:1px solid rgb(var(--primary-dark));border-radius:0.75rem;box-sizing:border-box;padding:calc(0.4375rem - 1px) 0.625rem;color:rgb(var(--primary-dark));background:transparent;font-size:0.875rem;font-weight:500;line-height:1.25rem}nav[aria-label=\"Main\"] .navbar-link a[href*=\"#free-license\"]:hover{background-color:rgb(var(--primary-dark) / 0.1)}.dark nav[aria-label=\"Main\"] .navbar-link a[href*=\"#free-license\"]{border-color:rgb(var(--primary-light));color:rgb(var(--primary-light))}.dark nav[aria-label=\"Main\"] .navbar-link a[href*=\"#free-license\"]:hover{background-color:rgb(var(--primary-light) / 0.12)}#sidebar-group>li>button>div{line-height:normal}.footer-compliance{display:flex;align-items:center;flex-wrap:wrap;gap:0.5rem;max-width:100%}.footer-compliance img{width:2.5rem;height:2.5rem;flex:none;object-fit:contain}@media (max-width: 767px){footer.advanced-footer>div>div:first-child>div:first-child{flex-direction:column;align-items:flex-start;justify-content:flex-start;row-gap:1rem;width:100%;height:auto}footer.advanced-footer>div>div:first-child>div:first-child>div:last-child{justify-content:flex-start;min-width:0;max-width:100%}footer.advanced-footer>div>div:first-child>div:last-child,footer.advanced-footer>div>div:first-child>div:last-child>div,footer.advanced-footer a[class*=\"truncate\"]{white-space:normal!important}}@media (min-width: 768px){footer.advanced-footer>div>div:first-child{justify-content:flex-start;column-gap:3rem}footer.advanced-footer>div>div:first-child>div:first-child{min-width:0;justify-content:flex-start;align-items:flex-start;row-gap:1.25rem}footer.advanced-footer>div>div:first-child>div:first-child>div:last-child{margin-top:auto}footer.advanced-footer>div>div:first-child>div:last-child{flex:0 1 auto;justify-content:start;grid-template-columns:repeat(4, max-content)!important;column-gap:4rem!important}footer.advanced-footer>div>div:first-child>div:last-child>div{align-items:flex-start;width:auto;flex:none}footer.advanced-footer a[class*=\"truncate\"]{max-width:none!important;overflow:visible!important;text-overflow:unset!important;white-space:nowrap!important}}"}]}
{"page":{"pagePath":"api-reference/mcp/add-mcp-client","slug":"/api-reference/mcp/add-mcp-client","pageMetadata":{"title":"Add MCP client","description":"Adds a new MCP client with the specified configuration.\nNote: tool_pricing is not available when creating a new client; tool\npricing can only be set once the tool list is known. For shared-connection\nclients tools are fetched after client creation; for per-user auth types\nthey are discovered during the create/verify flow itself.\n\nTwo cases require a genuinely authenticated admin session and are refused\nwith 403 when dashboard authentication is disabled or unconfigured, even\nthough other management endpoints stay reachable in that state:\nconnection_type \"stdio\" (which runs the supplied command as a gateway\nsubprocess), and connection_type \"http\"/\"sse\" whose connection_string\nresolves to a loopback, private-network, link-local, or CGNAT address.\nPublic http/sse targets are unaffected.\n\nFor auth_type \"token_exchange\", verification and tool discovery run\nduring the create as the signed-in admin: Bifrost exchanges the\nidentity-provider token on the request or, when it carries none, the\naccess token from the admin's own Bifrost sign-in. A request with\nneither (for example one made with an API key) creates the client in\npending_verification; finish it with\nPOST /api/mcp/client/{id}/verify-exchange.\n\nFor auth_type \"oauth\" and \"per_user_oauth\", the name and endpoint slug\nare checked before the OAuth flow starts, so a conflict returns 409 at\ncreate rather than when the flow is completed, and endpoint_slug is kept\nfor the client the completion creates. OAuth discovery against a private\naddress that mcp_oauth_private_allowlist does not permit returns 400.\n\nauth_type must be one of the MCPAuthType values; any other value returns\n400. per_user_oauth and token_exchange need connection_type \"http\", and\nper_user_headers needs \"http\" or \"openapi\": each call opens its own\nconnection, so all three return 400 on \"sse\" and \"stdio\". An omitted\nauth_type is \"headers\".\n","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/mcp/client","href":"/api-reference/mcp/add-mcp-client","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Adds a new MCP client with the specified configuration.\\nNote: tool_pricing is not available when creating a new client; tool\\npricing can only be set once the tool list is known. For shared-connection\\nclients tools are fetched after client creation; for per-user auth types\\nthey are discovered during the create/verify flow itself.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"Two cases require a genuinely authenticated admin session and are refused\\nwith 403 when dashboard authentication is disabled or unconfigured, even\\nthough other management endpoints stay reachable in that state:\\nconnection_type “stdio” (which runs the supplied command as a gateway\\nsubprocess), and connection_type “http”/“sse” whose connection_string\\nresolves to a loopback, private-network, link-local, or CGNAT address.\\nPublic http/sse targets are unaffected.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"For auth_type “token_exchange”, verification and tool discovery run\\nduring the create as the signed-in admin: Bifrost exchanges the\\nidentity-provider token on the request or, when it carries none, the\\naccess token from the admin’s own Bifrost sign-in. A request with\\nneither (for example one made with an API key) creates the client in\\npending_verification; finish it with\\nPOST /api/mcp/client/\", \"/verify-exchange.\"]\n }), \"\\n\", _jsx(_components.p, {\n children: \"For auth_type “oauth” and “per_user_oauth”, the name and endpoint slug\\nare checked before the OAuth flow starts, so a conflict returns 409 at\\ncreate rather than when the flow is completed, and endpoint_slug is kept\\nfor the client the completion creates. OAuth discovery against a private\\naddress that mcp_oauth_private_allowlist does not permit returns 400.\"\n }), \"\\n\", _jsx(_components.p, {\n children: \"auth_type must be one of the MCPAuthType values; any other value returns\\n400. per_user_oauth and token_exchange need connection_type “http”, and\\nper_user_headers needs “http” or “openapi”: each call opens its own\\nconnection, so all three return 400 on “sse” and “stdio”. An omitted\\nauth_type is “headers”.\"\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,..._provideComponents(),...props.components},{Table}=_components;if(!Table)_missingMdxReference(`Table`,true);return _jsxs(_Fragment,{children:[_jsx(_components.p,{children:_jsx(_components.strong,{children:`Required Permissions`})}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Permission`}),_jsx(_components.th,{children:`Granted via`})]})}),_jsx(_components.tbody,{children:_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`MCPGateway:Create`})}),_jsx(_components.td,{children:`RBAC role or API key scope`})]})})]}),`\n`,_jsx(_components.p,{children:_jsx(_components.a,{href:`/api/procuring-api-keys#required-permissions`,children:`How permissions work`})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Add MCP client","description":"Adds a new MCP client with the specified configuration.\nNote: tool_pricing is not available when creating a new client; tool\npricing can only be set once the tool list is known. For shared-connection\nclients tools are fetched after client creation; for per-user auth types\nthey are discovered during the create/verify flow itself.\n\nTwo cases require a genuinely authenticated admin session and are refused\nwith 403 when dashboard authentication is disabled or unconfigured, even\nthough other management endpoints stay reachable in that state:\nconnection_type \"stdio\" (which runs the supplied command as a gateway\nsubprocess), and connection_type \"http\"/\"sse\" whose connection_string\nresolves to a loopback, private-network, link-local, or CGNAT address.\nPublic http/sse targets are unaffected.\n\nFor auth_type \"token_exchange\", verification and tool discovery run\nduring the create as the signed-in admin: Bifrost exchanges the\nidentity-provider token on the request or, when it carries none, the\naccess token from the admin's own Bifrost sign-in. A request with\nneither (for example one made with an API key) creates the client in\npending_verification; finish it with\nPOST /api/mcp/client/{id}/verify-exchange.\n\nFor auth_type \"oauth\" and \"per_user_oauth\", the name and endpoint slug\nare checked before the OAuth flow starts, so a conflict returns 409 at\ncreate rather than when the flow is completed, and endpoint_slug is kept\nfor the client the completion creates. OAuth discovery against a private\naddress that mcp_oauth_private_allowlist does not permit returns 400.\n\nauth_type must be one of the MCPAuthType values; any other value returns\n400. per_user_oauth and token_exchange need connection_type \"http\", and\nper_user_headers needs \"http\" or \"openapi\": each call opens its own\nconnection, so all three return 400 on \"sse\" and \"stdio\". An omitted\nauth_type is \"headers\".\n","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/mcp/client","href":"/api-reference/mcp/add-mcp-client","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/bifrost/62ad9b1aea461302/googleTag.js","/_mintlify/custom/bifrost/c4c9272fd1c525e5/jsonLd.js","/_mintlify/custom/bifrost/5a8b9314a2dac891/supportWidget.js","/_mintlify/custom/bifrost/088e287583b748b0/baseUrlSwitcher.js","/_mintlify/custom/bifrost/aa532cead633d329/tally-embed.js","/_mintlify/custom/bifrost/fe58824b4f1a0ad5/footerCompliance.js"],"openApiReferenceData":{"operation":{"operationId":"addMCPClient","x-mint":{"content":"**Required Permissions**\n\n| Permission | Granted via |\n| --- | --- |\n| `MCPGateway:Create` | RBAC role or API key scope |\n\n[How permissions work](/api/procuring-api-keys#required-permissions)\n"},"summary":"Add MCP client","description":"Adds a new MCP client with the specified configuration.\nNote: tool_pricing is not available when creating a new client; tool\npricing can only be set once the tool list is known. For shared-connection\nclients tools are fetched after client creation; for per-user auth types\nthey are discovered during the create/verify flow itself.\n\nTwo cases require a genuinely authenticated admin session and are refused\nwith 403 when dashboard authentication is disabled or unconfigured, even\nthough other management endpoints stay reachable in that state:\nconnection_type \"stdio\" (which runs the supplied command as a gateway\nsubprocess), and connection_type \"http\"/\"sse\" whose connection_string\nresolves to a loopback, private-network, link-local, or CGNAT address.\nPublic http/sse targets are unaffected.\n\nFor auth_type \"token_exchange\", verification and tool discovery run\nduring the create as the signed-in admin: Bifrost exchanges the\nidentity-provider token on the request or, when it carries none, the\naccess token from the admin's own Bifrost sign-in. A request with\nneither (for example one made with an API key) creates the client in\npending_verification; finish it with\nPOST /api/mcp/client/{id}/verify-exchange.\n\nFor auth_type \"oauth\" and \"per_user_oauth\", the name and endpoint slug\nare checked before the OAuth flow starts, so a conflict returns 409 at\ncreate rather than when the flow is completed, and endpoint_slug is kept\nfor the client the completion creates. OAuth discovery against a private\naddress that mcp_oauth_private_allowlist does not permit returns 400.\n\nauth_type must be one of the MCPAuthType values; any other value returns\n400. per_user_oauth and token_exchange need connection_type \"http\", and\nper_user_headers needs \"http\" or \"openapi\": each call opens its own\nconnection, so all three return 400 on \"sse\" and \"stdio\". An omitted\nauth_type is \"headers\".\n","tags":["MCP"],"requestBody":"0b3ffafb-4fd8-43f8-8e7f-818620184b39","security":["afb851c3-1301-4082-b638-c584da07787b","15dfe425-b30e-4883-87db-2c47bd7d6578"],"responses":{"200":"0c8093a2-0729-425d-9584-19552bcd215a","400":"94bb537d-cd13-47b4-abfc-094708740a3b","403":"eb73f765-99a8-45a8-ae18-a9ee062898fa","409":"f6f0e20c-9285-4408-a913-632a1f3df577","422":"1d3c40a0-3f82-4fc2-9ce4-2ba75c020d02","500":"dae07f34-6534-4e7d-9521-0952f3d1d2e6"},"method":"post","type":"path","servers":["3967813b-562c-40d9-bb92-9d6426d2f033"],"path":"/api/mcp/client","baseUrlOptions":["{baseUrl}"],"title":"Add MCP client","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","description":"MCP client configuration for creating a new client (tool_pricing not available at creation).\nThe schema varies based on connection_type:\n- HTTP/SSE: connection_string is required\n- STDIO: stdio_config is required\n- OpenAPI: openapi_config is required (spec or spec_url); connection_string must be omitted\n- InProcess: server instance must be provided programmatically (Go package only)\n","required":["connection_string","name","connection_type"],"conditionallyRequiredProperties":{"per_user_header_keys":[{"when":[[{"property":"auth_type","values":["per_user_headers"]}]]}],"token_exchange":[{"when":[[{"property":"auth_type","values":["token_exchange"]}]]}],"auth_type":[{"when":[[{"property":"per_user_discovery","values":[true]}]]}]},"properties":{"name":{"type":"string","description":"Display name for the MCP client","isRequired":true,"uniqueKey":"oneOf.0.name","typeLabel":"string"},"connection_type":{"type":"string","description":"Connection type for MCP client. `openapi` synthesizes an in-process MCP\nserver from an OpenAPI/Swagger document (see `openapi_config`): every\nsupported operation becomes a tool whose call is proxied as an HTTP\nrequest to the described API.\n","enum":["http"],"isRequired":true,"uniqueKey":"oneOf.0.connection_type","typeLabel":"enum\u003cstring>"},"connection_string":{"type":"string","description":"HTTP URL (required for HTTP connection type)","isRequired":true,"uniqueKey":"oneOf.0.connection_string","typeLabel":"string"},"client_id":{"type":"string","description":"Unique identifier for the MCP client (optional, auto-generated if not provided)","uniqueKey":"oneOf.0.client_id","typeLabel":"string"},"is_code_mode_client":{"type":"boolean","uniqueKey":"oneOf.0.is_code_mode_client","typeLabel":"boolean"},"server_type_on_slug":{"type":"string","enum":["inherit","enabled","disabled"],"default":"inherit","description":"Code mode on this client's own /mcp/\u003cslug> endpoint only. \"inherit\" follows\nis_code_mode_client, \"enabled\" turns code mode on there, \"disabled\" serves the\nclient's tools directly there. /mcp, Virtual MCP endpoints and LLM requests\nalways follow is_code_mode_client.\n","uniqueKey":"oneOf.0.server_type_on_slug","typeLabel":"enum\u003cstring>"},"is_ping_available":{"type":"boolean","default":true,"description":"Whether the MCP server supports ping for health checks.\nIf true, uses lightweight ping method for health checks.\nIf false, uses listTools method for health checks instead.\n","uniqueKey":"oneOf.0.is_ping_available","typeLabel":"boolean"},"needs_session_stickiness":{"type":"boolean","default":false,"description":"HTTP-only. Only meaningful for auth_type \"oauth\", \"headers\", or \"none\"\n(a server-level connection) — per-user auth types are always per-call\nregardless of this field. When true, Bifrost holds one persistent\nupstream connection, reused for every tool call. When false or\nomitted (the default), a fresh connection is dialed per tool call.\nCannot be set to false for connection_type \"sse\" or \"stdio\" — both\nare always sticky.\n","uniqueKey":"oneOf.0.needs_session_stickiness","typeLabel":"boolean"},"tool_sync_interval":{"type":"integer","minimum":0,"description":"Per-client tool-list sync interval in minutes. 0 (or omitted) falls back\nto the global mcp_tool_sync_interval client config.\n","uniqueKey":"oneOf.0.tool_sync_interval","typeLabel":"integer"},"max_protocol_version":{"type":"string","enum":["","auto","2026-07-28","2025-11-25","2025-06-18"],"description":"Newest MCP protocol version Bifrost offers this server; the server can\nstill negotiate an older one. \"auto\" uses the newest version Bifrost\nsupports. Omitted or \"\" follows the global mcp_max_protocol_version. Ignored for\nopenapi servers.\n","uniqueKey":"oneOf.0.max_protocol_version","typeLabel":"enum\u003cstring>"},"tool_execution_timeout":{"type":"integer","minimum":0,"description":"Per-client tool execution timeout in seconds. 0 (or omitted) falls back\nto the global mcp_tool_execution_timeout client config.\n","uniqueKey":"oneOf.0.tool_execution_timeout","typeLabel":"integer"},"max_instructions_length":{"type":"integer","minimum":0,"description":"Per-client cap on forwarded instructions, in bytes. 0 (or omitted) falls\nback to the global mcp_max_instructions_per_client client config. The\naggregate across servers is still bounded by mcp_max_instructions_total.\n","uniqueKey":"oneOf.0.max_instructions_length","typeLabel":"integer"},"allowed_extra_headers":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.allowed_extra_headers.items.[INDEX]","typeLabel":"string"},"description":"Allowlist of request-level headers callers may forward to this MCP\nserver at execution time.\n[\"*\"] => any header may be forwarded\n[] or omitted => no extra headers are forwarded\n[\"header1\", \"header2\"] => only the specified headers\n","uniqueKey":"oneOf.0.allowed_extra_headers","typeLabel":"string[]"},"auth_type":{"type":"string","enum":["none","headers","oauth","per_user_oauth","per_user_headers","token_exchange"],"description":"Authentication type for the MCP connection","conditionalRequirements":[{"when":[[{"property":"per_user_discovery","values":[true]}]]}],"uniqueKey":"oneOf.0.auth_type","typeLabel":"enum\u003cstring>"},"oauth_config_id":{"type":"string","description":"OAuth config ID for OAuth authentication.\nSet after OAuth flow is completed. References the oauth_configs table.\nOnly relevant when auth_type is \"oauth\".\n","uniqueKey":"oneOf.0.oauth_config_id","typeLabel":"string"},"headers":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"oneOf.0.headers.additionalProperties","typeLabel":"string"},"description":"Custom headers to include in requests.\nOnly used when auth_type is \"headers\".\n","uniqueKey":"oneOf.0.headers","typeLabel":"object"},"oauth_config":{"type":"object","description":"OAuth configuration for initiating OAuth flow.\nRequired when creating a client with auth_type \"oauth\" or \"per_user_oauth\".\nThis will trigger the OAuth flow and return an authorization URL\n(see the pending_oauth response variant).\n","properties":{"client_id":{"oneOf":[{"type":"string","description":"OAuth client ID. Optional if client supports dynamic client registration (RFC 7591).\nIf not provided, the server_url must be set for OAuth discovery and dynamic registration.\nSupports env./vault. references.\n","uniqueKey":"oneOf.0.oauth_config.client_id.oneOf.0","typeLabel":"string"},{"type":"object","description":"OAuth client ID. Optional if client supports dynamic client registration (RFC 7591).\nIf not provided, the server_url must be set for OAuth discovery and dynamic registration.\nSupports env./vault. references.\n","properties":{"value":{"type":"string","description":"Resolved value (redacted in GET responses for secret fields)","uniqueKey":"oneOf.0.oauth_config.client_id.oneOf.1.value","typeLabel":"string"},"ref":{"type":"string","description":"Source reference (`env.VAR_NAME` or `vault.path`); empty for plain-text values","uniqueKey":"oneOf.0.oauth_config.client_id.oneOf.1.ref","typeLabel":"string"},"type":{"type":"string","enum":["plain_text","env","vault"],"description":"Source type of the value","uniqueKey":"oneOf.0.oauth_config.client_id.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.oauth_config.client_id.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.0.oauth_config.client_id","typeLabel":"string | object"},"client_secret":{"oneOf":[{"type":"string","description":"OAuth client secret. Optional for public clients using PKCE or clients obtained via dynamic registration.\nSupports env./vault. references.\n","uniqueKey":"oneOf.0.oauth_config.client_secret.oneOf.0","typeLabel":"string"},{"type":"object","description":"OAuth client secret. Optional for public clients using PKCE or clients obtained via dynamic registration.\nSupports env./vault. references.\n","properties":{"value":{"type":"string","description":"Resolved value (redacted in GET responses for secret fields)","uniqueKey":"oneOf.0.oauth_config.client_secret.oneOf.1.value","typeLabel":"string"},"ref":{"type":"string","description":"Source reference (`env.VAR_NAME` or `vault.path`); empty for plain-text values","uniqueKey":"oneOf.0.oauth_config.client_secret.oneOf.1.ref","typeLabel":"string"},"type":{"type":"string","enum":["plain_text","env","vault"],"description":"Source type of the value","uniqueKey":"oneOf.0.oauth_config.client_secret.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.oauth_config.client_secret.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.0.oauth_config.client_secret","typeLabel":"string | object"},"authorize_url":{"type":"string","description":"OAuth authorization endpoint URL. Optional - will be discovered from server_url if not provided.\n","uniqueKey":"oneOf.0.oauth_config.authorize_url","typeLabel":"string"},"token_url":{"type":"string","description":"OAuth token endpoint URL. Optional - will be discovered from server_url if not provided.\n","uniqueKey":"oneOf.0.oauth_config.token_url","typeLabel":"string"},"registration_url":{"type":"string","description":"Dynamic client registration endpoint URL (RFC 7591). Optional - will be discovered from server_url if not provided.\n","uniqueKey":"oneOf.0.oauth_config.registration_url","typeLabel":"string"},"scopes":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.oauth_config.scopes.items.[INDEX]","typeLabel":"string"},"description":"OAuth scopes requested. Optional - can be discovered from server_url if not provided.\nExample: [\"read\", \"write\"]\n","uniqueKey":"oneOf.0.oauth_config.scopes","typeLabel":"string[]"},"resource":{"type":"string","description":"Resource indicator (RFC 8707) sent on authorization and token requests.\nOptional - identifies the protected MCP resource the token is intended\nfor, when the upstream provider supports resource indicators.\n","uniqueKey":"oneOf.0.oauth_config.resource","typeLabel":"string"}},"uniqueKey":"oneOf.0.oauth_config","typeLabel":"object"},"tools_to_execute":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.tools_to_execute.items.[INDEX]","typeLabel":"string"},"description":"Include-only list for tools.\n[\"*\"] => all tools are included\n[] => no tools are included\n[\"tool1\", \"tool2\"] => include only the specified tools\n","uniqueKey":"oneOf.0.tools_to_execute","typeLabel":"string[]"},"tools_to_auto_execute":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.tools_to_auto_execute.items.[INDEX]","typeLabel":"string"},"description":"List of tools that can be auto-executed without user approval.\nMust be a subset of tools_to_execute.\n[\"*\"] => all executable tools can be auto-executed\n[] => no tools are auto-executed\n[\"tool1\", \"tool2\"] => only specified tools can be auto-executed\n","uniqueKey":"oneOf.0.tools_to_auto_execute","typeLabel":"string[]"},"prompts_to_expose":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.prompts_to_expose.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Prompts (by the server's own name) served through Bifrost's MCP gateway.\nOmitted, null or [\"*\"] => all prompts; [] => none.\n","uniqueKey":"oneOf.0.prompts_to_expose.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Prompts (by the server's own name) served through Bifrost's MCP gateway.\nOmitted, null or [\"*\"] => all prompts; [] => none.\n","uniqueKey":"oneOf.0.prompts_to_expose.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.prompts_to_expose","typeLabel":"string[] | null"},"resources_to_expose":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.resources_to_expose.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Resource URIs and URI templates served through Bifrost's MCP gateway.\nOmitted, null or [\"*\"] => all; [] => none.\n","uniqueKey":"oneOf.0.resources_to_expose.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Resource URIs and URI templates served through Bifrost's MCP gateway.\nOmitted, null or [\"*\"] => all; [] => none.\n","uniqueKey":"oneOf.0.resources_to_expose.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.resources_to_expose","typeLabel":"string[] | null"},"endpoint_slug":{"type":"string","description":"URL-safe path segment this client is served at (/mcp/\u003cslug>). Derived from the name\nwhen omitted; rejected with 400 if no slug can be derived and 409 if it is taken.\nImmutable after creation.\n","uniqueKey":"oneOf.0.endpoint_slug","typeLabel":"string"},"tool_pricing":{"type":"object","additionalProperties":{"type":"number","format":"double","uniqueKey":"oneOf.0.tool_pricing.additionalProperties","typeLabel":"number\u003cdouble>"},"description":"Per-tool cost in USD for execution.\nKey is the tool name, value is the cost per execution.\n","uniqueKey":"oneOf.0.tool_pricing","typeLabel":"object"},"allow_by_default":{"type":"boolean","default":false,"description":"When true, this MCP client's tools are available to all virtual keys by default,\nwithout requiring an explicit virtual key assignment.\nAn explicit virtual key config always overrides this setting for that key.\n","uniqueKey":"oneOf.0.allow_by_default","typeLabel":"boolean"},"allow_on_all_virtual_keys":{"type":"boolean","deprecated":true,"description":"Deprecated earlier name of allow_by_default, still accepted. allow_by_default\ndecides when both are sent.\n","uniqueKey":"oneOf.0.allow_on_all_virtual_keys","typeLabel":"boolean"},"tls_config":{"type":"object","description":"TLS configuration for HTTP and SSE connections.\nNot applicable to stdio or inprocess connection types.\n","properties":{"insecure_skip_verify":{"type":"boolean","description":"Disable TLS certificate verification. Takes priority over ca_cert_pem when both are set.\nUse only in development or trusted isolated environments. Not recommended for production.\n","uniqueKey":"oneOf.0.tls_config.insecure_skip_verify","typeLabel":"boolean"},"ca_cert_pem":{"type":"string","description":"PEM-encoded CA certificate to trust for MCP server connections.\nUse when the MCP server uses a self-signed or private CA certificate.\nSupports env.VAR_NAME syntax to read the certificate from an environment variable.\nA value that does not parse as a PEM certificate is refused when the client is\ncreated or edited, unless insecure_skip_verify is set.\n","uniqueKey":"oneOf.0.tls_config.ca_cert_pem","typeLabel":"string"}},"uniqueKey":"oneOf.0.tls_config","typeLabel":"object"},"per_user_header_keys":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.per_user_header_keys.items.[INDEX]","typeLabel":"string"},"description":"Required when `auth_type` is `per_user_headers`. List of header names each\nend-user must supply the first time they hit this MCP server. Values are\nsubmitted per user via the inline-401 flow — never persisted on the MCP\nclient config.\n","conditionalRequirements":[{"when":[[{"property":"auth_type","values":["per_user_headers"]}]]}],"uniqueKey":"oneOf.0.per_user_header_keys","typeLabel":"string[]"},"token_exchange":{"type":"object","description":"Required when creating a client with auth_type \"token_exchange\".\nVerification runs automatically as the signed-in admin, exchanging the\nidentity-provider token on the request or, when it carries none, the\naccess token from the admin's own Bifrost sign-in (see\nPOST /api/mcp/client/{id}/verify-exchange). A request with neither,\nsuch as one made with an API key, creates the client in\npending_verification. There is no sample-token field on this request.\n","required":["audience"],"conditionallyRequiredProperties":{"client_id":[{}]},"properties":{"audience":{"type":"string","minLength":1,"description":"Resource identifier this server is scoped to at the identity provider (e.g. \"api://jira-mcp\")","isRequired":true,"uniqueKey":"oneOf.0.token_exchange.audience","typeLabel":"string"},"use_idp_credentials":{"type":"boolean","description":"When true, performs the exchange as the SSO login application itself\ninstead of client_id/client_secret below, which are then ignored.\nSome providers require this: Microsoft Entra ID's on-behalf-of grant\nonly accepts an assertion audienced to the exchanging application,\nand the SSO login flow always requests a token self-audienced to the\nSSO application, so a separate exchange application can never\nreceive a usable one.\n","uniqueKey":"oneOf.0.token_exchange.use_idp_credentials","typeLabel":"boolean"},"client_id":{"type":"string","minLength":1,"description":"The identity-provider application authorized to perform exchanges for\nthis audience — typically a dedicated registration carrying the\ntoken-exchange (or on-behalf-of) grant, separate from the SSO login\napplication. Required unless use_idp_credentials is true. Supports\nenv.VAR_NAME and vault.path references. Redacted in API responses.\n","conditionalRequirements":[{}],"uniqueKey":"oneOf.0.token_exchange.client_id","typeLabel":"string"},"client_secret":{"type":"string","description":"Secret for the exchange application; omit for public clients. Ignored\nwhen use_idp_credentials is true. Supports env.VAR_NAME and\nvault.path references. Redacted in API responses.\n","uniqueKey":"oneOf.0.token_exchange.client_secret","typeLabel":"string"},"scopes":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.token_exchange.scopes.items.[INDEX]","typeLabel":"string"},"description":"Optional scopes to request on the exchanged token. Include\n\"offline_access\" (where the identity provider supports it) so the\nretained admin discovery credential gets a refresh token and stays\nself-renewing.\n","uniqueKey":"oneOf.0.token_exchange.scopes","typeLabel":"string[]"},"authorization_server_url":{"type":"string","description":"Overrides the Authorization Server the exchange request is sent to.\nOnly needed when the audience is registered on a different\nAuthorization Server than the one used for SSO login (e.g. Okta's\nper-resource Custom Authorization Servers). Leave unset to use the\ndeployment's SSO login issuer, which is correct for providers with a\nsingle tenant-wide token endpoint (Entra, Auth0).\n","uniqueKey":"oneOf.0.token_exchange.authorization_server_url","typeLabel":"string"}},"additionalProperties":false,"conditionalRequirements":[{"when":[[{"property":"auth_type","values":["token_exchange"]}]]}],"uniqueKey":"oneOf.0.token_exchange","typeLabel":"object"},"per_user_discovery":{"type":"boolean","default":false,"description":"Per-user auth types only (`per_user_oauth`, `per_user_headers`,\n`token_exchange`), and not for connection_type \"openapi\". When true,\neach caller's tools, prompts and resources are discovered with their\nown credential when they connect, and the client keeps no admin\ncredential or discovery of its own: the admin's verification only\nchecks the server. Every caller is served their own tools, prompts,\nresources and resource templates, the MCP gateway (`/mcp`) included, and a caller who has not\nconnected yet is offered the client's `\u003cname>-connect` tool. When false\nor omitted, every caller is served what was discovered with the admin\ncredential.\n","uniqueKey":"oneOf.0.per_user_discovery","typeLabel":"boolean"},"user_headers":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"oneOf.0.user_headers.additionalProperties","typeLabel":"string"},"description":"Used only at create time when `auth_type` is `per_user_headers`. A sample\nset of header values the admin supplies so Bifrost can run a one-time\nupstream verify and discover the tool list. The create call also keeps\nthem as the client's admin discovery credential, as\nPOST /api/mcp/client/{id}/verify-headers does, used only for periodic\nand on-demand (POST /api/mcp/client/{id}/refresh-tools) tool-list\nrefresh. Keeping them is best effort: if storing the credential fails,\nthe client is still created. Each end-user submits their own values at\nruntime.\n","uniqueKey":"oneOf.0.user_headers","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","description":"MCP client configuration for creating a new client (tool_pricing not available at creation).\nThe schema varies based on connection_type:\n- HTTP/SSE: connection_string is required\n- STDIO: stdio_config is required\n- OpenAPI: openapi_config is required (spec or spec_url); connection_string must be omitted\n- InProcess: server instance must be provided programmatically (Go package only)\n","required":["connection_string","name","connection_type"],"conditionallyRequiredProperties":{"per_user_header_keys":[{"when":[[{"property":"auth_type","values":["per_user_headers"]}]]}],"token_exchange":[{"when":[[{"property":"auth_type","values":["token_exchange"]}]]}],"auth_type":[{"when":[[{"property":"per_user_discovery","values":[true]}]]}]},"properties":{"name":{"type":"string","description":"Display name for the MCP client","isRequired":true,"uniqueKey":"oneOf.1.name","typeLabel":"string"},"connection_type":{"type":"string","description":"Connection type for MCP client. `openapi` synthesizes an in-process MCP\nserver from an OpenAPI/Swagger document (see `openapi_config`): every\nsupported operation becomes a tool whose call is proxied as an HTTP\nrequest to the described API.\n","enum":["sse"],"isRequired":true,"uniqueKey":"oneOf.1.connection_type","typeLabel":"enum\u003cstring>"},"connection_string":{"type":"string","description":"SSE URL (required for SSE connection type)","isRequired":true,"uniqueKey":"oneOf.1.connection_string","typeLabel":"string"},"client_id":{"type":"string","description":"Unique identifier for the MCP client (optional, auto-generated if not provided)","uniqueKey":"oneOf.1.client_id","typeLabel":"string"},"is_code_mode_client":{"type":"boolean","uniqueKey":"oneOf.1.is_code_mode_client","typeLabel":"boolean"},"server_type_on_slug":{"type":"string","enum":["inherit","enabled","disabled"],"default":"inherit","description":"Code mode on this client's own /mcp/\u003cslug> endpoint only. \"inherit\" follows\nis_code_mode_client, \"enabled\" turns code mode on there, \"disabled\" serves the\nclient's tools directly there. /mcp, Virtual MCP endpoints and LLM requests\nalways follow is_code_mode_client.\n","uniqueKey":"oneOf.1.server_type_on_slug","typeLabel":"enum\u003cstring>"},"is_ping_available":{"type":"boolean","default":true,"description":"Whether the MCP server supports ping for health checks.\nIf true, uses lightweight ping method for health checks.\nIf false, uses listTools method for health checks instead.\n","uniqueKey":"oneOf.1.is_ping_available","typeLabel":"boolean"},"needs_session_stickiness":{"type":"boolean","default":false,"description":"HTTP-only. Only meaningful for auth_type \"oauth\", \"headers\", or \"none\"\n(a server-level connection) — per-user auth types are always per-call\nregardless of this field. When true, Bifrost holds one persistent\nupstream connection, reused for every tool call. When false or\nomitted (the default), a fresh connection is dialed per tool call.\nCannot be set to false for connection_type \"sse\" or \"stdio\" — both\nare always sticky.\n","uniqueKey":"oneOf.1.needs_session_stickiness","typeLabel":"boolean"},"tool_sync_interval":{"type":"integer","minimum":0,"description":"Per-client tool-list sync interval in minutes. 0 (or omitted) falls back\nto the global mcp_tool_sync_interval client config.\n","uniqueKey":"oneOf.1.tool_sync_interval","typeLabel":"integer"},"max_protocol_version":{"type":"string","enum":["","auto","2026-07-28","2025-11-25","2025-06-18"],"description":"Newest MCP protocol version Bifrost offers this server; the server can\nstill negotiate an older one. \"auto\" uses the newest version Bifrost\nsupports. Omitted or \"\" follows the global mcp_max_protocol_version. Ignored for\nopenapi servers.\n","uniqueKey":"oneOf.1.max_protocol_version","typeLabel":"enum\u003cstring>"},"tool_execution_timeout":{"type":"integer","minimum":0,"description":"Per-client tool execution timeout in seconds. 0 (or omitted) falls back\nto the global mcp_tool_execution_timeout client config.\n","uniqueKey":"oneOf.1.tool_execution_timeout","typeLabel":"integer"},"max_instructions_length":{"type":"integer","minimum":0,"description":"Per-client cap on forwarded instructions, in bytes. 0 (or omitted) falls\nback to the global mcp_max_instructions_per_client client config. The\naggregate across servers is still bounded by mcp_max_instructions_total.\n","uniqueKey":"oneOf.1.max_instructions_length","typeLabel":"integer"},"allowed_extra_headers":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.allowed_extra_headers.items.[INDEX]","typeLabel":"string"},"description":"Allowlist of request-level headers callers may forward to this MCP\nserver at execution time.\n[\"*\"] => any header may be forwarded\n[] or omitted => no extra headers are forwarded\n[\"header1\", \"header2\"] => only the specified headers\n","uniqueKey":"oneOf.1.allowed_extra_headers","typeLabel":"string[]"},"auth_type":{"type":"string","description":"The per-user auth types open a new connection for each call, which an\nSSE stream does not allow, so SSE takes the shared auth types only.\n","enum":["none","headers","oauth"],"conditionalRequirements":[{"when":[[{"property":"per_user_discovery","values":[true]}]]}],"uniqueKey":"oneOf.1.auth_type","typeLabel":"enum\u003cstring>"},"oauth_config_id":{"type":"string","description":"OAuth config ID for OAuth authentication.\nSet after OAuth flow is completed. References the oauth_configs table.\nOnly relevant when auth_type is \"oauth\".\n","uniqueKey":"oneOf.1.oauth_config_id","typeLabel":"string"},"headers":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"oneOf.1.headers.additionalProperties","typeLabel":"string"},"description":"Custom headers to include in requests.\nOnly used when auth_type is \"headers\".\n","uniqueKey":"oneOf.1.headers","typeLabel":"object"},"oauth_config":{"type":"object","description":"OAuth configuration for initiating OAuth flow.\nRequired when creating a client with auth_type \"oauth\" or \"per_user_oauth\".\nThis will trigger the OAuth flow and return an authorization URL\n(see the pending_oauth response variant).\n","properties":{"client_id":{"oneOf":[{"type":"string","description":"OAuth client ID. Optional if client supports dynamic client registration (RFC 7591).\nIf not provided, the server_url must be set for OAuth discovery and dynamic registration.\nSupports env./vault. references.\n","uniqueKey":"oneOf.1.oauth_config.client_id.oneOf.0","typeLabel":"string"},{"type":"object","description":"OAuth client ID. Optional if client supports dynamic client registration (RFC 7591).\nIf not provided, the server_url must be set for OAuth discovery and dynamic registration.\nSupports env./vault. references.\n","properties":{"value":{"type":"string","description":"Resolved value (redacted in GET responses for secret fields)","uniqueKey":"oneOf.1.oauth_config.client_id.oneOf.1.value","typeLabel":"string"},"ref":{"type":"string","description":"Source reference (`env.VAR_NAME` or `vault.path`); empty for plain-text values","uniqueKey":"oneOf.1.oauth_config.client_id.oneOf.1.ref","typeLabel":"string"},"type":{"type":"string","enum":["plain_text","env","vault"],"description":"Source type of the value","uniqueKey":"oneOf.1.oauth_config.client_id.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.oauth_config.client_id.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.1.oauth_config.client_id","typeLabel":"string | object"},"client_secret":{"oneOf":[{"type":"string","description":"OAuth client secret. Optional for public clients using PKCE or clients obtained via dynamic registration.\nSupports env./vault. references.\n","uniqueKey":"oneOf.1.oauth_config.client_secret.oneOf.0","typeLabel":"string"},{"type":"object","description":"OAuth client secret. Optional for public clients using PKCE or clients obtained via dynamic registration.\nSupports env./vault. references.\n","properties":{"value":{"type":"string","description":"Resolved value (redacted in GET responses for secret fields)","uniqueKey":"oneOf.1.oauth_config.client_secret.oneOf.1.value","typeLabel":"string"},"ref":{"type":"string","description":"Source reference (`env.VAR_NAME` or `vault.path`); empty for plain-text values","uniqueKey":"oneOf.1.oauth_config.client_secret.oneOf.1.ref","typeLabel":"string"},"type":{"type":"string","enum":["plain_text","env","vault"],"description":"Source type of the value","uniqueKey":"oneOf.1.oauth_config.client_secret.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.oauth_config.client_secret.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.1.oauth_config.client_secret","typeLabel":"string | object"},"authorize_url":{"type":"string","description":"OAuth authorization endpoint URL. Optional - will be discovered from server_url if not provided.\n","uniqueKey":"oneOf.1.oauth_config.authorize_url","typeLabel":"string"},"token_url":{"type":"string","description":"OAuth token endpoint URL. Optional - will be discovered from server_url if not provided.\n","uniqueKey":"oneOf.1.oauth_config.token_url","typeLabel":"string"},"registration_url":{"type":"string","description":"Dynamic client registration endpoint URL (RFC 7591). Optional - will be discovered from server_url if not provided.\n","uniqueKey":"oneOf.1.oauth_config.registration_url","typeLabel":"string"},"scopes":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.oauth_config.scopes.items.[INDEX]","typeLabel":"string"},"description":"OAuth scopes requested. Optional - can be discovered from server_url if not provided.\nExample: [\"read\", \"write\"]\n","uniqueKey":"oneOf.1.oauth_config.scopes","typeLabel":"string[]"},"resource":{"type":"string","description":"Resource indicator (RFC 8707) sent on authorization and token requests.\nOptional - identifies the protected MCP resource the token is intended\nfor, when the upstream provider supports resource indicators.\n","uniqueKey":"oneOf.1.oauth_config.resource","typeLabel":"string"}},"uniqueKey":"oneOf.1.oauth_config","typeLabel":"object"},"tools_to_execute":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.tools_to_execute.items.[INDEX]","typeLabel":"string"},"description":"Include-only list for tools.\n[\"*\"] => all tools are included\n[] => no tools are included\n[\"tool1\", \"tool2\"] => include only the specified tools\n","uniqueKey":"oneOf.1.tools_to_execute","typeLabel":"string[]"},"tools_to_auto_execute":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.tools_to_auto_execute.items.[INDEX]","typeLabel":"string"},"description":"List of tools that can be auto-executed without user approval.\nMust be a subset of tools_to_execute.\n[\"*\"] => all executable tools can be auto-executed\n[] => no tools are auto-executed\n[\"tool1\", \"tool2\"] => only specified tools can be auto-executed\n","uniqueKey":"oneOf.1.tools_to_auto_execute","typeLabel":"string[]"},"prompts_to_expose":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.prompts_to_expose.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Prompts (by the server's own name) served through Bifrost's MCP gateway.\nOmitted, null or [\"*\"] => all prompts; [] => none.\n","uniqueKey":"oneOf.1.prompts_to_expose.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Prompts (by the server's own name) served through Bifrost's MCP gateway.\nOmitted, null or [\"*\"] => all prompts; [] => none.\n","uniqueKey":"oneOf.1.prompts_to_expose.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.prompts_to_expose","typeLabel":"string[] | null"},"resources_to_expose":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.resources_to_expose.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Resource URIs and URI templates served through Bifrost's MCP gateway.\nOmitted, null or [\"*\"] => all; [] => none.\n","uniqueKey":"oneOf.1.resources_to_expose.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Resource URIs and URI templates served through Bifrost's MCP gateway.\nOmitted, null or [\"*\"] => all; [] => none.\n","uniqueKey":"oneOf.1.resources_to_expose.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.resources_to_expose","typeLabel":"string[] | null"},"endpoint_slug":{"type":"string","description":"URL-safe path segment this client is served at (/mcp/\u003cslug>). Derived from the name\nwhen omitted; rejected with 400 if no slug can be derived and 409 if it is taken.\nImmutable after creation.\n","uniqueKey":"oneOf.1.endpoint_slug","typeLabel":"string"},"tool_pricing":{"type":"object","additionalProperties":{"type":"number","format":"double","uniqueKey":"oneOf.1.tool_pricing.additionalProperties","typeLabel":"number\u003cdouble>"},"description":"Per-tool cost in USD for execution.\nKey is the tool name, value is the cost per execution.\n","uniqueKey":"oneOf.1.tool_pricing","typeLabel":"object"},"allow_by_default":{"type":"boolean","default":false,"description":"When true, this MCP client's tools are available to all virtual keys by default,\nwithout requiring an explicit virtual key assignment.\nAn explicit virtual key config always overrides this setting for that key.\n","uniqueKey":"oneOf.1.allow_by_default","typeLabel":"boolean"},"allow_on_all_virtual_keys":{"type":"boolean","deprecated":true,"description":"Deprecated earlier name of allow_by_default, still accepted. allow_by_default\ndecides when both are sent.\n","uniqueKey":"oneOf.1.allow_on_all_virtual_keys","typeLabel":"boolean"},"tls_config":{"type":"object","description":"TLS configuration for HTTP and SSE connections.\nNot applicable to stdio or inprocess connection types.\n","properties":{"insecure_skip_verify":{"type":"boolean","description":"Disable TLS certificate verification. Takes priority over ca_cert_pem when both are set.\nUse only in development or trusted isolated environments. Not recommended for production.\n","uniqueKey":"oneOf.1.tls_config.insecure_skip_verify","typeLabel":"boolean"},"ca_cert_pem":{"type":"string","description":"PEM-encoded CA certificate to trust for MCP server connections.\nUse when the MCP server uses a self-signed or private CA certificate.\nSupports env.VAR_NAME syntax to read the certificate from an environment variable.\nA value that does not parse as a PEM certificate is refused when the client is\ncreated or edited, unless insecure_skip_verify is set.\n","uniqueKey":"oneOf.1.tls_config.ca_cert_pem","typeLabel":"string"}},"uniqueKey":"oneOf.1.tls_config","typeLabel":"object"},"per_user_header_keys":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.per_user_header_keys.items.[INDEX]","typeLabel":"string"},"description":"Required when `auth_type` is `per_user_headers`. List of header names each\nend-user must supply the first time they hit this MCP server. Values are\nsubmitted per user via the inline-401 flow — never persisted on the MCP\nclient config.\n","conditionalRequirements":[{"when":[[{"property":"auth_type","values":["per_user_headers"]}]]}],"uniqueKey":"oneOf.1.per_user_header_keys","typeLabel":"string[]"},"token_exchange":{"type":"object","description":"Required when creating a client with auth_type \"token_exchange\".\nVerification runs automatically as the signed-in admin, exchanging the\nidentity-provider token on the request or, when it carries none, the\naccess token from the admin's own Bifrost sign-in (see\nPOST /api/mcp/client/{id}/verify-exchange). A request with neither,\nsuch as one made with an API key, creates the client in\npending_verification. There is no sample-token field on this request.\n","required":["audience"],"conditionallyRequiredProperties":{"client_id":[{}]},"properties":{"audience":{"type":"string","minLength":1,"description":"Resource identifier this server is scoped to at the identity provider (e.g. \"api://jira-mcp\")","isRequired":true,"uniqueKey":"oneOf.1.token_exchange.audience","typeLabel":"string"},"use_idp_credentials":{"type":"boolean","description":"When true, performs the exchange as the SSO login application itself\ninstead of client_id/client_secret below, which are then ignored.\nSome providers require this: Microsoft Entra ID's on-behalf-of grant\nonly accepts an assertion audienced to the exchanging application,\nand the SSO login flow always requests a token self-audienced to the\nSSO application, so a separate exchange application can never\nreceive a usable one.\n","uniqueKey":"oneOf.1.token_exchange.use_idp_credentials","typeLabel":"boolean"},"client_id":{"type":"string","minLength":1,"description":"The identity-provider application authorized to perform exchanges for\nthis audience — typically a dedicated registration carrying the\ntoken-exchange (or on-behalf-of) grant, separate from the SSO login\napplication. Required unless use_idp_credentials is true. Supports\nenv.VAR_NAME and vault.path references. Redacted in API responses.\n","conditionalRequirements":[{}],"uniqueKey":"oneOf.1.token_exchange.client_id","typeLabel":"string"},"client_secret":{"type":"string","description":"Secret for the exchange application; omit for public clients. Ignored\nwhen use_idp_credentials is true. Supports env.VAR_NAME and\nvault.path references. Redacted in API responses.\n","uniqueKey":"oneOf.1.token_exchange.client_secret","typeLabel":"string"},"scopes":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.token_exchange.scopes.items.[INDEX]","typeLabel":"string"},"description":"Optional scopes to request on the exchanged token. Include\n\"offline_access\" (where the identity provider supports it) so the\nretained admin discovery credential gets a refresh token and stays\nself-renewing.\n","uniqueKey":"oneOf.1.token_exchange.scopes","typeLabel":"string[]"},"authorization_server_url":{"type":"string","description":"Overrides the Authorization Server the exchange request is sent to.\nOnly needed when the audience is registered on a different\nAuthorization Server than the one used for SSO login (e.g. Okta's\nper-resource Custom Authorization Servers). Leave unset to use the\ndeployment's SSO login issuer, which is correct for providers with a\nsingle tenant-wide token endpoint (Entra, Auth0).\n","uniqueKey":"oneOf.1.token_exchange.authorization_server_url","typeLabel":"string"}},"additionalProperties":false,"conditionalRequirements":[{"when":[[{"property":"auth_type","values":["token_exchange"]}]]}],"uniqueKey":"oneOf.1.token_exchange","typeLabel":"object"},"per_user_discovery":{"type":"boolean","default":false,"description":"Per-user auth types only (`per_user_oauth`, `per_user_headers`,\n`token_exchange`), and not for connection_type \"openapi\". When true,\neach caller's tools, prompts and resources are discovered with their\nown credential when they connect, and the client keeps no admin\ncredential or discovery of its own: the admin's verification only\nchecks the server. Every caller is served their own tools, prompts,\nresources and resource templates, the MCP gateway (`/mcp`) included, and a caller who has not\nconnected yet is offered the client's `\u003cname>-connect` tool. When false\nor omitted, every caller is served what was discovered with the admin\ncredential.\n","uniqueKey":"oneOf.1.per_user_discovery","typeLabel":"boolean"},"user_headers":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"oneOf.1.user_headers.additionalProperties","typeLabel":"string"},"description":"Used only at create time when `auth_type` is `per_user_headers`. A sample\nset of header values the admin supplies so Bifrost can run a one-time\nupstream verify and discover the tool list. The create call also keeps\nthem as the client's admin discovery credential, as\nPOST /api/mcp/client/{id}/verify-headers does, used only for periodic\nand on-demand (POST /api/mcp/client/{id}/refresh-tools) tool-list\nrefresh. Keeping them is best effort: if storing the credential fails,\nthe client is still created. Each end-user submits their own values at\nruntime.\n","uniqueKey":"oneOf.1.user_headers","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"object"},{"type":"object","description":"MCP client configuration for creating a new client (tool_pricing not available at creation).\nThe schema varies based on connection_type:\n- HTTP/SSE: connection_string is required\n- STDIO: stdio_config is required\n- OpenAPI: openapi_config is required (spec or spec_url); connection_string must be omitted\n- InProcess: server instance must be provided programmatically (Go package only)\n","required":["stdio_config","name","connection_type"],"conditionallyRequiredProperties":{"per_user_header_keys":[{"when":[[{"property":"auth_type","values":["per_user_headers"]}]]}],"token_exchange":[{"when":[[{"property":"auth_type","values":["token_exchange"]}]]}],"auth_type":[{"when":[[{"property":"per_user_discovery","values":[true]}]]}]},"properties":{"name":{"type":"string","description":"Display name for the MCP client","isRequired":true,"uniqueKey":"oneOf.2.name","typeLabel":"string"},"connection_type":{"type":"string","description":"Connection type for MCP client. `openapi` synthesizes an in-process MCP\nserver from an OpenAPI/Swagger document (see `openapi_config`): every\nsupported operation becomes a tool whose call is proxied as an HTTP\nrequest to the described API.\n","enum":["stdio"],"isRequired":true,"uniqueKey":"oneOf.2.connection_type","typeLabel":"enum\u003cstring>"},"stdio_config":{"type":"object","description":"STDIO configuration (required for STDIO connection type)","properties":{"command":{"type":"string","description":"Executable command to run","uniqueKey":"oneOf.2.stdio_config.command","typeLabel":"string"},"args":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.2.stdio_config.args.items.[INDEX]","typeLabel":"string"},"description":"Command line arguments","uniqueKey":"oneOf.2.stdio_config.args","typeLabel":"string[]"},"envs":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.2.stdio_config.envs.items.[INDEX]","typeLabel":"string"},"description":"Environment variables required","uniqueKey":"oneOf.2.stdio_config.envs","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"oneOf.2.stdio_config","typeLabel":"object"},"client_id":{"type":"string","description":"Unique identifier for the MCP client (optional, auto-generated if not provided)","uniqueKey":"oneOf.2.client_id","typeLabel":"string"},"is_code_mode_client":{"type":"boolean","uniqueKey":"oneOf.2.is_code_mode_client","typeLabel":"boolean"},"server_type_on_slug":{"type":"string","enum":["inherit","enabled","disabled"],"default":"inherit","description":"Code mode on this client's own /mcp/\u003cslug> endpoint only. \"inherit\" follows\nis_code_mode_client, \"enabled\" turns code mode on there, \"disabled\" serves the\nclient's tools directly there. /mcp, Virtual MCP endpoints and LLM requests\nalways follow is_code_mode_client.\n","uniqueKey":"oneOf.2.server_type_on_slug","typeLabel":"enum\u003cstring>"},"is_ping_available":{"type":"boolean","default":true,"description":"Whether the MCP server supports ping for health checks.\nIf true, uses lightweight ping method for health checks.\nIf false, uses listTools method for health checks instead.\n","uniqueKey":"oneOf.2.is_ping_available","typeLabel":"boolean"},"needs_session_stickiness":{"type":"boolean","default":false,"description":"HTTP-only. Only meaningful for auth_type \"oauth\", \"headers\", or \"none\"\n(a server-level connection) — per-user auth types are always per-call\nregardless of this field. When true, Bifrost holds one persistent\nupstream connection, reused for every tool call. When false or\nomitted (the default), a fresh connection is dialed per tool call.\nCannot be set to false for connection_type \"sse\" or \"stdio\" — both\nare always sticky.\n","uniqueKey":"oneOf.2.needs_session_stickiness","typeLabel":"boolean"},"tool_sync_interval":{"type":"integer","minimum":0,"description":"Per-client tool-list sync interval in minutes. 0 (or omitted) falls back\nto the global mcp_tool_sync_interval client config.\n","uniqueKey":"oneOf.2.tool_sync_interval","typeLabel":"integer"},"max_protocol_version":{"type":"string","enum":["","auto","2026-07-28","2025-11-25","2025-06-18"],"description":"Newest MCP protocol version Bifrost offers this server; the server can\nstill negotiate an older one. \"auto\" uses the newest version Bifrost\nsupports. Omitted or \"\" follows the global mcp_max_protocol_version. Ignored for\nopenapi servers.\n","uniqueKey":"oneOf.2.max_protocol_version","typeLabel":"enum\u003cstring>"},"tool_execution_timeout":{"type":"integer","minimum":0,"description":"Per-client tool execution timeout in seconds. 0 (or omitted) falls back\nto the global mcp_tool_execution_timeout client config.\n","uniqueKey":"oneOf.2.tool_execution_timeout","typeLabel":"integer"},"max_instructions_length":{"type":"integer","minimum":0,"description":"Per-client cap on forwarded instructions, in bytes. 0 (or omitted) falls\nback to the global mcp_max_instructions_per_client client config. The\naggregate across servers is still bounded by mcp_max_instructions_total.\n","uniqueKey":"oneOf.2.max_instructions_length","typeLabel":"integer"},"allowed_extra_headers":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.2.allowed_extra_headers.items.[INDEX]","typeLabel":"string"},"description":"Allowlist of request-level headers callers may forward to this MCP\nserver at execution time.\n[\"*\"] => any header may be forwarded\n[] or omitted => no extra headers are forwarded\n[\"header1\", \"header2\"] => only the specified headers\n","uniqueKey":"oneOf.2.allowed_extra_headers","typeLabel":"string[]"},"auth_type":{"type":"string","description":"A STDIO subprocess is one connection for every caller, so STDIO takes\nthe shared auth types only.\n","enum":["none","headers","oauth"],"conditionalRequirements":[{"when":[[{"property":"per_user_discovery","values":[true]}]]}],"uniqueKey":"oneOf.2.auth_type","typeLabel":"enum\u003cstring>"},"oauth_config_id":{"type":"string","description":"OAuth config ID for OAuth authentication.\nSet after OAuth flow is completed. References the oauth_configs table.\nOnly relevant when auth_type is \"oauth\".\n","uniqueKey":"oneOf.2.oauth_config_id","typeLabel":"string"},"headers":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"oneOf.2.headers.additionalProperties","typeLabel":"string"},"description":"Custom headers to include in requests.\nOnly used when auth_type is \"headers\".\n","uniqueKey":"oneOf.2.headers","typeLabel":"object"},"oauth_config":{"type":"object","description":"OAuth configuration for initiating OAuth flow.\nRequired when creating a client with auth_type \"oauth\" or \"per_user_oauth\".\nThis will trigger the OAuth flow and return an authorization URL\n(see the pending_oauth response variant).\n","properties":{"client_id":{"oneOf":[{"type":"string","description":"OAuth client ID. Optional if client supports dynamic client registration (RFC 7591).\nIf not provided, the server_url must be set for OAuth discovery and dynamic registration.\nSupports env./vault. references.\n","uniqueKey":"oneOf.2.oauth_config.client_id.oneOf.0","typeLabel":"string"},{"type":"object","description":"OAuth client ID. Optional if client supports dynamic client registration (RFC 7591).\nIf not provided, the server_url must be set for OAuth discovery and dynamic registration.\nSupports env./vault. references.\n","properties":{"value":{"type":"string","description":"Resolved value (redacted in GET responses for secret fields)","uniqueKey":"oneOf.2.oauth_config.client_id.oneOf.1.value","typeLabel":"string"},"ref":{"type":"string","description":"Source reference (`env.VAR_NAME` or `vault.path`); empty for plain-text values","uniqueKey":"oneOf.2.oauth_config.client_id.oneOf.1.ref","typeLabel":"string"},"type":{"type":"string","enum":["plain_text","env","vault"],"description":"Source type of the value","uniqueKey":"oneOf.2.oauth_config.client_id.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.oauth_config.client_id.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.2.oauth_config.client_id","typeLabel":"string | object"},"client_secret":{"oneOf":[{"type":"string","description":"OAuth client secret. Optional for public clients using PKCE or clients obtained via dynamic registration.\nSupports env./vault. references.\n","uniqueKey":"oneOf.2.oauth_config.client_secret.oneOf.0","typeLabel":"string"},{"type":"object","description":"OAuth client secret. Optional for public clients using PKCE or clients obtained via dynamic registration.\nSupports env./vault. references.\n","properties":{"value":{"type":"string","description":"Resolved value (redacted in GET responses for secret fields)","uniqueKey":"oneOf.2.oauth_config.client_secret.oneOf.1.value","typeLabel":"string"},"ref":{"type":"string","description":"Source reference (`env.VAR_NAME` or `vault.path`); empty for plain-text values","uniqueKey":"oneOf.2.oauth_config.client_secret.oneOf.1.ref","typeLabel":"string"},"type":{"type":"string","enum":["plain_text","env","vault"],"description":"Source type of the value","uniqueKey":"oneOf.2.oauth_config.client_secret.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.2.oauth_config.client_secret.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.2.oauth_config.client_secret","typeLabel":"string | object"},"authorize_url":{"type":"string","description":"OAuth authorization endpoint URL. Optional - will be discovered from server_url if not provided.\n","uniqueKey":"oneOf.2.oauth_config.authorize_url","typeLabel":"string"},"token_url":{"type":"string","description":"OAuth token endpoint URL. Optional - will be discovered from server_url if not provided.\n","uniqueKey":"oneOf.2.oauth_config.token_url","typeLabel":"string"},"registration_url":{"type":"string","description":"Dynamic client registration endpoint URL (RFC 7591). Optional - will be discovered from server_url if not provided.\n","uniqueKey":"oneOf.2.oauth_config.registration_url","typeLabel":"string"},"scopes":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.2.oauth_config.scopes.items.[INDEX]","typeLabel":"string"},"description":"OAuth scopes requested. Optional - can be discovered from server_url if not provided.\nExample: [\"read\", \"write\"]\n","uniqueKey":"oneOf.2.oauth_config.scopes","typeLabel":"string[]"},"resource":{"type":"string","description":"Resource indicator (RFC 8707) sent on authorization and token requests.\nOptional - identifies the protected MCP resource the token is intended\nfor, when the upstream provider supports resource indicators.\n","uniqueKey":"oneOf.2.oauth_config.resource","typeLabel":"string"}},"uniqueKey":"oneOf.2.oauth_config","typeLabel":"object"},"tools_to_execute":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.2.tools_to_execute.items.[INDEX]","typeLabel":"string"},"description":"Include-only list for tools.\n[\"*\"] => all tools are included\n[] => no tools are included\n[\"tool1\", \"tool2\"] => include only the specified tools\n","uniqueKey":"oneOf.2.tools_to_execute","typeLabel":"string[]"},"tools_to_auto_execute":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.2.tools_to_auto_execute.items.[INDEX]","typeLabel":"string"},"description":"List of tools that can be auto-executed without user approval.\nMust be a subset of tools_to_execute.\n[\"*\"] => all executable tools can be auto-executed\n[] => no tools are auto-executed\n[\"tool1\", \"tool2\"] => only specified tools can be auto-executed\n","uniqueKey":"oneOf.2.tools_to_auto_execute","typeLabel":"string[]"},"prompts_to_expose":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"oneOf.2.prompts_to_expose.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Prompts (by the server's own name) served through Bifrost's MCP gateway.\nOmitted, null or [\"*\"] => all prompts; [] => none.\n","uniqueKey":"oneOf.2.prompts_to_expose.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Prompts (by the server's own name) served through Bifrost's MCP gateway.\nOmitted, null or [\"*\"] => all prompts; [] => none.\n","uniqueKey":"oneOf.2.prompts_to_expose.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.prompts_to_expose","typeLabel":"string[] | null"},"resources_to_expose":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"oneOf.2.resources_to_expose.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Resource URIs and URI templates served through Bifrost's MCP gateway.\nOmitted, null or [\"*\"] => all; [] => none.\n","uniqueKey":"oneOf.2.resources_to_expose.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Resource URIs and URI templates served through Bifrost's MCP gateway.\nOmitted, null or [\"*\"] => all; [] => none.\n","uniqueKey":"oneOf.2.resources_to_expose.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.resources_to_expose","typeLabel":"string[] | null"},"endpoint_slug":{"type":"string","description":"URL-safe path segment this client is served at (/mcp/\u003cslug>). Derived from the name\nwhen omitted; rejected with 400 if no slug can be derived and 409 if it is taken.\nImmutable after creation.\n","uniqueKey":"oneOf.2.endpoint_slug","typeLabel":"string"},"tool_pricing":{"type":"object","additionalProperties":{"type":"number","format":"double","uniqueKey":"oneOf.2.tool_pricing.additionalProperties","typeLabel":"number\u003cdouble>"},"description":"Per-tool cost in USD for execution.\nKey is the tool name, value is the cost per execution.\n","uniqueKey":"oneOf.2.tool_pricing","typeLabel":"object"},"allow_by_default":{"type":"boolean","default":false,"description":"When true, this MCP client's tools are available to all virtual keys by default,\nwithout requiring an explicit virtual key assignment.\nAn explicit virtual key config always overrides this setting for that key.\n","uniqueKey":"oneOf.2.allow_by_default","typeLabel":"boolean"},"allow_on_all_virtual_keys":{"type":"boolean","deprecated":true,"description":"Deprecated earlier name of allow_by_default, still accepted. allow_by_default\ndecides when both are sent.\n","uniqueKey":"oneOf.2.allow_on_all_virtual_keys","typeLabel":"boolean"},"tls_config":{"type":"object","description":"TLS configuration for HTTP and SSE connections.\nNot applicable to stdio or inprocess connection types.\n","properties":{"insecure_skip_verify":{"type":"boolean","description":"Disable TLS certificate verification. Takes priority over ca_cert_pem when both are set.\nUse only in development or trusted isolated environments. Not recommended for production.\n","uniqueKey":"oneOf.2.tls_config.insecure_skip_verify","typeLabel":"boolean"},"ca_cert_pem":{"type":"string","description":"PEM-encoded CA certificate to trust for MCP server connections.\nUse when the MCP server uses a self-signed or private CA certificate.\nSupports env.VAR_NAME syntax to read the certificate from an environment variable.\nA value that does not parse as a PEM certificate is refused when the client is\ncreated or edited, unless insecure_skip_verify is set.\n","uniqueKey":"oneOf.2.tls_config.ca_cert_pem","typeLabel":"string"}},"uniqueKey":"oneOf.2.tls_config","typeLabel":"object"},"per_user_header_keys":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.2.per_user_header_keys.items.[INDEX]","typeLabel":"string"},"description":"Required when `auth_type` is `per_user_headers`. List of header names each\nend-user must supply the first time they hit this MCP server. Values are\nsubmitted per user via the inline-401 flow — never persisted on the MCP\nclient config.\n","conditionalRequirements":[{"when":[[{"property":"auth_type","values":["per_user_headers"]}]]}],"uniqueKey":"oneOf.2.per_user_header_keys","typeLabel":"string[]"},"token_exchange":{"type":"object","description":"Required when creating a client with auth_type \"token_exchange\".\nVerification runs automatically as the signed-in admin, exchanging the\nidentity-provider token on the request or, when it carries none, the\naccess token from the admin's own Bifrost sign-in (see\nPOST /api/mcp/client/{id}/verify-exchange). A request with neither,\nsuch as one made with an API key, creates the client in\npending_verification. There is no sample-token field on this request.\n","required":["audience"],"conditionallyRequiredProperties":{"client_id":[{}]},"properties":{"audience":{"type":"string","minLength":1,"description":"Resource identifier this server is scoped to at the identity provider (e.g. \"api://jira-mcp\")","isRequired":true,"uniqueKey":"oneOf.2.token_exchange.audience","typeLabel":"string"},"use_idp_credentials":{"type":"boolean","description":"When true, performs the exchange as the SSO login application itself\ninstead of client_id/client_secret below, which are then ignored.\nSome providers require this: Microsoft Entra ID's on-behalf-of grant\nonly accepts an assertion audienced to the exchanging application,\nand the SSO login flow always requests a token self-audienced to the\nSSO application, so a separate exchange application can never\nreceive a usable one.\n","uniqueKey":"oneOf.2.token_exchange.use_idp_credentials","typeLabel":"boolean"},"client_id":{"type":"string","minLength":1,"description":"The identity-provider application authorized to perform exchanges for\nthis audience — typically a dedicated registration carrying the\ntoken-exchange (or on-behalf-of) grant, separate from the SSO login\napplication. Required unless use_idp_credentials is true. Supports\nenv.VAR_NAME and vault.path references. Redacted in API responses.\n","conditionalRequirements":[{}],"uniqueKey":"oneOf.2.token_exchange.client_id","typeLabel":"string"},"client_secret":{"type":"string","description":"Secret for the exchange application; omit for public clients. Ignored\nwhen use_idp_credentials is true. Supports env.VAR_NAME and\nvault.path references. Redacted in API responses.\n","uniqueKey":"oneOf.2.token_exchange.client_secret","typeLabel":"string"},"scopes":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.2.token_exchange.scopes.items.[INDEX]","typeLabel":"string"},"description":"Optional scopes to request on the exchanged token. Include\n\"offline_access\" (where the identity provider supports it) so the\nretained admin discovery credential gets a refresh token and stays\nself-renewing.\n","uniqueKey":"oneOf.2.token_exchange.scopes","typeLabel":"string[]"},"authorization_server_url":{"type":"string","description":"Overrides the Authorization Server the exchange request is sent to.\nOnly needed when the audience is registered on a different\nAuthorization Server than the one used for SSO login (e.g. Okta's\nper-resource Custom Authorization Servers). Leave unset to use the\ndeployment's SSO login issuer, which is correct for providers with a\nsingle tenant-wide token endpoint (Entra, Auth0).\n","uniqueKey":"oneOf.2.token_exchange.authorization_server_url","typeLabel":"string"}},"additionalProperties":false,"conditionalRequirements":[{"when":[[{"property":"auth_type","values":["token_exchange"]}]]}],"uniqueKey":"oneOf.2.token_exchange","typeLabel":"object"},"per_user_discovery":{"type":"boolean","default":false,"description":"Per-user auth types only (`per_user_oauth`, `per_user_headers`,\n`token_exchange`), and not for connection_type \"openapi\". When true,\neach caller's tools, prompts and resources are discovered with their\nown credential when they connect, and the client keeps no admin\ncredential or discovery of its own: the admin's verification only\nchecks the server. Every caller is served their own tools, prompts,\nresources and resource templates, the MCP gateway (`/mcp`) included, and a caller who has not\nconnected yet is offered the client's `\u003cname>-connect` tool. When false\nor omitted, every caller is served what was discovered with the admin\ncredential.\n","uniqueKey":"oneOf.2.per_user_discovery","typeLabel":"boolean"},"user_headers":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"oneOf.2.user_headers.additionalProperties","typeLabel":"string"},"description":"Used only at create time when `auth_type` is `per_user_headers`. A sample\nset of header values the admin supplies so Bifrost can run a one-time\nupstream verify and discover the tool list. The create call also keeps\nthem as the client's admin discovery credential, as\nPOST /api/mcp/client/{id}/verify-headers does, used only for periodic\nand on-demand (POST /api/mcp/client/{id}/refresh-tools) tool-list\nrefresh. Keeping them is best effort: if storing the credential fails,\nthe client is still created. Each end-user submits their own values at\nruntime.\n","uniqueKey":"oneOf.2.user_headers","typeLabel":"object"}},"uniqueKey":"oneOf.2","typeLabel":"object"},{"type":"object","description":"MCP client configuration for creating a new client (tool_pricing not available at creation).\nThe schema varies based on connection_type:\n- HTTP/SSE: connection_string is required\n- STDIO: stdio_config is required\n- OpenAPI: openapi_config is required (spec or spec_url); connection_string must be omitted\n- InProcess: server instance must be provided programmatically (Go package only)\n","required":["openapi_config","name","connection_type"],"conditionallyRequiredProperties":{"per_user_header_keys":[{"when":[[{"property":"auth_type","values":["per_user_headers"]}]]}],"token_exchange":[{"when":[[{"property":"auth_type","values":["token_exchange"]}]]}],"auth_type":[{"when":[[{"property":"per_user_discovery","values":[true]}]]}]},"properties":{"name":{"type":"string","description":"Display name for the MCP client","isRequired":true,"uniqueKey":"oneOf.3.name","typeLabel":"string"},"connection_type":{"type":"string","description":"Connection type for MCP client. `openapi` synthesizes an in-process MCP\nserver from an OpenAPI/Swagger document (see `openapi_config`): every\nsupported operation becomes a tool whose call is proxied as an HTTP\nrequest to the described API.\n","enum":["openapi"],"isRequired":true,"uniqueKey":"oneOf.3.connection_type","typeLabel":"enum\u003cstring>"},"openapi_config":{"type":"object","description":"Configuration of an `openapi` connection-type client. At least one of\n`spec` (inline document text, JSON or YAML) or `spec_url` supplies the\ndocument on create. A `spec_url` alone is fetched once and stored inline,\nwith `spec_url` kept as provenance. When both are sent, `spec` is the\ndocument and `spec_url` is the URL its relative servers resolve against\n(send the preview's `spec` and `spec_url` together for this). Supported documents: Swagger 2.0, OpenAPI\n3.0, 3.1 and 3.2. `spec_size`, `spec_hash`, `spec_title`,\n`openapi_version` and `operation_count` are computed by Bifrost and\ninformational on read; `spec` itself is omitted from client reads (use\nGET /api/mcp/client/{id}/openapi-spec).\n","properties":{"spec":{"type":"string","description":"Inline OpenAPI/Swagger document (JSON or YAML text). Write-only.","uniqueKey":"oneOf.3.openapi_config.spec","typeLabel":"string"},"spec_url":{"type":"string","format":"uri","description":"http(s) URL of the document. Fetched on create when spec is empty; sent with spec, it is the URL relative servers resolve against.","uniqueKey":"oneOf.3.openapi_config.spec_url","typeLabel":"string\u003curi>"},"base_url":{"type":"string","format":"uri","description":"Upstream API base URL. Defaults to the document's first server; required when the document declares none or only relative ones.","uniqueKey":"oneOf.3.openapi_config.base_url","typeLabel":"string\u003curi>"},"security_credentials":{"type":"object","additionalProperties":{"type":"object","description":"Secret material for one `securitySchemes` entry. `apiKey` and `http`\nbearer schemes use `value`; `http` basic uses `username` and `password`.\nValues accept `env.VAR` and `vault.path` references. Responses return\nredacted placeholders; sending a placeholder back on update keeps the\nstored secret.\n","properties":{"value":{"type":"string","uniqueKey":"oneOf.3.openapi_config.security_credentials.additionalProperties.value","typeLabel":"string"},"username":{"type":"string","uniqueKey":"oneOf.3.openapi_config.security_credentials.additionalProperties.username","typeLabel":"string"},"password":{"type":"string","uniqueKey":"oneOf.3.openapi_config.security_credentials.additionalProperties.password","typeLabel":"string"}},"uniqueKey":"oneOf.3.openapi_config.security_credentials.additionalProperties","typeLabel":"object"},"description":"Credentials keyed by the document's securitySchemes name.","uniqueKey":"oneOf.3.openapi_config.security_credentials","typeLabel":"object"},"include_deprecated":{"type":"boolean","default":false,"description":"Expose operations the document marks deprecated.","uniqueKey":"oneOf.3.openapi_config.include_deprecated","typeLabel":"boolean"},"max_response_bytes":{"type":"integer","minimum":0,"description":"Cap on the upstream response body returned to the model (0 = default 64 KiB).","uniqueKey":"oneOf.3.openapi_config.max_response_bytes","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"oneOf.3.openapi_config","typeLabel":"object"},"client_id":{"type":"string","description":"Unique identifier for the MCP client (optional, auto-generated if not provided)","uniqueKey":"oneOf.3.client_id","typeLabel":"string"},"is_code_mode_client":{"type":"boolean","uniqueKey":"oneOf.3.is_code_mode_client","typeLabel":"boolean"},"server_type_on_slug":{"type":"string","enum":["inherit","enabled","disabled"],"default":"inherit","description":"Code mode on this client's own /mcp/\u003cslug> endpoint only. \"inherit\" follows\nis_code_mode_client, \"enabled\" turns code mode on there, \"disabled\" serves the\nclient's tools directly there. /mcp, Virtual MCP endpoints and LLM requests\nalways follow is_code_mode_client.\n","uniqueKey":"oneOf.3.server_type_on_slug","typeLabel":"enum\u003cstring>"},"is_ping_available":{"type":"boolean","default":true,"description":"Whether the MCP server supports ping for health checks.\nIf true, uses lightweight ping method for health checks.\nIf false, uses listTools method for health checks instead.\n","uniqueKey":"oneOf.3.is_ping_available","typeLabel":"boolean"},"needs_session_stickiness":{"type":"boolean","default":false,"description":"HTTP-only. Only meaningful for auth_type \"oauth\", \"headers\", or \"none\"\n(a server-level connection) — per-user auth types are always per-call\nregardless of this field. When true, Bifrost holds one persistent\nupstream connection, reused for every tool call. When false or\nomitted (the default), a fresh connection is dialed per tool call.\nCannot be set to false for connection_type \"sse\" or \"stdio\" — both\nare always sticky.\n","uniqueKey":"oneOf.3.needs_session_stickiness","typeLabel":"boolean"},"tool_sync_interval":{"type":"integer","minimum":0,"description":"Per-client tool-list sync interval in minutes. 0 (or omitted) falls back\nto the global mcp_tool_sync_interval client config.\n","uniqueKey":"oneOf.3.tool_sync_interval","typeLabel":"integer"},"max_protocol_version":{"type":"string","enum":["","auto","2026-07-28","2025-11-25","2025-06-18"],"description":"Newest MCP protocol version Bifrost offers this server; the server can\nstill negotiate an older one. \"auto\" uses the newest version Bifrost\nsupports. Omitted or \"\" follows the global mcp_max_protocol_version. Ignored for\nopenapi servers.\n","uniqueKey":"oneOf.3.max_protocol_version","typeLabel":"enum\u003cstring>"},"tool_execution_timeout":{"type":"integer","minimum":0,"description":"Per-client tool execution timeout in seconds. 0 (or omitted) falls back\nto the global mcp_tool_execution_timeout client config.\n","uniqueKey":"oneOf.3.tool_execution_timeout","typeLabel":"integer"},"max_instructions_length":{"type":"integer","minimum":0,"description":"Per-client cap on forwarded instructions, in bytes. 0 (or omitted) falls\nback to the global mcp_max_instructions_per_client client config. The\naggregate across servers is still bounded by mcp_max_instructions_total.\n","uniqueKey":"oneOf.3.max_instructions_length","typeLabel":"integer"},"allowed_extra_headers":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.3.allowed_extra_headers.items.[INDEX]","typeLabel":"string"},"description":"Allowlist of request-level headers callers may forward to this MCP\nserver at execution time.\n[\"*\"] => any header may be forwarded\n[] or omitted => no extra headers are forwarded\n[\"header1\", \"header2\"] => only the specified headers\n","uniqueKey":"oneOf.3.allowed_extra_headers","typeLabel":"string[]"},"auth_type":{"type":"string","description":"The synthesized server has no remote MCP handshake, so only the\nheader-shaped auth types apply. Static `headers` and per-user\nheaders are forwarded to the upstream API on every call; the\ndocument's own security schemes are satisfied from\n`openapi_config.security_credentials`. OAuth-flavored and\ntoken-exchange auth types are rejected with 400.\n","enum":["none","headers","per_user_headers"],"conditionalRequirements":[{"when":[[{"property":"per_user_discovery","values":[true]}]]}],"uniqueKey":"oneOf.3.auth_type","typeLabel":"enum\u003cstring>"},"oauth_config_id":{"type":"string","description":"OAuth config ID for OAuth authentication.\nSet after OAuth flow is completed. References the oauth_configs table.\nOnly relevant when auth_type is \"oauth\".\n","uniqueKey":"oneOf.3.oauth_config_id","typeLabel":"string"},"headers":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"oneOf.3.headers.additionalProperties","typeLabel":"string"},"description":"Custom headers to include in requests.\nOnly used when auth_type is \"headers\".\n","uniqueKey":"oneOf.3.headers","typeLabel":"object"},"oauth_config":{"type":"object","description":"OAuth configuration for initiating OAuth flow.\nRequired when creating a client with auth_type \"oauth\" or \"per_user_oauth\".\nThis will trigger the OAuth flow and return an authorization URL\n(see the pending_oauth response variant).\n","properties":{"client_id":{"oneOf":[{"type":"string","description":"OAuth client ID. Optional if client supports dynamic client registration (RFC 7591).\nIf not provided, the server_url must be set for OAuth discovery and dynamic registration.\nSupports env./vault. references.\n","uniqueKey":"oneOf.3.oauth_config.client_id.oneOf.0","typeLabel":"string"},{"type":"object","description":"OAuth client ID. Optional if client supports dynamic client registration (RFC 7591).\nIf not provided, the server_url must be set for OAuth discovery and dynamic registration.\nSupports env./vault. references.\n","properties":{"value":{"type":"string","description":"Resolved value (redacted in GET responses for secret fields)","uniqueKey":"oneOf.3.oauth_config.client_id.oneOf.1.value","typeLabel":"string"},"ref":{"type":"string","description":"Source reference (`env.VAR_NAME` or `vault.path`); empty for plain-text values","uniqueKey":"oneOf.3.oauth_config.client_id.oneOf.1.ref","typeLabel":"string"},"type":{"type":"string","enum":["plain_text","env","vault"],"description":"Source type of the value","uniqueKey":"oneOf.3.oauth_config.client_id.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.oauth_config.client_id.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.3.oauth_config.client_id","typeLabel":"string | object"},"client_secret":{"oneOf":[{"type":"string","description":"OAuth client secret. Optional for public clients using PKCE or clients obtained via dynamic registration.\nSupports env./vault. references.\n","uniqueKey":"oneOf.3.oauth_config.client_secret.oneOf.0","typeLabel":"string"},{"type":"object","description":"OAuth client secret. Optional for public clients using PKCE or clients obtained via dynamic registration.\nSupports env./vault. references.\n","properties":{"value":{"type":"string","description":"Resolved value (redacted in GET responses for secret fields)","uniqueKey":"oneOf.3.oauth_config.client_secret.oneOf.1.value","typeLabel":"string"},"ref":{"type":"string","description":"Source reference (`env.VAR_NAME` or `vault.path`); empty for plain-text values","uniqueKey":"oneOf.3.oauth_config.client_secret.oneOf.1.ref","typeLabel":"string"},"type":{"type":"string","enum":["plain_text","env","vault"],"description":"Source type of the value","uniqueKey":"oneOf.3.oauth_config.client_secret.oneOf.1.type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.3.oauth_config.client_secret.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.3.oauth_config.client_secret","typeLabel":"string | object"},"authorize_url":{"type":"string","description":"OAuth authorization endpoint URL. Optional - will be discovered from server_url if not provided.\n","uniqueKey":"oneOf.3.oauth_config.authorize_url","typeLabel":"string"},"token_url":{"type":"string","description":"OAuth token endpoint URL. Optional - will be discovered from server_url if not provided.\n","uniqueKey":"oneOf.3.oauth_config.token_url","typeLabel":"string"},"registration_url":{"type":"string","description":"Dynamic client registration endpoint URL (RFC 7591). Optional - will be discovered from server_url if not provided.\n","uniqueKey":"oneOf.3.oauth_config.registration_url","typeLabel":"string"},"scopes":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.3.oauth_config.scopes.items.[INDEX]","typeLabel":"string"},"description":"OAuth scopes requested. Optional - can be discovered from server_url if not provided.\nExample: [\"read\", \"write\"]\n","uniqueKey":"oneOf.3.oauth_config.scopes","typeLabel":"string[]"},"resource":{"type":"string","description":"Resource indicator (RFC 8707) sent on authorization and token requests.\nOptional - identifies the protected MCP resource the token is intended\nfor, when the upstream provider supports resource indicators.\n","uniqueKey":"oneOf.3.oauth_config.resource","typeLabel":"string"}},"uniqueKey":"oneOf.3.oauth_config","typeLabel":"object"},"tools_to_execute":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.3.tools_to_execute.items.[INDEX]","typeLabel":"string"},"description":"Synthesized tool names to expose (`[\"*\"]` for all). Names come from\nthe preview endpoint; an entry the document does not define is\nrejected with 400.\n","uniqueKey":"oneOf.3.tools_to_execute","typeLabel":"string[]"},"tools_to_auto_execute":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.3.tools_to_auto_execute.items.[INDEX]","typeLabel":"string"},"description":"List of tools that can be auto-executed without user approval.\nMust be a subset of tools_to_execute.\n[\"*\"] => all executable tools can be auto-executed\n[] => no tools are auto-executed\n[\"tool1\", \"tool2\"] => only specified tools can be auto-executed\n","uniqueKey":"oneOf.3.tools_to_auto_execute","typeLabel":"string[]"},"prompts_to_expose":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"oneOf.3.prompts_to_expose.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Prompts (by the server's own name) served through Bifrost's MCP gateway.\nOmitted, null or [\"*\"] => all prompts; [] => none.\n","uniqueKey":"oneOf.3.prompts_to_expose.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Prompts (by the server's own name) served through Bifrost's MCP gateway.\nOmitted, null or [\"*\"] => all prompts; [] => none.\n","uniqueKey":"oneOf.3.prompts_to_expose.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.3.prompts_to_expose","typeLabel":"string[] | null"},"resources_to_expose":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"oneOf.3.resources_to_expose.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Resource URIs and URI templates served through Bifrost's MCP gateway.\nOmitted, null or [\"*\"] => all; [] => none.\n","uniqueKey":"oneOf.3.resources_to_expose.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Resource URIs and URI templates served through Bifrost's MCP gateway.\nOmitted, null or [\"*\"] => all; [] => none.\n","uniqueKey":"oneOf.3.resources_to_expose.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.3.resources_to_expose","typeLabel":"string[] | null"},"endpoint_slug":{"type":"string","description":"URL-safe path segment this client is served at (/mcp/\u003cslug>). Derived from the name\nwhen omitted; rejected with 400 if no slug can be derived and 409 if it is taken.\nImmutable after creation.\n","uniqueKey":"oneOf.3.endpoint_slug","typeLabel":"string"},"tool_pricing":{"type":"object","additionalProperties":{"type":"number","format":"double","uniqueKey":"oneOf.3.tool_pricing.additionalProperties","typeLabel":"number\u003cdouble>"},"description":"Per-tool cost in USD for execution.\nKey is the tool name, value is the cost per execution.\n","uniqueKey":"oneOf.3.tool_pricing","typeLabel":"object"},"allow_by_default":{"type":"boolean","default":false,"description":"When true, this MCP client's tools are available to all virtual keys by default,\nwithout requiring an explicit virtual key assignment.\nAn explicit virtual key config always overrides this setting for that key.\n","uniqueKey":"oneOf.3.allow_by_default","typeLabel":"boolean"},"allow_on_all_virtual_keys":{"type":"boolean","deprecated":true,"description":"Deprecated earlier name of allow_by_default, still accepted. allow_by_default\ndecides when both are sent.\n","uniqueKey":"oneOf.3.allow_on_all_virtual_keys","typeLabel":"boolean"},"tls_config":{"type":"object","description":"TLS configuration for HTTP and SSE connections.\nNot applicable to stdio or inprocess connection types.\n","properties":{"insecure_skip_verify":{"type":"boolean","description":"Disable TLS certificate verification. Takes priority over ca_cert_pem when both are set.\nUse only in development or trusted isolated environments. Not recommended for production.\n","uniqueKey":"oneOf.3.tls_config.insecure_skip_verify","typeLabel":"boolean"},"ca_cert_pem":{"type":"string","description":"PEM-encoded CA certificate to trust for MCP server connections.\nUse when the MCP server uses a self-signed or private CA certificate.\nSupports env.VAR_NAME syntax to read the certificate from an environment variable.\nA value that does not parse as a PEM certificate is refused when the client is\ncreated or edited, unless insecure_skip_verify is set.\n","uniqueKey":"oneOf.3.tls_config.ca_cert_pem","typeLabel":"string"}},"uniqueKey":"oneOf.3.tls_config","typeLabel":"object"},"per_user_header_keys":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.3.per_user_header_keys.items.[INDEX]","typeLabel":"string"},"description":"Required when `auth_type` is `per_user_headers`. List of header names each\nend-user must supply the first time they hit this MCP server. Values are\nsubmitted per user via the inline-401 flow — never persisted on the MCP\nclient config.\n","conditionalRequirements":[{"when":[[{"property":"auth_type","values":["per_user_headers"]}]]}],"uniqueKey":"oneOf.3.per_user_header_keys","typeLabel":"string[]"},"token_exchange":{"type":"object","description":"Required when creating a client with auth_type \"token_exchange\".\nVerification runs automatically as the signed-in admin, exchanging the\nidentity-provider token on the request or, when it carries none, the\naccess token from the admin's own Bifrost sign-in (see\nPOST /api/mcp/client/{id}/verify-exchange). A request with neither,\nsuch as one made with an API key, creates the client in\npending_verification. There is no sample-token field on this request.\n","required":["audience"],"conditionallyRequiredProperties":{"client_id":[{}]},"properties":{"audience":{"type":"string","minLength":1,"description":"Resource identifier this server is scoped to at the identity provider (e.g. \"api://jira-mcp\")","isRequired":true,"uniqueKey":"oneOf.3.token_exchange.audience","typeLabel":"string"},"use_idp_credentials":{"type":"boolean","description":"When true, performs the exchange as the SSO login application itself\ninstead of client_id/client_secret below, which are then ignored.\nSome providers require this: Microsoft Entra ID's on-behalf-of grant\nonly accepts an assertion audienced to the exchanging application,\nand the SSO login flow always requests a token self-audienced to the\nSSO application, so a separate exchange application can never\nreceive a usable one.\n","uniqueKey":"oneOf.3.token_exchange.use_idp_credentials","typeLabel":"boolean"},"client_id":{"type":"string","minLength":1,"description":"The identity-provider application authorized to perform exchanges for\nthis audience — typically a dedicated registration carrying the\ntoken-exchange (or on-behalf-of) grant, separate from the SSO login\napplication. Required unless use_idp_credentials is true. Supports\nenv.VAR_NAME and vault.path references. Redacted in API responses.\n","conditionalRequirements":[{}],"uniqueKey":"oneOf.3.token_exchange.client_id","typeLabel":"string"},"client_secret":{"type":"string","description":"Secret for the exchange application; omit for public clients. Ignored\nwhen use_idp_credentials is true. Supports env.VAR_NAME and\nvault.path references. Redacted in API responses.\n","uniqueKey":"oneOf.3.token_exchange.client_secret","typeLabel":"string"},"scopes":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.3.token_exchange.scopes.items.[INDEX]","typeLabel":"string"},"description":"Optional scopes to request on the exchanged token. Include\n\"offline_access\" (where the identity provider supports it) so the\nretained admin discovery credential gets a refresh token and stays\nself-renewing.\n","uniqueKey":"oneOf.3.token_exchange.scopes","typeLabel":"string[]"},"authorization_server_url":{"type":"string","description":"Overrides the Authorization Server the exchange request is sent to.\nOnly needed when the audience is registered on a different\nAuthorization Server than the one used for SSO login (e.g. Okta's\nper-resource Custom Authorization Servers). Leave unset to use the\ndeployment's SSO login issuer, which is correct for providers with a\nsingle tenant-wide token endpoint (Entra, Auth0).\n","uniqueKey":"oneOf.3.token_exchange.authorization_server_url","typeLabel":"string"}},"additionalProperties":false,"conditionalRequirements":[{"when":[[{"property":"auth_type","values":["token_exchange"]}]]}],"uniqueKey":"oneOf.3.token_exchange","typeLabel":"object"},"per_user_discovery":{"type":"boolean","default":false,"description":"Per-user auth types only (`per_user_oauth`, `per_user_headers`,\n`token_exchange`), and not for connection_type \"openapi\". When true,\neach caller's tools, prompts and resources are discovered with their\nown credential when they connect, and the client keeps no admin\ncredential or discovery of its own: the admin's verification only\nchecks the server. Every caller is served their own tools, prompts,\nresources and resource templates, the MCP gateway (`/mcp`) included, and a caller who has not\nconnected yet is offered the client's `\u003cname>-connect` tool. When false\nor omitted, every caller is served what was discovered with the admin\ncredential.\n","uniqueKey":"oneOf.3.per_user_discovery","typeLabel":"boolean"},"user_headers":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"oneOf.3.user_headers.additionalProperties","typeLabel":"string"},"description":"Used only at create time when `auth_type` is `per_user_headers`. A sample\nset of header values the admin supplies so Bifrost can run a one-time\nupstream verify and discover the tool list. The create call also keeps\nthem as the client's admin discovery credential, as\nPOST /api/mcp/client/{id}/verify-headers does, used only for periodic\nand on-demand (POST /api/mcp/client/{id}/refresh-tools) tool-list\nrefresh. Keeping them is best effort: if storing the credential fails,\nthe client is still created. Each end-user submits their own values at\nruntime.\n","uniqueKey":"oneOf.3.user_headers","typeLabel":"object"}},"uniqueKey":"oneOf.3","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","connection_type":"http","connection_string":"\u003cstring>","client_id":"\u003cstring>","is_code_mode_client":true,"server_type_on_slug":"inherit","is_ping_available":true,"needs_session_stickiness":false,"tool_sync_interval":1,"tool_execution_timeout":1,"max_instructions_length":1,"allowed_extra_headers":["\u003cstring>"],"oauth_config_id":"\u003cstring>","headers":{},"oauth_config":{"client_id":"\u003cstring>","client_secret":"\u003cstring>","authorize_url":"\u003cstring>","token_url":"\u003cstring>","registration_url":"\u003cstring>","scopes":["\u003cstring>"],"resource":"\u003cstring>"},"tools_to_execute":["\u003cstring>"],"tools_to_auto_execute":["\u003cstring>"],"prompts_to_expose":["\u003cstring>"],"resources_to_expose":["\u003cstring>"],"endpoint_slug":"\u003cstring>","tool_pricing":{},"allow_by_default":false,"allow_on_all_virtual_keys":true,"tls_config":{"insecure_skip_verify":true,"ca_cert_pem":"\u003cstring>"},"per_user_header_keys":["\u003cstring>"],"per_user_discovery":false,"user_headers":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"0c8093a2-0729-425d-9584-19552bcd215a":{"description":"MCP client added successfully. For auth_type \"oauth\" and\n\"per_user_oauth\" the client is not created yet — the response is the\npending_oauth variant carrying authorize_url plus status_url /\ncomplete_url / next_steps hints; the client is created when the flow\nis completed via complete_url.\n","content":{"application/json":{"schema":{"oneOf":[{"type":"object","description":"Generic success response","properties":{"status":{"type":"string","example":"success","uniqueKey":"oneOf.0.status","typeLabel":"string"},"message":{"type":"string","example":"Operation completed successfully","uniqueKey":"oneOf.0.message","typeLabel":"string"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","description":"Response when initiating an OAuth flow","properties":{"status":{"type":"string","enum":["pending_oauth"],"uniqueKey":"oneOf.1.status","typeLabel":"enum\u003cstring>"},"message":{"type":"string","uniqueKey":"oneOf.1.message","typeLabel":"string"},"oauth_config_id":{"type":"string","description":"ID of the OAuth config created for this flow","uniqueKey":"oneOf.1.oauth_config_id","typeLabel":"string"},"flow_id":{"type":"string","description":"ID of the flow row driving this consent. Returned by\nPOST /api/mcp/client/{id}/reauthorize, whose OAuth config has been\n\"authorized\" since the client was first verified; pass it as the\nflow_id query parameter on status polls so they report this flow's\nown state rather than that stale bootstrap status. Create-time flows\ndo not need it (their config starts \"pending\").\n","uniqueKey":"oneOf.1.flow_id","typeLabel":"string"},"authorize_url":{"type":"string","description":"URL to redirect the user to for authorization","uniqueKey":"oneOf.1.authorize_url","typeLabel":"string"},"expires_at":{"type":"string","format":"date-time","description":"When the OAuth authorization request expires","uniqueKey":"oneOf.1.expires_at","typeLabel":"string\u003cdate-time>"},"mcp_client_id":{"type":"string","description":"The MCP client ID that initiated this OAuth flow","uniqueKey":"oneOf.1.mcp_client_id","typeLabel":"string"},"complete_url":{"type":"string","description":"Relative URL to POST once the flow is authorized\n(/api/mcp/client/{oauth_config_id}/complete-oauth). Note the path\nparameter is the oauth_config_id, not the MCP client ID.\n","uniqueKey":"oneOf.1.complete_url","typeLabel":"string"},"status_url":{"type":"string","description":"Relative URL to poll for the flow status\n(/api/oauth/config/{oauth_config_id}/status, with ?flow_id=\nappended for reauthorize flows). Wait for status \"authorized\"\nbefore calling complete_url.\n","uniqueKey":"oneOf.1.status_url","typeLabel":"string"},"next_steps":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.next_steps.items.[INDEX]","typeLabel":"string"},"description":"Human-readable steps to complete the flow (authorize, poll, complete)","uniqueKey":"oneOf.1.next_steps","typeLabel":"string[]"},"registered_client_id":{"type":"string","description":"The OAuth client_id the provider issued for the replacement client,\nwhich is the one authorize_url runs consent against. Returned only by\nPOST /api/mcp/client/{id}/reregister. This is the provider's OAuth\nclient_id, not the MCP client ID in mcp_client_id.\n","uniqueKey":"oneOf.1.registered_client_id","typeLabel":"string"},"previous_client_id":{"type":"string","description":"The OAuth client_id that registered_client_id replaced. Returned only\nby POST /api/mcp/client/{id}/reregister. Equal to\nregistered_client_id when the provider answered the registration with\nthe client it already held, in which case nothing was replaced and no\ntoken was invalidated.\n","uniqueKey":"oneOf.1.previous_client_id","typeLabel":"string"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"status":"success","message":"Operation completed successfully"}}},"exampleType":"generated"}},"exampleType":"generated"},"94bb537d-cd13-47b4-abfc-094708740a3b":{"description":"Bad request","content":{"application/json":{"schema":{"type":"object","description":"Error response from Bifrost","properties":{"event_id":{"type":"string","uniqueKey":"event_id","typeLabel":"string"},"type":{"type":"string","uniqueKey":"type","typeLabel":"string"},"is_bifrost_error":{"type":"boolean","uniqueKey":"is_bifrost_error","typeLabel":"boolean"},"status_code":{"type":"integer","uniqueKey":"status_code","typeLabel":"integer"},"error":{"type":"object","properties":{"type":{"type":"string","uniqueKey":"error.type","typeLabel":"string"},"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"param":{"type":"string","uniqueKey":"error.param","typeLabel":"string"},"event_id":{"type":"string","uniqueKey":"error.event_id","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"},"extra_fields":{"type":"object","properties":{"routing_info":{"type":"object","description":"Which provider, model and key handled the attempt that produced this response or error, and what the caller asked for. Also sent as x-bifrost-routing-info-* response headers.","properties":{"provider":{"type":"string","description":"Provider that ran the attempt","enum":["anthropic","azure","bedrock","bedrock_mantle","sagemaker","cerebras","cohere","deepseek","gemini","groq","mistral","ollama","opencode-go","opencode-zen","openai","parasail","perplexity","sgl","vertex","openrouter","elevenlabs","huggingface","nebius","xai","replicate","vllm","runway","runware","fireworks","sarvam","wafer","databricks","cloudflare","typesafe","minimax","byteplus","machgen","baseten","kimchi","soniox"],"uniqueKey":"extra_fields.routing_info.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"Model sent to that provider","uniqueKey":"extra_fields.routing_info.model","typeLabel":"string"},"key":{"type":"string","description":"Name of the stored key used, never its ID or secret","uniqueKey":"extra_fields.routing_info.key","typeLabel":"string"},"resolved_key_alias":{"type":"object","description":"Set only when the requested model matched a model alias on the key","required":["model_id"],"properties":{"model_id":{"type":"string","description":"Model ID sent to the provider","isRequired":true,"uniqueKey":"extra_fields.routing_info.resolved_key_alias.model_id","typeLabel":"string"},"model_name":{"type":"string","description":"Canonical model name, used for pricing and logs","uniqueKey":"extra_fields.routing_info.resolved_key_alias.model_name","typeLabel":"string"},"model_family":{"type":"string","description":"Resolved model family","uniqueKey":"extra_fields.routing_info.resolved_key_alias.model_family","typeLabel":"string"}},"uniqueKey":"extra_fields.routing_info.resolved_key_alias","typeLabel":"object"},"is_fallback":{"type":"boolean","description":"True when a fallback served the request or returned the error. Omitted when false.","uniqueKey":"extra_fields.routing_info.is_fallback","typeLabel":"boolean"},"primary_provider":{"type":"string","description":"The primary attempt's provider. Set only when a fallback ran.","enum":["anthropic","azure","bedrock","bedrock_mantle","sagemaker","cerebras","cohere","deepseek","gemini","groq","mistral","ollama","opencode-go","opencode-zen","openai","parasail","perplexity","sgl","vertex","openrouter","elevenlabs","huggingface","nebius","xai","replicate","vllm","runway","runware","fireworks","sarvam","wafer","databricks","cloudflare","typesafe","minimax","byteplus","machgen","baseten","kimchi","soniox"],"uniqueKey":"extra_fields.routing_info.primary_provider","typeLabel":"enum\u003cstring>"},"primary_model":{"type":"string","description":"The primary attempt's model. Set only when a fallback ran.","uniqueKey":"extra_fields.routing_info.primary_model","typeLabel":"string"},"requested_provider":{"type":"string","description":"Provider the caller asked for, before routing rules, load balancing or session affinity changed it. Omitted when the caller sent a bare model.","enum":["anthropic","azure","bedrock","bedrock_mantle","sagemaker","cerebras","cohere","deepseek","gemini","groq","mistral","ollama","opencode-go","opencode-zen","openai","parasail","perplexity","sgl","vertex","openrouter","elevenlabs","huggingface","nebius","xai","replicate","vllm","runway","runware","fireworks","sarvam","wafer","databricks","cloudflare","typesafe","minimax","byteplus","machgen","baseten","kimchi","soniox"],"uniqueKey":"extra_fields.routing_info.requested_provider","typeLabel":"enum\u003cstring>"},"requested_model":{"type":"string","description":"Model the caller asked for, before anything changed it","uniqueKey":"extra_fields.routing_info.requested_model","typeLabel":"string"},"server_side_fallback_model":{"type":"string","description":"Model that answered when Anthropic switched models inside one call","uniqueKey":"extra_fields.routing_info.server_side_fallback_model","typeLabel":"string"}},"uniqueKey":"extra_fields.routing_info","typeLabel":"object"},"provider":{"type":"string","description":"Deprecated: use routing_info.provider.","enum":["anthropic","azure","bedrock","bedrock_mantle","sagemaker","cerebras","cohere","deepseek","gemini","groq","mistral","ollama","opencode-go","opencode-zen","openai","parasail","perplexity","sgl","vertex","openrouter","elevenlabs","huggingface","nebius","xai","replicate","vllm","runway","runware","fireworks","sarvam","wafer","databricks","cloudflare","typesafe","minimax","byteplus","machgen","baseten","kimchi","soniox"],"deprecated":true,"uniqueKey":"extra_fields.provider","typeLabel":"enum\u003cstring>"},"original_model_requested":{"type":"string","deprecated":true,"description":"Deprecated: use routing_info.primary_model when routing_info.is_fallback is true, otherwise routing_info.model. For the model the caller asked for, read routing_info.requested_model.","uniqueKey":"extra_fields.original_model_requested","typeLabel":"string"},"resolved_model_used":{"type":"string","deprecated":true,"description":"Deprecated: use routing_info.resolved_key_alias.model_id when an alias matched, otherwise routing_info.model.","uniqueKey":"extra_fields.resolved_model_used","typeLabel":"string"},"request_type":{"type":"string","uniqueKey":"extra_fields.request_type","typeLabel":"string"},"mcp_request_type":{"type":"string","uniqueKey":"extra_fields.mcp_request_type","typeLabel":"string"},"a2a_request_type":{"type":"string","description":"Agent Gateway operation, for A2A errors","uniqueKey":"extra_fields.a2a_request_type","typeLabel":"string"},"a2a_agent_name":{"type":"string","uniqueKey":"extra_fields.a2a_agent_name","typeLabel":"string"},"error_type":{"type":"string","description":"Normalized, low-cardinality classification of why the request failed, declared by whichever component refused it. Prefixed by fault domain (caller_, policy_, provider_, bifrost_). Absent on failures that were not classified at source.","uniqueKey":"extra_fields.error_type","typeLabel":"string"},"retry_after_ms":{"type":"integer","format":"int64","minimum":1000,"maximum":300000,"description":"The provider's hint for how long to wait before retrying, in milliseconds, read from its retry-after-ms or Retry-After header or its google.rpc.RetryInfo error detail, and clamped to between 1000 and 300000. Absent when the provider gave no explicit hint.","uniqueKey":"extra_fields.retry_after_ms","typeLabel":"integer\u003cint64>"},"raw_request":{"description":"Raw provider request, when raw request capture is enabled","uniqueKey":"extra_fields.raw_request","typeLabel":"any"},"raw_response":{"description":"Raw provider response, when raw response capture is enabled","uniqueKey":"extra_fields.raw_response","typeLabel":"any"},"converted_request_type":{"type":"string","uniqueKey":"extra_fields.converted_request_type","typeLabel":"string"},"dropped_compat_plugin_params":{"type":"array","items":{"type":"string","uniqueKey":"extra_fields.dropped_compat_plugin_params.items.[INDEX]","typeLabel":"string"},"uniqueKey":"extra_fields.dropped_compat_plugin_params","typeLabel":"string[]"},"latency":{"type":"integer","format":"int64","description":"Latency in milliseconds","uniqueKey":"extra_fields.latency","typeLabel":"integer\u003cint64>"},"key_statuses":{"type":"array","description":"Per-key results, for requests that ran on every key such as listing models","items":{"type":"object","properties":{"key_id":{"type":"string","uniqueKey":"extra_fields.key_statuses.items.[INDEX].key_id","typeLabel":"string"},"status":{"type":"string","enum":["success","list_models_failed"],"uniqueKey":"extra_fields.key_statuses.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"provider":{"type":"string","description":"AI model provider identifier","enum":["anthropic","azure","bedrock","bedrock_mantle","sagemaker","cerebras","cohere","deepseek","gemini","groq","mistral","ollama","opencode-go","opencode-zen","openai","parasail","perplexity","sgl","vertex","openrouter","elevenlabs","huggingface","nebius","xai","replicate","vllm","runway","runware","fireworks","sarvam","wafer","databricks","cloudflare","typesafe","minimax","byteplus","machgen","baseten","kimchi","soniox"],"uniqueKey":"extra_fields.key_statuses.items.[INDEX].provider","typeLabel":"enum\u003cstring>"},"error":{"oneOf":[{"$circularRef":"b7b33d72-0345-4aec-8d43-fa5c76a08d30"}],"uniqueKey":"extra_fields.key_statuses.items.[INDEX].error","typeLabel":"any"}},"uniqueKey":"extra_fields.key_statuses.items.[INDEX]","typeLabel":"object"},"uniqueKey":"extra_fields.key_statuses","typeLabel":"object[]"},"fallback_attempts":{"type":"array","description":"Set when the primary and every fallback failed and the primary's error was returned: what became of each fallback, in chain order. A fallback refused before reaching its provider (for example by a virtual key that does not allow it) is only visible here.","items":{"type":"object","properties":{"provider":{"type":"string","description":"AI model provider identifier","enum":["anthropic","azure","bedrock","bedrock_mantle","sagemaker","cerebras","cohere","deepseek","gemini","groq","mistral","ollama","opencode-go","opencode-zen","openai","parasail","perplexity","sgl","vertex","openrouter","elevenlabs","huggingface","nebius","xai","replicate","vllm","runway","runware","fireworks","sarvam","wafer","databricks","cloudflare","typesafe","minimax","byteplus","machgen","baseten","kimchi","soniox"],"uniqueKey":"extra_fields.fallback_attempts.items.[INDEX].provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","uniqueKey":"extra_fields.fallback_attempts.items.[INDEX].model","typeLabel":"string"},"status_code":{"type":"integer","uniqueKey":"extra_fields.fallback_attempts.items.[INDEX].status_code","typeLabel":"integer"},"type":{"type":"string","uniqueKey":"extra_fields.fallback_attempts.items.[INDEX].type","typeLabel":"string"},"message":{"type":"string","uniqueKey":"extra_fields.fallback_attempts.items.[INDEX].message","typeLabel":"string"},"skipped":{"type":"boolean","description":"The fallback was never attempted (no provider config, or the request type has no fallback support)","uniqueKey":"extra_fields.fallback_attempts.items.[INDEX].skipped","typeLabel":"boolean"}},"uniqueKey":"extra_fields.fallback_attempts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"extra_fields.fallback_attempts","typeLabel":"object[]"},"mcp_auth_required":{"type":"object","description":"Set when a per-user MCP tool needs the caller to complete an inline auth flow","properties":{"kind":{"type":"string","uniqueKey":"extra_fields.mcp_auth_required.kind","typeLabel":"string"},"mcp_client_id":{"type":"string","uniqueKey":"extra_fields.mcp_auth_required.mcp_client_id","typeLabel":"string"},"mcp_client_name":{"type":"string","uniqueKey":"extra_fields.mcp_auth_required.mcp_client_name","typeLabel":"string"},"message":{"type":"string","uniqueKey":"extra_fields.mcp_auth_required.message","typeLabel":"string"},"authorize_url":{"type":"string","uniqueKey":"extra_fields.mcp_auth_required.authorize_url","typeLabel":"string"},"session_id":{"type":"string","uniqueKey":"extra_fields.mcp_auth_required.session_id","typeLabel":"string"},"subject_token_missing":{"type":"boolean","description":"token_exchange only. True when there was nothing to exchange, including when the caller's Bifrost sign-in has expired; message says which","uniqueKey":"extra_fields.mcp_auth_required.subject_token_missing","typeLabel":"boolean"},"exchange_error":{"type":"string","description":"token_exchange only. The identity provider's error code and description when it refused the exchange","uniqueKey":"extra_fields.mcp_auth_required.exchange_error","typeLabel":"string"}},"uniqueKey":"extra_fields.mcp_auth_required","typeLabel":"object"},"billed_usage":{"type":"object","description":"Usage the provider reported and billed even though the request failed","properties":{"prompt_tokens":{"type":"integer","description":"Total input tokens including any prompt-cache tokens (read + write). Subtract prompt_tokens_details.cached_read_tokens and prompt_tokens_details.cached_write_tokens to get the non-cached portion.\n","uniqueKey":"extra_fields.billed_usage.prompt_tokens","typeLabel":"integer"},"prompt_tokens_details":{"type":"object","properties":{"text_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.prompt_tokens_details.text_tokens","typeLabel":"integer"},"audio_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.prompt_tokens_details.audio_tokens","typeLabel":"integer"},"image_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.prompt_tokens_details.image_tokens","typeLabel":"integer"},"cached_read_tokens":{"type":"integer","description":"Tokens served from the prompt cache (cache hit). These tokens are already included in prompt_tokens and are billed at the reduced cache-read rate. Populated for all providers that support prompt caching (Anthropic, Bedrock, OpenAI, Gemini, xAI, etc.).\n","uniqueKey":"extra_fields.billed_usage.prompt_tokens_details.cached_read_tokens","typeLabel":"integer"},"cached_write_tokens":{"type":"integer","description":"Tokens written to the prompt cache on this request (cache creation / write). These tokens are already included in prompt_tokens and are billed at the cache-creation rate. Populated for providers that separately report cache write tokens (Anthropic, Bedrock).\n","uniqueKey":"extra_fields.billed_usage.prompt_tokens_details.cached_write_tokens","typeLabel":"integer"}},"uniqueKey":"extra_fields.billed_usage.prompt_tokens_details","typeLabel":"object"},"completion_tokens":{"type":"integer","description":"Number of output/completion tokens generated.","uniqueKey":"extra_fields.billed_usage.completion_tokens","typeLabel":"integer"},"completion_tokens_details":{"type":"object","properties":{"text_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.text_tokens","typeLabel":"integer"},"accepted_prediction_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.accepted_prediction_tokens","typeLabel":"integer"},"audio_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.audio_tokens","typeLabel":"integer"},"citation_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.citation_tokens","typeLabel":"integer"},"num_search_queries":{"type":"integer","deprecated":true,"description":"Deprecated, use tool_usage.web_search.num_requests. Will be removed in 3.0.0.","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.num_search_queries","typeLabel":"integer"},"reasoning_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.reasoning_tokens","typeLabel":"integer"},"image_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.image_tokens","typeLabel":"integer"},"rejected_prediction_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.rejected_prediction_tokens","typeLabel":"integer"}},"uniqueKey":"extra_fields.billed_usage.completion_tokens_details","typeLabel":"object"},"total_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.total_tokens","typeLabel":"integer"},"tool_usage":{"type":"object","description":"Counts of provider-hosted (server-side) tool calls billed per call.\n","properties":{"web_search":{"type":"object","properties":{"num_requests":{"type":"integer","description":"Number of billable web search calls.","uniqueKey":"extra_fields.billed_usage.tool_usage.web_search.num_requests","typeLabel":"integer"}},"uniqueKey":"extra_fields.billed_usage.tool_usage.web_search","typeLabel":"object"}},"uniqueKey":"extra_fields.billed_usage.tool_usage","typeLabel":"object"},"cost":{"type":"object","description":"Cost breakdown for the request","properties":{"input_tokens_cost":{"type":"number","uniqueKey":"extra_fields.billed_usage.cost.input_tokens_cost","typeLabel":"number"},"output_tokens_cost":{"type":"number","uniqueKey":"extra_fields.billed_usage.cost.output_tokens_cost","typeLabel":"number"},"reasoning_tokens_cost":{"type":"number","description":"Cost for reasoning/thinking tokens (reasoning models)","uniqueKey":"extra_fields.billed_usage.cost.reasoning_tokens_cost","typeLabel":"number"},"citation_tokens_cost":{"type":"number","description":"Cost for citation tokens","uniqueKey":"extra_fields.billed_usage.cost.citation_tokens_cost","typeLabel":"number"},"search_queries_cost":{"type":"number","description":"Cost for web search queries","uniqueKey":"extra_fields.billed_usage.cost.search_queries_cost","typeLabel":"number"},"request_cost":{"type":"number","uniqueKey":"extra_fields.billed_usage.cost.request_cost","typeLabel":"number"},"total_cost":{"type":"number","uniqueKey":"extra_fields.billed_usage.cost.total_cost","typeLabel":"number"}},"uniqueKey":"extra_fields.billed_usage.cost","typeLabel":"object"}},"uniqueKey":"extra_fields.billed_usage","typeLabel":"object"}},"uniqueKey":"extra_fields","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"event_id":"\u003cstring>","type":"\u003cstring>","is_bifrost_error":true,"status_code":123,"error":{"type":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>","param":"\u003cstring>","event_id":"\u003cstring>"},"extra_fields":{"routing_info":{"provider":"anthropic","model":"\u003cstring>","key":"\u003cstring>","resolved_key_alias":{"model_id":"\u003cstring>","model_name":"\u003cstring>","model_family":"\u003cstring>"},"is_fallback":true,"primary_provider":"anthropic","primary_model":"\u003cstring>","requested_provider":"anthropic","requested_model":"\u003cstring>","server_side_fallback_model":"\u003cstring>"},"provider":"anthropic","original_model_requested":"\u003cstring>","resolved_model_used":"\u003cstring>","request_type":"\u003cstring>","mcp_request_type":"\u003cstring>","a2a_request_type":"\u003cstring>","a2a_agent_name":"\u003cstring>","error_type":"\u003cstring>","retry_after_ms":150500,"raw_request":"\u003cunknown>","raw_response":"\u003cunknown>","converted_request_type":"\u003cstring>","dropped_compat_plugin_params":["\u003cstring>"],"latency":123,"key_statuses":[{"key_id":"\u003cstring>","status":"success","provider":"anthropic","error":"\u003cunknown>"}],"fallback_attempts":[{"provider":"anthropic","model":"\u003cstring>","status_code":123,"type":"\u003cstring>","message":"\u003cstring>","skipped":true}],"mcp_auth_required":{"kind":"\u003cstring>","mcp_client_id":"\u003cstring>","mcp_client_name":"\u003cstring>","message":"\u003cstring>","authorize_url":"\u003cstring>","session_id":"\u003cstring>","subject_token_missing":true,"exchange_error":"\u003cstring>"},"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}}}}}},"exampleType":"generated"}},"exampleType":"generated"},"eb73f765-99a8-45a8-ae18-a9ee062898fa":{"description":"The request was not genuinely authenticated (dashboard authentication is disabled or unconfigured) and connection_type is \"stdio\", or is \"http\"/\"sse\" with a connection_string resolving to a loopback, private-network, link-local, or CGNAT address.","content":{"_mintlify/placeholder":{"schema":{"type":"object","description":""}}}},"f6f0e20c-9285-4408-a913-632a1f3df577":{"description":"Another MCP client already has the name, or an MCP client or Virtual MCP already serves the endpoint slug.","content":{"application/json":{"schema":{"type":"object","description":"Error response from Bifrost","properties":{"event_id":{"type":"string","uniqueKey":"event_id","typeLabel":"string"},"type":{"type":"string","uniqueKey":"type","typeLabel":"string"},"is_bifrost_error":{"type":"boolean","uniqueKey":"is_bifrost_error","typeLabel":"boolean"},"status_code":{"type":"integer","uniqueKey":"status_code","typeLabel":"integer"},"error":{"type":"object","properties":{"type":{"type":"string","uniqueKey":"error.type","typeLabel":"string"},"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"param":{"type":"string","uniqueKey":"error.param","typeLabel":"string"},"event_id":{"type":"string","uniqueKey":"error.event_id","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"},"extra_fields":{"type":"object","properties":{"routing_info":{"type":"object","description":"Which provider, model and key handled the attempt that produced this response or error, and what the caller asked for. Also sent as x-bifrost-routing-info-* response headers.","properties":{"provider":{"type":"string","description":"Provider that ran the attempt","enum":["anthropic","azure","bedrock","bedrock_mantle","sagemaker","cerebras","cohere","deepseek","gemini","groq","mistral","ollama","opencode-go","opencode-zen","openai","parasail","perplexity","sgl","vertex","openrouter","elevenlabs","huggingface","nebius","xai","replicate","vllm","runway","runware","fireworks","sarvam","wafer","databricks","cloudflare","typesafe","minimax","byteplus","machgen","baseten","kimchi","soniox"],"uniqueKey":"extra_fields.routing_info.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"Model sent to that provider","uniqueKey":"extra_fields.routing_info.model","typeLabel":"string"},"key":{"type":"string","description":"Name of the stored key used, never its ID or secret","uniqueKey":"extra_fields.routing_info.key","typeLabel":"string"},"resolved_key_alias":{"type":"object","description":"Set only when the requested model matched a model alias on the key","required":["model_id"],"properties":{"model_id":{"type":"string","description":"Model ID sent to the provider","isRequired":true,"uniqueKey":"extra_fields.routing_info.resolved_key_alias.model_id","typeLabel":"string"},"model_name":{"type":"string","description":"Canonical model name, used for pricing and logs","uniqueKey":"extra_fields.routing_info.resolved_key_alias.model_name","typeLabel":"string"},"model_family":{"type":"string","description":"Resolved model family","uniqueKey":"extra_fields.routing_info.resolved_key_alias.model_family","typeLabel":"string"}},"uniqueKey":"extra_fields.routing_info.resolved_key_alias","typeLabel":"object"},"is_fallback":{"type":"boolean","description":"True when a fallback served the request or returned the error. Omitted when false.","uniqueKey":"extra_fields.routing_info.is_fallback","typeLabel":"boolean"},"primary_provider":{"type":"string","description":"The primary attempt's provider. Set only when a fallback ran.","enum":["anthropic","azure","bedrock","bedrock_mantle","sagemaker","cerebras","cohere","deepseek","gemini","groq","mistral","ollama","opencode-go","opencode-zen","openai","parasail","perplexity","sgl","vertex","openrouter","elevenlabs","huggingface","nebius","xai","replicate","vllm","runway","runware","fireworks","sarvam","wafer","databricks","cloudflare","typesafe","minimax","byteplus","machgen","baseten","kimchi","soniox"],"uniqueKey":"extra_fields.routing_info.primary_provider","typeLabel":"enum\u003cstring>"},"primary_model":{"type":"string","description":"The primary attempt's model. Set only when a fallback ran.","uniqueKey":"extra_fields.routing_info.primary_model","typeLabel":"string"},"requested_provider":{"type":"string","description":"Provider the caller asked for, before routing rules, load balancing or session affinity changed it. Omitted when the caller sent a bare model.","enum":["anthropic","azure","bedrock","bedrock_mantle","sagemaker","cerebras","cohere","deepseek","gemini","groq","mistral","ollama","opencode-go","opencode-zen","openai","parasail","perplexity","sgl","vertex","openrouter","elevenlabs","huggingface","nebius","xai","replicate","vllm","runway","runware","fireworks","sarvam","wafer","databricks","cloudflare","typesafe","minimax","byteplus","machgen","baseten","kimchi","soniox"],"uniqueKey":"extra_fields.routing_info.requested_provider","typeLabel":"enum\u003cstring>"},"requested_model":{"type":"string","description":"Model the caller asked for, before anything changed it","uniqueKey":"extra_fields.routing_info.requested_model","typeLabel":"string"},"server_side_fallback_model":{"type":"string","description":"Model that answered when Anthropic switched models inside one call","uniqueKey":"extra_fields.routing_info.server_side_fallback_model","typeLabel":"string"}},"uniqueKey":"extra_fields.routing_info","typeLabel":"object"},"provider":{"type":"string","description":"Deprecated: use routing_info.provider.","enum":["anthropic","azure","bedrock","bedrock_mantle","sagemaker","cerebras","cohere","deepseek","gemini","groq","mistral","ollama","opencode-go","opencode-zen","openai","parasail","perplexity","sgl","vertex","openrouter","elevenlabs","huggingface","nebius","xai","replicate","vllm","runway","runware","fireworks","sarvam","wafer","databricks","cloudflare","typesafe","minimax","byteplus","machgen","baseten","kimchi","soniox"],"deprecated":true,"uniqueKey":"extra_fields.provider","typeLabel":"enum\u003cstring>"},"original_model_requested":{"type":"string","deprecated":true,"description":"Deprecated: use routing_info.primary_model when routing_info.is_fallback is true, otherwise routing_info.model. For the model the caller asked for, read routing_info.requested_model.","uniqueKey":"extra_fields.original_model_requested","typeLabel":"string"},"resolved_model_used":{"type":"string","deprecated":true,"description":"Deprecated: use routing_info.resolved_key_alias.model_id when an alias matched, otherwise routing_info.model.","uniqueKey":"extra_fields.resolved_model_used","typeLabel":"string"},"request_type":{"type":"string","uniqueKey":"extra_fields.request_type","typeLabel":"string"},"mcp_request_type":{"type":"string","uniqueKey":"extra_fields.mcp_request_type","typeLabel":"string"},"a2a_request_type":{"type":"string","description":"Agent Gateway operation, for A2A errors","uniqueKey":"extra_fields.a2a_request_type","typeLabel":"string"},"a2a_agent_name":{"type":"string","uniqueKey":"extra_fields.a2a_agent_name","typeLabel":"string"},"error_type":{"type":"string","description":"Normalized, low-cardinality classification of why the request failed, declared by whichever component refused it. Prefixed by fault domain (caller_, policy_, provider_, bifrost_). Absent on failures that were not classified at source.","uniqueKey":"extra_fields.error_type","typeLabel":"string"},"retry_after_ms":{"type":"integer","format":"int64","minimum":1000,"maximum":300000,"description":"The provider's hint for how long to wait before retrying, in milliseconds, read from its retry-after-ms or Retry-After header or its google.rpc.RetryInfo error detail, and clamped to between 1000 and 300000. Absent when the provider gave no explicit hint.","uniqueKey":"extra_fields.retry_after_ms","typeLabel":"integer\u003cint64>"},"raw_request":{"description":"Raw provider request, when raw request capture is enabled","uniqueKey":"extra_fields.raw_request","typeLabel":"any"},"raw_response":{"description":"Raw provider response, when raw response capture is enabled","uniqueKey":"extra_fields.raw_response","typeLabel":"any"},"converted_request_type":{"type":"string","uniqueKey":"extra_fields.converted_request_type","typeLabel":"string"},"dropped_compat_plugin_params":{"type":"array","items":{"type":"string","uniqueKey":"extra_fields.dropped_compat_plugin_params.items.[INDEX]","typeLabel":"string"},"uniqueKey":"extra_fields.dropped_compat_plugin_params","typeLabel":"string[]"},"latency":{"type":"integer","format":"int64","description":"Latency in milliseconds","uniqueKey":"extra_fields.latency","typeLabel":"integer\u003cint64>"},"key_statuses":{"type":"array","description":"Per-key results, for requests that ran on every key such as listing models","items":{"type":"object","properties":{"key_id":{"type":"string","uniqueKey":"extra_fields.key_statuses.items.[INDEX].key_id","typeLabel":"string"},"status":{"type":"string","enum":["success","list_models_failed"],"uniqueKey":"extra_fields.key_statuses.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"provider":{"type":"string","description":"AI model provider identifier","enum":["anthropic","azure","bedrock","bedrock_mantle","sagemaker","cerebras","cohere","deepseek","gemini","groq","mistral","ollama","opencode-go","opencode-zen","openai","parasail","perplexity","sgl","vertex","openrouter","elevenlabs","huggingface","nebius","xai","replicate","vllm","runway","runware","fireworks","sarvam","wafer","databricks","cloudflare","typesafe","minimax","byteplus","machgen","baseten","kimchi","soniox"],"uniqueKey":"extra_fields.key_statuses.items.[INDEX].provider","typeLabel":"enum\u003cstring>"},"error":{"oneOf":[{"$circularRef":"b7b33d72-0345-4aec-8d43-fa5c76a08d30"}],"uniqueKey":"extra_fields.key_statuses.items.[INDEX].error","typeLabel":"any"}},"uniqueKey":"extra_fields.key_statuses.items.[INDEX]","typeLabel":"object"},"uniqueKey":"extra_fields.key_statuses","typeLabel":"object[]"},"fallback_attempts":{"type":"array","description":"Set when the primary and every fallback failed and the primary's error was returned: what became of each fallback, in chain order. A fallback refused before reaching its provider (for example by a virtual key that does not allow it) is only visible here.","items":{"type":"object","properties":{"provider":{"type":"string","description":"AI model provider identifier","enum":["anthropic","azure","bedrock","bedrock_mantle","sagemaker","cerebras","cohere","deepseek","gemini","groq","mistral","ollama","opencode-go","opencode-zen","openai","parasail","perplexity","sgl","vertex","openrouter","elevenlabs","huggingface","nebius","xai","replicate","vllm","runway","runware","fireworks","sarvam","wafer","databricks","cloudflare","typesafe","minimax","byteplus","machgen","baseten","kimchi","soniox"],"uniqueKey":"extra_fields.fallback_attempts.items.[INDEX].provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","uniqueKey":"extra_fields.fallback_attempts.items.[INDEX].model","typeLabel":"string"},"status_code":{"type":"integer","uniqueKey":"extra_fields.fallback_attempts.items.[INDEX].status_code","typeLabel":"integer"},"type":{"type":"string","uniqueKey":"extra_fields.fallback_attempts.items.[INDEX].type","typeLabel":"string"},"message":{"type":"string","uniqueKey":"extra_fields.fallback_attempts.items.[INDEX].message","typeLabel":"string"},"skipped":{"type":"boolean","description":"The fallback was never attempted (no provider config, or the request type has no fallback support)","uniqueKey":"extra_fields.fallback_attempts.items.[INDEX].skipped","typeLabel":"boolean"}},"uniqueKey":"extra_fields.fallback_attempts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"extra_fields.fallback_attempts","typeLabel":"object[]"},"mcp_auth_required":{"type":"object","description":"Set when a per-user MCP tool needs the caller to complete an inline auth flow","properties":{"kind":{"type":"string","uniqueKey":"extra_fields.mcp_auth_required.kind","typeLabel":"string"},"mcp_client_id":{"type":"string","uniqueKey":"extra_fields.mcp_auth_required.mcp_client_id","typeLabel":"string"},"mcp_client_name":{"type":"string","uniqueKey":"extra_fields.mcp_auth_required.mcp_client_name","typeLabel":"string"},"message":{"type":"string","uniqueKey":"extra_fields.mcp_auth_required.message","typeLabel":"string"},"authorize_url":{"type":"string","uniqueKey":"extra_fields.mcp_auth_required.authorize_url","typeLabel":"string"},"session_id":{"type":"string","uniqueKey":"extra_fields.mcp_auth_required.session_id","typeLabel":"string"},"subject_token_missing":{"type":"boolean","description":"token_exchange only. True when there was nothing to exchange, including when the caller's Bifrost sign-in has expired; message says which","uniqueKey":"extra_fields.mcp_auth_required.subject_token_missing","typeLabel":"boolean"},"exchange_error":{"type":"string","description":"token_exchange only. The identity provider's error code and description when it refused the exchange","uniqueKey":"extra_fields.mcp_auth_required.exchange_error","typeLabel":"string"}},"uniqueKey":"extra_fields.mcp_auth_required","typeLabel":"object"},"billed_usage":{"type":"object","description":"Usage the provider reported and billed even though the request failed","properties":{"prompt_tokens":{"type":"integer","description":"Total input tokens including any prompt-cache tokens (read + write). Subtract prompt_tokens_details.cached_read_tokens and prompt_tokens_details.cached_write_tokens to get the non-cached portion.\n","uniqueKey":"extra_fields.billed_usage.prompt_tokens","typeLabel":"integer"},"prompt_tokens_details":{"type":"object","properties":{"text_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.prompt_tokens_details.text_tokens","typeLabel":"integer"},"audio_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.prompt_tokens_details.audio_tokens","typeLabel":"integer"},"image_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.prompt_tokens_details.image_tokens","typeLabel":"integer"},"cached_read_tokens":{"type":"integer","description":"Tokens served from the prompt cache (cache hit). These tokens are already included in prompt_tokens and are billed at the reduced cache-read rate. Populated for all providers that support prompt caching (Anthropic, Bedrock, OpenAI, Gemini, xAI, etc.).\n","uniqueKey":"extra_fields.billed_usage.prompt_tokens_details.cached_read_tokens","typeLabel":"integer"},"cached_write_tokens":{"type":"integer","description":"Tokens written to the prompt cache on this request (cache creation / write). These tokens are already included in prompt_tokens and are billed at the cache-creation rate. Populated for providers that separately report cache write tokens (Anthropic, Bedrock).\n","uniqueKey":"extra_fields.billed_usage.prompt_tokens_details.cached_write_tokens","typeLabel":"integer"}},"uniqueKey":"extra_fields.billed_usage.prompt_tokens_details","typeLabel":"object"},"completion_tokens":{"type":"integer","description":"Number of output/completion tokens generated.","uniqueKey":"extra_fields.billed_usage.completion_tokens","typeLabel":"integer"},"completion_tokens_details":{"type":"object","properties":{"text_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.text_tokens","typeLabel":"integer"},"accepted_prediction_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.accepted_prediction_tokens","typeLabel":"integer"},"audio_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.audio_tokens","typeLabel":"integer"},"citation_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.citation_tokens","typeLabel":"integer"},"num_search_queries":{"type":"integer","deprecated":true,"description":"Deprecated, use tool_usage.web_search.num_requests. Will be removed in 3.0.0.","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.num_search_queries","typeLabel":"integer"},"reasoning_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.reasoning_tokens","typeLabel":"integer"},"image_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.image_tokens","typeLabel":"integer"},"rejected_prediction_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.rejected_prediction_tokens","typeLabel":"integer"}},"uniqueKey":"extra_fields.billed_usage.completion_tokens_details","typeLabel":"object"},"total_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.total_tokens","typeLabel":"integer"},"tool_usage":{"type":"object","description":"Counts of provider-hosted (server-side) tool calls billed per call.\n","properties":{"web_search":{"type":"object","properties":{"num_requests":{"type":"integer","description":"Number of billable web search calls.","uniqueKey":"extra_fields.billed_usage.tool_usage.web_search.num_requests","typeLabel":"integer"}},"uniqueKey":"extra_fields.billed_usage.tool_usage.web_search","typeLabel":"object"}},"uniqueKey":"extra_fields.billed_usage.tool_usage","typeLabel":"object"},"cost":{"type":"object","description":"Cost breakdown for the request","properties":{"input_tokens_cost":{"type":"number","uniqueKey":"extra_fields.billed_usage.cost.input_tokens_cost","typeLabel":"number"},"output_tokens_cost":{"type":"number","uniqueKey":"extra_fields.billed_usage.cost.output_tokens_cost","typeLabel":"number"},"reasoning_tokens_cost":{"type":"number","description":"Cost for reasoning/thinking tokens (reasoning models)","uniqueKey":"extra_fields.billed_usage.cost.reasoning_tokens_cost","typeLabel":"number"},"citation_tokens_cost":{"type":"number","description":"Cost for citation tokens","uniqueKey":"extra_fields.billed_usage.cost.citation_tokens_cost","typeLabel":"number"},"search_queries_cost":{"type":"number","description":"Cost for web search queries","uniqueKey":"extra_fields.billed_usage.cost.search_queries_cost","typeLabel":"number"},"request_cost":{"type":"number","uniqueKey":"extra_fields.billed_usage.cost.request_cost","typeLabel":"number"},"total_cost":{"type":"number","uniqueKey":"extra_fields.billed_usage.cost.total_cost","typeLabel":"number"}},"uniqueKey":"extra_fields.billed_usage.cost","typeLabel":"object"}},"uniqueKey":"extra_fields.billed_usage","typeLabel":"object"}},"uniqueKey":"extra_fields","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"event_id":"\u003cstring>","type":"\u003cstring>","is_bifrost_error":true,"status_code":123,"error":{"type":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>","param":"\u003cstring>","event_id":"\u003cstring>"},"extra_fields":{"routing_info":{"provider":"anthropic","model":"\u003cstring>","key":"\u003cstring>","resolved_key_alias":{"model_id":"\u003cstring>","model_name":"\u003cstring>","model_family":"\u003cstring>"},"is_fallback":true,"primary_provider":"anthropic","primary_model":"\u003cstring>","requested_provider":"anthropic","requested_model":"\u003cstring>","server_side_fallback_model":"\u003cstring>"},"provider":"anthropic","original_model_requested":"\u003cstring>","resolved_model_used":"\u003cstring>","request_type":"\u003cstring>","mcp_request_type":"\u003cstring>","a2a_request_type":"\u003cstring>","a2a_agent_name":"\u003cstring>","error_type":"\u003cstring>","retry_after_ms":150500,"raw_request":"\u003cunknown>","raw_response":"\u003cunknown>","converted_request_type":"\u003cstring>","dropped_compat_plugin_params":["\u003cstring>"],"latency":123,"key_statuses":[{"key_id":"\u003cstring>","status":"success","provider":"anthropic","error":"\u003cunknown>"}],"fallback_attempts":[{"provider":"anthropic","model":"\u003cstring>","status_code":123,"type":"\u003cstring>","message":"\u003cstring>","skipped":true}],"mcp_auth_required":{"kind":"\u003cstring>","mcp_client_id":"\u003cstring>","mcp_client_name":"\u003cstring>","message":"\u003cstring>","authorize_url":"\u003cstring>","session_id":"\u003cstring>","subject_token_missing":true,"exchange_error":"\u003cstring>"},"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}}}}}},"exampleType":"generated"}},"exampleType":"generated"},"1d3c40a0-3f82-4fc2-9ce4-2ba75c020d02":{"description":"A per-user client failed verification during create, and was not\ncreated: per_user_headers sample values were rejected upstream, or\nfor token_exchange the admin credential exchange failed, the\nadmin's Bifrost sign-in has expired (sign in to Bifrost again and\nretry), or the upstream verification connection failed.\n","content":{"application/json":{"schema":{"type":"object","description":"Error response","properties":{"event_id":{"type":"string","uniqueKey":"event_id","typeLabel":"string"},"type":{"type":"string","uniqueKey":"type","typeLabel":"string"},"is_bifrost_error":{"type":"boolean","uniqueKey":"is_bifrost_error","typeLabel":"boolean"},"status_code":{"type":"integer","uniqueKey":"status_code","typeLabel":"integer"},"error":{"type":"object","properties":{"type":{"type":"string","uniqueKey":"error.type","typeLabel":"string"},"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"param":{"type":"string","uniqueKey":"error.param","typeLabel":"string"},"event_id":{"type":"string","uniqueKey":"error.event_id","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"},"extra_fields":{"type":"object","properties":{"routing_info":{"type":"object","description":"Which provider, model and key handled the attempt that produced this response or error, and what the caller asked for. Also sent as x-bifrost-routing-info-* response headers.","properties":{"provider":{"type":"string","description":"Provider that ran the attempt","enum":["anthropic","azure","bedrock","bedrock_mantle","sagemaker","cerebras","cohere","deepseek","gemini","groq","mistral","ollama","opencode-go","opencode-zen","openai","parasail","perplexity","sgl","vertex","openrouter","elevenlabs","huggingface","nebius","xai","replicate","vllm","runway","runware","fireworks","sarvam","wafer","databricks","cloudflare","typesafe","minimax","byteplus","machgen","baseten","kimchi","soniox"],"uniqueKey":"extra_fields.routing_info.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"Model sent to that provider","uniqueKey":"extra_fields.routing_info.model","typeLabel":"string"},"key":{"type":"string","description":"Name of the stored key used, never its ID or secret","uniqueKey":"extra_fields.routing_info.key","typeLabel":"string"},"resolved_key_alias":{"type":"object","description":"Set only when the requested model matched a model alias on the key","required":["model_id"],"properties":{"model_id":{"type":"string","description":"Model ID sent to the provider","isRequired":true,"uniqueKey":"extra_fields.routing_info.resolved_key_alias.model_id","typeLabel":"string"},"model_name":{"type":"string","description":"Canonical model name, used for pricing and logs","uniqueKey":"extra_fields.routing_info.resolved_key_alias.model_name","typeLabel":"string"},"model_family":{"type":"string","description":"Resolved model family","uniqueKey":"extra_fields.routing_info.resolved_key_alias.model_family","typeLabel":"string"}},"uniqueKey":"extra_fields.routing_info.resolved_key_alias","typeLabel":"object"},"is_fallback":{"type":"boolean","description":"True when a fallback served the request or returned the error. Omitted when false.","uniqueKey":"extra_fields.routing_info.is_fallback","typeLabel":"boolean"},"primary_provider":{"type":"string","description":"The primary attempt's provider. Set only when a fallback ran.","enum":["anthropic","azure","bedrock","bedrock_mantle","sagemaker","cerebras","cohere","deepseek","gemini","groq","mistral","ollama","opencode-go","opencode-zen","openai","parasail","perplexity","sgl","vertex","openrouter","elevenlabs","huggingface","nebius","xai","replicate","vllm","runway","runware","fireworks","sarvam","wafer","databricks","cloudflare","typesafe","minimax","byteplus","machgen","baseten","kimchi","soniox"],"uniqueKey":"extra_fields.routing_info.primary_provider","typeLabel":"enum\u003cstring>"},"primary_model":{"type":"string","description":"The primary attempt's model. Set only when a fallback ran.","uniqueKey":"extra_fields.routing_info.primary_model","typeLabel":"string"},"requested_provider":{"type":"string","description":"Provider the caller asked for, before routing rules, load balancing or session affinity changed it. Omitted when the caller sent a bare model.","enum":["anthropic","azure","bedrock","bedrock_mantle","sagemaker","cerebras","cohere","deepseek","gemini","groq","mistral","ollama","opencode-go","opencode-zen","openai","parasail","perplexity","sgl","vertex","openrouter","elevenlabs","huggingface","nebius","xai","replicate","vllm","runway","runware","fireworks","sarvam","wafer","databricks","cloudflare","typesafe","minimax","byteplus","machgen","baseten","kimchi","soniox"],"uniqueKey":"extra_fields.routing_info.requested_provider","typeLabel":"enum\u003cstring>"},"requested_model":{"type":"string","description":"Model the caller asked for, before anything changed it","uniqueKey":"extra_fields.routing_info.requested_model","typeLabel":"string"},"server_side_fallback_model":{"type":"string","description":"Model that answered when Anthropic switched models inside one call","uniqueKey":"extra_fields.routing_info.server_side_fallback_model","typeLabel":"string"}},"uniqueKey":"extra_fields.routing_info","typeLabel":"object"},"provider":{"type":"string","description":"Deprecated: use routing_info.provider.","enum":["anthropic","azure","bedrock","bedrock_mantle","sagemaker","cerebras","cohere","deepseek","gemini","groq","mistral","ollama","opencode-go","opencode-zen","openai","parasail","perplexity","sgl","vertex","openrouter","elevenlabs","huggingface","nebius","xai","replicate","vllm","runway","runware","fireworks","sarvam","wafer","databricks","cloudflare","typesafe","minimax","byteplus","machgen","baseten","kimchi","soniox"],"deprecated":true,"uniqueKey":"extra_fields.provider","typeLabel":"enum\u003cstring>"},"original_model_requested":{"type":"string","deprecated":true,"description":"Deprecated: use routing_info.primary_model when routing_info.is_fallback is true, otherwise routing_info.model. For the model the caller asked for, read routing_info.requested_model.","uniqueKey":"extra_fields.original_model_requested","typeLabel":"string"},"resolved_model_used":{"type":"string","deprecated":true,"description":"Deprecated: use routing_info.resolved_key_alias.model_id when an alias matched, otherwise routing_info.model.","uniqueKey":"extra_fields.resolved_model_used","typeLabel":"string"},"request_type":{"type":"string","uniqueKey":"extra_fields.request_type","typeLabel":"string"},"mcp_request_type":{"type":"string","uniqueKey":"extra_fields.mcp_request_type","typeLabel":"string"},"a2a_request_type":{"type":"string","description":"Agent Gateway operation, for A2A errors","uniqueKey":"extra_fields.a2a_request_type","typeLabel":"string"},"a2a_agent_name":{"type":"string","uniqueKey":"extra_fields.a2a_agent_name","typeLabel":"string"},"error_type":{"type":"string","description":"Normalized, low-cardinality classification of why the request failed, declared by whichever component refused it. Prefixed by fault domain (caller_, policy_, provider_, bifrost_). Absent on failures that were not classified at source.","uniqueKey":"extra_fields.error_type","typeLabel":"string"},"retry_after_ms":{"type":"integer","format":"int64","minimum":1000,"maximum":300000,"description":"The provider's hint for how long to wait before retrying, in milliseconds, read from its retry-after-ms or Retry-After header or its google.rpc.RetryInfo error detail, and clamped to between 1000 and 300000. Absent when the provider gave no explicit hint.","uniqueKey":"extra_fields.retry_after_ms","typeLabel":"integer\u003cint64>"},"raw_request":{"description":"Raw provider request, when raw request capture is enabled","uniqueKey":"extra_fields.raw_request","typeLabel":"any"},"raw_response":{"description":"Raw provider response, when raw response capture is enabled","uniqueKey":"extra_fields.raw_response","typeLabel":"any"},"converted_request_type":{"type":"string","uniqueKey":"extra_fields.converted_request_type","typeLabel":"string"},"dropped_compat_plugin_params":{"type":"array","items":{"type":"string","uniqueKey":"extra_fields.dropped_compat_plugin_params.items.[INDEX]","typeLabel":"string"},"uniqueKey":"extra_fields.dropped_compat_plugin_params","typeLabel":"string[]"},"latency":{"type":"integer","format":"int64","description":"Latency in milliseconds","uniqueKey":"extra_fields.latency","typeLabel":"integer\u003cint64>"},"key_statuses":{"type":"array","description":"Per-key results, for requests that ran on every key such as listing models","items":{"type":"object","properties":{"key_id":{"type":"string","uniqueKey":"extra_fields.key_statuses.items.[INDEX].key_id","typeLabel":"string"},"status":{"type":"string","enum":["success","list_models_failed"],"uniqueKey":"extra_fields.key_statuses.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"provider":{"type":"string","description":"AI model provider identifier","enum":["anthropic","azure","bedrock","bedrock_mantle","sagemaker","cerebras","cohere","deepseek","gemini","groq","mistral","ollama","opencode-go","opencode-zen","openai","parasail","perplexity","sgl","vertex","openrouter","elevenlabs","huggingface","nebius","xai","replicate","vllm","runway","runware","fireworks","sarvam","wafer","databricks","cloudflare","typesafe","minimax","byteplus","machgen","baseten","kimchi","soniox"],"uniqueKey":"extra_fields.key_statuses.items.[INDEX].provider","typeLabel":"enum\u003cstring>"},"error":{"oneOf":[{"$circularRef":"b7b33d72-0345-4aec-8d43-fa5c76a08d30"}],"uniqueKey":"extra_fields.key_statuses.items.[INDEX].error","typeLabel":"any"}},"uniqueKey":"extra_fields.key_statuses.items.[INDEX]","typeLabel":"object"},"uniqueKey":"extra_fields.key_statuses","typeLabel":"object[]"},"fallback_attempts":{"type":"array","description":"Set when the primary and every fallback failed and the primary's error was returned: what became of each fallback, in chain order. A fallback refused before reaching its provider (for example by a virtual key that does not allow it) is only visible here.","items":{"type":"object","properties":{"provider":{"type":"string","description":"AI model provider identifier","enum":["anthropic","azure","bedrock","bedrock_mantle","sagemaker","cerebras","cohere","deepseek","gemini","groq","mistral","ollama","opencode-go","opencode-zen","openai","parasail","perplexity","sgl","vertex","openrouter","elevenlabs","huggingface","nebius","xai","replicate","vllm","runway","runware","fireworks","sarvam","wafer","databricks","cloudflare","typesafe","minimax","byteplus","machgen","baseten","kimchi","soniox"],"uniqueKey":"extra_fields.fallback_attempts.items.[INDEX].provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","uniqueKey":"extra_fields.fallback_attempts.items.[INDEX].model","typeLabel":"string"},"status_code":{"type":"integer","uniqueKey":"extra_fields.fallback_attempts.items.[INDEX].status_code","typeLabel":"integer"},"type":{"type":"string","uniqueKey":"extra_fields.fallback_attempts.items.[INDEX].type","typeLabel":"string"},"message":{"type":"string","uniqueKey":"extra_fields.fallback_attempts.items.[INDEX].message","typeLabel":"string"},"skipped":{"type":"boolean","description":"The fallback was never attempted (no provider config, or the request type has no fallback support)","uniqueKey":"extra_fields.fallback_attempts.items.[INDEX].skipped","typeLabel":"boolean"}},"uniqueKey":"extra_fields.fallback_attempts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"extra_fields.fallback_attempts","typeLabel":"object[]"},"mcp_auth_required":{"type":"object","description":"Set when a per-user MCP tool needs the caller to complete an inline auth flow","properties":{"kind":{"type":"string","uniqueKey":"extra_fields.mcp_auth_required.kind","typeLabel":"string"},"mcp_client_id":{"type":"string","uniqueKey":"extra_fields.mcp_auth_required.mcp_client_id","typeLabel":"string"},"mcp_client_name":{"type":"string","uniqueKey":"extra_fields.mcp_auth_required.mcp_client_name","typeLabel":"string"},"message":{"type":"string","uniqueKey":"extra_fields.mcp_auth_required.message","typeLabel":"string"},"authorize_url":{"type":"string","uniqueKey":"extra_fields.mcp_auth_required.authorize_url","typeLabel":"string"},"session_id":{"type":"string","uniqueKey":"extra_fields.mcp_auth_required.session_id","typeLabel":"string"},"subject_token_missing":{"type":"boolean","description":"token_exchange only. True when there was nothing to exchange, including when the caller's Bifrost sign-in has expired; message says which","uniqueKey":"extra_fields.mcp_auth_required.subject_token_missing","typeLabel":"boolean"},"exchange_error":{"type":"string","description":"token_exchange only. The identity provider's error code and description when it refused the exchange","uniqueKey":"extra_fields.mcp_auth_required.exchange_error","typeLabel":"string"}},"uniqueKey":"extra_fields.mcp_auth_required","typeLabel":"object"},"billed_usage":{"type":"object","description":"Usage the provider reported and billed even though the request failed","properties":{"prompt_tokens":{"type":"integer","description":"Total input tokens including any prompt-cache tokens (read + write). Subtract prompt_tokens_details.cached_read_tokens and prompt_tokens_details.cached_write_tokens to get the non-cached portion.\n","uniqueKey":"extra_fields.billed_usage.prompt_tokens","typeLabel":"integer"},"prompt_tokens_details":{"type":"object","properties":{"text_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.prompt_tokens_details.text_tokens","typeLabel":"integer"},"audio_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.prompt_tokens_details.audio_tokens","typeLabel":"integer"},"image_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.prompt_tokens_details.image_tokens","typeLabel":"integer"},"cached_read_tokens":{"type":"integer","description":"Tokens served from the prompt cache (cache hit). These tokens are already included in prompt_tokens and are billed at the reduced cache-read rate. Populated for all providers that support prompt caching (Anthropic, Bedrock, OpenAI, Gemini, xAI, etc.).\n","uniqueKey":"extra_fields.billed_usage.prompt_tokens_details.cached_read_tokens","typeLabel":"integer"},"cached_write_tokens":{"type":"integer","description":"Tokens written to the prompt cache on this request (cache creation / write). These tokens are already included in prompt_tokens and are billed at the cache-creation rate. Populated for providers that separately report cache write tokens (Anthropic, Bedrock).\n","uniqueKey":"extra_fields.billed_usage.prompt_tokens_details.cached_write_tokens","typeLabel":"integer"}},"uniqueKey":"extra_fields.billed_usage.prompt_tokens_details","typeLabel":"object"},"completion_tokens":{"type":"integer","description":"Number of output/completion tokens generated.","uniqueKey":"extra_fields.billed_usage.completion_tokens","typeLabel":"integer"},"completion_tokens_details":{"type":"object","properties":{"text_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.text_tokens","typeLabel":"integer"},"accepted_prediction_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.accepted_prediction_tokens","typeLabel":"integer"},"audio_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.audio_tokens","typeLabel":"integer"},"citation_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.citation_tokens","typeLabel":"integer"},"num_search_queries":{"type":"integer","deprecated":true,"description":"Deprecated, use tool_usage.web_search.num_requests. Will be removed in 3.0.0.","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.num_search_queries","typeLabel":"integer"},"reasoning_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.reasoning_tokens","typeLabel":"integer"},"image_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.image_tokens","typeLabel":"integer"},"rejected_prediction_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.rejected_prediction_tokens","typeLabel":"integer"}},"uniqueKey":"extra_fields.billed_usage.completion_tokens_details","typeLabel":"object"},"total_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.total_tokens","typeLabel":"integer"},"tool_usage":{"type":"object","description":"Counts of provider-hosted (server-side) tool calls billed per call.\n","properties":{"web_search":{"type":"object","properties":{"num_requests":{"type":"integer","description":"Number of billable web search calls.","uniqueKey":"extra_fields.billed_usage.tool_usage.web_search.num_requests","typeLabel":"integer"}},"uniqueKey":"extra_fields.billed_usage.tool_usage.web_search","typeLabel":"object"}},"uniqueKey":"extra_fields.billed_usage.tool_usage","typeLabel":"object"},"cost":{"type":"object","description":"Cost breakdown for the request","properties":{"input_tokens_cost":{"type":"number","uniqueKey":"extra_fields.billed_usage.cost.input_tokens_cost","typeLabel":"number"},"output_tokens_cost":{"type":"number","uniqueKey":"extra_fields.billed_usage.cost.output_tokens_cost","typeLabel":"number"},"reasoning_tokens_cost":{"type":"number","description":"Cost for reasoning/thinking tokens (reasoning models)","uniqueKey":"extra_fields.billed_usage.cost.reasoning_tokens_cost","typeLabel":"number"},"citation_tokens_cost":{"type":"number","description":"Cost for citation tokens","uniqueKey":"extra_fields.billed_usage.cost.citation_tokens_cost","typeLabel":"number"},"search_queries_cost":{"type":"number","description":"Cost for web search queries","uniqueKey":"extra_fields.billed_usage.cost.search_queries_cost","typeLabel":"number"},"request_cost":{"type":"number","uniqueKey":"extra_fields.billed_usage.cost.request_cost","typeLabel":"number"},"total_cost":{"type":"number","uniqueKey":"extra_fields.billed_usage.cost.total_cost","typeLabel":"number"}},"uniqueKey":"extra_fields.billed_usage.cost","typeLabel":"object"}},"uniqueKey":"extra_fields.billed_usage","typeLabel":"object"}},"uniqueKey":"extra_fields","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"event_id":"\u003cstring>","type":"\u003cstring>","is_bifrost_error":true,"status_code":123,"error":{"type":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>","param":"\u003cstring>","event_id":"\u003cstring>"},"extra_fields":{"routing_info":{"provider":"anthropic","model":"\u003cstring>","key":"\u003cstring>","resolved_key_alias":{"model_id":"\u003cstring>","model_name":"\u003cstring>","model_family":"\u003cstring>"},"is_fallback":true,"primary_provider":"anthropic","primary_model":"\u003cstring>","requested_provider":"anthropic","requested_model":"\u003cstring>","server_side_fallback_model":"\u003cstring>"},"provider":"anthropic","original_model_requested":"\u003cstring>","resolved_model_used":"\u003cstring>","request_type":"\u003cstring>","mcp_request_type":"\u003cstring>","a2a_request_type":"\u003cstring>","a2a_agent_name":"\u003cstring>","error_type":"\u003cstring>","retry_after_ms":150500,"raw_request":"\u003cunknown>","raw_response":"\u003cunknown>","converted_request_type":"\u003cstring>","dropped_compat_plugin_params":["\u003cstring>"],"latency":123,"key_statuses":[{"key_id":"\u003cstring>","status":"success","provider":"anthropic","error":"\u003cunknown>"}],"fallback_attempts":[{"provider":"anthropic","model":"\u003cstring>","status_code":123,"type":"\u003cstring>","message":"\u003cstring>","skipped":true}],"mcp_auth_required":{"kind":"\u003cstring>","mcp_client_id":"\u003cstring>","mcp_client_name":"\u003cstring>","message":"\u003cstring>","authorize_url":"\u003cstring>","session_id":"\u003cstring>","subject_token_missing":true,"exchange_error":"\u003cstring>"},"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}}}}}},"exampleType":"generated"}},"exampleType":"generated"},"dae07f34-6534-4e7d-9521-0952f3d1d2e6":{"description":"Internal server error","content":{"application/json":{"schema":{"type":"object","description":"Error response from Bifrost","properties":{"event_id":{"type":"string","uniqueKey":"event_id","typeLabel":"string"},"type":{"type":"string","uniqueKey":"type","typeLabel":"string"},"is_bifrost_error":{"type":"boolean","uniqueKey":"is_bifrost_error","typeLabel":"boolean"},"status_code":{"type":"integer","uniqueKey":"status_code","typeLabel":"integer"},"error":{"type":"object","properties":{"type":{"type":"string","uniqueKey":"error.type","typeLabel":"string"},"code":{"type":"string","uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.message","typeLabel":"string"},"param":{"type":"string","uniqueKey":"error.param","typeLabel":"string"},"event_id":{"type":"string","uniqueKey":"error.event_id","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"},"extra_fields":{"type":"object","properties":{"routing_info":{"type":"object","description":"Which provider, model and key handled the attempt that produced this response or error, and what the caller asked for. Also sent as x-bifrost-routing-info-* response headers.","properties":{"provider":{"type":"string","description":"Provider that ran the attempt","enum":["anthropic","azure","bedrock","bedrock_mantle","sagemaker","cerebras","cohere","deepseek","gemini","groq","mistral","ollama","opencode-go","opencode-zen","openai","parasail","perplexity","sgl","vertex","openrouter","elevenlabs","huggingface","nebius","xai","replicate","vllm","runway","runware","fireworks","sarvam","wafer","databricks","cloudflare","typesafe","minimax","byteplus","machgen","baseten","kimchi","soniox"],"uniqueKey":"extra_fields.routing_info.provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"Model sent to that provider","uniqueKey":"extra_fields.routing_info.model","typeLabel":"string"},"key":{"type":"string","description":"Name of the stored key used, never its ID or secret","uniqueKey":"extra_fields.routing_info.key","typeLabel":"string"},"resolved_key_alias":{"type":"object","description":"Set only when the requested model matched a model alias on the key","required":["model_id"],"properties":{"model_id":{"type":"string","description":"Model ID sent to the provider","isRequired":true,"uniqueKey":"extra_fields.routing_info.resolved_key_alias.model_id","typeLabel":"string"},"model_name":{"type":"string","description":"Canonical model name, used for pricing and logs","uniqueKey":"extra_fields.routing_info.resolved_key_alias.model_name","typeLabel":"string"},"model_family":{"type":"string","description":"Resolved model family","uniqueKey":"extra_fields.routing_info.resolved_key_alias.model_family","typeLabel":"string"}},"uniqueKey":"extra_fields.routing_info.resolved_key_alias","typeLabel":"object"},"is_fallback":{"type":"boolean","description":"True when a fallback served the request or returned the error. Omitted when false.","uniqueKey":"extra_fields.routing_info.is_fallback","typeLabel":"boolean"},"primary_provider":{"type":"string","description":"The primary attempt's provider. Set only when a fallback ran.","enum":["anthropic","azure","bedrock","bedrock_mantle","sagemaker","cerebras","cohere","deepseek","gemini","groq","mistral","ollama","opencode-go","opencode-zen","openai","parasail","perplexity","sgl","vertex","openrouter","elevenlabs","huggingface","nebius","xai","replicate","vllm","runway","runware","fireworks","sarvam","wafer","databricks","cloudflare","typesafe","minimax","byteplus","machgen","baseten","kimchi","soniox"],"uniqueKey":"extra_fields.routing_info.primary_provider","typeLabel":"enum\u003cstring>"},"primary_model":{"type":"string","description":"The primary attempt's model. Set only when a fallback ran.","uniqueKey":"extra_fields.routing_info.primary_model","typeLabel":"string"},"requested_provider":{"type":"string","description":"Provider the caller asked for, before routing rules, load balancing or session affinity changed it. Omitted when the caller sent a bare model.","enum":["anthropic","azure","bedrock","bedrock_mantle","sagemaker","cerebras","cohere","deepseek","gemini","groq","mistral","ollama","opencode-go","opencode-zen","openai","parasail","perplexity","sgl","vertex","openrouter","elevenlabs","huggingface","nebius","xai","replicate","vllm","runway","runware","fireworks","sarvam","wafer","databricks","cloudflare","typesafe","minimax","byteplus","machgen","baseten","kimchi","soniox"],"uniqueKey":"extra_fields.routing_info.requested_provider","typeLabel":"enum\u003cstring>"},"requested_model":{"type":"string","description":"Model the caller asked for, before anything changed it","uniqueKey":"extra_fields.routing_info.requested_model","typeLabel":"string"},"server_side_fallback_model":{"type":"string","description":"Model that answered when Anthropic switched models inside one call","uniqueKey":"extra_fields.routing_info.server_side_fallback_model","typeLabel":"string"}},"uniqueKey":"extra_fields.routing_info","typeLabel":"object"},"provider":{"type":"string","description":"Deprecated: use routing_info.provider.","enum":["anthropic","azure","bedrock","bedrock_mantle","sagemaker","cerebras","cohere","deepseek","gemini","groq","mistral","ollama","opencode-go","opencode-zen","openai","parasail","perplexity","sgl","vertex","openrouter","elevenlabs","huggingface","nebius","xai","replicate","vllm","runway","runware","fireworks","sarvam","wafer","databricks","cloudflare","typesafe","minimax","byteplus","machgen","baseten","kimchi","soniox"],"deprecated":true,"uniqueKey":"extra_fields.provider","typeLabel":"enum\u003cstring>"},"original_model_requested":{"type":"string","deprecated":true,"description":"Deprecated: use routing_info.primary_model when routing_info.is_fallback is true, otherwise routing_info.model. For the model the caller asked for, read routing_info.requested_model.","uniqueKey":"extra_fields.original_model_requested","typeLabel":"string"},"resolved_model_used":{"type":"string","deprecated":true,"description":"Deprecated: use routing_info.resolved_key_alias.model_id when an alias matched, otherwise routing_info.model.","uniqueKey":"extra_fields.resolved_model_used","typeLabel":"string"},"request_type":{"type":"string","uniqueKey":"extra_fields.request_type","typeLabel":"string"},"mcp_request_type":{"type":"string","uniqueKey":"extra_fields.mcp_request_type","typeLabel":"string"},"a2a_request_type":{"type":"string","description":"Agent Gateway operation, for A2A errors","uniqueKey":"extra_fields.a2a_request_type","typeLabel":"string"},"a2a_agent_name":{"type":"string","uniqueKey":"extra_fields.a2a_agent_name","typeLabel":"string"},"error_type":{"type":"string","description":"Normalized, low-cardinality classification of why the request failed, declared by whichever component refused it. Prefixed by fault domain (caller_, policy_, provider_, bifrost_). Absent on failures that were not classified at source.","uniqueKey":"extra_fields.error_type","typeLabel":"string"},"retry_after_ms":{"type":"integer","format":"int64","minimum":1000,"maximum":300000,"description":"The provider's hint for how long to wait before retrying, in milliseconds, read from its retry-after-ms or Retry-After header or its google.rpc.RetryInfo error detail, and clamped to between 1000 and 300000. Absent when the provider gave no explicit hint.","uniqueKey":"extra_fields.retry_after_ms","typeLabel":"integer\u003cint64>"},"raw_request":{"description":"Raw provider request, when raw request capture is enabled","uniqueKey":"extra_fields.raw_request","typeLabel":"any"},"raw_response":{"description":"Raw provider response, when raw response capture is enabled","uniqueKey":"extra_fields.raw_response","typeLabel":"any"},"converted_request_type":{"type":"string","uniqueKey":"extra_fields.converted_request_type","typeLabel":"string"},"dropped_compat_plugin_params":{"type":"array","items":{"type":"string","uniqueKey":"extra_fields.dropped_compat_plugin_params.items.[INDEX]","typeLabel":"string"},"uniqueKey":"extra_fields.dropped_compat_plugin_params","typeLabel":"string[]"},"latency":{"type":"integer","format":"int64","description":"Latency in milliseconds","uniqueKey":"extra_fields.latency","typeLabel":"integer\u003cint64>"},"key_statuses":{"type":"array","description":"Per-key results, for requests that ran on every key such as listing models","items":{"type":"object","properties":{"key_id":{"type":"string","uniqueKey":"extra_fields.key_statuses.items.[INDEX].key_id","typeLabel":"string"},"status":{"type":"string","enum":["success","list_models_failed"],"uniqueKey":"extra_fields.key_statuses.items.[INDEX].status","typeLabel":"enum\u003cstring>"},"provider":{"type":"string","description":"AI model provider identifier","enum":["anthropic","azure","bedrock","bedrock_mantle","sagemaker","cerebras","cohere","deepseek","gemini","groq","mistral","ollama","opencode-go","opencode-zen","openai","parasail","perplexity","sgl","vertex","openrouter","elevenlabs","huggingface","nebius","xai","replicate","vllm","runway","runware","fireworks","sarvam","wafer","databricks","cloudflare","typesafe","minimax","byteplus","machgen","baseten","kimchi","soniox"],"uniqueKey":"extra_fields.key_statuses.items.[INDEX].provider","typeLabel":"enum\u003cstring>"},"error":{"oneOf":[{"$circularRef":"b7b33d72-0345-4aec-8d43-fa5c76a08d30"}],"uniqueKey":"extra_fields.key_statuses.items.[INDEX].error","typeLabel":"any"}},"uniqueKey":"extra_fields.key_statuses.items.[INDEX]","typeLabel":"object"},"uniqueKey":"extra_fields.key_statuses","typeLabel":"object[]"},"fallback_attempts":{"type":"array","description":"Set when the primary and every fallback failed and the primary's error was returned: what became of each fallback, in chain order. A fallback refused before reaching its provider (for example by a virtual key that does not allow it) is only visible here.","items":{"type":"object","properties":{"provider":{"type":"string","description":"AI model provider identifier","enum":["anthropic","azure","bedrock","bedrock_mantle","sagemaker","cerebras","cohere","deepseek","gemini","groq","mistral","ollama","opencode-go","opencode-zen","openai","parasail","perplexity","sgl","vertex","openrouter","elevenlabs","huggingface","nebius","xai","replicate","vllm","runway","runware","fireworks","sarvam","wafer","databricks","cloudflare","typesafe","minimax","byteplus","machgen","baseten","kimchi","soniox"],"uniqueKey":"extra_fields.fallback_attempts.items.[INDEX].provider","typeLabel":"enum\u003cstring>"},"model":{"type":"string","uniqueKey":"extra_fields.fallback_attempts.items.[INDEX].model","typeLabel":"string"},"status_code":{"type":"integer","uniqueKey":"extra_fields.fallback_attempts.items.[INDEX].status_code","typeLabel":"integer"},"type":{"type":"string","uniqueKey":"extra_fields.fallback_attempts.items.[INDEX].type","typeLabel":"string"},"message":{"type":"string","uniqueKey":"extra_fields.fallback_attempts.items.[INDEX].message","typeLabel":"string"},"skipped":{"type":"boolean","description":"The fallback was never attempted (no provider config, or the request type has no fallback support)","uniqueKey":"extra_fields.fallback_attempts.items.[INDEX].skipped","typeLabel":"boolean"}},"uniqueKey":"extra_fields.fallback_attempts.items.[INDEX]","typeLabel":"object"},"uniqueKey":"extra_fields.fallback_attempts","typeLabel":"object[]"},"mcp_auth_required":{"type":"object","description":"Set when a per-user MCP tool needs the caller to complete an inline auth flow","properties":{"kind":{"type":"string","uniqueKey":"extra_fields.mcp_auth_required.kind","typeLabel":"string"},"mcp_client_id":{"type":"string","uniqueKey":"extra_fields.mcp_auth_required.mcp_client_id","typeLabel":"string"},"mcp_client_name":{"type":"string","uniqueKey":"extra_fields.mcp_auth_required.mcp_client_name","typeLabel":"string"},"message":{"type":"string","uniqueKey":"extra_fields.mcp_auth_required.message","typeLabel":"string"},"authorize_url":{"type":"string","uniqueKey":"extra_fields.mcp_auth_required.authorize_url","typeLabel":"string"},"session_id":{"type":"string","uniqueKey":"extra_fields.mcp_auth_required.session_id","typeLabel":"string"},"subject_token_missing":{"type":"boolean","description":"token_exchange only. True when there was nothing to exchange, including when the caller's Bifrost sign-in has expired; message says which","uniqueKey":"extra_fields.mcp_auth_required.subject_token_missing","typeLabel":"boolean"},"exchange_error":{"type":"string","description":"token_exchange only. The identity provider's error code and description when it refused the exchange","uniqueKey":"extra_fields.mcp_auth_required.exchange_error","typeLabel":"string"}},"uniqueKey":"extra_fields.mcp_auth_required","typeLabel":"object"},"billed_usage":{"type":"object","description":"Usage the provider reported and billed even though the request failed","properties":{"prompt_tokens":{"type":"integer","description":"Total input tokens including any prompt-cache tokens (read + write). Subtract prompt_tokens_details.cached_read_tokens and prompt_tokens_details.cached_write_tokens to get the non-cached portion.\n","uniqueKey":"extra_fields.billed_usage.prompt_tokens","typeLabel":"integer"},"prompt_tokens_details":{"type":"object","properties":{"text_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.prompt_tokens_details.text_tokens","typeLabel":"integer"},"audio_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.prompt_tokens_details.audio_tokens","typeLabel":"integer"},"image_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.prompt_tokens_details.image_tokens","typeLabel":"integer"},"cached_read_tokens":{"type":"integer","description":"Tokens served from the prompt cache (cache hit). These tokens are already included in prompt_tokens and are billed at the reduced cache-read rate. Populated for all providers that support prompt caching (Anthropic, Bedrock, OpenAI, Gemini, xAI, etc.).\n","uniqueKey":"extra_fields.billed_usage.prompt_tokens_details.cached_read_tokens","typeLabel":"integer"},"cached_write_tokens":{"type":"integer","description":"Tokens written to the prompt cache on this request (cache creation / write). These tokens are already included in prompt_tokens and are billed at the cache-creation rate. Populated for providers that separately report cache write tokens (Anthropic, Bedrock).\n","uniqueKey":"extra_fields.billed_usage.prompt_tokens_details.cached_write_tokens","typeLabel":"integer"}},"uniqueKey":"extra_fields.billed_usage.prompt_tokens_details","typeLabel":"object"},"completion_tokens":{"type":"integer","description":"Number of output/completion tokens generated.","uniqueKey":"extra_fields.billed_usage.completion_tokens","typeLabel":"integer"},"completion_tokens_details":{"type":"object","properties":{"text_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.text_tokens","typeLabel":"integer"},"accepted_prediction_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.accepted_prediction_tokens","typeLabel":"integer"},"audio_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.audio_tokens","typeLabel":"integer"},"citation_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.citation_tokens","typeLabel":"integer"},"num_search_queries":{"type":"integer","deprecated":true,"description":"Deprecated, use tool_usage.web_search.num_requests. Will be removed in 3.0.0.","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.num_search_queries","typeLabel":"integer"},"reasoning_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.reasoning_tokens","typeLabel":"integer"},"image_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.image_tokens","typeLabel":"integer"},"rejected_prediction_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.completion_tokens_details.rejected_prediction_tokens","typeLabel":"integer"}},"uniqueKey":"extra_fields.billed_usage.completion_tokens_details","typeLabel":"object"},"total_tokens":{"type":"integer","uniqueKey":"extra_fields.billed_usage.total_tokens","typeLabel":"integer"},"tool_usage":{"type":"object","description":"Counts of provider-hosted (server-side) tool calls billed per call.\n","properties":{"web_search":{"type":"object","properties":{"num_requests":{"type":"integer","description":"Number of billable web search calls.","uniqueKey":"extra_fields.billed_usage.tool_usage.web_search.num_requests","typeLabel":"integer"}},"uniqueKey":"extra_fields.billed_usage.tool_usage.web_search","typeLabel":"object"}},"uniqueKey":"extra_fields.billed_usage.tool_usage","typeLabel":"object"},"cost":{"type":"object","description":"Cost breakdown for the request","properties":{"input_tokens_cost":{"type":"number","uniqueKey":"extra_fields.billed_usage.cost.input_tokens_cost","typeLabel":"number"},"output_tokens_cost":{"type":"number","uniqueKey":"extra_fields.billed_usage.cost.output_tokens_cost","typeLabel":"number"},"reasoning_tokens_cost":{"type":"number","description":"Cost for reasoning/thinking tokens (reasoning models)","uniqueKey":"extra_fields.billed_usage.cost.reasoning_tokens_cost","typeLabel":"number"},"citation_tokens_cost":{"type":"number","description":"Cost for citation tokens","uniqueKey":"extra_fields.billed_usage.cost.citation_tokens_cost","typeLabel":"number"},"search_queries_cost":{"type":"number","description":"Cost for web search queries","uniqueKey":"extra_fields.billed_usage.cost.search_queries_cost","typeLabel":"number"},"request_cost":{"type":"number","uniqueKey":"extra_fields.billed_usage.cost.request_cost","typeLabel":"number"},"total_cost":{"type":"number","uniqueKey":"extra_fields.billed_usage.cost.total_cost","typeLabel":"number"}},"uniqueKey":"extra_fields.billed_usage.cost","typeLabel":"object"}},"uniqueKey":"extra_fields.billed_usage","typeLabel":"object"}},"uniqueKey":"extra_fields","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"event_id":"\u003cstring>","type":"\u003cstring>","is_bifrost_error":true,"status_code":123,"error":{"type":"\u003cstring>","code":"\u003cstring>","message":"\u003cstring>","param":"\u003cstring>","event_id":"\u003cstring>"},"extra_fields":{"routing_info":{"provider":"anthropic","model":"\u003cstring>","key":"\u003cstring>","resolved_key_alias":{"model_id":"\u003cstring>","model_name":"\u003cstring>","model_family":"\u003cstring>"},"is_fallback":true,"primary_provider":"anthropic","primary_model":"\u003cstring>","requested_provider":"anthropic","requested_model":"\u003cstring>","server_side_fallback_model":"\u003cstring>"},"provider":"anthropic","original_model_requested":"\u003cstring>","resolved_model_used":"\u003cstring>","request_type":"\u003cstring>","mcp_request_type":"\u003cstring>","a2a_request_type":"\u003cstring>","a2a_agent_name":"\u003cstring>","error_type":"\u003cstring>","retry_after_ms":150500,"raw_request":"\u003cunknown>","raw_response":"\u003cunknown>","converted_request_type":"\u003cstring>","dropped_compat_plugin_params":["\u003cstring>"],"latency":123,"key_statuses":[{"key_id":"\u003cstring>","status":"success","provider":"anthropic","error":"\u003cunknown>"}],"fallback_attempts":[{"provider":"anthropic","model":"\u003cstring>","status_code":123,"type":"\u003cstring>","message":"\u003cstring>","skipped":true}],"mcp_auth_required":{"kind":"\u003cstring>","mcp_client_id":"\u003cstring>","mcp_client_name":"\u003cstring>","message":"\u003cstring>","authorize_url":"\u003cstring>","session_id":"\u003cstring>","subject_token_missing":true,"exchange_error":"\u003cstring>"},"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}}}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"afb851c3-1301-4082-b638-c584da07787b":{"ManagementBearerAuth":{"type":"http","scheme":"bearer","description":"Management API authentication for `/api/*` endpoints. Use the `Authorization` header\nwith `Bearer \u003ctoken>`, where `\u003ctoken>` is one of:\n\n- a Bifrost management API key,\n- a dashboard session token issued by `POST /api/session/login`,\n- base64 of `\u003cadmin-username>:\u003cadmin-password>` (legacy equivalent of `BasicAuth`).\n\nVirtual keys (`sk-bf-*`) and the `x-api-key` header are not accepted on management APIs -\nthe sole exception is `GET /api/governance/virtual-keys/quota`, which is virtual-key-only.\n\nAuthentication alone is not sufficient in Bifrost Enterprise: each operation page shows a\n**Required Permissions** table (`Resource:Operation`, for example `Dashboard:View`) above\nits Authorizations section, and the caller's RBAC role or management API key scopes must\ninclude what it lists, otherwise the request is rejected with `403 Forbidden`.\n\nA local admin — authenticated with the admin password, or any caller on a deployment with\ndashboard auth disabled — bypasses these checks and can call every management endpoint.\n\n**OSS setup lock.** On Bifrost OSS, while dashboard auth is not active (no admin account,\nor auth disabled), every management endpoint except the public ones (`/health`,\n`/api/version`, `/api/session/is-auth-enabled`, `/api/session/login`, ...) requires the\noperator's setup token in the `X-Bifrost-Setup-Token` header, in place of `Authorization`.\nThe token is set with `setup_token` in `config.json` or the `BIFROST_SETUP_TOKEN`\nenvironment variable. A missing header returns `401`, a wrong token `403`. The header\nstops working once dashboard auth is enabled. The dashboard instead trades the token once\nfor an HttpOnly `bifrost_setup_session` cookie via `POST /api/session/setup`.\nSee [Required permissions](/api/procuring-api-keys#required-permissions) for how\npermissions are derived and which endpoints are exempt.\n","scopes":[],"schemeName":"ManagementBearerAuth"}},"15dfe425-b30e-4883-87db-2c47bd7d6578":{"BasicAuth":{"type":"http","scheme":"basic","description":"Basic authentication using the Bifrost admin username and password\n(`auth_config.admin_username` / `auth_config.admin_password`).\nAccepted on management APIs (`/api/*`, `/metrics`, `/ws`) only - the inference\nmiddleware never validates Basic credentials.\n","scopes":[],"schemeName":"BasicAuth"}}},"servers":{"3967813b-562c-40d9-bb92-9d6426d2f033":{"url":"{baseUrl}","description":"Your Bifrost instance","variables":{"baseUrl":{"default":"http://localhost:8080","description":"Base URL of your Bifrost instance (e.g. https://bifrost.mycompany.com, or https://mycompany.com/bifrost when served under server.base_path)"}}}},"schemas":{"b7b33d72-0345-4aec-8d43-fa5c76a08d30":{"type":"object","description":"Error response from Bifrost","properties":{"event_id":{"type":"string"},"type":{"type":"string"},"is_bifrost_error":{"type":"boolean"},"status_code":{"type":"integer"},"error":{"type":"object","properties":{"type":{"type":"string"},"code":{"type":"string"},"message":{"type":"string"},"param":{"type":"string"},"event_id":{"type":"string"}}},"extra_fields":{"type":"object","properties":{"routing_info":{"type":"object","description":"Which provider, model and key handled the attempt that produced this response or error, and what the caller asked for. Also sent as x-bifrost-routing-info-* response headers.","properties":{"provider":{"type":"string","description":"Provider that ran the attempt","enum":["anthropic","azure","bedrock","bedrock_mantle","sagemaker","cerebras","cohere","deepseek","gemini","groq","mistral","ollama","opencode-go","opencode-zen","openai","parasail","perplexity","sgl","vertex","openrouter","elevenlabs","huggingface","nebius","xai","replicate","vllm","runway","runware","fireworks","sarvam","wafer","databricks","cloudflare","typesafe","minimax","byteplus","machgen","baseten","kimchi","soniox"]},"model":{"type":"string","description":"Model sent to that provider"},"key":{"type":"string","description":"Name of the stored key used, never its ID or secret"},"resolved_key_alias":{"type":"object","description":"Set only when the requested model matched a model alias on the key","required":["model_id"],"properties":{"model_id":{"type":"string","description":"Model ID sent to the provider","isRequired":true},"model_name":{"type":"string","description":"Canonical model name, used for pricing and logs"},"model_family":{"type":"string","description":"Resolved model family"}}},"is_fallback":{"type":"boolean","description":"True when a fallback served the request or returned the error. Omitted when false."},"primary_provider":{"type":"string","description":"The primary attempt's provider. Set only when a fallback ran.","enum":["anthropic","azure","bedrock","bedrock_mantle","sagemaker","cerebras","cohere","deepseek","gemini","groq","mistral","ollama","opencode-go","opencode-zen","openai","parasail","perplexity","sgl","vertex","openrouter","elevenlabs","huggingface","nebius","xai","replicate","vllm","runway","runware","fireworks","sarvam","wafer","databricks","cloudflare","typesafe","minimax","byteplus","machgen","baseten","kimchi","soniox"]},"primary_model":{"type":"string","description":"The primary attempt's model. Set only when a fallback ran."},"requested_provider":{"type":"string","description":"Provider the caller asked for, before routing rules, load balancing or session affinity changed it. Omitted when the caller sent a bare model.","enum":["anthropic","azure","bedrock","bedrock_mantle","sagemaker","cerebras","cohere","deepseek","gemini","groq","mistral","ollama","opencode-go","opencode-zen","openai","parasail","perplexity","sgl","vertex","openrouter","elevenlabs","huggingface","nebius","xai","replicate","vllm","runway","runware","fireworks","sarvam","wafer","databricks","cloudflare","typesafe","minimax","byteplus","machgen","baseten","kimchi","soniox"]},"requested_model":{"type":"string","description":"Model the caller asked for, before anything changed it"},"server_side_fallback_model":{"type":"string","description":"Model that answered when Anthropic switched models inside one call"}}},"provider":{"type":"string","description":"Deprecated: use routing_info.provider.","enum":["anthropic","azure","bedrock","bedrock_mantle","sagemaker","cerebras","cohere","deepseek","gemini","groq","mistral","ollama","opencode-go","opencode-zen","openai","parasail","perplexity","sgl","vertex","openrouter","elevenlabs","huggingface","nebius","xai","replicate","vllm","runway","runware","fireworks","sarvam","wafer","databricks","cloudflare","typesafe","minimax","byteplus","machgen","baseten","kimchi","soniox"],"deprecated":true},"original_model_requested":{"type":"string","deprecated":true,"description":"Deprecated: use routing_info.primary_model when routing_info.is_fallback is true, otherwise routing_info.model. For the model the caller asked for, read routing_info.requested_model."},"resolved_model_used":{"type":"string","deprecated":true,"description":"Deprecated: use routing_info.resolved_key_alias.model_id when an alias matched, otherwise routing_info.model."},"request_type":{"type":"string"},"mcp_request_type":{"type":"string"},"a2a_request_type":{"type":"string","description":"Agent Gateway operation, for A2A errors"},"a2a_agent_name":{"type":"string"},"error_type":{"type":"string","description":"Normalized, low-cardinality classification of why the request failed, declared by whichever component refused it. Prefixed by fault domain (caller_, policy_, provider_, bifrost_). Absent on failures that were not classified at source."},"retry_after_ms":{"type":"integer","format":"int64","minimum":1000,"maximum":300000,"description":"The provider's hint for how long to wait before retrying, in milliseconds, read from its retry-after-ms or Retry-After header or its google.rpc.RetryInfo error detail, and clamped to between 1000 and 300000. Absent when the provider gave no explicit hint."},"raw_request":{"description":"Raw provider request, when raw request capture is enabled"},"raw_response":{"description":"Raw provider response, when raw response capture is enabled"},"converted_request_type":{"type":"string"},"dropped_compat_plugin_params":{"type":"array","items":{"type":"string"}},"latency":{"type":"integer","format":"int64","description":"Latency in milliseconds"},"key_statuses":{"type":"array","description":"Per-key results, for requests that ran on every key such as listing models","items":{"type":"object","properties":{"key_id":{"type":"string"},"status":{"type":"string","enum":["success","list_models_failed"]},"provider":{"type":"string","description":"AI model provider identifier","enum":["anthropic","azure","bedrock","bedrock_mantle","sagemaker","cerebras","cohere","deepseek","gemini","groq","mistral","ollama","opencode-go","opencode-zen","openai","parasail","perplexity","sgl","vertex","openrouter","elevenlabs","huggingface","nebius","xai","replicate","vllm","runway","runware","fireworks","sarvam","wafer","databricks","cloudflare","typesafe","minimax","byteplus","machgen","baseten","kimchi","soniox"]},"error":{"oneOf":[{}]}}}},"fallback_attempts":{"type":"array","description":"Set when the primary and every fallback failed and the primary's error was returned: what became of each fallback, in chain order. A fallback refused before reaching its provider (for example by a virtual key that does not allow it) is only visible here.","items":{"type":"object","properties":{"provider":{"type":"string","description":"AI model provider identifier","enum":["anthropic","azure","bedrock","bedrock_mantle","sagemaker","cerebras","cohere","deepseek","gemini","groq","mistral","ollama","opencode-go","opencode-zen","openai","parasail","perplexity","sgl","vertex","openrouter","elevenlabs","huggingface","nebius","xai","replicate","vllm","runway","runware","fireworks","sarvam","wafer","databricks","cloudflare","typesafe","minimax","byteplus","machgen","baseten","kimchi","soniox"]},"model":{"type":"string"},"status_code":{"type":"integer"},"type":{"type":"string"},"message":{"type":"string"},"skipped":{"type":"boolean","description":"The fallback was never attempted (no provider config, or the request type has no fallback support)"}}}},"mcp_auth_required":{"type":"object","description":"Set when a per-user MCP tool needs the caller to complete an inline auth flow","properties":{"kind":{"type":"string"},"mcp_client_id":{"type":"string"},"mcp_client_name":{"type":"string"},"message":{"type":"string"},"authorize_url":{"type":"string"},"session_id":{"type":"string"},"subject_token_missing":{"type":"boolean","description":"token_exchange only. True when there was nothing to exchange, including when the caller's Bifrost sign-in has expired; message says which"},"exchange_error":{"type":"string","description":"token_exchange only. The identity provider's error code and description when it refused the exchange"}}},"billed_usage":{"type":"object","description":"Usage the provider reported and billed even though the request failed","properties":{"prompt_tokens":{"type":"integer","description":"Total input tokens including any prompt-cache tokens (read + write). Subtract prompt_tokens_details.cached_read_tokens and prompt_tokens_details.cached_write_tokens to get the non-cached portion.\n"},"prompt_tokens_details":{"type":"object","properties":{"text_tokens":{"type":"integer"},"audio_tokens":{"type":"integer"},"image_tokens":{"type":"integer"},"cached_read_tokens":{"type":"integer","description":"Tokens served from the prompt cache (cache hit). These tokens are already included in prompt_tokens and are billed at the reduced cache-read rate. Populated for all providers that support prompt caching (Anthropic, Bedrock, OpenAI, Gemini, xAI, etc.).\n"},"cached_write_tokens":{"type":"integer","description":"Tokens written to the prompt cache on this request (cache creation / write). These tokens are already included in prompt_tokens and are billed at the cache-creation rate. Populated for providers that separately report cache write tokens (Anthropic, Bedrock).\n"}}},"completion_tokens":{"type":"integer","description":"Number of output/completion tokens generated."},"completion_tokens_details":{"type":"object","properties":{"text_tokens":{"type":"integer"},"accepted_prediction_tokens":{"type":"integer"},"audio_tokens":{"type":"integer"},"citation_tokens":{"type":"integer"},"num_search_queries":{"type":"integer","deprecated":true,"description":"Deprecated, use tool_usage.web_search.num_requests. Will be removed in 3.0.0."},"reasoning_tokens":{"type":"integer"},"image_tokens":{"type":"integer"},"rejected_prediction_tokens":{"type":"integer"}}},"total_tokens":{"type":"integer"},"tool_usage":{"type":"object","description":"Counts of provider-hosted (server-side) tool calls billed per call.\n","properties":{"web_search":{"type":"object","properties":{"num_requests":{"type":"integer","description":"Number of billable web search calls."}}}}},"cost":{"type":"object","description":"Cost breakdown for the request","properties":{"input_tokens_cost":{"type":"number"},"output_tokens_cost":{"type":"number"},"reasoning_tokens_cost":{"type":"number","description":"Cost for reasoning/thinking tokens (reasoning models)"},"citation_tokens_cost":{"type":"number","description":"Cost for citation tokens"},"search_queries_cost":{"type":"number","description":"Cost for web search queries"},"request_cost":{"type":"number"},"total_cost":{"type":"number"}}}}}}}}}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Management API authentication for `/api/*` endpoints. Use the `Authorization` header\nwith `Bearer \u003ctoken>`, where `\u003ctoken>` is one of:\n\n- a Bifrost management API key,\n- a dashboard session token issued by `POST /api/session/login`,\n- base64 of `\u003cadmin-username>:\u003cadmin-password>` (legacy equivalent of `BasicAuth`).\n\nVirtual keys (`sk-bf-*`) and the `x-api-key` header are not accepted on management APIs -\nthe sole exception is `GET /api/governance/virtual-keys/quota`, which is virtual-key-only.\n\nAuthentication alone is not sufficient in Bifrost Enterprise: each operation page shows a\n**Required Permissions** table (`Resource:Operation`, for example `Dashboard:View`) above\nits Authorizations section, and the caller's RBAC role or management API key scopes must\ninclude what it lists, otherwise the request is rejected with `403 Forbidden`.\n\nA local admin — authenticated with the admin password, or any caller on a deployment with\ndashboard auth disabled — bypasses these checks and can call every management endpoint.\n\n**OSS setup lock.** On Bifrost OSS, while dashboard auth is not active (no admin account,\nor auth disabled), every management endpoint except the public ones (`/health`,\n`/api/version`, `/api/session/is-auth-enabled`, `/api/session/login`, ...) requires the\noperator's setup token in the `X-Bifrost-Setup-Token` header, in place of `Authorization`.\nThe token is set with `setup_token` in `config.json` or the `BIFROST_SETUP_TOKEN`\nenvironment variable. A missing header returns `401`, a wrong token `403`. The header\nstops working once dashboard auth is enabled. The dashboard instead trades the token once\nfor an HttpOnly `bifrost_setup_session` cookie via `POST /api/session/setup`.\nSee [Required permissions](/api/procuring-api-keys#required-permissions) for how\npermissions are derived and which endpoints are exempt.\n","scopes":[],"schemeName":"ManagementBearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Management API authentication for `/api/*` endpoints. Use the `Authorization` header\nwith `Bearer \u003ctoken>`, where `\u003ctoken>` is one of:\n\n- a Bifrost management API key,\n- a dashboard session token issued by `POST /api/session/login`,\n- base64 of `\u003cadmin-username>:\u003cadmin-password>` (legacy equivalent of `BasicAuth`).\n\nVirtual keys (`sk-bf-*`) and the `x-api-key` header are not accepted on management APIs -\nthe sole exception is `GET /api/governance/virtual-keys/quota`, which is virtual-key-only.\n\nAuthentication alone is not sufficient in Bifrost Enterprise: each operation page shows a\n**Required Permissions** table (`Resource:Operation`, for example `Dashboard:View`) above\nits Authorizations section, and the caller's RBAC role or management API key scopes must\ninclude what it lists, otherwise the request is rejected with `403 Forbidden`.\n\nA local admin — authenticated with the admin password, or any caller on a deployment with\ndashboard auth disabled — bypasses these checks and can call every management endpoint.\n\n**OSS setup lock.** On Bifrost OSS, while dashboard auth is not active (no admin account,\nor auth disabled), every management endpoint except the public ones (`/health`,\n`/api/version`, `/api/session/is-auth-enabled`, `/api/session/login`, ...) requires the\noperator's setup token in the `X-Bifrost-Setup-Token` header, in place of `Authorization`.\nThe token is set with `setup_token` in `config.json` or the `BIFROST_SETUP_TOKEN`\nenvironment variable. A missing header returns `401`, a wrong token `403`. The header\nstops working once dashboard auth is enabled. The dashboard instead trades the token once\nfor an HttpOnly `bifrost_setup_session` cookie via `POST /api/session/setup`.\nSee [Required permissions](/api/procuring-api-keys#required-permissions) for how\npermissions are derived and which endpoints are exempt.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ManagementBearerAuth","name":"Authorization"}],"title":"ManagementBearerAuth"},{"schemes":[{"scheme":{"type":"http","scheme":"basic","description":"Basic authentication using the Bifrost admin username and password\n(`auth_config.admin_username` / `auth_config.admin_password`).\nAccepted on management APIs (`/api/*`, `/metrics`, `/ws`) only - the inference\nmiddleware never validates Basic credentials.\n","scopes":[],"schemeName":"BasicAuth"},"schema":{"title":"Basic Auth","type":"object","description":"Basic authentication using the Bifrost admin username and password\n(`auth_config.admin_username` / `auth_config.admin_password`).\nAccepted on management APIs (`/api/*`, `/metrics`, `/ws`) only - the inference\nmiddleware never validates Basic credentials.\n","isRequired":true,"properties":{"username":{"type":"string","uniqueKey":"username","isRequired":true,"typeLabel":"string","deprecated":false},"password":{"type":"string","uniqueKey":"password","isRequired":true,"typeLabel":"string","deprecated":false}},"additionalProperties":false,"deprecated":false},"schemeName":"BasicAuth","name":"Authorization"}],"title":"BasicAuth"}]},"originalFileLocation":"openapi/openapi.json"},"subdomain":"bifrost","siteName":"Bifrost","title":"Add MCP client - Bifrost","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-18T19:10:30.844Z","originalFileLocation":"api-reference/mcp/add-mcp-client.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Adds a new MCP client with the specified configuration. Note: tool_pricing is not available when creating a new client; tool pricing can only be set once the tool list is known. For shared-connection clients tools are fetched after client creation; for per-user auth types they are discovered during the create/verify flow itself. Two cases require a genuinely authenticated admin session and are refused with 403 when dashboard authentication is disabled or unconfigured, even though other management endpoints stay reachable in that state: connection_type \u0026quot;stdio\u0026quot; (which runs the supplied command as a gateway subprocess), and connection_type \u0026quot;http\u0026quot;/\u0026quot;sse\u0026quot; whose connection_string resolves to a loopback, private-network, link-local, or CGNAT address. Public http/sse targets are unaffected. For auth_type \u0026quot;token_exchange\u0026quot;, verification and tool discovery run during the create as the signed-in admin: Bifrost exchanges the identity-provider token on the request or, when it carries none, the access token from the admin\u0026#x27;s own Bifrost sign-in. A request with neither (for example one made with an API key) creates the client in pending_verification; finish it with POST /api/mcp/client/{id}/verify-exchange. For auth_type \u0026quot;oauth\u0026quot; and \u0026quot;per_user_oauth\u0026quot;, the name and endpoint slug are checked before the OAuth flow starts, so a conflict returns 409 at create rather than when the flow is completed, and endpoint_slug is kept for the client the completion creates. OAuth discovery against a private address that mcp_oauth_private_allowlist does not permit returns 400. auth_type must be one of the MCPAuthType values; any other value returns 400. per_user_oauth and token_exchange need connection_type \u0026quot;http\u0026quot;, and per_user_headers needs \u0026quot;http\u0026quot; or \u0026quot;openapi\u0026quot;: each call opens its own connection, so all three return 400 on \u0026quot;sse\u0026quot; and \u0026quot;stdio\u0026quot;. An omitted auth_type is \u0026quot;headers\u0026quot;.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Bifrost\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/bifrost/kXIL-Qs6IzN4ZLK4/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/bifrost/kXIL-Qs6IzN4ZLK4/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/bifrost/kXIL-Qs6IzN4ZLK4/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/bifrost/kXIL-Qs6IzN4ZLK4/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/bifrost/kXIL-Qs6IzN4ZLK4/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/bifrost/kXIL-Qs6IzN4ZLK4/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/bifrost/kXIL-Qs6IzN4ZLK4/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/bifrost/kXIL-Qs6IzN4ZLK4/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/bifrost/kXIL-Qs6IzN4ZLK4/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Add MCP client - Bifrost\">\u003cmeta data-mint-head property=\"og:description\" content=\"Adds a new MCP client with the specified configuration. Note: tool_pricing is not available when creating a new client; tool pricing can only be set once the tool list is known. For shared-connection clients tools are fetched after client creation; for per-user auth types they are discovered during the create/verify flow itself. Two cases require a genuinely authenticated admin session and are refused with 403 when dashboard authentication is disabled or unconfigured, even though other management endpoints stay reachable in that state: connection_type \u0026quot;stdio\u0026quot; (which runs the supplied command as a gateway subprocess), and connection_type \u0026quot;http\u0026quot;/\u0026quot;sse\u0026quot; whose connection_string resolves to a loopback, private-network, link-local, or CGNAT address. Public http/sse targets are unaffected. For auth_type \u0026quot;token_exchange\u0026quot;, verification and tool discovery run during the create as the signed-in admin: Bifrost exchanges the identity-provider token on the request or, when it carries none, the access token from the admin\u0026#x27;s own Bifrost sign-in. A request with neither (for example one made with an API key) creates the client in pending_verification; finish it with POST /api/mcp/client/{id}/verify-exchange. For auth_type \u0026quot;oauth\u0026quot; and \u0026quot;per_user_oauth\u0026quot;, the name and endpoint slug are checked before the OAuth flow starts, so a conflict returns 409 at create rather than when the flow is completed, and endpoint_slug is kept for the client the completion creates. OAuth discovery against a private address that mcp_oauth_private_allowlist does not permit returns 400. auth_type must be one of the MCPAuthType values; any other value returns 400. per_user_oauth and token_exchange need connection_type \u0026quot;http\u0026quot;, and per_user_headers needs \u0026quot;http\u0026quot; or \u0026quot;openapi\u0026quot;: each call opens its own connection, so all three return 400 on \u0026quot;sse\u0026quot; and \u0026quot;stdio\u0026quot;. An omitted auth_type is \u0026quot;headers\u0026quot;.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Bifrost\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.getbifrost.ai/api-reference/mcp/add-mcp-client\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://bifrost.mintlify.site/_mintlify/api/og/v2?division=MCP\u0026amp;title=Add+MCP+client\u0026amp;description=Adds+a+new+MCP+client+with+the+specified+configuration.%0ANote%3A+tool_pricing+is+not+available+when+creating+a+new+client%3B+tool%0Apricing+can+only+be+set+once+the+to\u0026amp;theme=b382615b1ec5d0a74479e6c7\u0026amp;signature=dc5eb7cd2fbfbbcdd9a16ef0d537106188d822af210f376979cd6900748f9e46\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Add MCP client - Bifrost\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Adds a new MCP client with the specified configuration. Note: tool_pricing is not available when creating a new client; tool pricing can only be set once the tool list is known. For shared-connection clients tools are fetched after client creation; for per-user auth types they are discovered during the create/verify flow itself. Two cases require a genuinely authenticated admin session and are refused with 403 when dashboard authentication is disabled or unconfigured, even though other management endpoints stay reachable in that state: connection_type \u0026quot;stdio\u0026quot; (which runs the supplied command as a gateway subprocess), and connection_type \u0026quot;http\u0026quot;/\u0026quot;sse\u0026quot; whose connection_string resolves to a loopback, private-network, link-local, or CGNAT address. Public http/sse targets are unaffected. For auth_type \u0026quot;token_exchange\u0026quot;, verification and tool discovery run during the create as the signed-in admin: Bifrost exchanges the identity-provider token on the request or, when it carries none, the access token from the admin\u0026#x27;s own Bifrost sign-in. A request with neither (for example one made with an API key) creates the client in pending_verification; finish it with POST /api/mcp/client/{id}/verify-exchange. For auth_type \u0026quot;oauth\u0026quot; and \u0026quot;per_user_oauth\u0026quot;, the name and endpoint slug are checked before the OAuth flow starts, so a conflict returns 409 at create rather than when the flow is completed, and endpoint_slug is kept for the client the completion creates. OAuth discovery against a private address that mcp_oauth_private_allowlist does not permit returns 400. auth_type must be one of the MCPAuthType values; any other value returns 400. per_user_oauth and token_exchange need connection_type \u0026quot;http\u0026quot;, and per_user_headers needs \u0026quot;http\u0026quot; or \u0026quot;openapi\u0026quot;: each call opens its own connection, so all three return 400 on \u0026quot;sse\u0026quot; and \u0026quot;stdio\u0026quot;. An omitted auth_type is \u0026quot;headers\u0026quot;.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://bifrost.mintlify.site/_mintlify/api/og/v2?division=MCP\u0026amp;title=Add+MCP+client\u0026amp;description=Adds+a+new+MCP+client+with+the+specified+configuration.%0ANote%3A+tool_pricing+is+not+available+when+creating+a+new+client%3B+tool%0Apricing+can+only+be+set+once+the+to\u0026amp;theme=b382615b1ec5d0a74479e6c7\u0026amp;signature=dc5eb7cd2fbfbbcdd9a16ef0d537106188d822af210f376979cd6900748f9e46\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/bifrost/kXIL-Qs6IzN4ZLK4/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Bifrost\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0C3B43\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.getbifrost.ai/api-reference/mcp/add-mcp-client\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/mcp/add-mcp-client.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.getbifrost.ai/#organization\",\"name\":\"Bifrost\",\"url\":\"https://docs.getbifrost.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/bifrost/qFMmk8bNSnvgFYDI/media/bifrost-logo.png?fit=max\u0026auto=format\u0026n=qFMmk8bNSnvgFYDI\u0026q=85\u0026s=6af701a560aee4103444fa017b226cf0\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.getbifrost.ai#website\",\"name\":\"Bifrost\",\"url\":\"https://docs.getbifrost.ai\",\"publisher\":{\"@id\":\"https://docs.getbifrost.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.getbifrost.ai/api-reference/mcp/add-mcp-client#webpage\",\"url\":\"https://docs.getbifrost.ai/api-reference/mcp/add-mcp-client\",\"name\":\"Add MCP client\",\"description\":\"Adds a new MCP client with the specified configuration. Note: tool_pricing is not available when creating a new client; tool pricing can only be set once the tool list is known. For shared-connection clients tools are fetched after client creation; for per-user auth types they are discovered during the create/verify flow itself. Two cases require a genuinely authenticated admin session and are refused with 403 when dashboard authentication is disabled or unconfigured, even though other management endpoints stay reachable in that state: connection_type \\\"stdio\\\" (which runs the supplied command as a gateway subprocess), and connection_type \\\"http\\\"/\\\"sse\\\" whose connection_string resolves to a loopback, private-network, link-local, or CGNAT address. Public http/sse targets are unaffected. For auth_type \\\"token_exchange\\\", verification and tool discovery run during the create as the signed-in admin: Bifrost exchanges the identity-provider token on the request or, when it carries none, the access token from the admin's own Bifrost sign-in. A request with neither (for example one made with an API key) creates the client in pending_verification; finish it with POST /api/mcp/client/{id}/verify-exchange. For auth_type \\\"oauth\\\" and \\\"per_user_oauth\\\", the name and endpoint slug are checked before the OAuth flow starts, so a conflict returns 409 at create rather than when the flow is completed, and endpoint_slug is kept for the client the completion creates. OAuth discovery against a private address that mcp_oauth_private_allowlist does not permit returns 400. auth_type must be one of the MCPAuthType values; any other value returns 400. per_user_oauth and token_exchange need connection_type \\\"http\\\", and per_user_headers needs \\\"http\\\" or \\\"openapi\\\": each call opens its own connection, so all three return 400 on \\\"sse\\\" and \\\"stdio\\\". An omitted auth_type is \\\"headers\\\".\",\"dateModified\":\"2026-11-18T19:10:30.844Z\",\"isPartOf\":{\"@id\":\"https://docs.getbifrost.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.getbifrost.ai/api-reference/mcp/add-mcp-client#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.getbifrost.ai/api-reference/mcp/add-mcp-client#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Platform\",\"item\":\"https://docs.getbifrost.ai/api-reference/health/health-check\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"MCP\",\"item\":\"https://docs.getbifrost.ai/api-reference/mcp/execute-mcp-tool\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Add MCP client\",\"item\":\"https://docs.getbifrost.ai/api-reference/mcp/add-mcp-client\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.getbifrost.ai/api-reference/mcp/add-mcp-client#apireference\",\"headline\":\"Add MCP client\",\"name\":\"Add MCP client\",\"description\":\"Adds a new MCP client with the specified configuration. Note: tool_pricing is not available when creating a new client; tool pricing can only be set once the tool list is known. For shared-connection clients tools are fetched after client creation; for per-user auth types they are discovered during the create/verify flow itself. Two cases require a genuinely authenticated admin session and are refused with 403 when dashboard authentication is disabled or unconfigured, even though other management endpoints stay reachable in that state: connection_type \\\"stdio\\\" (which runs the supplied command as a gateway subprocess), and connection_type \\\"http\\\"/\\\"sse\\\" whose connection_string resolves to a loopback, private-network, link-local, or CGNAT address. Public http/sse targets are unaffected. For auth_type \\\"token_exchange\\\", verification and tool discovery run during the create as the signed-in admin: Bifrost exchanges the identity-provider token on the request or, when it carries none, the access token from the admin's own Bifrost sign-in. A request with neither (for example one made with an API key) creates the client in pending_verification; finish it with POST /api/mcp/client/{id}/verify-exchange. For auth_type \\\"oauth\\\" and \\\"per_user_oauth\\\", the name and endpoint slug are checked before the OAuth flow starts, so a conflict returns 409 at create rather than when the flow is completed, and endpoint_slug is kept for the client the completion creates. OAuth discovery against a private address that mcp_oauth_private_allowlist does not permit returns 400. auth_type must be one of the MCPAuthType values; any other value returns 400. per_user_oauth and token_exchange need connection_type \\\"http\\\", and per_user_headers needs \\\"http\\\" or \\\"openapi\\\": each call opens its own connection, so all three return 400 on \\\"sse\\\" and \\\"stdio\\\". An omitted auth_type is \\\"headers\\\".\",\"url\":\"https://docs.getbifrost.ai/api-reference/mcp/add-mcp-client\",\"mainEntityOfPage\":{\"@id\":\"https://docs.getbifrost.ai/api-reference/mcp/add-mcp-client#webpage\"},\"dateModified\":\"2026-11-18T19:10:30.844Z\",\"publisher\":{\"@id\":\"https://docs.getbifrost.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.getbifrost.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Bifrost\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Bifrost\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/mcp/add-mcp-client.md","siteName":"Bifrost","nav":{"global":{"anchors":[{"anchor":"Discord","icon":"discord","href":"https://discord.gg/exN5KAydbU"},{"anchor":"GitHub","icon":"github","href":"https://github.com/maximhq/bifrost"},{"anchor":"Try Enterprise","icon":"building","href":"https://www.getmaxim.ai/bifrost/enterprise"}]},"tabs":[{"tab":"OSS","icon":"book-open-cover","pages":[{"title":"OSS","href":"/overview"}]},{"tab":"Enterprise","icon":"building","pages":[{"title":"Enterprise","href":"/enterprise/overview"}]},{"tab":"Edge","icon":"globe","pages":[{"title":"Edge","href":"/edge/overview"}]},{"tab":"Integrations","icon":"plug","pages":[{"title":"Integrations","href":"/runbooks/claude-code-bedrock"}]},{"tab":"Deployment Guides","icon":"server","pages":[{"title":"Deployment Guides","href":"/deployment-guides/overview"}]},{"tab":"API","icon":"code","groups":[{"group":"Authentication","icon":"key","pages":[{"title":"Creating API Keys","icon":"key","href":"/api/procuring-api-keys"}]},{"group":"Inference","pages":[{"group":"Models","expanded":false,"pages":[{"title":"List available models","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/models","href":"/api-reference/models/list-available-models"}]},{"group":"Chat Completions","expanded":false,"pages":[{"title":"Create a chat completion","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/chat/completions","href":"/api-reference/chat-completions/create-a-chat-completion"}]},{"group":"Text Completions","expanded":false,"pages":[{"title":"Create a text completion","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/completions","href":"/api-reference/text-completions/create-a-text-completion"}]},{"group":"Responses","expanded":false,"pages":[{"title":"Responses API over WebSocket","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/responses","href":"/api-reference/responses/responses-api-over-websocket"},{"title":"Create a response","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/responses","href":"/api-reference/responses/create-a-response"},{"title":"Retrieve a response","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/responses/{response_id}","href":"/api-reference/responses/retrieve-a-response"},{"title":"Delete a response","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /v1/responses/{response_id}","href":"/api-reference/responses/delete-a-response"},{"title":"Cancel a response","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/responses/{response_id}/cancel","href":"/api-reference/responses/cancel-a-response"},{"title":"List response input items","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/responses/{response_id}/input_items","href":"/api-reference/responses/list-response-input-items"}]},{"group":"OCR","expanded":false,"pages":[{"title":"Perform OCR","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/ocr","href":"/api-reference/ocr/perform-ocr"}]},{"group":"Rerank","expanded":false,"pages":[{"title":"Rerank documents","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/rerank","href":"/api-reference/rerank/rerank-documents"}]},{"group":"Decisions","expanded":false,"pages":[{"title":"Evaluate a decision","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/decisions","href":"/api-reference/decisions/evaluate-a-decision"}]},{"group":"Embeddings","expanded":false,"pages":[{"title":"Create embeddings","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/embeddings","href":"/api-reference/embeddings/create-embeddings"}]},{"group":"Audio","expanded":false,"pages":[{"title":"Create speech","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/audio/speech","href":"/api-reference/audio/create-speech"},{"title":"Create transcription","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/audio/transcriptions","href":"/api-reference/audio/create-transcription"}]},{"group":"Images","expanded":false,"pages":[{"title":"Generate an image","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/images/generations","href":"/api-reference/images/generate-an-image"},{"title":"Edit an image","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/images/edits","href":"/api-reference/images/edit-an-image"},{"title":"Create Variation","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/images/variations","href":"/api-reference/images/create-variation"}]},{"group":"Videos","expanded":false,"pages":[{"title":"List video generation jobs","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/videos","href":"/api-reference/videos/list-video-generation-jobs"},{"title":"Generate a video","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/videos","href":"/api-reference/videos/generate-a-video"},{"title":"Retrieve a video generation job","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/videos/{video_id}","href":"/api-reference/videos/retrieve-a-video-generation-job"},{"title":"Delete a video generation job","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /v1/videos/{video_id}","href":"/api-reference/videos/delete-a-video-generation-job"},{"title":"Download video content","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/videos/{video_id}/content","href":"/api-reference/videos/download-video-content"},{"title":"Remix a video","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/videos/{video_id}/remix","href":"/api-reference/videos/remix-a-video"}]},{"group":"Count Tokens","expanded":false,"pages":[{"title":"Count tokens","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/responses/input_tokens","href":"/api-reference/count-tokens/count-tokens"}]},{"group":"Compaction","expanded":false,"pages":[{"title":"Compact context","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/responses/compact","href":"/api-reference/compaction/compact-context"}]},{"group":"Batch","expanded":false,"pages":[{"title":"List batch jobs","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/batches","href":"/api-reference/batch/list-batch-jobs"},{"title":"Create a batch job","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/batches","href":"/api-reference/batch/create-a-batch-job"},{"title":"Retrieve a batch job","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/batches/{batch_id}","href":"/api-reference/batch/retrieve-a-batch-job"},{"title":"Cancel a batch job","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/batches/{batch_id}/cancel","href":"/api-reference/batch/cancel-a-batch-job"},{"title":"Get batch results","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/batches/{batch_id}/results","href":"/api-reference/batch/get-batch-results"}]},{"group":"Files","expanded":false,"pages":[{"title":"List files","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/files","href":"/api-reference/files/list-files"},{"title":"Upload a file","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/files","href":"/api-reference/files/upload-a-file"},{"title":"Retrieve file metadata","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/files/{file_id}","href":"/api-reference/files/retrieve-file-metadata"},{"title":"Delete a file","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /v1/files/{file_id}","href":"/api-reference/files/delete-a-file"},{"title":"Download file content","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/files/{file_id}/content","href":"/api-reference/files/download-file-content"}]},{"group":"Containers","expanded":false,"pages":[{"title":"List containers","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/containers","href":"/api-reference/containers/list-containers"},{"title":"Create a container","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/containers","href":"/api-reference/containers/create-a-container"},{"title":"Retrieve a container","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/containers/{container_id}","href":"/api-reference/containers/retrieve-a-container"},{"title":"Delete a container","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /v1/containers/{container_id}","href":"/api-reference/containers/delete-a-container"},{"title":"List files in a container","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/containers/{container_id}/files","href":"/api-reference/containers/list-files-in-a-container"},{"title":"Create a file in a container","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/containers/{container_id}/files","href":"/api-reference/containers/create-a-file-in-a-container"},{"title":"Retrieve a file from a container","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/containers/{container_id}/files/{file_id}","href":"/api-reference/containers/retrieve-a-file-from-a-container"},{"title":"Delete a file from a container","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /v1/containers/{container_id}/files/{file_id}","href":"/api-reference/containers/delete-a-file-from-a-container"},{"title":"Download file content from a container","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/containers/{container_id}/files/{file_id}/content","href":"/api-reference/containers/download-file-content-from-a-container"}]},{"group":"Async Jobs","expanded":false,"pages":[{"title":"Create async chat completion","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/async/chat/completions","href":"/api-reference/async-jobs/create-async-chat-completion"},{"title":"Create async text completion","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/async/completions","href":"/api-reference/async-jobs/create-async-text-completion"},{"title":"Create async response","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/async/responses","href":"/api-reference/async-jobs/create-async-response"},{"title":"Create async embedding","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/async/embeddings","href":"/api-reference/async-jobs/create-async-embedding"},{"title":"Create async speech","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/async/audio/speech","href":"/api-reference/async-jobs/create-async-speech"},{"title":"Create async transcription","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/async/audio/transcriptions","href":"/api-reference/async-jobs/create-async-transcription"},{"title":"Create async image generation","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/async/images/generations","href":"/api-reference/async-jobs/create-async-image-generation"},{"title":"Create async image edit","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/async/images/edits","href":"/api-reference/async-jobs/create-async-image-edit"},{"title":"Create async image variation","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/async/images/variations","href":"/api-reference/async-jobs/create-async-image-variation"},{"title":"Get async chat completion job","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/async/chat/completions/{job_id}","href":"/api-reference/async-jobs/get-async-chat-completion-job"},{"title":"Get async text completion job","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/async/completions/{job_id}","href":"/api-reference/async-jobs/get-async-text-completion-job"},{"title":"Get async response job","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/async/responses/{job_id}","href":"/api-reference/async-jobs/get-async-response-job"},{"title":"Get async embedding job","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/async/embeddings/{job_id}","href":"/api-reference/async-jobs/get-async-embedding-job"},{"title":"Get async speech job","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/async/audio/speech/{job_id}","href":"/api-reference/async-jobs/get-async-speech-job"},{"title":"Get async transcription job","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/async/audio/transcriptions/{job_id}","href":"/api-reference/async-jobs/get-async-transcription-job"},{"title":"Get async image generation job","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/async/images/generations/{job_id}","href":"/api-reference/async-jobs/get-async-image-generation-job"},{"title":"Get async image edit job","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/async/images/edits/{job_id}","href":"/api-reference/async-jobs/get-async-image-edit-job"},{"title":"Get async image variation job","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/async/images/variations/{job_id}","href":"/api-reference/async-jobs/get-async-image-variation-job"},{"title":"Create async rerank","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/async/rerank","href":"/api-reference/async-jobs/create-async-rerank"},{"title":"Get async rerank job","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/async/rerank/{job_id}","href":"/api-reference/async-jobs/get-async-rerank-job"},{"title":"Create async OCR job","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/async/ocr","href":"/api-reference/async-jobs/create-async-ocr-job"},{"title":"Get async OCR job","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/async/ocr/{job_id}","href":"/api-reference/async-jobs/get-async-ocr-job"}]},{"group":"Realtime","expanded":false,"pages":[{"title":"Realtime API WebSocket","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/realtime","href":"/api-reference/realtime/realtime-api-websocket"},{"title":"Realtime WebRTC SDP exchange","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/realtime/calls","href":"/api-reference/realtime/realtime-webrtc-sdp-exchange"},{"title":"Mint a realtime ephemeral client secret","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/realtime/client_secrets","href":"/api-reference/realtime/mint-a-realtime-ephemeral-client-secret"},{"title":"Mint a realtime session (legacy alias)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/realtime/sessions","href":"/api-reference/realtime/mint-a-realtime-session-legacy-alias"}]}]},{"group":"Integrations","pages":[{"group":"OpenAI Integration","expanded":false,"pages":[{"title":"Create chat completion (OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /openai/v1/chat/completions","href":"/api-reference/openai-integration/create-chat-completion-openai-format"},{"title":"Create chat completion (Azure OpenAI)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /openai/openai/deployments/{deployment-id}/chat/completions","href":"/api-reference/openai-integration/create-chat-completion-azure-openai"},{"title":"Create text completion (OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /openai/v1/completions","href":"/api-reference/openai-integration/create-text-completion-openai-format"},{"title":"Create text completion (Azure OpenAI)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /openai/openai/deployments/{deployment-id}/completions","href":"/api-reference/openai-integration/create-text-completion-azure-openai"},{"title":"WebSocket Responses (OpenAI alias)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /openai/v1/responses","href":"/api-reference/openai-integration/websocket-responses-openai-alias"},{"title":"Create response (OpenAI Responses API)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /openai/v1/responses","href":"/api-reference/openai-integration/create-response-openai-responses-api"},{"title":"Create response (Azure OpenAI)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /openai/openai/deployments/{deployment-id}/responses","href":"/api-reference/openai-integration/create-response-azure-openai"},{"title":"Count input tokens","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /openai/v1/responses/input_tokens","href":"/api-reference/openai-integration/count-input-tokens"},{"title":"Retrieve a response (OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /openai/v1/responses/{response_id}","href":"/api-reference/openai-integration/retrieve-a-response-openai-format"},{"title":"Delete a response (OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /openai/v1/responses/{response_id}","href":"/api-reference/openai-integration/delete-a-response-openai-format"},{"title":"Cancel a response (OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /openai/v1/responses/{response_id}/cancel","href":"/api-reference/openai-integration/cancel-a-response-openai-format"},{"title":"List response input items (OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /openai/v1/responses/{response_id}/input_items","href":"/api-reference/openai-integration/list-response-input-items-openai-format"},{"title":"Compact context (OpenAI)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /openai/v1/responses/compact","href":"/api-reference/openai-integration/compact-context-openai"},{"title":"Create embeddings (OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /openai/v1/embeddings","href":"/api-reference/openai-integration/create-embeddings-openai-format"},{"title":"Create embeddings (Azure OpenAI)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /openai/openai/deployments/{deployment-id}/embeddings","href":"/api-reference/openai-integration/create-embeddings-azure-openai"},{"title":"Evaluate a decision (OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /openai/v1/decisions","href":"/api-reference/openai-integration/evaluate-a-decision-openai-format"},{"title":"Create speech (OpenAI TTS)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /openai/v1/audio/speech","href":"/api-reference/openai-integration/create-speech-openai-tts"},{"title":"Create speech (Azure OpenAI TTS)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /openai/openai/deployments/{deployment-id}/audio/speech","href":"/api-reference/openai-integration/create-speech-azure-openai-tts"},{"title":"Create transcription (OpenAI Whisper)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /openai/v1/audio/transcriptions","href":"/api-reference/openai-integration/create-transcription-openai-whisper"},{"title":"Create transcription (Azure OpenAI)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /openai/openai/deployments/{deployment-id}/audio/transcriptions","href":"/api-reference/openai-integration/create-transcription-azure-openai"},{"title":"List models (OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /openai/v1/models","href":"/api-reference/openai-integration/list-models-openai-format"},{"title":"List models (Azure OpenAI)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /openai/openai/deployments/{deployment-id}/models","href":"/api-reference/openai-integration/list-models-azure-openai"},{"title":"List batch jobs (OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /openai/v1/batches","href":"/api-reference/openai-integration/list-batch-jobs-openai-format"},{"title":"Create batch job (OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /openai/v1/batches","href":"/api-reference/openai-integration/create-batch-job-openai-format"},{"title":"Retrieve batch job (OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /openai/v1/batches/{batch_id}","href":"/api-reference/openai-integration/retrieve-batch-job-openai-format"},{"title":"Cancel batch job (OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /openai/v1/batches/{batch_id}/cancel","href":"/api-reference/openai-integration/cancel-batch-job-openai-format"},{"title":"Create image","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /openai/v1/images/generations","href":"/api-reference/openai-integration/create-image"},{"title":"Create image (Azure OpenAI)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /openai/openai/deployments/{deployment-id}/images/generations","href":"/api-reference/openai-integration/create-image-azure-openai"},{"title":"List files (OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /openai/v1/files","href":"/api-reference/openai-integration/list-files-openai-format"},{"title":"Upload file (OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /openai/v1/files","href":"/api-reference/openai-integration/upload-file-openai-format"},{"title":"Retrieve file metadata (OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /openai/v1/files/{file_id}","href":"/api-reference/openai-integration/retrieve-file-metadata-openai-format"},{"title":"Delete file (OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /openai/v1/files/{file_id}","href":"/api-reference/openai-integration/delete-file-openai-format"},{"title":"Get file content (OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /openai/v1/files/{file_id}/content","href":"/api-reference/openai-integration/get-file-content-openai-format"},{"title":"List containers (OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /openai/v1/containers","href":"/api-reference/openai-integration/list-containers-openai-format"},{"title":"Create container (OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /openai/v1/containers","href":"/api-reference/openai-integration/create-container-openai-format"},{"title":"Retrieve container (OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /openai/v1/containers/{container_id}","href":"/api-reference/openai-integration/retrieve-container-openai-format"},{"title":"Delete container (OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /openai/v1/containers/{container_id}","href":"/api-reference/openai-integration/delete-container-openai-format"},{"title":"List files in container (OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /openai/v1/containers/{container_id}/files","href":"/api-reference/openai-integration/list-files-in-container-openai-format"},{"title":"Create file in container (OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /openai/v1/containers/{container_id}/files","href":"/api-reference/openai-integration/create-file-in-container-openai-format"},{"title":"Retrieve file from container (OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /openai/v1/containers/{container_id}/files/{file_id}","href":"/api-reference/openai-integration/retrieve-file-from-container-openai-format"},{"title":"Delete file from container (OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /openai/v1/containers/{container_id}/files/{file_id}","href":"/api-reference/openai-integration/delete-file-from-container-openai-format"},{"title":"Get file content from container (OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /openai/v1/containers/{container_id}/files/{file_id}/content","href":"/api-reference/openai-integration/get-file-content-from-container-openai-format"},{"title":"List video generations","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /openai/v1/videos","href":"/api-reference/openai-integration/list-video-generations"},{"title":"Create a video generation","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /openai/v1/videos","href":"/api-reference/openai-integration/create-a-video-generation"},{"title":"Retrieve a video generation","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /openai/v1/videos/{video_id}","href":"/api-reference/openai-integration/retrieve-a-video-generation"},{"title":"Delete a video generation","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /openai/v1/videos/{video_id}","href":"/api-reference/openai-integration/delete-a-video-generation"},{"title":"Download generated video content","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /openai/v1/videos/{video_id}/content","href":"/api-reference/openai-integration/download-generated-video-content"},{"title":"Remix an existing video","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /openai/v1/videos/{video_id}/remix","href":"/api-reference/openai-integration/remix-an-existing-video"},{"title":"WebSocket Realtime (OpenAI alias)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /openai/v1/realtime","href":"/api-reference/openai-integration/websocket-realtime-openai-alias"},{"title":"WebRTC Realtime SDP exchange (OpenAI alias)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /openai/v1/realtime/calls","href":"/api-reference/openai-integration/webrtc-realtime-sdp-exchange-openai-alias"},{"title":"Create realtime client secret (OpenAI alias)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /openai/v1/realtime/client_secrets","href":"/api-reference/openai-integration/create-realtime-client-secret-openai-alias"},{"title":"Create realtime session (OpenAI alias)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /openai/v1/realtime/sessions","href":"/api-reference/openai-integration/create-realtime-session-openai-alias"}]},{"group":"Anthropic Integration","expanded":false,"pages":[{"title":"Create message (Anthropic format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /anthropic/v1/messages","href":"/api-reference/anthropic-integration/create-message-anthropic-format"},{"title":"Create message (Anthropic format) - wildcard","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /anthropic/v1/messages/{path}","href":"/api-reference/anthropic-integration/create-message-anthropic-format--wildcard"},{"title":"Create completion (Anthropic legacy format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /anthropic/v1/complete","href":"/api-reference/anthropic-integration/create-completion-anthropic-legacy-format"},{"title":"List models (Anthropic format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /anthropic/v1/models","href":"/api-reference/anthropic-integration/list-models-anthropic-format"},{"title":"Count tokens (Anthropic format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /anthropic/v1/messages/count_tokens","href":"/api-reference/anthropic-integration/count-tokens-anthropic-format"},{"title":"List batch jobs (Anthropic format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /anthropic/v1/messages/batches","href":"/api-reference/anthropic-integration/list-batch-jobs-anthropic-format"},{"title":"Create batch job (Anthropic format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /anthropic/v1/messages/batches","href":"/api-reference/anthropic-integration/create-batch-job-anthropic-format"},{"title":"Retrieve batch job (Anthropic format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /anthropic/v1/messages/batches/{batch_id}","href":"/api-reference/anthropic-integration/retrieve-batch-job-anthropic-format"},{"title":"Cancel batch job (Anthropic format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /anthropic/v1/messages/batches/{batch_id}/cancel","href":"/api-reference/anthropic-integration/cancel-batch-job-anthropic-format"},{"title":"Get batch results (Anthropic format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /anthropic/v1/messages/batches/{batch_id}/results","href":"/api-reference/anthropic-integration/get-batch-results-anthropic-format"},{"title":"List files (Anthropic format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /anthropic/v1/files","href":"/api-reference/anthropic-integration/list-files-anthropic-format"},{"title":"Upload file (Anthropic format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /anthropic/v1/files","href":"/api-reference/anthropic-integration/upload-file-anthropic-format"},{"title":"Get file content (Anthropic format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /anthropic/v1/files/{file_id}/content","href":"/api-reference/anthropic-integration/get-file-content-anthropic-format"},{"title":"Delete file (Anthropic format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /anthropic/v1/files/{file_id}","href":"/api-reference/anthropic-integration/delete-file-anthropic-format"}]},{"group":"GenAI Integration","expanded":false,"pages":[{"title":"Generate content (Gemini format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /genai/v1beta/models/{model}:generateContent","href":"/api-reference/genai-integration/generate-content-gemini-format"},{"title":"Stream generate content (Gemini format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /genai/v1beta/models/{model}:streamGenerateContent","href":"/api-reference/genai-integration/stream-generate-content-gemini-format"},{"title":"Embed content (Gemini format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /genai/v1beta/models/{model}:embedContent","href":"/api-reference/genai-integration/embed-content-gemini-format"},{"title":"Count tokens (Gemini format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /genai/v1beta/models/{model}:countTokens","href":"/api-reference/genai-integration/count-tokens-gemini-format"},{"title":"Generate image (Gemini format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /genai/v1beta/models/{model}:predict","href":"/api-reference/genai-integration/generate-image-gemini-format"},{"title":"List models (Gemini format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /genai/v1beta/models","href":"/api-reference/genai-integration/list-models-gemini-format"},{"title":"Upload file (Gemini format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /genai/upload/v1beta/files","href":"/api-reference/genai-integration/upload-file-gemini-format"},{"title":"List files (Gemini format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /genai/v1beta/files","href":"/api-reference/genai-integration/list-files-gemini-format"},{"title":"Retrieve file (Gemini format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /genai/v1beta/files/{file_id}","href":"/api-reference/genai-integration/retrieve-file-gemini-format"},{"title":"Delete file (Gemini format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /genai/v1beta/files/{file_id}","href":"/api-reference/genai-integration/delete-file-gemini-format"},{"title":"List batch jobs (Gemini format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /genai/v1beta/batches","href":"/api-reference/genai-integration/list-batch-jobs-gemini-format"},{"title":"Retrieve a batch job (Gemini format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /genai/v1beta/batches/{batch_id}","href":"/api-reference/genai-integration/retrieve-a-batch-job-gemini-format"},{"title":"Cancel a batch job (Gemini format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /genai/v1beta/batches/{batch_id}","href":"/api-reference/genai-integration/cancel-a-batch-job-gemini-format"},{"title":"Delete a batch job (Gemini format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /genai/v1beta/batches/{batch_id}","href":"/api-reference/genai-integration/delete-a-batch-job-gemini-format"},{"title":"List cached content entries (Gemini format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /genai/v1beta/cachedContents","href":"/api-reference/genai-integration/list-cached-content-entries-gemini-format"},{"title":"Create cached content (Gemini format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /genai/v1beta/cachedContents","href":"/api-reference/genai-integration/create-cached-content-gemini-format"},{"title":"Retrieve cached content (Gemini format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /genai/v1beta/cachedContents/{cached_id}","href":"/api-reference/genai-integration/retrieve-cached-content-gemini-format"},{"title":"Update cached content (Gemini format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json patch /genai/v1beta/cachedContents/{cached_id}","href":"/api-reference/genai-integration/update-cached-content-gemini-format"},{"title":"Delete cached content (Gemini format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /genai/v1beta/cachedContents/{cached_id}","href":"/api-reference/genai-integration/delete-cached-content-gemini-format"},{"title":"Rerank documents (Vertex Rank)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /genai/v1/rank","href":"/api-reference/genai-integration/rerank-documents-vertex-rank"},{"title":"Retrieve video generation operation (Gemini format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /genai/v1beta/models/{model}/operations/{operation_id}","href":"/api-reference/genai-integration/retrieve-video-generation-operation-gemini-format"}]},{"group":"Bedrock Integration","expanded":false,"pages":[{"title":"Converse with model (Bedrock format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /bedrock/model/{modelId}/converse","href":"/api-reference/bedrock-integration/converse-with-model-bedrock-format"},{"title":"Stream converse with model (Bedrock format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /bedrock/model/{modelId}/converse-stream","href":"/api-reference/bedrock-integration/stream-converse-with-model-bedrock-format"},{"title":"Invoke model (Bedrock format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /bedrock/model/{modelId}/invoke","href":"/api-reference/bedrock-integration/invoke-model-bedrock-format"},{"title":"Invoke model with streaming (Bedrock format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /bedrock/model/{modelId}/invoke-with-response-stream","href":"/api-reference/bedrock-integration/invoke-model-with-streaming-bedrock-format"},{"title":"Count tokens (Bedrock format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /bedrock/model/{modelId}/count-tokens","href":"/api-reference/bedrock-integration/count-tokens-bedrock-format"},{"title":"Create batch inference job (Bedrock format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /bedrock/model-invocation-job","href":"/api-reference/bedrock-integration/create-batch-inference-job-bedrock-format"},{"title":"List batch inference jobs (Bedrock format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /bedrock/model-invocation-jobs","href":"/api-reference/bedrock-integration/list-batch-inference-jobs-bedrock-format"},{"title":"Retrieve batch inference job (Bedrock format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /bedrock/model-invocation-job/{job_arn}","href":"/api-reference/bedrock-integration/retrieve-batch-inference-job-bedrock-format"},{"title":"Cancel batch inference job (Bedrock format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /bedrock/model-invocation-job/{job_arn}/stop","href":"/api-reference/bedrock-integration/cancel-batch-inference-job-bedrock-format"},{"title":"S3-compatible ListObjectsV2","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /bedrock/files/{bucket}","href":"/api-reference/bedrock-integration/s3-compatible-listobjectsv2"},{"title":"S3-compatible GetObject","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /bedrock/files/{bucket}/{key}","href":"/api-reference/bedrock-integration/s3-compatible-getobject"},{"title":"S3-compatible PutObject","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /bedrock/files/{bucket}/{key}","href":"/api-reference/bedrock-integration/s3-compatible-putobject"},{"title":"S3-compatible DeleteObject","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /bedrock/files/{bucket}/{key}","href":"/api-reference/bedrock-integration/s3-compatible-deleteobject"},{"title":"S3-compatible HeadObject","deprecated":null,"version":null,"openapi":"/openapi/openapi.json head /bedrock/files/{bucket}/{key}","href":"/api-reference/bedrock-integration/s3-compatible-headobject"}]},{"group":"Cohere Integration","expanded":false,"pages":[{"title":"Chat with model (Cohere v2 format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /cohere/v2/chat","href":"/api-reference/cohere-integration/chat-with-model-cohere-v2-format"},{"title":"Create embeddings (Cohere v2 format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /cohere/v2/embed","href":"/api-reference/cohere-integration/create-embeddings-cohere-v2-format"},{"title":"Rerank documents (Cohere format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /cohere/v2/rerank","href":"/api-reference/cohere-integration/rerank-documents-cohere-format"},{"title":"Tokenize text (Cohere format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /cohere/v1/tokenize","href":"/api-reference/cohere-integration/tokenize-text-cohere-format"}]},{"group":"Typesafe Integration","expanded":false,"pages":[{"title":"Evaluate state (Typesafe format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /typesafe/v1/systemone","href":"/api-reference/typesafe-integration/evaluate-state-typesafe-format"},{"title":"List models (Typesafe format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /typesafe/v1/models","href":"/api-reference/typesafe-integration/list-models-typesafe-format"}]},{"group":"Cursor Integration","expanded":false,"pages":[{"title":"Cursor hybrid chat completions","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /cursor/v1/chat/completions","href":"/api-reference/cursor-integration/cursor-hybrid-chat-completions"},{"title":"List models (Cursor)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /cursor/v1/models","href":"/api-reference/cursor-integration/list-models-cursor"},{"title":"Anthropic complete (Cursor mount)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /cursor/v1/complete","href":"/api-reference/cursor-integration/anthropic-complete-cursor-mount"},{"title":"Anthropic messages (Cursor mount)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /cursor/v1/messages","href":"/api-reference/cursor-integration/anthropic-messages-cursor-mount"},{"title":"Anthropic messages — wildcard (Cursor mount)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /cursor/v1/messages/{path}","href":"/api-reference/cursor-integration/anthropic-messages-—-wildcard-cursor-mount"},{"title":"Anthropic count tokens (Cursor mount)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /cursor/v1/messages/count_tokens","href":"/api-reference/cursor-integration/anthropic-count-tokens-cursor-mount"},{"title":"Gemini list models (Cursor mount)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /cursor/v1beta/models","href":"/api-reference/cursor-integration/gemini-list-models-cursor-mount"},{"title":"Gemini model action (Cursor mount)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /cursor/v1beta/models/{model}","href":"/api-reference/cursor-integration/gemini-model-action-cursor-mount"},{"title":"Gemini video operation polling (Cursor mount)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /cursor/v1beta/models/{model}/operations/{operation_id}","href":"/api-reference/cursor-integration/gemini-video-operation-polling-cursor-mount"},{"title":"Vertex rank (Cursor mount)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /cursor/v1/rank","href":"/api-reference/cursor-integration/vertex-rank-cursor-mount"},{"title":"Bedrock converse (Cursor mount)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /cursor/model/{modelId}/converse","href":"/api-reference/cursor-integration/bedrock-converse-cursor-mount"},{"title":"Bedrock converse stream (Cursor mount)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /cursor/model/{modelId}/converse-stream","href":"/api-reference/cursor-integration/bedrock-converse-stream-cursor-mount"},{"title":"Bedrock invoke (Cursor mount)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /cursor/model/{modelId}/invoke","href":"/api-reference/cursor-integration/bedrock-invoke-cursor-mount"},{"title":"Bedrock invoke-with-response-stream (Cursor mount)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /cursor/model/{modelId}/invoke-with-response-stream","href":"/api-reference/cursor-integration/bedrock-invoke-with-response-stream-cursor-mount"},{"title":"Bedrock rerank (Cursor mount)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /cursor/rerank","href":"/api-reference/cursor-integration/bedrock-rerank-cursor-mount"},{"title":"Bedrock count tokens (Cursor mount)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /cursor/model/{modelId}/count-tokens","href":"/api-reference/cursor-integration/bedrock-count-tokens-cursor-mount"},{"title":"Cohere chat (Cursor mount)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /cursor/v2/chat","href":"/api-reference/cursor-integration/cohere-chat-cursor-mount"},{"title":"Cohere embed (Cursor mount)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /cursor/v2/embed","href":"/api-reference/cursor-integration/cohere-embed-cursor-mount"},{"title":"Cohere rerank (Cursor mount)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /cursor/v2/rerank","href":"/api-reference/cursor-integration/cohere-rerank-cursor-mount"},{"title":"Cohere tokenize (Cursor mount)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /cursor/v1/tokenize","href":"/api-reference/cursor-integration/cohere-tokenize-cursor-mount"}]},{"group":"LiteLLM Integration","expanded":false,"pages":[{"title":"Text completions (LiteLLM - OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /litellm/v1/completions","href":"/api-reference/litellm-integration/text-completions-litellm--openai-format"},{"title":"Chat completions (LiteLLM - OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /litellm/v1/chat/completions","href":"/api-reference/litellm-integration/chat-completions-litellm--openai-format"},{"title":"Create embeddings (LiteLLM - OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /litellm/v1/embeddings","href":"/api-reference/litellm-integration/create-embeddings-litellm--openai-format"},{"title":"List models (LiteLLM - OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /litellm/v1/models","href":"/api-reference/litellm-integration/list-models-litellm--openai-format"},{"title":"Create response (LiteLLM - OpenAI Responses API)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /litellm/v1/responses","href":"/api-reference/litellm-integration/create-response-litellm--openai-responses-api"},{"title":"Count input tokens (LiteLLM - OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /litellm/v1/responses/input_tokens","href":"/api-reference/litellm-integration/count-input-tokens-litellm--openai-format"},{"title":"Create speech (LiteLLM - OpenAI TTS)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /litellm/v1/audio/speech","href":"/api-reference/litellm-integration/create-speech-litellm--openai-tts"},{"title":"Create transcription (LiteLLM - OpenAI Whisper)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /litellm/v1/audio/transcriptions","href":"/api-reference/litellm-integration/create-transcription-litellm--openai-whisper"},{"title":"Create message (LiteLLM - Anthropic format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /litellm/anthropic/v1/messages","href":"/api-reference/litellm-integration/create-message-litellm--anthropic-format"},{"title":"List models (LiteLLM - Gemini format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /litellm/genai/v1beta/models","href":"/api-reference/litellm-integration/list-models-litellm--gemini-format"},{"title":"Generate content (LiteLLM - Gemini format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /litellm/genai/v1beta/models/{model}:generateContent","href":"/api-reference/litellm-integration/generate-content-litellm--gemini-format"},{"title":"Stream generate content (LiteLLM - Gemini format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /litellm/genai/v1beta/models/{model}:streamGenerateContent","href":"/api-reference/litellm-integration/stream-generate-content-litellm--gemini-format"},{"title":"Converse with model (LiteLLM - Bedrock format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /litellm/bedrock/model/{modelId}/converse","href":"/api-reference/litellm-integration/converse-with-model-litellm--bedrock-format"},{"title":"Stream converse with model (LiteLLM - Bedrock format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /litellm/bedrock/model/{modelId}/converse-stream","href":"/api-reference/litellm-integration/stream-converse-with-model-litellm--bedrock-format"},{"title":"Chat with model (LiteLLM - Cohere format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /litellm/cohere/v2/chat","href":"/api-reference/litellm-integration/chat-with-model-litellm--cohere-format"},{"title":"Create embeddings (LiteLLM - Cohere format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /litellm/cohere/v2/embed","href":"/api-reference/litellm-integration/create-embeddings-litellm--cohere-format"},{"title":"Tokenize text (LiteLLM - Cohere format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /litellm/cohere/v1/tokenize","href":"/api-reference/litellm-integration/tokenize-text-litellm--cohere-format"}]},{"group":"LangChain Integration","expanded":false,"pages":[{"title":"Text completions (LangChain - OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /langchain/v1/completions","href":"/api-reference/langchain-integration/text-completions-langchain--openai-format"},{"title":"Chat completions (LangChain - OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /langchain/v1/chat/completions","href":"/api-reference/langchain-integration/chat-completions-langchain--openai-format"},{"title":"Create embeddings (LangChain - OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /langchain/v1/embeddings","href":"/api-reference/langchain-integration/create-embeddings-langchain--openai-format"},{"title":"List models (LangChain - OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /langchain/v1/models","href":"/api-reference/langchain-integration/list-models-langchain--openai-format"},{"title":"Create response (LangChain - OpenAI Responses API)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /langchain/v1/responses","href":"/api-reference/langchain-integration/create-response-langchain--openai-responses-api"},{"title":"Count input tokens (LangChain - OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /langchain/v1/responses/input_tokens","href":"/api-reference/langchain-integration/count-input-tokens-langchain--openai-format"},{"title":"Create speech (LangChain - OpenAI TTS)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /langchain/v1/audio/speech","href":"/api-reference/langchain-integration/create-speech-langchain--openai-tts"},{"title":"Create transcription (LangChain - OpenAI Whisper)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /langchain/v1/audio/transcriptions","href":"/api-reference/langchain-integration/create-transcription-langchain--openai-whisper"},{"title":"Create message (LangChain - Anthropic format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /langchain/anthropic/v1/messages","href":"/api-reference/langchain-integration/create-message-langchain--anthropic-format"},{"title":"Count tokens (LangChain - Anthropic format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /langchain/anthropic/v1/messages/count_tokens","href":"/api-reference/langchain-integration/count-tokens-langchain--anthropic-format"},{"title":"List models (LangChain - Gemini format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /langchain/genai/v1beta/models","href":"/api-reference/langchain-integration/list-models-langchain--gemini-format"},{"title":"Generate content (LangChain - Gemini format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /langchain/genai/v1beta/models/{model}:generateContent","href":"/api-reference/langchain-integration/generate-content-langchain--gemini-format"},{"title":"Stream generate content (LangChain - Gemini format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /langchain/genai/v1beta/models/{model}:streamGenerateContent","href":"/api-reference/langchain-integration/stream-generate-content-langchain--gemini-format"},{"title":"Converse with model (LangChain - Bedrock format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /langchain/bedrock/model/{modelId}/converse","href":"/api-reference/langchain-integration/converse-with-model-langchain--bedrock-format"},{"title":"Stream converse with model (LangChain - Bedrock format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /langchain/bedrock/model/{modelId}/converse-stream","href":"/api-reference/langchain-integration/stream-converse-with-model-langchain--bedrock-format"},{"title":"Chat with model (LangChain - Cohere format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /langchain/cohere/v2/chat","href":"/api-reference/langchain-integration/chat-with-model-langchain--cohere-format"},{"title":"Create embeddings (LangChain - Cohere format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /langchain/cohere/v2/embed","href":"/api-reference/langchain-integration/create-embeddings-langchain--cohere-format"},{"title":"Tokenize text (LangChain - Cohere format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /langchain/cohere/v1/tokenize","href":"/api-reference/langchain-integration/tokenize-text-langchain--cohere-format"}]},{"group":"PydanticAI Integration","expanded":false,"pages":[{"title":"Text completions (PydanticAI - OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /pydanticai/v1/completions","href":"/api-reference/pydanticai-integration/text-completions-pydanticai--openai-format"},{"title":"Chat completions (PydanticAI - OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /pydanticai/v1/chat/completions","href":"/api-reference/pydanticai-integration/chat-completions-pydanticai--openai-format"},{"title":"Create embeddings (PydanticAI - OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /pydanticai/v1/embeddings","href":"/api-reference/pydanticai-integration/create-embeddings-pydanticai--openai-format"},{"title":"List models (PydanticAI - OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /pydanticai/v1/models","href":"/api-reference/pydanticai-integration/list-models-pydanticai--openai-format"},{"title":"Create response (PydanticAI - OpenAI Responses API)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /pydanticai/v1/responses","href":"/api-reference/pydanticai-integration/create-response-pydanticai--openai-responses-api"},{"title":"Count input tokens (PydanticAI - OpenAI format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /pydanticai/v1/responses/input_tokens","href":"/api-reference/pydanticai-integration/count-input-tokens-pydanticai--openai-format"},{"title":"Create speech (PydanticAI - OpenAI TTS)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /pydanticai/v1/audio/speech","href":"/api-reference/pydanticai-integration/create-speech-pydanticai--openai-tts"},{"title":"Create transcription (PydanticAI - OpenAI Whisper)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /pydanticai/v1/audio/transcriptions","href":"/api-reference/pydanticai-integration/create-transcription-pydanticai--openai-whisper"},{"title":"Create message (PydanticAI - Anthropic format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /pydanticai/anthropic/v1/messages","href":"/api-reference/pydanticai-integration/create-message-pydanticai--anthropic-format"},{"title":"List models (PydanticAI - Gemini format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /pydanticai/genai/v1beta/models","href":"/api-reference/pydanticai-integration/list-models-pydanticai--gemini-format"},{"title":"Generate content (PydanticAI - Gemini format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /pydanticai/genai/v1beta/models/{model}:generateContent","href":"/api-reference/pydanticai-integration/generate-content-pydanticai--gemini-format"},{"title":"Stream generate content (PydanticAI - Gemini format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /pydanticai/genai/v1beta/models/{model}:streamGenerateContent","href":"/api-reference/pydanticai-integration/stream-generate-content-pydanticai--gemini-format"},{"title":"Converse with model (PydanticAI - Bedrock format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /pydanticai/bedrock/model/{modelId}/converse","href":"/api-reference/pydanticai-integration/converse-with-model-pydanticai--bedrock-format"},{"title":"Stream converse with model (PydanticAI - Bedrock format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /pydanticai/bedrock/model/{modelId}/converse-stream","href":"/api-reference/pydanticai-integration/stream-converse-with-model-pydanticai--bedrock-format"},{"title":"Chat with model (PydanticAI - Cohere format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /pydanticai/cohere/v2/chat","href":"/api-reference/pydanticai-integration/chat-with-model-pydanticai--cohere-format"},{"title":"Create embeddings (PydanticAI - Cohere format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /pydanticai/cohere/v2/embed","href":"/api-reference/pydanticai-integration/create-embeddings-pydanticai--cohere-format"},{"title":"Tokenize text (PydanticAI - Cohere format)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /pydanticai/cohere/v1/tokenize","href":"/api-reference/pydanticai-integration/tokenize-text-pydanticai--cohere-format"}]}]},{"group":"Platform","pages":[{"group":"Health","expanded":false,"pages":[{"title":"Health check","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /health","href":"/api-reference/health/health-check"}]},{"group":"Configuration","expanded":false,"pages":[{"title":"Get configuration","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/config","href":"/api-reference/configuration/get-configuration"},{"title":"Update configuration","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/config","href":"/api-reference/configuration/update-configuration"},{"title":"Get version","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/version","href":"/api-reference/configuration/get-version"},{"title":"Get proxy configuration","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/proxy-config","href":"/api-reference/configuration/get-proxy-configuration"},{"title":"Update proxy configuration","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/proxy-config","href":"/api-reference/configuration/update-proxy-configuration"},{"title":"Force pricing sync","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/pricing/force-sync","href":"/api-reference/configuration/force-pricing-sync"}]},{"group":"Session","expanded":false,"pages":[{"title":"Login","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/session/login","href":"/api-reference/session/login"},{"title":"Logout","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/session/logout","href":"/api-reference/session/logout"},{"title":"Check if authentication is enabled","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/session/is-auth-enabled","href":"/api-reference/session/check-if-authentication-is-enabled"},{"title":"Issue WebSocket ticket","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/session/ws-ticket","href":"/api-reference/session/issue-websocket-ticket"}]},{"group":"Providers","expanded":false,"pages":[{"title":"List all providers","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/providers","href":"/api-reference/providers/list-all-providers"},{"title":"Add a new provider","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/providers","href":"/api-reference/providers/add-a-new-provider"},{"title":"Get a specific provider","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/providers/{provider}","href":"/api-reference/providers/get-a-specific-provider"},{"title":"Update a provider","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/providers/{provider}","href":"/api-reference/providers/update-a-provider"},{"title":"Delete a provider","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/providers/{provider}","href":"/api-reference/providers/delete-a-provider"},{"title":"List keys for a provider","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/providers/{provider}/keys","href":"/api-reference/providers/list-keys-for-a-provider"},{"title":"Create a key for a provider","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/providers/{provider}/keys","href":"/api-reference/providers/create-a-key-for-a-provider"},{"title":"Get a specific key for a provider","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/providers/{provider}/keys/{key_id}","href":"/api-reference/providers/get-a-specific-key-for-a-provider"},{"title":"Update a key for a provider","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/providers/{provider}/keys/{key_id}","href":"/api-reference/providers/update-a-key-for-a-provider"},{"title":"Delete a key from a provider","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/providers/{provider}/keys/{key_id}","href":"/api-reference/providers/delete-a-key-from-a-provider"},{"title":"List all keys","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/keys","href":"/api-reference/providers/list-all-keys"},{"title":"List models","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/models","href":"/api-reference/providers/list-models"},{"title":"List model details","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/models/details","href":"/api-reference/providers/list-model-details"},{"title":"Get model parameters","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/models/parameters","href":"/api-reference/providers/get-model-parameters"},{"title":"List base models","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/models/base","href":"/api-reference/providers/list-base-models"},{"title":"List newest models per provider","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/models/newest","href":"/api-reference/providers/list-newest-models-per-provider"},{"title":"List datasheet entries","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/models/datasheet","href":"/api-reference/providers/list-datasheet-entries"},{"title":"Get a datasheet entry","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/models/datasheet/entry","href":"/api-reference/providers/get-a-datasheet-entry"},{"title":"Save a datasheet override","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/models/datasheet/overrides","href":"/api-reference/providers/save-a-datasheet-override"},{"title":"Delete a datasheet override","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/models/datasheet/overrides/{id}","href":"/api-reference/providers/delete-a-datasheet-override"}]},{"group":"Plugins","expanded":false,"pages":[{"title":"List all plugins","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/plugins","href":"/api-reference/plugins/list-all-plugins"},{"title":"Create a new plugin","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/plugins","href":"/api-reference/plugins/create-a-new-plugin"},{"title":"List built-in plugin names","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/plugins/builtins","href":"/api-reference/plugins/list-built-in-plugin-names"},{"title":"Get a specific plugin","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/plugins/{name}","href":"/api-reference/plugins/get-a-specific-plugin"},{"title":"Update a plugin","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/plugins/{name}","href":"/api-reference/plugins/update-a-plugin"},{"title":"Delete a plugin","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/plugins/{name}","href":"/api-reference/plugins/delete-a-plugin"}]},{"group":"MCP","expanded":false,"pages":[{"title":"Execute MCP tool","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/mcp/tool/execute","href":"/api-reference/mcp/execute-mcp-tool"},{"title":"List MCP clients","description":"Returns a paginated list of configured MCP clients with their tools and connection state.\nSupports case-insensitive name search and exact-match filtering by connection type, auth type,\ncode-mode, and enabled/disabled status. Multi-value filters accept a comma-separated list and\nuse OR semantics within a field.\n","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/mcp/clients","href":"/api-reference/mcp/list-mcp-clients"},{"title":"Add MCP client","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/mcp/client","href":"/api-reference/mcp/add-mcp-client"},{"title":"Edit MCP client","description":"Updates an existing MCP client's configuration. All fields are optional\n(PATCH semantics); connection_type, auth_type, connection_string,\nstdio_config, and oauth_config_id are immutable after creation.\nUnlike client creation, tool_pricing can be included to set per-tool execution costs since tools are already fetched.\nFor OAuth-based clients, providing oauth_config rotates the stored OAuth\nconfiguration in place and flips every bound token to needs_reauth when\na field actually changes (see MCPClientUpdateRequest.oauth_config).\nOptionally provide vk_configs to manage which virtual keys have access to this MCP server and with which tools. When provided, this fully replaces all existing VK assignments in a single atomic transaction.\nSet disabled: true to shut down the client's connection and workers without removing it. Set disabled: false to reconnect a previously disabled client.\n","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/mcp/client/{id}","href":"/api-reference/mcp/edit-mcp-client"},{"title":"Remove MCP client","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/mcp/client/{id}","href":"/api-reference/mcp/remove-mcp-client"},{"title":"Reconnect MCP client","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/mcp/client/{id}/reconnect","href":"/api-reference/mcp/reconnect-mcp-client"},{"title":"Refresh MCP client tools","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/mcp/client/{id}/refresh-tools","href":"/api-reference/mcp/refresh-mcp-client-tools"},{"title":"Complete MCP client OAuth flow","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/mcp/client/{id}/complete-oauth","href":"/api-reference/mcp/complete-mcp-client-oauth-flow"},{"title":"Initiate verification for a pending MCP client","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/mcp/client/{id}/initiate-verification","href":"/api-reference/mcp/initiate-verification-for-a-pending-mcp-client"},{"title":"Reauthorize an MCP client","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/mcp/client/{id}/reauthorize","href":"/api-reference/mcp/reauthorize-an-mcp-client"},{"title":"Reauthorize an MCP client against a newly registered OAuth client","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/mcp/client/{id}/reregister","href":"/api-reference/mcp/reauthorize-an-mcp-client-against-a-newly-registered-oauth-client"},{"title":"Verify a pending per-user-headers MCP client","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/mcp/client/{id}/verify-headers","href":"/api-reference/mcp/verify-a-pending-per-user-headers-mcp-client"},{"title":"Verify a pending or repair a needs_reauth token_exchange MCP client","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/mcp/client/{id}/verify-exchange","href":"/api-reference/mcp/verify-a-pending-or-repair-a-needs_reauth-token_exchange-mcp-client"},{"title":"List MCP sessions","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/mcp/sessions","href":"/api-reference/mcp/list-mcp-sessions"},{"title":"Revoke an MCP session","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/mcp/sessions/{id}","href":"/api-reference/mcp/revoke-an-mcp-session"},{"title":"Re-authenticate or edit an MCP session","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/mcp/sessions/{id}/reauth","href":"/api-reference/mcp/re-authenticate-or-edit-an-mcp-session"},{"title":"Get per-user-headers submission flow","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/mcp/per-user-headers/flows/{id}","href":"/api-reference/mcp/get-per-user-headers-submission-flow"},{"title":"Submit per-user-headers values","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/mcp/per-user-headers/flows/{id}","href":"/api-reference/mcp/submit-per-user-headers-values"},{"title":"Revoke a per-user-headers credential","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/mcp/per-user-headers/credential/{id}","href":"/api-reference/mcp/revoke-a-per-user-headers-credential"}]},{"group":"Virtual MCPs","expanded":false,"pages":[{"title":"List Virtual MCPs","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/mcp/virtual-mcps","href":"/api-reference/mcp/list-virtual-mcps"},{"title":"Create Virtual MCP","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/mcp/virtual-mcps","href":"/api-reference/mcp/create-virtual-mcp"},{"title":"Get Virtual MCP by ID","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/mcp/virtual-mcps/{id}","href":"/api-reference/mcp/get-virtual-mcp-by-id"},{"title":"Update Virtual MCP","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/mcp/virtual-mcps/{id}","href":"/api-reference/mcp/update-virtual-mcp"},{"title":"Delete Virtual MCP","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/mcp/virtual-mcps/{id}","href":"/api-reference/mcp/delete-virtual-mcp"},{"title":"Assign Virtual MCP to a virtual key","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/mcp/virtual-mcps/{id}/virtual-keys/{vkId}","href":"/api-reference/mcp/assign-virtual-mcp-to-a-virtual-key"},{"title":"Unassign Virtual MCP from a virtual key","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/mcp/virtual-mcps/{id}/virtual-keys/{vkId}","href":"/api-reference/mcp/unassign-virtual-mcp-from-a-virtual-key"}]},{"group":"MCP Tool Groups (deprecated)","expanded":false,"pages":[{"title":"List MCP Tool Groups","deprecated":true,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/mcp/tool-groups","href":"/api-reference/mcp-tool-groups/list-mcp-tool-groups"},{"title":"Create MCP Tool Group","deprecated":true,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json post /api/mcp/tool-groups","href":"/api-reference/mcp-tool-groups/create-mcp-tool-group"},{"title":"Get MCP Tool Group by ID","deprecated":true,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/mcp/tool-groups/{id}","href":"/api-reference/mcp-tool-groups/get-mcp-tool-group-by-id"},{"title":"Update MCP Tool Group","deprecated":true,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json put /api/mcp/tool-groups/{id}","href":"/api-reference/mcp-tool-groups/update-mcp-tool-group"},{"title":"Delete MCP Tool Group","deprecated":true,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json delete /api/mcp/tool-groups/{id}","href":"/api-reference/mcp-tool-groups/delete-mcp-tool-group"}]},{"group":"Agent Gateway","expanded":false,"pages":[{"title":"Register agent","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/agents","href":"/api-reference/agent-gateway/register-agent"},{"title":"List agents","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/agents","href":"/api-reference/agent-gateway/list-agents"},{"title":"Get agent","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/agents/{name}","href":"/api-reference/agent-gateway/get-agent"},{"title":"Replace agent","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/agents/{name}","href":"/api-reference/agent-gateway/replace-agent"},{"title":"Delete agent","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/agents/{name}","href":"/api-reference/agent-gateway/delete-agent"},{"title":"Inspect agent card","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/agents/inspect","href":"/api-reference/agent-gateway/inspect-agent-card"},{"title":"List stored push configurations","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/agents/push-configs","href":"/api-reference/agent-gateway/list-stored-push-configurations"},{"title":"Delete stored push configuration","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/agents/push-configs/{agent}/{task}/{config}","href":"/api-reference/agent-gateway/delete-stored-push-configuration"},{"title":"List agent history","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/agents/history","href":"/api-reference/agent-gateway/list-agent-history"},{"title":"Delete agent history","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/agents/history","href":"/api-reference/agent-gateway/delete-agent-history"},{"title":"Get agent history statistics","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/agents/history/stats","href":"/api-reference/agent-gateway/get-agent-history-statistics"},{"title":"Get agent history histogram","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/agents/history/histogram","href":"/api-reference/agent-gateway/get-agent-history-histogram"},{"title":"Get top agents","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/agents/history/top-agents","href":"/api-reference/agent-gateway/get-top-agents"},{"title":"Get agent history filter values","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/agents/history/filterdata","href":"/api-reference/agent-gateway/get-agent-history-filter-values"},{"title":"Get agent history entry","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/agents/history/{id}","href":"/api-reference/agent-gateway/get-agent-history-entry"},{"title":"Get gateway agent card","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /agents/a2a/{name}/.well-known/agent-card.json","href":"/api-reference/agent-gateway/get-gateway-agent-card"},{"title":"Call agent over JSON-RPC","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /agents/a2a/{name}/json-rpc","href":"/api-reference/agent-gateway/call-agent-over-json-rpc"},{"title":"Send message","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /agents/a2a/{name}/rest/message:send","href":"/api-reference/agent-gateway/send-message"},{"title":"Send streaming message","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /agents/a2a/{name}/rest/message:stream","href":"/api-reference/agent-gateway/send-streaming-message"},{"title":"List tasks","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /agents/a2a/{name}/rest/tasks","href":"/api-reference/agent-gateway/list-tasks"},{"title":"Get task","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /agents/a2a/{name}/rest/tasks/{taskId}","href":"/api-reference/agent-gateway/get-task"},{"title":"Cancel task","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /agents/a2a/{name}/rest/tasks/{taskId}:cancel","href":"/api-reference/agent-gateway/cancel-task"},{"title":"Subscribe to task","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /agents/a2a/{name}/rest/tasks/{taskId}:subscribe","href":"/api-reference/agent-gateway/subscribe-to-task"},{"title":"Create task push configuration","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /agents/a2a/{name}/rest/tasks/{taskId}/pushNotificationConfigs","href":"/api-reference/agent-gateway/create-task-push-configuration"},{"title":"List task push configurations","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /agents/a2a/{name}/rest/tasks/{taskId}/pushNotificationConfigs","href":"/api-reference/agent-gateway/list-task-push-configurations"},{"title":"Get task push configuration","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /agents/a2a/{name}/rest/tasks/{taskId}/pushNotificationConfigs/{configId}","href":"/api-reference/agent-gateway/get-task-push-configuration"},{"title":"Delete task push configuration","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /agents/a2a/{name}/rest/tasks/{taskId}/pushNotificationConfigs/{configId}","href":"/api-reference/agent-gateway/delete-task-push-configuration"},{"title":"Get extended agent card","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /agents/a2a/{name}/rest/extendedAgentCard","href":"/api-reference/agent-gateway/get-extended-agent-card"},{"title":"Receive upstream push notification","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /agents/a2a/{name}/push/callback","href":"/api-reference/agent-gateway/receive-upstream-push-notification"}]},{"group":"Relays","expanded":false,"pages":[{"title":"List relays","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/relays","href":"/api-reference/relays/list-relays"},{"title":"Create relay","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/relays","href":"/api-reference/relays/create-relay"},{"title":"Get relay","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/relays/{name}","href":"/api-reference/relays/get-relay"},{"title":"Update relay","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/relays/{name}","href":"/api-reference/relays/update-relay"},{"title":"Delete relay","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/relays/{name}","href":"/api-reference/relays/delete-relay"},{"title":"Preview relay usage","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/relays/usage-preview","href":"/api-reference/relays/preview-relay-usage"},{"title":"Fetch an OpenAPI document for route import","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/relays/openapi-spec","href":"/api-reference/relays/fetch-an-openapi-document-for-route-import"},{"title":"List access profiles granting a relay","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/relays/{name}/access-profiles","href":"/api-reference/relays/list-access-profiles-granting-a-relay"},{"title":"Get relay logs","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/relay-logs","href":"/api-reference/relays/get-relay-logs"},{"title":"Delete relay logs","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/relay-logs","href":"/api-reference/relays/delete-relay-logs"},{"title":"Get relay log by ID","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/relay-logs/{id}","href":"/api-reference/relays/get-relay-log-by-id"},{"title":"Get relay log statistics","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/relay-logs/stats","href":"/api-reference/relays/get-relay-log-statistics"},{"title":"Get relay log filter values","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/relay-logs/filterdata","href":"/api-reference/relays/get-relay-log-filter-values"},{"title":"Get relay log histogram","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/relay-logs/histogram","href":"/api-reference/relays/get-relay-log-histogram"},{"title":"Get top relays","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/relay-logs/top-endpoints","href":"/api-reference/relays/get-top-relays"},{"title":"Relay a GET request","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /relay/{endpoint}/{path}","href":"/api-reference/relays/relay-a-get-request"},{"title":"Relay a POST request","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /relay/{endpoint}/{path}","href":"/api-reference/relays/relay-a-post-request"},{"title":"Relay a PUT request","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /relay/{endpoint}/{path}","href":"/api-reference/relays/relay-a-put-request"},{"title":"Relay a PATCH request","deprecated":null,"version":null,"openapi":"/openapi/openapi.json patch /relay/{endpoint}/{path}","href":"/api-reference/relays/relay-a-patch-request"},{"title":"Relay a DELETE request","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /relay/{endpoint}/{path}","href":"/api-reference/relays/relay-a-delete-request"},{"title":"Relay a HEAD request","deprecated":null,"version":null,"openapi":"/openapi/openapi.json head /relay/{endpoint}/{path}","href":"/api-reference/relays/relay-a-head-request"}]},{"group":"OAuth","expanded":false,"pages":[{"title":"Get per-user OAuth flow detail","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/oauth/per-user/flows/{id}","href":"/api-reference/oauth/get-per-user-oauth-flow-detail"},{"title":"Start the upstream OAuth authorization for a pending flow","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/oauth/per-user/flows/{id}/start","href":"/api-reference/oauth/start-the-upstream-oauth-authorization-for-a-pending-flow"},{"title":"OAuth callback endpoint","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/oauth/callback","href":"/api-reference/oauth/oauth-callback-endpoint"},{"title":"Get OAuth config status","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/oauth/config/{id}/status","href":"/api-reference/oauth/get-oauth-config-status"},{"title":"Revoke OAuth config","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/oauth/config/{id}","href":"/api-reference/oauth/revoke-oauth-config"}]},{"group":"Logging","expanded":false,"pages":[{"title":"Get logs","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/logs","href":"/api-reference/logging/get-logs"},{"title":"Delete logs","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/logs","href":"/api-reference/logging/delete-logs"},{"title":"Search logged conversations by meaning","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/logs/search","href":"/api-reference/logging/search-logged-conversations-by-meaning"},{"title":"Get a single log entry","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/logs/{id}","href":"/api-reference/logging/get-a-single-log-entry"},{"title":"Get the causal trace of a request","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/logs/{id}/trace","href":"/api-reference/logging/get-the-causal-trace-of-a-request"},{"title":"Get logs for a session","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/logs/sessions/{session_id}","href":"/api-reference/logging/get-logs-for-a-session"},{"title":"Get aggregate totals for a session","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/logs/sessions/{session_id}/summary","href":"/api-reference/logging/get-aggregate-totals-for-a-session"},{"title":"Get log statistics","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/logs/stats","href":"/api-reference/logging/get-log-statistics"},{"title":"Get request count histogram","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/logs/histogram","href":"/api-reference/logging/get-request-count-histogram"},{"title":"Get token usage histogram","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/logs/histogram/tokens","href":"/api-reference/logging/get-token-usage-histogram"},{"title":"Get cost histogram","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/logs/histogram/cost","href":"/api-reference/logging/get-cost-histogram"},{"title":"Get model usage histogram","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/logs/histogram/models","href":"/api-reference/logging/get-model-usage-histogram"},{"title":"Get latency histogram","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/logs/histogram/latency","href":"/api-reference/logging/get-latency-histogram"},{"title":"Get cost histogram by provider","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/logs/histogram/cost/by-provider","href":"/api-reference/logging/get-cost-histogram-by-provider"},{"title":"Get token histogram by provider","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/logs/histogram/tokens/by-provider","href":"/api-reference/logging/get-token-histogram-by-provider"},{"title":"Get latency histogram by provider","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/logs/histogram/latency/by-provider","href":"/api-reference/logging/get-latency-histogram-by-provider"},{"title":"Get throughput histogram","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/logs/histogram/throughput","href":"/api-reference/logging/get-throughput-histogram"},{"title":"Get throughput histogram by provider","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/logs/histogram/throughput/by-provider","href":"/api-reference/logging/get-throughput-histogram-by-provider"},{"title":"Get cost histogram by dimension","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/logs/histogram/cost/by-dimension","href":"/api-reference/logging/get-cost-histogram-by-dimension"},{"title":"Get token histogram by dimension","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/logs/histogram/tokens/by-dimension","href":"/api-reference/logging/get-token-histogram-by-dimension"},{"title":"Get latency histogram by dimension","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/logs/histogram/latency/by-dimension","href":"/api-reference/logging/get-latency-histogram-by-dimension"},{"title":"Get dropped requests count","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/logs/dropped","href":"/api-reference/logging/get-dropped-requests-count"},{"title":"Get available filter data","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/logs/filterdata","href":"/api-reference/logging/get-available-filter-data"},{"title":"Get model usage rankings","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/logs/rankings","href":"/api-reference/logging/get-model-usage-rankings"},{"title":"Get rankings by governance dimension","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/logs/rankings/by-dimension","href":"/api-reference/logging/get-rankings-by-governance-dimension"},{"title":"Get user usage rankings","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/logs/rankings/users","href":"/api-reference/logging/get-user-usage-rankings"},{"title":"Get consolidated dashboard data","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/logs/dashboard","href":"/api-reference/logging/get-consolidated-dashboard-data"},{"title":"Recalculate log costs","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/logs/recalculate-cost","href":"/api-reference/logging/recalculate-log-costs"},{"title":"Get log cost recalculation status","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/logs/recalculate-cost/status","href":"/api-reference/logging/get-log-cost-recalculation-status"},{"title":"Cancel log cost recalculation","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/logs/recalculate-cost/cancel","href":"/api-reference/logging/cancel-log-cost-recalculation"},{"title":"Get MCP tool logs","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/mcp-logs","href":"/api-reference/logging/get-mcp-tool-logs"},{"title":"Delete MCP tool logs","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/mcp-logs","href":"/api-reference/logging/delete-mcp-tool-logs"},{"title":"Get MCP tool log by ID","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/mcp-logs/{id}","href":"/api-reference/logging/get-mcp-tool-log-by-id"},{"title":"Get MCP tool log statistics","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/mcp-logs/stats","href":"/api-reference/logging/get-mcp-tool-log-statistics"},{"title":"Get available MCP log filter data","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/mcp-logs/filterdata","href":"/api-reference/logging/get-available-mcp-log-filter-data"},{"title":"Get MCP tool call volume histogram","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/mcp-logs/histogram","href":"/api-reference/logging/get-mcp-tool-call-volume-histogram"},{"title":"Get MCP cost histogram","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/mcp-logs/histogram/cost","href":"/api-reference/logging/get-mcp-cost-histogram"},{"title":"Get MCP tool call latency histogram","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/mcp-logs/histogram/latency","href":"/api-reference/logging/get-mcp-tool-call-latency-histogram"},{"title":"Get top MCP tools by call count","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/mcp-logs/histogram/top-tools","href":"/api-reference/logging/get-top-mcp-tools-by-call-count"}]},{"group":"Prompt Repository","expanded":false,"pages":[{"title":"List folders","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/prompt-repo/folders","href":"/api-reference/prompt-repository/list-folders"},{"title":"Create folder","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/prompt-repo/folders","href":"/api-reference/prompt-repository/create-folder"},{"title":"Get folder","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/prompt-repo/folders/{id}","href":"/api-reference/prompt-repository/get-folder"},{"title":"Update folder","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/prompt-repo/folders/{id}","href":"/api-reference/prompt-repository/update-folder"},{"title":"Delete folder","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/prompt-repo/folders/{id}","href":"/api-reference/prompt-repository/delete-folder"},{"title":"List prompts","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/prompt-repo/prompts","href":"/api-reference/prompt-repository/list-prompts"},{"title":"Create prompt","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/prompt-repo/prompts","href":"/api-reference/prompt-repository/create-prompt"},{"title":"Get prompt","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/prompt-repo/prompts/{id}","href":"/api-reference/prompt-repository/get-prompt"},{"title":"Update prompt","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/prompt-repo/prompts/{id}","href":"/api-reference/prompt-repository/update-prompt"},{"title":"Delete prompt","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/prompt-repo/prompts/{id}","href":"/api-reference/prompt-repository/delete-prompt"},{"title":"List prompt versions","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/prompt-repo/prompts/{id}/versions","href":"/api-reference/prompt-repository/list-prompt-versions"},{"title":"Create prompt version","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/prompt-repo/prompts/{id}/versions","href":"/api-reference/prompt-repository/create-prompt-version"},{"title":"Get prompt version","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/prompt-repo/versions/{id}","href":"/api-reference/prompt-repository/get-prompt-version"},{"title":"Delete prompt version","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/prompt-repo/versions/{id}","href":"/api-reference/prompt-repository/delete-prompt-version"},{"title":"List prompt sessions","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/prompt-repo/prompts/{id}/sessions","href":"/api-reference/prompt-repository/list-prompt-sessions"},{"title":"Create prompt session","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/prompt-repo/prompts/{id}/sessions","href":"/api-reference/prompt-repository/create-prompt-session"},{"title":"Get prompt session","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/prompt-repo/sessions/{id}","href":"/api-reference/prompt-repository/get-prompt-session"},{"title":"Update prompt session","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/prompt-repo/sessions/{id}","href":"/api-reference/prompt-repository/update-prompt-session"},{"title":"Delete prompt session","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/prompt-repo/sessions/{id}","href":"/api-reference/prompt-repository/delete-prompt-session"},{"title":"Rename prompt session","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/prompt-repo/sessions/{id}/rename","href":"/api-reference/prompt-repository/rename-prompt-session"},{"title":"Commit session as version","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/prompt-repo/sessions/{id}/commit","href":"/api-reference/prompt-repository/commit-session-as-version"}]},{"group":"Skills","expanded":false,"pages":[{"title":"Upload skill file","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/skills/files/upload","href":"/api-reference/skills/upload-skill-file"},{"title":"Clean up orphan skill files","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/skills/files/orphans","href":"/api-reference/skills/clean-up-orphan-skill-files"},{"title":"Get all-skills version","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/skills/all/version","href":"/api-reference/skills/get-all-skills-version"},{"title":"Bump all-skills version","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/skills/all/version","href":"/api-reference/skills/bump-all-skills-version"},{"title":"List skills","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/skills","href":"/api-reference/skills/list-skills"},{"title":"Create skill","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/skills","href":"/api-reference/skills/create-skill"},{"title":"Get skill","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/skills/{id}","href":"/api-reference/skills/get-skill"},{"title":"Update skill","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/skills/{id}","href":"/api-reference/skills/update-skill"},{"title":"Delete skill","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/skills/{id}","href":"/api-reference/skills/delete-skill"},{"title":"List skill versions","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/skills/{id}/versions","href":"/api-reference/skills/list-skill-versions"},{"title":"Shift served skill version","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/skills/{id}/shift-version","href":"/api-reference/skills/shift-served-skill-version"},{"title":"Get Claude Code skills marketplace","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/skills/serve/claude-code/.claude-plugin/marketplace.json","href":"/api-reference/skills/get-claude-code-skills-marketplace"},{"title":"Get Codex skills marketplace JSON","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/skills/serve/codex/.agents/plugins/marketplace.json","href":"/api-reference/skills/get-codex-skills-marketplace-json"},{"title":"Download all skills as ZIP","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/skills/serve/all/download.zip","href":"/api-reference/skills/download-all-skills-as-zip"},{"title":"Download skill as ZIP","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/skills/serve/{skill-name}/download.zip","href":"/api-reference/skills/download-skill-as-zip"},{"title":"Download skill file","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/skills/serve/{skill-name}/files/{filepath}","href":"/api-reference/skills/download-skill-file"}]},{"group":"Cache","expanded":false,"pages":[{"title":"Clear cache entry by cache ID","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/cache/clear/{cacheId}","href":"/api-reference/cache/clear-cache-entry-by-cache-id"},{"title":"Clear cache by cache key","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/cache/clear-by-key/{cacheKey}","href":"/api-reference/cache/clear-cache-by-cache-key"}]},{"group":"Vault","expanded":false,"pages":[{"title":"Flush vault secret cache","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json post /api/vault/flush-cache","href":"/api-reference/vault/flush-vault-secret-cache"}]},{"group":"Infrastructure","expanded":false,"pages":[{"title":"WebSocket connection","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /ws","href":"/api-reference/infrastructure/websocket-connection"},{"title":"MCP protocol SSE stream","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /mcp","href":"/api-reference/infrastructure/mcp-protocol-sse-stream"},{"title":"MCP protocol message","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /mcp","href":"/api-reference/infrastructure/mcp-protocol-message"},{"title":"Bifrost MCP SSE stream (not offered)","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /v1/mcp","href":"/api-reference/infrastructure/bifrost-mcp-sse-stream-not-offered"},{"title":"Bifrost MCP message","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /v1/mcp","href":"/api-reference/infrastructure/bifrost-mcp-message"},{"title":"Prometheus metrics","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /metrics","href":"/api-reference/infrastructure/prometheus-metrics"},{"title":"Inspect a request without forwarding it","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json post /inspect","href":"/api-reference/infrastructure/inspect-a-request-without-forwarding-it"}]},{"group":"API Keys","expanded":false,"pages":[{"title":"List API keys","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/api-keys","href":"/api-reference/api-keys/list-api-keys"},{"title":"Create an API key","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json post /api/api-keys","href":"/api-reference/api-keys/create-an-api-key"},{"title":"Get an API key","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/api-keys/{id}","href":"/api-reference/api-keys/get-an-api-key"},{"title":"Update an API key","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json put /api/api-keys/{id}","href":"/api-reference/api-keys/update-an-api-key"},{"title":"Delete an API key","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json delete /api/api-keys/{id}","href":"/api-reference/api-keys/delete-an-api-key"}]},{"group":"Webhooks","expanded":false,"pages":[{"title":"List webhook endpoints","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/webhooks","href":"/api-reference/webhooks/list-webhook-endpoints"},{"title":"Create a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/webhooks","href":"/api-reference/webhooks/create-a-webhook-endpoint"},{"title":"Get a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/webhooks/{id}","href":"/api-reference/webhooks/get-a-webhook-endpoint"},{"title":"Update a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/webhooks/{id}","href":"/api-reference/webhooks/update-a-webhook-endpoint"},{"title":"Delete a webhook endpoint","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/webhooks/{id}","href":"/api-reference/webhooks/delete-a-webhook-endpoint"},{"title":"Rotate a webhook signing secret","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/webhooks/{id}/rotate-secret","href":"/api-reference/webhooks/rotate-a-webhook-signing-secret"},{"title":"Send a test delivery","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/webhooks/{id}/test","href":"/api-reference/webhooks/send-a-test-delivery"},{"title":"List delivery history","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/webhooks/{id}/deliveries","href":"/api-reference/webhooks/list-delivery-history"},{"title":"Search delivery history","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/webhooks/deliveries","href":"/api-reference/webhooks/search-delivery-history"},{"title":"Re-queue a delivery","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/webhooks/deliveries/{id}/redeliver","href":"/api-reference/webhooks/re-queue-a-delivery"}]},{"group":"Notifications","expanded":false,"pages":[{"title":"List dashboard notifications","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/notifications","href":"/api-reference/notifications/list-dashboard-notifications"},{"title":"Publish a dashboard notification","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/notifications","href":"/api-reference/notifications/publish-a-dashboard-notification"}]},{"group":"News Feeds","expanded":false,"pages":[{"title":"List news feeds","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/rss/feeds","href":"/api-reference/news-feeds/list-news-feeds"},{"title":"Add a custom news feed","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/rss/feeds","href":"/api-reference/news-feeds/add-a-custom-news-feed"},{"title":"Update a news feed","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/rss/feeds/{id}","href":"/api-reference/news-feeds/update-a-news-feed"},{"title":"Delete a custom news feed","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/rss/feeds/{id}","href":"/api-reference/news-feeds/delete-a-custom-news-feed"},{"title":"List news items","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/rss/items","href":"/api-reference/news-feeds/list-news-items"},{"title":"Get news settings","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/rss/settings","href":"/api-reference/news-feeds/get-news-settings"},{"title":"Turn news on or off","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/rss/settings","href":"/api-reference/news-feeds/turn-news-on-or-off"}]},{"group":"Warp","expanded":false,"pages":[{"title":"Read Warp configuration","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/warp/config","href":"/api-reference/warp/read-warp-configuration"},{"title":"Update Warp configuration","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/warp/config","href":"/api-reference/warp/update-warp-configuration"},{"title":"Start a Warp log embedding backfill","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/warp/log-index/backfill","href":"/api-reference/warp/start-a-warp-log-embedding-backfill"},{"title":"Read Warp log embedding backfill progress","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/warp/log-index/backfill/status","href":"/api-reference/warp/read-warp-log-embedding-backfill-progress"},{"title":"Cancel a Warp log embedding backfill","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/warp/log-index/backfill/cancel","href":"/api-reference/warp/cancel-a-warp-log-embedding-backfill"},{"title":"Compute Warp topic clusters","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/warp/log-index/topics","href":"/api-reference/warp/compute-warp-topic-clusters"},{"title":"Read Warp topic clustering progress","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/warp/log-index/topics/status","href":"/api-reference/warp/read-warp-topic-clustering-progress"},{"title":"Cancel Warp topic clustering","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/warp/log-index/topics/cancel","href":"/api-reference/warp/cancel-warp-topic-clustering"},{"title":"Ask Warp a question","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/warp/chat","href":"/api-reference/warp/ask-warp-a-question"},{"title":"Read Warp semantic search index status","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/warp/log-index/status","href":"/api-reference/warp/read-warp-semantic-search-index-status"},{"title":"List the caller's Warp conversations","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/warp/conversations","href":"/api-reference/warp/list-the-callers-warp-conversations"},{"title":"Read one Warp conversation","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/warp/conversations/{id}","href":"/api-reference/warp/read-one-warp-conversation"},{"title":"Delete a Warp conversation","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/warp/conversations/{id}","href":"/api-reference/warp/delete-a-warp-conversation"}]}]},{"group":"Governance","pages":[{"group":"Teams","expanded":false,"pages":[{"title":"List teams","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/governance/teams","href":"/api-reference/governance/list-teams"},{"title":"Create team","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/governance/teams","href":"/api-reference/governance/create-team"},{"title":"Get team","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/governance/teams/{team_id}","href":"/api-reference/governance/get-team"},{"title":"Update team","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/governance/teams/{team_id}","href":"/api-reference/governance/update-team"},{"title":"Delete team","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/governance/teams/{team_id}","href":"/api-reference/governance/delete-team"},{"title":"List team members","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/teams/{team_id}/members","href":"/api-reference/teams/list-team-members"},{"title":"Add team member","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json post /api/governance/teams/{team_id}/members","href":"/api-reference/teams/add-team-member"},{"title":"Remove team member","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json delete /api/governance/teams/{team_id}/members/{user_id}","href":"/api-reference/teams/remove-team-member"},{"title":"Get user's teams","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/users/{user_id}/teams","href":"/api-reference/users/get-users-teams"},{"title":"Update user's team assignments","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json put /api/governance/users/{user_id}/teams","href":"/api-reference/users/update-users-team-assignments"},{"title":"List customers attached to a team","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/teams/{team_id}/customers","href":"/api-reference/teams/list-customers-attached-to-a-team"},{"title":"Attach a customer to a team","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json post /api/governance/teams/{team_id}/customers","href":"/api-reference/teams/attach-a-customer-to-a-team"},{"title":"Detach a customer from a team","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json delete /api/governance/teams/{team_id}/customers/{customer_id}","href":"/api-reference/teams/detach-a-customer-from-a-team"},{"title":"List teams attached to a customer","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/customers/{customer_id}/teams","href":"/api-reference/customers/list-teams-attached-to-a-customer"}]},{"group":"Virtual Keys","expanded":false,"pages":[{"title":"List virtual keys","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/governance/virtual-keys","href":"/api-reference/governance/list-virtual-keys"},{"title":"Create virtual key","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/governance/virtual-keys","href":"/api-reference/governance/create-virtual-key"},{"title":"Get virtual key quota","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/governance/virtual-keys/quota","href":"/api-reference/governance/get-virtual-key-quota"},{"title":"Rotate multiple virtual keys","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/governance/virtual-keys/rotate","href":"/api-reference/governance/rotate-multiple-virtual-keys"},{"title":"Get virtual key","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/governance/virtual-keys/{vk_id}","href":"/api-reference/governance/get-virtual-key"},{"title":"Update virtual key","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/governance/virtual-keys/{vk_id}","href":"/api-reference/governance/update-virtual-key"},{"title":"Delete virtual key","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/governance/virtual-keys/{vk_id}","href":"/api-reference/governance/delete-virtual-key"},{"title":"Rotate virtual key","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/governance/virtual-keys/{vk_id}/rotate","href":"/api-reference/governance/rotate-virtual-key"},{"title":"List users attached to a virtual key","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/virtual-keys/{vk_id}/users","href":"/api-reference/virtual-keys/list-users-attached-to-a-virtual-key"},{"title":"Attach users to a virtual key","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json post /api/governance/virtual-keys/{vk_id}/users","href":"/api-reference/virtual-keys/attach-users-to-a-virtual-key"},{"title":"Detach a user from a virtual key","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json delete /api/governance/virtual-keys/{vk_id}/users/{user_id}","href":"/api-reference/virtual-keys/detach-a-user-from-a-virtual-key"},{"title":"Set virtual key budget override","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/governance/virtual-keys/{vk_id}/budgets/{budget_id}/override","href":"/api-reference/governance/set-virtual-key-budget-override"},{"title":"Remove virtual key budget override","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/governance/virtual-keys/{vk_id}/budgets/{budget_id}/override","href":"/api-reference/governance/remove-virtual-key-budget-override"},{"title":"List virtual keys available to a user","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/users/{user_id}/virtual-keys","href":"/api-reference/users/list-virtual-keys-available-to-a-user"},{"title":"Mint an extra virtual key for a user","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json post /api/governance/users/{user_id}/virtual-keys","href":"/api-reference/users/mint-an-extra-virtual-key-for-a-user"},{"title":"Get user's virtual keys by email","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/users/email/{email}/virtual-keys","href":"/api-reference/users/get-users-virtual-keys-by-email"}]},{"group":"Customers","expanded":false,"pages":[{"title":"List customers","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/governance/customers","href":"/api-reference/governance/list-customers"},{"title":"Create customer","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/governance/customers","href":"/api-reference/governance/create-customer"},{"title":"Get customer","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/governance/customers/{customer_id}","href":"/api-reference/governance/get-customer"},{"title":"Update customer","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/governance/customers/{customer_id}","href":"/api-reference/governance/update-customer"},{"title":"Delete customer","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/governance/customers/{customer_id}","href":"/api-reference/governance/delete-customer"}]},{"group":"Users","expanded":false,"pages":[{"title":"List users","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/users","href":"/api-reference/users/list-users"},{"title":"Create user","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json post /api/governance/users","href":"/api-reference/users/create-user"},{"title":"Get user","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/users/{user_id}","href":"/api-reference/users/get-user"},{"title":"Delete user","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json delete /api/governance/users/{user_id}","href":"/api-reference/users/delete-user"},{"title":"Get user by email","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/users/email/{email}","href":"/api-reference/users/get-user-by-email"},{"title":"Get current user permissions","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/users/me/permissions","href":"/api-reference/users/get-current-user-permissions"},{"title":"Get the calling user's virtual-key creation policy","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/users/me/vk-creation-policy","href":"/api-reference/users/get-the-calling-users-virtual-key-creation-policy"},{"title":"Assign role to user","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json put /api/governance/users/{user_id}/role","href":"/api-reference/users/assign-role-to-user"}]},{"group":"Business Units","expanded":false,"pages":[{"title":"List business units","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/business-units","href":"/api-reference/governance/list-business-units"},{"title":"Create business unit","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json post /api/governance/business-units","href":"/api-reference/governance/create-business-unit"},{"title":"Get business unit","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/business-units/{business_unit_id}","href":"/api-reference/governance/get-business-unit"},{"title":"Update business unit","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json put /api/governance/business-units/{business_unit_id}","href":"/api-reference/governance/update-business-unit"},{"title":"Delete business unit","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json delete /api/governance/business-units/{business_unit_id}","href":"/api-reference/governance/delete-business-unit"},{"title":"List business unit users","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/business-units/{business_unit_id}/users","href":"/api-reference/governance/list-business-unit-users"},{"title":"Assign user to business unit","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json post /api/governance/business-units/{business_unit_id}/users","href":"/api-reference/governance/assign-user-to-business-unit"},{"title":"Remove user from business unit","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json delete /api/governance/business-units/{business_unit_id}/users/{user_id}","href":"/api-reference/governance/remove-user-from-business-unit"},{"title":"Create business unit governance","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json post /api/governance/business-units/{business_unit_id}/governance","href":"/api-reference/governance/create-business-unit-governance"},{"title":"Update business unit governance","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json put /api/governance/business-units/{business_unit_id}/governance","href":"/api-reference/governance/update-business-unit-governance"},{"title":"Delete business unit governance","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json delete /api/governance/business-units/{business_unit_id}/governance","href":"/api-reference/governance/delete-business-unit-governance"},{"title":"List customers attached to a business unit","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/business-units/{business_unit_id}/customers","href":"/api-reference/business-units/list-customers-attached-to-a-business-unit"},{"title":"Attach customers to a business unit","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json post /api/governance/business-units/{business_unit_id}/customers","href":"/api-reference/business-units/attach-customers-to-a-business-unit"},{"title":"Detach a customer from a business unit","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json delete /api/governance/business-units/{business_unit_id}/customers/{customer_id}","href":"/api-reference/business-units/detach-a-customer-from-a-business-unit"},{"title":"List business units attached to a customer","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/customers/{customer_id}/business-units","href":"/api-reference/customers/list-business-units-attached-to-a-customer"}]},{"group":"Access Profiles","expanded":false,"pages":[{"title":"List access profiles","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/access-profiles","href":"/api-reference/access-profiles/list-access-profiles"},{"title":"Create access profile","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json post /api/governance/access-profiles","href":"/api-reference/access-profiles/create-access-profile"},{"title":"Get access profile by ID","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/access-profiles/{profile_id}","href":"/api-reference/access-profiles/get-access-profile-by-id"},{"title":"Update access profile","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json put /api/governance/access-profiles/{profile_id}","href":"/api-reference/access-profiles/update-access-profile"},{"title":"Delete access profile","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json delete /api/governance/access-profiles/{profile_id}","href":"/api-reference/access-profiles/delete-access-profile"},{"title":"Activate access profile","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json put /api/governance/access-profiles/{profile_id}/activate","href":"/api-reference/access-profiles/activate-access-profile"},{"title":"Deactivate access profile","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json put /api/governance/access-profiles/{profile_id}/deactivate","href":"/api-reference/access-profiles/deactivate-access-profile"},{"title":"Clone an access profile","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json post /api/governance/access-profiles/{profile_id}/clone","href":"/api-reference/access-profiles/clone-an-access-profile"},{"title":"Propagate template changes to user copies","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json post /api/governance/access-profiles/{profile_id}/propagate","href":"/api-reference/access-profiles/propagate-template-changes-to-user-copies"},{"title":"Attach roles to access profile","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json post /api/governance/access-profiles/{profile_id}/roles","href":"/api-reference/access-profiles/attach-roles-to-access-profile"},{"title":"Detach role from access profile","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json delete /api/governance/access-profiles/{profile_id}/roles/{role_id}","href":"/api-reference/access-profiles/detach-role-from-access-profile"},{"title":"List version snapshots for an access profile","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/access-profiles/{profile_id}/versions","href":"/api-reference/access-profiles/list-version-snapshots-for-an-access-profile"},{"title":"Get a single version snapshot","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/access-profiles/{profile_id}/versions/{version}","href":"/api-reference/access-profiles/get-a-single-version-snapshot"},{"title":"List audit log entries for a single profile","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/access-profiles/{profile_id}/audit-logs","href":"/api-reference/access-profiles/list-audit-log-entries-for-a-single-profile"},{"title":"List workspace-wide audit log entries","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/access-profiles/audit-logs","href":"/api-reference/access-profiles/list-workspace-wide-audit-log-entries"},{"title":"List access profiles held by a user","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/users/{user_id}/access-profiles","href":"/api-reference/access-profiles/list-access-profiles-held-by-a-user"},{"title":"Detach a user's access profile","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json delete /api/governance/users/{user_id}/access-profiles/{profile_id}","href":"/api-reference/access-profiles/detach-a-users-access-profile"},{"title":"Set a user's access-profile budget override","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json put /api/governance/users/{user_id}/access-profiles/{profile_id}/budgets/{budget_id}/override","href":"/api-reference/access-profiles/set-a-users-access-profile-budget-override"},{"title":"Remove a user's access-profile budget override","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json delete /api/governance/users/{user_id}/access-profiles/{profile_id}/budgets/{budget_id}/override","href":"/api-reference/access-profiles/remove-a-users-access-profile-budget-override"},{"title":"Add an extra virtual key under a user's access profile (deprecated) (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json post /api/users/{user_id}/access-profiles/{profile_id}/virtual-keys","href":"/api-reference/access-profiles/add-an-extra-virtual-key-under-a-users-access-profile-deprecated-deprecated-path"},{"title":"Delete a virtual key from a user's access profile","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json delete /api/governance/users/{user_id}/access-profiles/virtual-keys/{vk_id}","href":"/api-reference/access-profiles/delete-a-virtual-key-from-a-users-access-profile"}]},{"group":"Projects","expanded":false,"pages":[{"title":"List projects","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/projects","href":"/api-reference/projects/list-projects"},{"title":"Create project","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json post /api/governance/projects","href":"/api-reference/projects/create-project"},{"title":"Get project","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/projects/{project_id}","href":"/api-reference/projects/get-project"},{"title":"Update project","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json put /api/governance/projects/{project_id}","href":"/api-reference/projects/update-project"},{"title":"Delete project","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json delete /api/governance/projects/{project_id}","href":"/api-reference/projects/delete-project"},{"title":"List project members","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/projects/{project_id}/members","href":"/api-reference/projects/list-project-members"},{"title":"Add project members","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json post /api/governance/projects/{project_id}/members","href":"/api-reference/projects/add-project-members"},{"title":"Update project member caps","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json put /api/governance/projects/{project_id}/members/{member_id}","href":"/api-reference/projects/update-project-member-caps"},{"title":"Remove project member","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json delete /api/governance/projects/{project_id}/members/{member_id}","href":"/api-reference/projects/remove-project-member"},{"title":"List a user's projects","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/users/{user_id}/projects","href":"/api-reference/projects/list-a-users-projects"}]},{"group":"RBAC","expanded":false,"pages":[{"title":"List roles","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/rbac/roles","href":"/api-reference/rbac/list-roles"},{"title":"Create role","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json post /api/governance/rbac/roles","href":"/api-reference/rbac/create-role"},{"title":"Get role by ID","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/rbac/roles/{role_id}","href":"/api-reference/rbac/get-role-by-id"},{"title":"Update role","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json put /api/governance/rbac/roles/{role_id}","href":"/api-reference/rbac/update-role"},{"title":"Delete role","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json delete /api/governance/rbac/roles/{role_id}","href":"/api-reference/rbac/delete-role"},{"title":"List permissions assigned to a role","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/rbac/roles/{role_id}/permissions","href":"/api-reference/rbac/list-permissions-assigned-to-a-role"},{"title":"Replace the permission set on a role","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json put /api/governance/rbac/roles/{role_id}/permissions","href":"/api-reference/rbac/replace-the-permission-set-on-a-role"},{"title":"List RBAC resources","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/rbac/resources","href":"/api-reference/rbac/list-rbac-resources"},{"title":"List RBAC operations","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/rbac/operations","href":"/api-reference/rbac/list-rbac-operations"},{"title":"List all RBAC permissions","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/rbac/permissions","href":"/api-reference/rbac/list-all-rbac-permissions"}]},{"group":"Audit Logs","expanded":false,"pages":[{"title":"List audit logs","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/audit-logs","href":"/api-reference/audit-logs/list-audit-logs"},{"title":"Get audit log filter data","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/audit-logs/filterdata","href":"/api-reference/audit-logs/get-audit-log-filter-data"},{"title":"Export audit logs","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/audit-logs/export","href":"/api-reference/audit-logs/export-audit-logs"},{"title":"Get audit log by ID","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/audit-logs/{id}","href":"/api-reference/audit-logs/get-audit-log-by-id"},{"title":"Verify audit log signature","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/governance/audit-logs/{id}/verify","href":"/api-reference/audit-logs/verify-audit-log-signature"}]},{"group":"Budgets \u0026 Rate Limits","expanded":false,"pages":[{"title":"List budgets","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/governance/budgets","href":"/api-reference/governance/list-budgets"},{"title":"List rate limits","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/governance/rate-limits","href":"/api-reference/governance/list-rate-limits"},{"title":"Approve a budget increase request","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json post /api/governance/budget-requests/{request_id}/approve","href":"/api-reference/governance/approve-a-budget-increase-request"}]},{"group":"Model Configs","expanded":false,"pages":[{"title":"List model limits","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/governance/model-configs","href":"/api-reference/governance/list-model-limits"},{"title":"Create model config","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/governance/model-configs","href":"/api-reference/governance/create-model-config"},{"title":"Get model config","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/governance/model-configs/{mc_id}","href":"/api-reference/governance/get-model-config"},{"title":"Update model config","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/governance/model-configs/{mc_id}","href":"/api-reference/governance/update-model-config"},{"title":"Delete model config","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/governance/model-configs/{mc_id}","href":"/api-reference/governance/delete-model-config"}]},{"group":"Provider Governance","expanded":false,"pages":[{"title":"List provider governance","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/governance/providers","href":"/api-reference/governance/list-provider-governance"},{"title":"Update provider governance","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/governance/providers/{provider_name}","href":"/api-reference/governance/update-provider-governance"},{"title":"Delete provider governance","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/governance/providers/{provider_name}","href":"/api-reference/governance/delete-provider-governance"}]},{"group":"Pricing Overrides","expanded":false,"pages":[{"title":"List pricing overrides","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/governance/pricing-overrides","href":"/api-reference/governance/list-pricing-overrides"},{"title":"Create pricing override","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/governance/pricing-overrides","href":"/api-reference/governance/create-pricing-override"},{"title":"Update pricing override","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/governance/pricing-overrides/{id}","href":"/api-reference/governance/update-pricing-override"},{"title":"Delete pricing override","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/governance/pricing-overrides/{id}","href":"/api-reference/governance/delete-pricing-override"}]}]},{"group":"Routing","pages":[{"group":"Routing Rules","expanded":false,"pages":[{"title":"List routing rules","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/routing/rules","href":"/api-reference/routing/list-routing-rules"},{"title":"Create routing rule","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/routing/rules","href":"/api-reference/routing/create-routing-rule"},{"title":"Get routing rule","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/routing/rules/{rule_id}","href":"/api-reference/routing/get-routing-rule"},{"title":"Update routing rule","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/routing/rules/{rule_id}","href":"/api-reference/routing/update-routing-rule"},{"title":"Delete routing rule","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/routing/rules/{rule_id}","href":"/api-reference/routing/delete-routing-rule"}]},{"group":"Routers","expanded":false,"pages":[{"title":"List model routers","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/routing/model-routers","href":"/api-reference/routing/list-model-routers"},{"title":"Create a model router","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/routing/model-routers","href":"/api-reference/routing/create-a-model-router"},{"title":"Get model router defaults","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/routing/model-routers/defaults","href":"/api-reference/routing/get-model-router-defaults"},{"title":"Get a model router","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/routing/model-routers/{router_id}","href":"/api-reference/routing/get-a-model-router"},{"title":"Update a model router","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/routing/model-routers/{router_id}","href":"/api-reference/routing/update-a-model-router"},{"title":"Delete a model router","deprecated":null,"version":null,"openapi":"/openapi/openapi.json delete /api/routing/model-routers/{router_id}","href":"/api-reference/routing/delete-a-model-router"},{"title":"Reset a model router","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/routing/model-routers/{router_id}/reset","href":"/api-reference/routing/reset-a-model-router"},{"title":"Set a model router's targets","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/routing/model-routers/{router_id}/targets","href":"/api-reference/routing/set-a-model-routers-targets"},{"title":"Update a model router's routing","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/routing/model-routers/{router_id}/routing","href":"/api-reference/routing/update-a-model-routers-routing"},{"title":"Get a model router's classifier status","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/routing/model-routers/{router_id}/status","href":"/api-reference/routing/get-a-model-routers-classifier-status"},{"title":"Retry a model router's failed warmup","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/routing/model-routers/{router_id}/status/retry","href":"/api-reference/routing/retry-a-model-routers-failed-warmup"},{"title":"Classify statements with a model router","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/routing/model-routers/{router_id}/classify","href":"/api-reference/routing/classify-statements-with-a-model-router"}]},{"group":"Phrase Suggestions","expanded":false,"pages":[{"title":"List phrase suggestions","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/routing/model-routers/{router_id}/suggestions","href":"/api-reference/routing/list-phrase-suggestions"},{"title":"Get a phrase suggestion with its examples","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/routing/model-routers/{router_id}/suggestions/{suggestion_id}","href":"/api-reference/routing/get-a-phrase-suggestion-with-its-examples"},{"title":"Accept, dismiss or reopen a phrase suggestion","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/routing/model-routers/{router_id}/suggestions/{suggestion_id}/status","href":"/api-reference/routing/accept-dismiss-or-reopen-a-phrase-suggestion"},{"title":"List phrase suggestion runs","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/routing/model-routers/{router_id}/suggestions/runs","href":"/api-reference/routing/list-phrase-suggestion-runs"},{"title":"Start a phrase suggestion run now","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/routing/model-routers/{router_id}/suggestions/runs","href":"/api-reference/routing/start-a-phrase-suggestion-run-now"},{"title":"Estimate a phrase suggestion run","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/routing/model-routers/{router_id}/suggestions/runs/estimate","href":"/api-reference/routing/estimate-a-phrase-suggestion-run"},{"title":"Cancel a phrase suggestion run","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/routing/model-routers/{router_id}/suggestions/runs/{run_id}/cancel","href":"/api-reference/routing/cancel-a-phrase-suggestion-run"},{"title":"Test phrases against routed requests","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/routing/model-routers/{router_id}/suggestions/test","href":"/api-reference/routing/test-phrases-against-routed-requests"},{"title":"Check what phrases would do to recent traffic","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/routing/model-routers/{router_id}/suggestions/impact","href":"/api-reference/routing/check-what-phrases-would-do-to-recent-traffic"},{"title":"Add phrases to a model router","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/routing/model-routers/{router_id}/phrases","href":"/api-reference/routing/add-phrases-to-a-model-router"}]},{"group":"Complexity Analyzer (deprecated)","expanded":false,"pages":[{"title":"Get complexity analyzer config","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/routing/complexity-analyzer-config","href":"/api-reference/routing/get-complexity-analyzer-config"},{"title":"Update complexity analyzer config","deprecated":null,"version":null,"openapi":"/openapi/openapi.json put /api/routing/complexity-analyzer-config","href":"/api-reference/routing/update-complexity-analyzer-config"},{"title":"Reset complexity analyzer config","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/routing/complexity-analyzer-config/reset","href":"/api-reference/routing/reset-complexity-analyzer-config"},{"title":"Get complexity classifier status","deprecated":null,"version":null,"openapi":"/openapi/openapi.json get /api/routing/complexity-analyzer-status","href":"/api-reference/routing/get-complexity-classifier-status"},{"title":"Retry failed complexity classifier warmup","deprecated":null,"version":null,"openapi":"/openapi/openapi.json post /api/routing/complexity-analyzer-status/retry","href":"/api-reference/routing/retry-failed-complexity-classifier-warmup"}]},{"group":"Adaptive Routing","expanded":false,"pages":[{"title":"Get adaptive routing settings","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/adaptive-routing/config","href":"/api-reference/adaptive-routing/get-adaptive-routing-settings"},{"title":"Update adaptive routing settings","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json put /api/adaptive-routing/config","href":"/api-reference/adaptive-routing/update-adaptive-routing-settings"}]},{"group":"Circuit Breaker","expanded":false,"pages":[{"title":"List circuit breaker policies","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/circuit-breaker/policies","href":"/api-reference/circuit-breaker/list-circuit-breaker-policies"},{"title":"Create circuit breaker policy","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json post /api/circuit-breaker/policies","href":"/api-reference/circuit-breaker/create-circuit-breaker-policy"},{"title":"Update circuit breaker policy","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json put /api/circuit-breaker/policies/{name}","href":"/api-reference/circuit-breaker/update-circuit-breaker-policy"},{"title":"Delete circuit breaker policy","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json delete /api/circuit-breaker/policies/{name}","href":"/api-reference/circuit-breaker/delete-circuit-breaker-policy"},{"title":"Get circuit breaker state","deprecated":null,"version":null,"tag":"Enterprise","openapi":"/openapi/openapi.json get /api/circuit-breaker/state","href":"/api-reference/circuit-breaker/get-circuit-breaker-state"}]}]},{"group":"Deprecated","pages":[{"group":"Virtual Keys","expanded":false,"pages":[{"title":"List users attached to a virtual key (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/virtual-keys/{vk_id}/users","href":"/api-reference/virtual-keys/list-users-attached-to-a-virtual-key-deprecated-path"},{"title":"Attach users to a virtual key (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json post /api/virtual-keys/{vk_id}/users","href":"/api-reference/virtual-keys/attach-users-to-a-virtual-key-deprecated-path"},{"title":"Detach a user from a virtual key (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json delete /api/virtual-keys/{vk_id}/users/{user_id}","href":"/api-reference/virtual-keys/detach-a-user-from-a-virtual-key-deprecated-path"}]},{"group":"Teams","expanded":false,"pages":[{"title":"List customers attached to a team (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/teams/{team_id}/customers","href":"/api-reference/teams/list-customers-attached-to-a-team-deprecated-path"},{"title":"Attach a customer to a team (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json post /api/teams/{team_id}/customers","href":"/api-reference/teams/attach-a-customer-to-a-team-deprecated-path"},{"title":"Detach a customer from a team (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json delete /api/teams/{team_id}/customers/{customer_id}","href":"/api-reference/teams/detach-a-customer-from-a-team-deprecated-path"},{"title":"List team members (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/teams/{team_id}/members","href":"/api-reference/teams/list-team-members-deprecated-path"},{"title":"Add team member (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json post /api/teams/{team_id}/members","href":"/api-reference/teams/add-team-member-deprecated-path"},{"title":"Remove team member (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json delete /api/teams/{team_id}/members/{user_id}","href":"/api-reference/teams/remove-team-member-deprecated-path"}]},{"group":"Customers","expanded":false,"pages":[{"title":"List teams attached to a customer (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/customers/{customer_id}/teams","href":"/api-reference/customers/list-teams-attached-to-a-customer-deprecated-path"}]},{"group":"RBAC","expanded":false,"pages":[{"title":"List roles (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/roles","href":"/api-reference/rbac/list-roles-deprecated-path"},{"title":"Create role (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json post /api/roles","href":"/api-reference/rbac/create-role-deprecated-path"},{"title":"Get role by ID (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/roles/{role_id}","href":"/api-reference/rbac/get-role-by-id-deprecated-path"},{"title":"Update role (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json put /api/roles/{role_id}","href":"/api-reference/rbac/update-role-deprecated-path"},{"title":"Delete role (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json delete /api/roles/{role_id}","href":"/api-reference/rbac/delete-role-deprecated-path"},{"title":"List permissions assigned to a role (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/roles/{role_id}/permissions","href":"/api-reference/rbac/list-permissions-assigned-to-a-role-deprecated-path"},{"title":"Replace the permission set on a role (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json put /api/roles/{role_id}/permissions","href":"/api-reference/rbac/replace-the-permission-set-on-a-role-deprecated-path"},{"title":"List RBAC resources (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/resources","href":"/api-reference/rbac/list-rbac-resources-deprecated-path"},{"title":"List RBAC operations (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/operations","href":"/api-reference/rbac/list-rbac-operations-deprecated-path"},{"title":"List all RBAC permissions (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/permissions","href":"/api-reference/rbac/list-all-rbac-permissions-deprecated-path"}]},{"group":"Users","expanded":false,"pages":[{"title":"List users (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/users","href":"/api-reference/users/list-users-deprecated-path"},{"title":"Create user (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json post /api/users","href":"/api-reference/users/create-user-deprecated-path"},{"title":"Get user (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/users/{user_id}","href":"/api-reference/users/get-user-deprecated-path"},{"title":"Delete user (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json delete /api/users/{user_id}","href":"/api-reference/users/delete-user-deprecated-path"},{"title":"Get current user permissions (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/users/me/permissions","href":"/api-reference/users/get-current-user-permissions-deprecated-path"},{"title":"Assign role to user (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json put /api/users/{user_id}/role","href":"/api-reference/users/assign-role-to-user-deprecated-path"},{"title":"Get user's teams (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/users/{user_id}/teams","href":"/api-reference/users/get-users-teams-deprecated-path"},{"title":"Update user's team assignments (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json put /api/users/{user_id}/teams","href":"/api-reference/users/update-users-team-assignments-deprecated-path"},{"title":"Get user's virtual keys by email (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/users/email/{email}/virtual-keys","href":"/api-reference/users/get-users-virtual-keys-by-email-deprecated-path"},{"title":"Get user by email (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/users/email/{email}","href":"/api-reference/users/get-user-by-email-deprecated-path"},{"title":"List virtual keys available to a user (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/users/{user_id}/virtual-keys","href":"/api-reference/users/list-virtual-keys-available-to-a-user-deprecated-path"}]},{"group":"Governance","expanded":false,"pages":[{"title":"List teams (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/teams","href":"/api-reference/governance/list-teams-deprecated-path"},{"title":"Create team (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json post /api/teams","href":"/api-reference/governance/create-team-deprecated-path"},{"title":"Get team (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/teams/{team_id}","href":"/api-reference/governance/get-team-deprecated-path"},{"title":"Update team (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json put /api/teams/{team_id}","href":"/api-reference/governance/update-team-deprecated-path"},{"title":"Delete team (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json delete /api/teams/{team_id}","href":"/api-reference/governance/delete-team-deprecated-path"}]},{"group":"Access Profiles","expanded":false,"pages":[{"title":"List access profiles (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/access-profiles","href":"/api-reference/access-profiles/list-access-profiles-deprecated-path"},{"title":"Create access profile (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json post /api/access-profiles","href":"/api-reference/access-profiles/create-access-profile-deprecated-path"},{"title":"Get access profile by ID (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/access-profiles/{profile_id}","href":"/api-reference/access-profiles/get-access-profile-by-id-deprecated-path"},{"title":"Update access profile (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json put /api/access-profiles/{profile_id}","href":"/api-reference/access-profiles/update-access-profile-deprecated-path"},{"title":"Delete access profile (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json delete /api/access-profiles/{profile_id}","href":"/api-reference/access-profiles/delete-access-profile-deprecated-path"},{"title":"Activate access profile (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json put /api/access-profiles/{profile_id}/activate","href":"/api-reference/access-profiles/activate-access-profile-deprecated-path"},{"title":"Deactivate access profile (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json put /api/access-profiles/{profile_id}/deactivate","href":"/api-reference/access-profiles/deactivate-access-profile-deprecated-path"},{"title":"Clone an access profile (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json post /api/access-profiles/{profile_id}/clone","href":"/api-reference/access-profiles/clone-an-access-profile-deprecated-path"},{"title":"Propagate template changes to user copies (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json post /api/access-profiles/{profile_id}/propagate","href":"/api-reference/access-profiles/propagate-template-changes-to-user-copies-deprecated-path"},{"title":"Attach roles to access profile (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json post /api/access-profiles/{profile_id}/roles","href":"/api-reference/access-profiles/attach-roles-to-access-profile-deprecated-path"},{"title":"Detach role from access profile (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json delete /api/access-profiles/{profile_id}/roles/{role_id}","href":"/api-reference/access-profiles/detach-role-from-access-profile-deprecated-path"},{"title":"List version snapshots for an access profile (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/access-profiles/{profile_id}/versions","href":"/api-reference/access-profiles/list-version-snapshots-for-an-access-profile-deprecated-path"},{"title":"Get a single version snapshot (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/access-profiles/{profile_id}/versions/{version}","href":"/api-reference/access-profiles/get-a-single-version-snapshot-deprecated-path"},{"title":"List audit log entries for a single profile (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/access-profiles/{profile_id}/audit-logs","href":"/api-reference/access-profiles/list-audit-log-entries-for-a-single-profile-deprecated-path"},{"title":"List workspace-wide audit log entries (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/access-profiles/audit-logs","href":"/api-reference/access-profiles/list-workspace-wide-audit-log-entries-deprecated-path"},{"title":"List access profiles held by a user (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/users/{user_id}/access-profiles","href":"/api-reference/access-profiles/list-access-profiles-held-by-a-user-deprecated-path"},{"title":"Set a user's access-profile budget override (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json put /api/users/{user_id}/access-profiles/{profile_id}/budgets/{budget_id}/override","href":"/api-reference/access-profiles/set-a-users-access-profile-budget-override-deprecated-path"},{"title":"Remove a user's access-profile budget override (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json delete /api/users/{user_id}/access-profiles/{profile_id}/budgets/{budget_id}/override","href":"/api-reference/access-profiles/remove-a-users-access-profile-budget-override-deprecated-path"},{"title":"Detach a user's access profile (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json delete /api/users/{user_id}/access-profiles/{profile_id}","href":"/api-reference/access-profiles/detach-a-users-access-profile-deprecated-path"},{"title":"Add an extra virtual key under a user's access profile (deprecated) (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json post /api/users/{user_id}/access-profiles/{profile_id}/virtual-keys","href":"/api-reference/access-profiles/add-an-extra-virtual-key-under-a-users-access-profile-deprecated-deprecated-path"},{"title":"Delete a virtual key from a user's access profile (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json delete /api/users/{user_id}/access-profiles/virtual-keys/{vk_id}","href":"/api-reference/access-profiles/delete-a-virtual-key-from-a-users-access-profile-deprecated-path"}]},{"group":"Audit Logs","expanded":false,"pages":[{"title":"List audit logs (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/audit-logs","href":"/api-reference/audit-logs/list-audit-logs-deprecated-path"},{"title":"Get audit log filter data (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/audit-logs/filterdata","href":"/api-reference/audit-logs/get-audit-log-filter-data-deprecated-path"},{"title":"Export audit logs (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/audit-logs/export","href":"/api-reference/audit-logs/export-audit-logs-deprecated-path"},{"title":"Get audit log by ID (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/audit-logs/{id}","href":"/api-reference/audit-logs/get-audit-log-by-id-deprecated-path"},{"title":"Verify audit log signature (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/audit-logs/{id}/verify","href":"/api-reference/audit-logs/verify-audit-log-signature-deprecated-path"}]},{"group":"Adaptive Routing","expanded":false,"pages":[{"title":"Get adaptive routing settings (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json get /api/load-balancer-config","href":"/api-reference/adaptive-routing/get-adaptive-routing-settings-deprecated-path"},{"title":"Update adaptive routing settings (deprecated path)","deprecated":true,"version":null,"tag":"Removing soon","openapi":"/openapi/openapi.json put /api/load-balancer-config","href":"/api-reference/adaptive-routing/update-adaptive-routing-settings-deprecated-path"}]}]}]},{"tab":"Contributing","icon":"code-pull-request","pages":[{"title":"Contributing","href":"/contributing/setting-up-repo"}]},{"tab":"Benchmarks","icon":"chart-line","pages":[{"title":"Benchmarks","href":"/benchmarking/getting-started"}]},{"tab":"Changelogs","icon":"bolt","menu":[{"item":"Open Source","icon":"rocket","pages":[{"title":"Open Source","href":"/changelogs/v2.6.0"}]},{"item":"Enterprise","icon":"building","pages":[{"title":"Enterprise","href":"/changelogs/ent-v2.6.0"}]},{"item":"Edge","icon":"grip","pages":[{"title":"Edge","href":"/changelogs/edge-v1.0.2"}]},{"item":"Bifrost CLI","icon":"laptop-code","pages":[{"title":"Bifrost CLI","href":"/changelogs/cli-v1.0.0"}]},{"item":"Helm","icon":"box","pages":[{"title":"Helm","href":"/changelogs/helm-v2.1.49"}]}],"pages":[{"title":"Changelogs","href":"/changelogs/v2.6.0"}]}]},"basePath":"","title":"Add MCP client - Bifrost","deploymentId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","buildId":"dpl_vSEmv961Ncyvz1psVwgUnTXQMSYk","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CrDfRf61.js","snippetPresets-Dv-cOUrx.js","utils-BUTreAgv.js","style-to-object-BY3JEAdk.js","utils-wsznt9RM.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-DEsMlaPy.js","conditional-requirements-CFM0id0Q.js","cloneDeep-DontW4xJ.js","_Uint8Array-pP7X6_RM.js","isObject-FP1Yky1u.js","ApiExamples-CU_aGGP0.js","usePlaygroundInputsStore-7dNmUIbS.js","shallow-fTtruD8x.js","isEqual-BRfNFpSD.js","CodeSnippets-52884wUJ.js","CodeSnippet-eoRjC4Le.js","getApiPlaygroundDisplay-CZyAPlR2.js","Page-Cr9IwkK7.js","DynamicMarkdown-NFqqduU7.js","SectionHeading-DQ-mJoAt.js","icon-DXTBUt6s.js","MethodPill-2v-b3js5.js","getPastedJson-v_8Y1_4v.js","DuplicateIcon-DXIkhZIo.js","createIcon-DRpYuPZs.js","axios-CsQoIw0U.js","Markdown-CwtoSfEf.js","AssistantPageLink-CTqa3eoi.js","dist-DIfYWxfm.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}