Replaces the model each tier of the router gets, and serves the new targets without restarting the router’s classifiers. A tier with no target keeps the request’s model; an empty list clears them.
PUT
/
api
/
routing
/
model-routers
/
{router_id}
/
targets
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.
Path Parameters
router_id
string
required
Model router id.
Body
application/json
The targets that replace a model router's. Weights within a tier sum to 1; an empty list clears them.
targets
object[]
required
One model for one tier of a model router. Omitting provider or model keeps the request's value, but a target sets at least one.
Option 1
Option 2
Show child attributes
Response
Model router targets saved successfully
A model router - an id, a name and a description beside the same settings as ComplexityAnalyzerConfig, sent and returned at the top level; its phrase suggestions, which only model routers make; the model each tier gets; and the routing that decides which requests it takes. Routers are separate from the complexity analyzer config, which routing rules read complexity_tier from. The cross-field rules of ComplexityAnalyzerConfig apply, and the suggestion rules below.
name
string
required
Display name, unique across routers.
Required string length: 1 - 255
keywords
object
required
Reference phrases for semantic complexity classification, one list per tier.
Each request is embedded and takes the tier of its nearest phrase. Entries
should be whole example prompts rather than individual keywords. Each phrase
is limited to 2000 characters, the normalized lists may contain at most 750
phrases combined, and the same phrase cannot appear in two tiers. The field
names predate semantic classification and are kept for backward compatibility.
Show child attributes
id
string
Stable router id; generated when omitted on create. defaults is reserved, since it names the endpoint that serves a new router's defaults.
Maximum string length: 64
Pattern: ^[A-Za-z0-9_-]+$
description
string
tier_boundaries
object
deprecated
Deprecated score thresholds for the retired lexical complexity classifier.
This block is optional and ignored by semantic classification, but remains
accepted for backward compatibility. When supplied, values must satisfy
0 < simple_medium < medium_complex < 1.
Show child attributes
classifier
enum<string>
default:semantic
Primary complexity classifier. llm classifies with the model in the llm block.
Available options:
semantic,
decision,
llm
semantic
object
conditionally required
Embedding configuration for semantic complexity classification. When absent,
no complexity tier is published and rules referencing complexity_tier fall
through. The provider must have an enabled key.
Show child attributes
decision
object
Decision-model complexity-classifier request settings. Credentials come from the selected provider's configuration.
Show child attributes
llm
object
requiredifclassifier=llm
conditionally required
Chat-completion (LLM) classifier settings. Used as the primary classifier
when classifier is llm, and as the fallback when semantic.fallback
selects llm, where it runs only after semantic classification produces no
tier. Otherwise the block is kept but not used. Tier names (SIMPLE, MEDIUM,
COMPLEX) and the response format are fixed: the gateway always appends a
non-editable reinforcement stating them.
Show child attributes
session
object
Session-aware complexity routing. When enabled and a supported session identity is present, Bifrost retains the highest tier observed across normally sequential turns for 24 hours of inactivity. It uses the configured primary classifier and is independent of provider session stickiness.
Show child attributes
suggestions
object
Phrase suggestions for the semantic router. When enabled, a sample of the vectors the semantic classifier already computes is kept under each request's log ID (request text stays in the logs), and a run on the schedule clusters that traffic and asks the suggestion model for phrases. Vectors are captured only into the top-level vector_store, and not when that is Chromem, which keeps them in each gateway's memory; with no vector_store, or only the semantic classifier's embedded store, nothing is captured and no run has traffic to read. Captured vectors are deleted with their logs, and become due for deletion after lookback_days or the log retention, whichever is shorter; an hourly cleanup removes them, so one can remain up to an hour past that, and longer while the vector store is unavailable.
Show child attributes
targets
object[]
read-only
The model each tier gets. Returned with the router; set with PUT /api/routing/model-routers/{router_id}/targets. Ignored in a create or update body.
One model for one tier of a model router. Omitting provider or model keeps the request's value, but a target sets at least one.
Option 1
Option 2
Show child attributes
routing
object
Which requests the router takes. Always returned. Optional on create, where omitting it starts the router off, global, with the priority after the last global router. Ignored in an update body; set it with PUT /api/routing/model-routers/{router_id}/routing.
Show child attributes
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":"6afdf9a407d1852717d18696","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"API","count":708},{"language":"default","tag":"Changelogs","count":327},{"language":"default","tag":"Integrations","count":253},{"language":"default","tag":"Platform","count":246},{"language":"default","tag":"Open Source","count":166},{"language":"default","tag":"OSS","count":161},{"language":"default","tag":"Governance","count":129},{"language":"default","tag":"Enterprise","count":107},{"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":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"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/routing/set-a-model-routers-targets","slug":"/api-reference/routing/set-a-model-routers-targets","pageMetadata":{"title":"Set a model router's targets","description":"Replaces the model each tier of the router gets, and serves the new targets without restarting the router's classifiers. A tier with no target keeps the request's model; an empty list clears them.","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","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Replaces the model each tier of the router gets, and serves the new targets without restarting the router’s classifiers. A tier with no target keeps the request’s model; an empty list clears them.\"\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:`Routers:Update`})}),_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":"Set a model router's targets","description":"Replaces the model each tier of the router gets, and serves the new targets without restarting the router's classifiers. A tier with no target keeps the request's model; an empty list clears them.","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","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":"setModelRouterTargets","x-mint":{"content":"**Required Permissions**\n\n| Permission | Granted via |\n| --- | --- |\n| `Routers:Update` | RBAC role or API key scope |\n\n[How permissions work](/api/procuring-api-keys#required-permissions)\n"},"summary":"Set a model router's targets","description":"Replaces the model each tier of the router gets, and serves the new targets without restarting the router's classifiers. A tier with no target keeps the request's model; an empty list clears them.","requestBody":"4ffc807f-017f-4873-9c8a-f815349ecd36","tags":["Routing"],"security":["f29338c1-86db-43f2-b398-fa33f80245f3","72371f95-6f25-457a-89b4-9ab87ce0337c"],"responses":{"200":"baa17444-a6aa-4f50-93a7-8eb293fe26f3","400":"d9a65f0b-075d-48e7-9c1c-b717947c3112","404":"1fcfe998-3871-4826-9e03-fe402cc5ef8b","500":"37ac5253-da03-4d25-bbe9-3d7577853f9d"},"method":"put","type":"path","servers":["3967813b-562c-40d9-bb92-9d6426d2f033"],"path":"/api/routing/model-routers/{router_id}/targets","baseUrlOptions":["{baseUrl}"],"title":"Set a model router's targets","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"9ae37f98-f02f-4b93-8158-15c359ab947a":{"name":"router_id","in":"path","required":true,"description":"Model router id.","schema":{"type":"string","isRequired":true,"description":"Model router id.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","description":"The targets that replace a model router's. Weights within a tier sum to 1; an empty list clears them.","additionalProperties":false,"required":["targets"],"properties":{"targets":{"type":"array","items":{"oneOf":[{"type":"object","description":"One model for one tier of a model router. Omitting provider or model keeps the request's value, but a target sets at least one.","required":["tier","weight","provider"],"conditionallyRequiredProperties":{"provider":[{"when":[[{"property":"key_id"}]]}]},"properties":{"provider":{"type":"string","description":"Target provider (omit to keep the request's provider). Moving to another provider clears a key the routing rules pinned.","minLength":1,"isRequired":true,"uniqueKey":"targets.items.[INDEX].oneOf.0.provider","typeLabel":"string"},"tier":{"type":"string","enum":["SIMPLE","MEDIUM","COMPLEX"],"isRequired":true,"uniqueKey":"targets.items.[INDEX].oneOf.0.tier","typeLabel":"enum\u003cstring>"},"weight":{"type":"number","format":"double","exclusiveMinimum":0,"description":"Probability weight within the tier; the weights of a tier sum to 1.","isRequired":true,"uniqueKey":"targets.items.[INDEX].oneOf.0.weight","typeLabel":"number\u003cdouble>"},"model":{"oneOf":[{"type":"string","description":"Target model (omit to keep the request's model)","uniqueKey":"targets.items.[INDEX].oneOf.0.model.oneOf.0","typeLabel":"string"},{"type":"null","description":"Target model (omit to keep the request's model)","uniqueKey":"targets.items.[INDEX].oneOf.0.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"targets.items.[INDEX].oneOf.0.model","typeLabel":"string | null"},"key_id":{"oneOf":[{"type":"string","description":"UUID of the API key to pin for this target","uniqueKey":"targets.items.[INDEX].oneOf.0.key_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"UUID of the API key to pin for this target","uniqueKey":"targets.items.[INDEX].oneOf.0.key_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"targets.items.[INDEX].oneOf.0.key_id","typeLabel":"string | null"},"fallbacks":{"type":"array","description":"Fallback chain used when this target is chosen. A non-empty list replaces the request's chain; omit it or send [] to keep the chain the routing rules set.","items":{"oneOf":[{"type":"string","description":"A fallback in a routing rule's chain. Either the \"provider/model\" string (\"provider/\" keeps the incoming model), or an object that additionally pins a provider key.","minLength":1,"uniqueKey":"targets.items.[INDEX].oneOf.0.fallbacks.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"object","description":"A fallback in a routing rule's chain. Either the \"provider/model\" string (\"provider/\" keeps the incoming model), or an object that additionally pins a provider key.","required":["provider"],"properties":{"provider":{"type":"string","minLength":1,"description":"Fallback provider","isRequired":true,"uniqueKey":"targets.items.[INDEX].oneOf.0.fallbacks.items.[INDEX].oneOf.1.provider","typeLabel":"string"},"model":{"oneOf":[{"type":"string","description":"Fallback model (omit or empty to use the incoming request model)","uniqueKey":"targets.items.[INDEX].oneOf.0.fallbacks.items.[INDEX].oneOf.1.model.oneOf.0","typeLabel":"string"},{"type":"null","description":"Fallback model (omit or empty to use the incoming request model)","uniqueKey":"targets.items.[INDEX].oneOf.0.fallbacks.items.[INDEX].oneOf.1.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"targets.items.[INDEX].oneOf.0.fallbacks.items.[INDEX].oneOf.1.model","typeLabel":"string | null"},"key_id":{"oneOf":[{"type":"string","description":"UUID of the API key to pin for this fallback (omit for load-balanced key selection). A fallback whose pinned key is missing from the provider's pool is skipped.","uniqueKey":"targets.items.[INDEX].oneOf.0.fallbacks.items.[INDEX].oneOf.1.key_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"UUID of the API key to pin for this fallback (omit for load-balanced key selection). A fallback whose pinned key is missing from the provider's pool is skipped.","uniqueKey":"targets.items.[INDEX].oneOf.0.fallbacks.items.[INDEX].oneOf.1.key_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"targets.items.[INDEX].oneOf.0.fallbacks.items.[INDEX].oneOf.1.key_id","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"targets.items.[INDEX].oneOf.0.fallbacks.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"targets.items.[INDEX].oneOf.0.fallbacks.items.[INDEX]","typeLabel":"string | object"},"uniqueKey":"targets.items.[INDEX].oneOf.0.fallbacks","typeLabel":"(string | object)[]"}},"additionalProperties":false,"uniqueKey":"targets.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"One model for one tier of a model router. Omitting provider or model keeps the request's value, but a target sets at least one.","required":["tier","weight","model"],"conditionallyRequiredProperties":{"provider":[{"when":[[{"property":"key_id"}]]}]},"properties":{"model":{"type":"string","description":"Target model (omit to keep the request's model)","minLength":1,"isRequired":true,"uniqueKey":"targets.items.[INDEX].oneOf.1.model","typeLabel":"string"},"tier":{"type":"string","enum":["SIMPLE","MEDIUM","COMPLEX"],"isRequired":true,"uniqueKey":"targets.items.[INDEX].oneOf.1.tier","typeLabel":"enum\u003cstring>"},"weight":{"type":"number","format":"double","exclusiveMinimum":0,"description":"Probability weight within the tier; the weights of a tier sum to 1.","isRequired":true,"uniqueKey":"targets.items.[INDEX].oneOf.1.weight","typeLabel":"number\u003cdouble>"},"provider":{"oneOf":[{"type":"string","description":"Target provider (omit to keep the request's provider). Moving to another provider clears a key the routing rules pinned.","conditionalRequirements":[{"when":[[{"property":"key_id"}]]}],"uniqueKey":"targets.items.[INDEX].oneOf.1.provider.oneOf.0","typeLabel":"string"},{"type":"null","description":"Target provider (omit to keep the request's provider). Moving to another provider clears a key the routing rules pinned.","conditionalRequirements":[{"when":[[{"property":"key_id"}]]}],"uniqueKey":"targets.items.[INDEX].oneOf.1.provider.oneOf.1","typeLabel":"null"}],"conditionalRequirements":[{"when":[[{"property":"key_id"}]]}],"uniqueKey":"targets.items.[INDEX].oneOf.1.provider","typeLabel":"string | null"},"key_id":{"oneOf":[{"type":"string","description":"UUID of the API key to pin for this target","uniqueKey":"targets.items.[INDEX].oneOf.1.key_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"UUID of the API key to pin for this target","uniqueKey":"targets.items.[INDEX].oneOf.1.key_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"targets.items.[INDEX].oneOf.1.key_id","typeLabel":"string | null"},"fallbacks":{"type":"array","description":"Fallback chain used when this target is chosen. A non-empty list replaces the request's chain; omit it or send [] to keep the chain the routing rules set.","items":{"oneOf":[{"type":"string","description":"A fallback in a routing rule's chain. Either the \"provider/model\" string (\"provider/\" keeps the incoming model), or an object that additionally pins a provider key.","minLength":1,"uniqueKey":"targets.items.[INDEX].oneOf.1.fallbacks.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"object","description":"A fallback in a routing rule's chain. Either the \"provider/model\" string (\"provider/\" keeps the incoming model), or an object that additionally pins a provider key.","required":["provider"],"properties":{"provider":{"type":"string","minLength":1,"description":"Fallback provider","isRequired":true,"uniqueKey":"targets.items.[INDEX].oneOf.1.fallbacks.items.[INDEX].oneOf.1.provider","typeLabel":"string"},"model":{"oneOf":[{"type":"string","description":"Fallback model (omit or empty to use the incoming request model)","uniqueKey":"targets.items.[INDEX].oneOf.1.fallbacks.items.[INDEX].oneOf.1.model.oneOf.0","typeLabel":"string"},{"type":"null","description":"Fallback model (omit or empty to use the incoming request model)","uniqueKey":"targets.items.[INDEX].oneOf.1.fallbacks.items.[INDEX].oneOf.1.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"targets.items.[INDEX].oneOf.1.fallbacks.items.[INDEX].oneOf.1.model","typeLabel":"string | null"},"key_id":{"oneOf":[{"type":"string","description":"UUID of the API key to pin for this fallback (omit for load-balanced key selection). A fallback whose pinned key is missing from the provider's pool is skipped.","uniqueKey":"targets.items.[INDEX].oneOf.1.fallbacks.items.[INDEX].oneOf.1.key_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"UUID of the API key to pin for this fallback (omit for load-balanced key selection). A fallback whose pinned key is missing from the provider's pool is skipped.","uniqueKey":"targets.items.[INDEX].oneOf.1.fallbacks.items.[INDEX].oneOf.1.key_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"targets.items.[INDEX].oneOf.1.fallbacks.items.[INDEX].oneOf.1.key_id","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"targets.items.[INDEX].oneOf.1.fallbacks.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"targets.items.[INDEX].oneOf.1.fallbacks.items.[INDEX]","typeLabel":"string | object"},"uniqueKey":"targets.items.[INDEX].oneOf.1.fallbacks","typeLabel":"(string | object)[]"}},"additionalProperties":false,"uniqueKey":"targets.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"targets.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"targets","typeLabel":"object[]"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"targets":[{"provider":"\u003cstring>","weight":123,"model":"\u003cstring>","key_id":"\u003cstring>","fallbacks":["\u003cstring>"]}]}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"baa17444-a6aa-4f50-93a7-8eb293fe26f3":{"description":"Model router targets saved successfully","content":{"application/json":{"schema":{"type":"object","description":"A model router - an id, a name and a description beside the same settings as ComplexityAnalyzerConfig, sent and returned at the top level; its phrase suggestions, which only model routers make; the model each tier gets; and the routing that decides which requests it takes. Routers are separate from the complexity analyzer config, which routing rules read complexity_tier from. The cross-field rules of ComplexityAnalyzerConfig apply, and the suggestion rules below.","required":["name","keywords"],"conditionallyRequiredProperties":{"semantic":[{},{}],"llm":[{},{},{"when":[[{"property":"classifier","values":["llm"]}]]}]},"properties":{"name":{"type":"string","minLength":1,"maxLength":255,"description":"Display name, unique across routers.","isRequired":true,"uniqueKey":"name","typeLabel":"string"},"keywords":{"type":"object","description":"Reference phrases for semantic complexity classification, one list per tier.\nEach request is embedded and takes the tier of its nearest phrase. Entries\nshould be whole example prompts rather than individual keywords. Each phrase\nis limited to 2000 characters, the normalized lists may contain at most 750\nphrases combined, and the same phrase cannot appear in two tiers. The field\nnames predate semantic classification and are kept for backward compatibility.\n","additionalProperties":false,"required":["simple_keywords","medium_keywords","complex_keywords"],"properties":{"simple_keywords":{"type":"array","description":"Reference phrases for the SIMPLE tier (50 built-in defaults)","items":{"type":"string","maxLength":2000,"uniqueKey":"keywords.simple_keywords.items.[INDEX]","typeLabel":"string"},"minItems":1,"isRequired":true,"uniqueKey":"keywords.simple_keywords","typeLabel":"string[]"},"medium_keywords":{"type":"array","description":"Reference phrases for the MEDIUM tier (50 built-in defaults)","items":{"type":"string","maxLength":2000,"uniqueKey":"keywords.medium_keywords.items.[INDEX]","typeLabel":"string"},"minItems":1,"isRequired":true,"uniqueKey":"keywords.medium_keywords","typeLabel":"string[]"},"complex_keywords":{"type":"array","description":"Reference phrases for the COMPLEX tier (50 built-in defaults)","items":{"type":"string","maxLength":2000,"uniqueKey":"keywords.complex_keywords.items.[INDEX]","typeLabel":"string"},"minItems":1,"isRequired":true,"uniqueKey":"keywords.complex_keywords","typeLabel":"string[]"}},"isRequired":true,"uniqueKey":"keywords","typeLabel":"object"},"id":{"type":"string","maxLength":64,"pattern":"^[A-Za-z0-9_-]+$","not":{"const":"defaults"},"description":"Stable router id; generated when omitted on create. `defaults` is reserved, since it names the endpoint that serves a new router's defaults.","uniqueKey":"id","typeLabel":"string"},"description":{"type":"string","uniqueKey":"description","typeLabel":"string"},"tier_boundaries":{"type":"object","deprecated":true,"description":"Deprecated score thresholds for the retired lexical complexity classifier.\nThis block is optional and ignored by semantic classification, but remains\naccepted for backward compatibility. When supplied, values must satisfy\n0 \u003c simple_medium \u003c medium_complex \u003c 1.\n","additionalProperties":false,"required":["simple_medium","medium_complex"],"properties":{"simple_medium":{"type":"number","deprecated":true,"description":"Deprecated score boundary between SIMPLE and MEDIUM tiers (ignored by semantic classification)","exclusiveMinimum":0,"exclusiveMaximum":1,"isRequired":true,"uniqueKey":"tier_boundaries.simple_medium","typeLabel":"number"},"medium_complex":{"type":"number","deprecated":true,"description":"Deprecated score boundary between MEDIUM and COMPLEX tiers (ignored by semantic classification)","exclusiveMinimum":0,"exclusiveMaximum":1,"isRequired":true,"uniqueKey":"tier_boundaries.medium_complex","typeLabel":"number"}},"uniqueKey":"tier_boundaries","typeLabel":"object"},"classifier":{"type":"string","enum":["semantic","decision","llm"],"default":"semantic","description":"Primary complexity classifier. llm classifies with the model in the llm block.","uniqueKey":"classifier","typeLabel":"enum\u003cstring>"},"semantic":{"type":"object","description":"Embedding configuration for semantic complexity classification. When absent,\nno complexity tier is published and rules referencing complexity_tier fall\nthrough. The provider must have an enabled key.\n","additionalProperties":false,"required":["provider","embedding_model"],"properties":{"provider":{"type":"string","minLength":1,"description":"Provider used for embedding calls (must have an enabled key)","isRequired":true,"uniqueKey":"semantic.provider","typeLabel":"string"},"embedding_model":{"type":"string","minLength":1,"description":"Embedding model, e.g. text-embedding-3-small","isRequired":true,"uniqueKey":"semantic.embedding_model","typeLabel":"string"},"timeout":{"oneOf":[{"type":"string","description":"Ceiling on the inline embedding call. Accepts a duration string (\"1.5s\") or milliseconds as a number. Default 1.5s; exceeding it publishes no tier for that request.","pattern":"^[0-9]+(\\.[0-9]+)?(ns|us|µs|ms|s|m|h)$","uniqueKey":"semantic.timeout.oneOf.0","typeLabel":"string"},{"type":"number","description":"Ceiling on the inline embedding call. Accepts a duration string (\"1.5s\") or milliseconds as a number. Default 1.5s; exceeding it publishes no tier for that request.","minimum":0,"exclusiveMinimum":true,"uniqueKey":"semantic.timeout.oneOf.1","typeLabel":"number"}],"uniqueKey":"semantic.timeout","typeLabel":"string | number"},"min_similarity":{"type":"number","minimum":0,"exclusiveMaximum":1,"description":"Similarity floor for the nearest reference phrase; below it no tier is published. 0 (default) accepts the nearest eligible match. Compared against the vector store backend's own similarity scale (raw cosine for chromem/Qdrant/Pinecone/Redis, certainty for Weaviate).","uniqueKey":"semantic.min_similarity","typeLabel":"number"},"message_history_count":{"type":"integer","minimum":1,"maximum":10,"description":"Number of recent user messages joined oldest-first into the embedded text. 1 (default) embeds only the latest message. System prompts and assistant replies are never embedded.","uniqueKey":"semantic.message_history_count","typeLabel":"integer"},"count_toward_budgets":{"type":"boolean","description":"Whether embedding usage counts toward virtual-key budgets (default false)","uniqueKey":"semantic.count_toward_budgets","typeLabel":"boolean"},"vector_store":{"type":"string","enum":["embedded","vector_store"],"description":"Where reference-phrase embeddings live. `embedded` (default) uses the\nbuilt-in in-memory store, so phrases are re-embedded on every restart.\n`vector_store` uses the top-level `vector_store` when one is configured\nand falls back to the embedded store otherwise.\n","uniqueKey":"semantic.vector_store","typeLabel":"enum\u003cstring>"},"fallback":{"type":"string","enum":["none","llm","decision"],"description":"What answers when semantic classification produces no tier. `none`\n(the default) records the request as skipped, `llm` uses the configured\nchat model, and `decision` uses the configured decision model.\n","uniqueKey":"semantic.fallback","typeLabel":"enum\u003cstring>"}},"conditionalRequirements":[{},{}],"uniqueKey":"semantic","typeLabel":"object"},"decision":{"type":"object","description":"Decision-model complexity-classifier request settings. Credentials come from the selected provider's configuration.","additionalProperties":false,"properties":{"provider":{"type":"string","description":"Provider serving the decision model, e.g. `typesafe`, `cloudflare` (Clef), or a custom provider with `base_provider_type` `typesafe` (Laya, Nimble). Set together with `model`; leave both empty for `typesafe`/`jev-latest`.","uniqueKey":"decision.provider","typeLabel":"string"},"model":{"type":"string","description":"Decision model on that provider, e.g. `jev-latest`, `@cf/cloudflare/clef-flash`, `nimble-latest`, `english`. Set together with `provider`; leave both empty for `typesafe`/`jev-latest`.","uniqueKey":"decision.model","typeLabel":"string"},"previous_message_count":{"type":"integer","minimum":0,"maximum":5,"default":1,"description":"Number of preceding user messages sent with the current user request. Assistant messages are excluded.","uniqueKey":"decision.previous_message_count","typeLabel":"integer"},"timeout":{"oneOf":[{"type":"string","description":"Maximum decision-model classification latency. Accepts a duration string or milliseconds as a number; default 1500ms.","pattern":"^[0-9]+(\\.[0-9]+)?(ns|us|µs|ms|s|m|h)$","uniqueKey":"decision.timeout.oneOf.0","typeLabel":"string"},{"type":"number","description":"Maximum decision-model classification latency. Accepts a duration string or milliseconds as a number; default 1500ms.","minimum":0,"uniqueKey":"decision.timeout.oneOf.1","typeLabel":"number"}],"uniqueKey":"decision.timeout","typeLabel":"string | number"},"min_confidence":{"type":"number","minimum":0,"maximum":1,"default":0,"description":"Confidence an answer must reach to publish its tier. An answer below it publishes no tier. A missing confidence is derived from the tier probabilities; an answer with neither is kept. 0 keeps every answer.","uniqueKey":"decision.min_confidence","typeLabel":"number"},"criteria":{"type":"object","description":"Per-tier overrides of the shipped decision-model definitions, signals, and examples. Any tier or field left out sends the default.","additionalProperties":false,"properties":{"SIMPLE":{"type":"object","additionalProperties":false,"properties":{"definition":{"type":"string","maxLength":500,"description":"Replaces this tier's shipped definition. Omit to use the default.","uniqueKey":"decision.criteria.SIMPLE.definition","typeLabel":"string"},"signals":{"type":"array","maxItems":12,"items":{"type":"string","maxLength":300,"uniqueKey":"decision.criteria.SIMPLE.signals.items.[INDEX]","typeLabel":"string"},"description":"Replaces this tier's shipped signals. Omit to use the default.","uniqueKey":"decision.criteria.SIMPLE.signals","typeLabel":"string[]"},"examples":{"type":"array","maxItems":12,"items":{"type":"string","maxLength":300,"uniqueKey":"decision.criteria.SIMPLE.examples.items.[INDEX]","typeLabel":"string"},"description":"Replaces this tier's shipped examples. Omit to use the default.","uniqueKey":"decision.criteria.SIMPLE.examples","typeLabel":"string[]"}},"uniqueKey":"decision.criteria.SIMPLE","typeLabel":"object"},"MEDIUM":{"type":"object","additionalProperties":false,"properties":{"definition":{"type":"string","maxLength":500,"description":"Replaces this tier's shipped definition. Omit to use the default.","uniqueKey":"decision.criteria.MEDIUM.definition","typeLabel":"string"},"signals":{"type":"array","maxItems":12,"items":{"type":"string","maxLength":300,"uniqueKey":"decision.criteria.MEDIUM.signals.items.[INDEX]","typeLabel":"string"},"description":"Replaces this tier's shipped signals. Omit to use the default.","uniqueKey":"decision.criteria.MEDIUM.signals","typeLabel":"string[]"},"examples":{"type":"array","maxItems":12,"items":{"type":"string","maxLength":300,"uniqueKey":"decision.criteria.MEDIUM.examples.items.[INDEX]","typeLabel":"string"},"description":"Replaces this tier's shipped examples. Omit to use the default.","uniqueKey":"decision.criteria.MEDIUM.examples","typeLabel":"string[]"}},"uniqueKey":"decision.criteria.MEDIUM","typeLabel":"object"},"COMPLEX":{"type":"object","additionalProperties":false,"properties":{"definition":{"type":"string","maxLength":500,"description":"Replaces this tier's shipped definition. Omit to use the default.","uniqueKey":"decision.criteria.COMPLEX.definition","typeLabel":"string"},"signals":{"type":"array","maxItems":12,"items":{"type":"string","maxLength":300,"uniqueKey":"decision.criteria.COMPLEX.signals.items.[INDEX]","typeLabel":"string"},"description":"Replaces this tier's shipped signals. Omit to use the default.","uniqueKey":"decision.criteria.COMPLEX.signals","typeLabel":"string[]"},"examples":{"type":"array","maxItems":12,"items":{"type":"string","maxLength":300,"uniqueKey":"decision.criteria.COMPLEX.examples.items.[INDEX]","typeLabel":"string"},"description":"Replaces this tier's shipped examples. Omit to use the default.","uniqueKey":"decision.criteria.COMPLEX.examples","typeLabel":"string[]"}},"uniqueKey":"decision.criteria.COMPLEX","typeLabel":"object"}},"uniqueKey":"decision.criteria","typeLabel":"object"}},"uniqueKey":"decision","typeLabel":"object"},"llm":{"type":"object","description":"Chat-completion (LLM) classifier settings. Used as the primary classifier\nwhen `classifier` is `llm`, and as the fallback when `semantic.fallback`\nselects `llm`, where it runs only after semantic classification produces no\ntier. Otherwise the block is kept but not used. Tier names (SIMPLE, MEDIUM,\nCOMPLEX) and the response format are fixed: the gateway always appends a\nnon-editable reinforcement stating them.\n","additionalProperties":false,"required":["provider","model"],"properties":{"provider":{"type":"string","minLength":1,"description":"Provider used to run the classification chat completion (must have an enabled key)","isRequired":true,"uniqueKey":"llm.provider","typeLabel":"string"},"model":{"type":"string","minLength":1,"description":"Chat model asked to name the tier. Every classification it makes waits on one completion from this model, so pick a small, fast one.","isRequired":true,"uniqueKey":"llm.model","typeLabel":"string"},"timeout":{"oneOf":[{"type":"string","description":"Per-request classification timeout. Accepts a duration string (\"2s\") or milliseconds as a number. Default 4s. On timeout no complexity tier is published and the request is recorded as skipped.","pattern":"^[0-9]+(\\.[0-9]+)?(ns|us|µs|ms|s|m|h)$","uniqueKey":"llm.timeout.oneOf.0","typeLabel":"string"},{"type":"number","description":"Per-request classification timeout. Accepts a duration string (\"2s\") or milliseconds as a number. Default 4s. On timeout no complexity tier is published and the request is recorded as skipped.","minimum":0,"exclusiveMinimum":true,"uniqueKey":"llm.timeout.oneOf.1","typeLabel":"number"}],"uniqueKey":"llm.timeout","typeLabel":"string | number"},"prompt":{"type":"string","maxLength":4000,"description":"Replaces the shipped classification guidance (max 4000 characters); empty means the shipped guidance is used. The tier-name and response-format reinforcement is appended by the gateway either way and cannot be edited.","uniqueKey":"llm.prompt","typeLabel":"string"},"message_history_count":{"type":"integer","minimum":1,"maximum":10,"description":"How many of the most recent user messages are given to the classifier, oldest first (default 1, the latest message only). Only user turns count; system prompts and assistant replies are never sent.","uniqueKey":"llm.message_history_count","typeLabel":"integer"},"count_toward_budgets":{"type":"boolean","description":"Whether classification completion cost counts toward virtual-key budgets (record-only, never enforced; default false)","uniqueKey":"llm.count_toward_budgets","typeLabel":"boolean"}},"conditionalRequirements":[{},{},{"when":[[{"property":"classifier","values":["llm"]}]]}],"uniqueKey":"llm","typeLabel":"object"},"session":{"type":"object","description":"Session-aware complexity routing. When enabled and a supported session identity is present, Bifrost retains the highest tier observed across normally sequential turns for 24 hours of inactivity. It uses the configured primary classifier and is independent of provider session stickiness.","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Enable monotonic session tier retention; default is false.","isRequired":true,"uniqueKey":"session.enabled","typeLabel":"boolean"}},"uniqueKey":"session","typeLabel":"object"},"suggestions":{"type":"object","description":"Phrase suggestions for the semantic router. When enabled, a sample of the vectors the semantic classifier already computes is kept under each request's log ID (request text stays in the logs), and a run on the schedule clusters that traffic and asks the suggestion model for phrases. Vectors are captured only into the top-level vector_store, and not when that is Chromem, which keeps them in each gateway's memory; with no vector_store, or only the semantic classifier's embedded store, nothing is captured and no run has traffic to read. Captured vectors are deleted with their logs, and become due for deletion after lookback_days or the log retention, whichever is shorter; an hourly cleanup removes them, so one can remain up to an hour past that, and longer while the vector store is unavailable.","additionalProperties":false,"required":["enabled"],"properties":{"enabled":{"type":"boolean","description":"Capture a sample of classified requests and run suggestions on the schedule; default false. Runs started through the API need this block and a suggestion model (provider and model here, or an llm block), not enabled; a router left at false runs suggestions only on demand, each run first embedding the router's logged requests in its window that are not yet captured - the sample_rate share of those whose content was logged, up to max_clustered_requests per run and newest first, so a smaller backlog is embedded in full and older requests past the limit wait for later runs. A run started without a suggestion model is accepted and then fails. Estimates and impact replays need this block but not the suggestion model, which they do not call. Capture needs a top-level vector_store other than Chromem; without one, enabling captures nothing. Enabling requires the semantic classifier as the primary classifier (a semantic block, classifier not decision) and a suggestion model (provider and model here, or an llm block).","isRequired":true,"uniqueKey":"suggestions.enabled","typeLabel":"boolean"},"sample_rate":{"type":"number","exclusiveMinimum":0,"maximum":1,"description":"Share of classified requests captured; default 0.1.","uniqueKey":"suggestions.sample_rate","typeLabel":"number"},"lookback_days":{"type":"integer","minimum":1,"maximum":90,"description":"Days of captured traffic a run draws on, and how long captured vectors are kept; default 7.","uniqueKey":"suggestions.lookback_days","typeLabel":"integer"},"schedule":{"type":"object","description":"When suggestion runs start - at start_at and every fixed interval after it, the same on every node. Default daily at 03:00 UTC.","additionalProperties":false,"properties":{"every":{"type":"string","pattern":"^([1-9]|1[0-9]|2[0-3])h$|^([1-9]|[12][0-9]|30)d$|^[1-4]w$","description":"The interval, as a fixed duration - hours (1h-23h), days (1d-30d) or weeks (1w-4w). Default 1d.","example":"1d","uniqueKey":"suggestions.schedule.every","typeLabel":"string"},"start_at":{"type":"string","format":"date-time","description":"The first run, an RFC 3339 time such as 2026-11-12T03:00:00Z. Runs repeat every interval from it, so it also sets the time of day (in UTC - a daily run moves by an hour of local time across a daylight-saving change). Default 1970-01-01T03:00:00Z.","example":"2026-11-12T03:00:00Z","uniqueKey":"suggestions.schedule.start_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"suggestions.schedule","typeLabel":"object"},"max_clustered_requests":{"type":"integer","minimum":1000,"maximum":100000,"description":"Most captured requests one run clusters; the rest of the window is counted into the clusters found. Default 20000.","uniqueKey":"suggestions.max_clustered_requests","typeLabel":"integer"},"min_cluster_requests":{"type":"integer","minimum":2,"maximum":1000,"description":"Smallest cluster, in requests, a suggestion is written for; default 6. A run raises it to 0.1% of the requests in its window when that is larger.","uniqueKey":"suggestions.min_cluster_requests","typeLabel":"integer"},"provider":{"type":"string","minLength":1,"description":"Provider of the suggestion model. Set together with model; both omitted use the llm block's model.","conditionalRequirements":[{"when":[[{"property":"model"}]]}],"uniqueKey":"suggestions.provider","typeLabel":"string"},"model":{"type":"string","minLength":1,"description":"Suggestion model. Set together with provider; both omitted use the llm block's model.","conditionalRequirements":[{"when":[[{"property":"provider"}]]}],"uniqueKey":"suggestions.model","typeLabel":"string"},"instructions":{"type":"string","maxLength":8000,"description":"Replaces the shipped suggestion instructions (served as suggestion_default_instructions by the status endpoint). Tier definitions and the fixed output and safety rules are added either way.","uniqueKey":"suggestions.instructions","typeLabel":"string"},"tier":{"type":"object","description":"How each suggestion's tier is decided, after its phrases are written. Omitted: the llm classifier on the phrase model.","properties":{"classifier":{"type":"string","enum":["llm","decision"],"description":"llm: a chat model prompted with instructions, the tier definitions, and the router's own phrases as examples. decision: a decision model asked one choice question with the router's tier definitions and its own phrases as examples. Shipped default phrases are never used as examples.","uniqueKey":"suggestions.tier.classifier","typeLabel":"enum\u003cstring>"},"provider":{"type":"string","minLength":1,"description":"Provider of the tier model. Set together with model; both omitted take the phrase model (llm) or the decision block's model, else the shipped decision model (decision), when the config is saved.","conditionalRequirements":[{"when":[[{"property":"model"}]]}],"uniqueKey":"suggestions.tier.provider","typeLabel":"string"},"model":{"type":"string","minLength":1,"description":"Tier model. Set together with provider.","conditionalRequirements":[{"when":[[{"property":"provider"}]]}],"uniqueKey":"suggestions.tier.model","typeLabel":"string"},"prompt":{"type":"string","maxLength":16000,"description":"llm only: the whole tier prompt (instructions, tier definitions and examples), sent as written followed by the fixed output and safety rules. Empty: generated by each run from the router's tier definitions and its own phrases. The generated text is served as suggestion_default_tier_prompt by the model router status endpoint.","uniqueKey":"suggestions.tier.prompt","typeLabel":"string"},"instructions":{"type":"string","maxLength":8000,"description":"decision only: the choice question's instructions, sent as written. Empty: the shipped instructions. Served as suggestion_default_tier_instructions.","uniqueKey":"suggestions.tier.instructions","typeLabel":"string"},"criteria":{"type":"object","description":"decision only: each tier's definition, signals and examples, sent as written as that tier's choice. A tier left out is generated from the router (its decision definitions and signals, its own phrases as examples). The generated criteria are served as suggestion_default_tier_criteria.","properties":{"SIMPLE":{"type":"object","properties":{"definition":{"type":"string","minLength":1,"maxLength":500,"isRequired":true,"uniqueKey":"suggestions.tier.criteria.SIMPLE.definition","typeLabel":"string"},"signals":{"type":"array","maxItems":12,"items":{"type":"string","maxLength":300,"uniqueKey":"suggestions.tier.criteria.SIMPLE.signals.items.[INDEX]","typeLabel":"string"},"uniqueKey":"suggestions.tier.criteria.SIMPLE.signals","typeLabel":"string[]"},"examples":{"type":"array","maxItems":12,"items":{"type":"string","maxLength":300,"uniqueKey":"suggestions.tier.criteria.SIMPLE.examples.items.[INDEX]","typeLabel":"string"},"uniqueKey":"suggestions.tier.criteria.SIMPLE.examples","typeLabel":"string[]"}},"required":["definition"],"additionalProperties":false,"uniqueKey":"suggestions.tier.criteria.SIMPLE","typeLabel":"object"},"MEDIUM":{"type":"object","properties":{"definition":{"type":"string","minLength":1,"maxLength":500,"isRequired":true,"uniqueKey":"suggestions.tier.criteria.MEDIUM.definition","typeLabel":"string"},"signals":{"type":"array","maxItems":12,"items":{"type":"string","maxLength":300,"uniqueKey":"suggestions.tier.criteria.MEDIUM.signals.items.[INDEX]","typeLabel":"string"},"uniqueKey":"suggestions.tier.criteria.MEDIUM.signals","typeLabel":"string[]"},"examples":{"type":"array","maxItems":12,"items":{"type":"string","maxLength":300,"uniqueKey":"suggestions.tier.criteria.MEDIUM.examples.items.[INDEX]","typeLabel":"string"},"uniqueKey":"suggestions.tier.criteria.MEDIUM.examples","typeLabel":"string[]"}},"required":["definition"],"additionalProperties":false,"uniqueKey":"suggestions.tier.criteria.MEDIUM","typeLabel":"object"},"COMPLEX":{"type":"object","properties":{"definition":{"type":"string","minLength":1,"maxLength":500,"isRequired":true,"uniqueKey":"suggestions.tier.criteria.COMPLEX.definition","typeLabel":"string"},"signals":{"type":"array","maxItems":12,"items":{"type":"string","maxLength":300,"uniqueKey":"suggestions.tier.criteria.COMPLEX.signals.items.[INDEX]","typeLabel":"string"},"uniqueKey":"suggestions.tier.criteria.COMPLEX.signals","typeLabel":"string[]"},"examples":{"type":"array","maxItems":12,"items":{"type":"string","maxLength":300,"uniqueKey":"suggestions.tier.criteria.COMPLEX.examples.items.[INDEX]","typeLabel":"string"},"uniqueKey":"suggestions.tier.criteria.COMPLEX.examples","typeLabel":"string[]"}},"required":["definition"],"additionalProperties":false,"uniqueKey":"suggestions.tier.criteria.COMPLEX","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"suggestions.tier.criteria","typeLabel":"object"}},"additionalProperties":false,"conditionallyRequiredProperties":{"model":[{"when":[[{"property":"provider"}]]}],"provider":[{"when":[[{"property":"model"}]]}]},"uniqueKey":"suggestions.tier","typeLabel":"object"}},"conditionallyRequiredProperties":{"model":[{"when":[[{"property":"provider"}]]}],"provider":[{"when":[[{"property":"model"}]]}]},"uniqueKey":"suggestions","typeLabel":"object"},"targets":{"type":"array","readOnly":true,"description":"The model each tier gets. Returned with the router; set with PUT /api/routing/model-routers/{router_id}/targets. Ignored in a create or update body.","items":{"oneOf":[{"type":"object","description":"One model for one tier of a model router. Omitting provider or model keeps the request's value, but a target sets at least one.","required":["tier","weight","provider"],"conditionallyRequiredProperties":{"provider":[{"when":[[{"property":"key_id"}]]}]},"properties":{"provider":{"type":"string","description":"Target provider (omit to keep the request's provider). Moving to another provider clears a key the routing rules pinned.","minLength":1,"isRequired":true,"uniqueKey":"targets.items.[INDEX].oneOf.0.provider","typeLabel":"string"},"tier":{"type":"string","enum":["SIMPLE","MEDIUM","COMPLEX"],"isRequired":true,"uniqueKey":"targets.items.[INDEX].oneOf.0.tier","typeLabel":"enum\u003cstring>"},"weight":{"type":"number","format":"double","exclusiveMinimum":0,"description":"Probability weight within the tier; the weights of a tier sum to 1.","isRequired":true,"uniqueKey":"targets.items.[INDEX].oneOf.0.weight","typeLabel":"number\u003cdouble>"},"model":{"oneOf":[{"type":"string","description":"Target model (omit to keep the request's model)","uniqueKey":"targets.items.[INDEX].oneOf.0.model.oneOf.0","typeLabel":"string"},{"type":"null","description":"Target model (omit to keep the request's model)","uniqueKey":"targets.items.[INDEX].oneOf.0.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"targets.items.[INDEX].oneOf.0.model","typeLabel":"string | null"},"key_id":{"oneOf":[{"type":"string","description":"UUID of the API key to pin for this target","uniqueKey":"targets.items.[INDEX].oneOf.0.key_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"UUID of the API key to pin for this target","uniqueKey":"targets.items.[INDEX].oneOf.0.key_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"targets.items.[INDEX].oneOf.0.key_id","typeLabel":"string | null"},"fallbacks":{"type":"array","description":"Fallback chain used when this target is chosen. A non-empty list replaces the request's chain; omit it or send [] to keep the chain the routing rules set.","items":{"oneOf":[{"type":"string","description":"A fallback in a routing rule's chain. Either the \"provider/model\" string (\"provider/\" keeps the incoming model), or an object that additionally pins a provider key.","minLength":1,"uniqueKey":"targets.items.[INDEX].oneOf.0.fallbacks.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"object","description":"A fallback in a routing rule's chain. Either the \"provider/model\" string (\"provider/\" keeps the incoming model), or an object that additionally pins a provider key.","required":["provider"],"properties":{"provider":{"type":"string","minLength":1,"description":"Fallback provider","isRequired":true,"uniqueKey":"targets.items.[INDEX].oneOf.0.fallbacks.items.[INDEX].oneOf.1.provider","typeLabel":"string"},"model":{"oneOf":[{"type":"string","description":"Fallback model (omit or empty to use the incoming request model)","uniqueKey":"targets.items.[INDEX].oneOf.0.fallbacks.items.[INDEX].oneOf.1.model.oneOf.0","typeLabel":"string"},{"type":"null","description":"Fallback model (omit or empty to use the incoming request model)","uniqueKey":"targets.items.[INDEX].oneOf.0.fallbacks.items.[INDEX].oneOf.1.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"targets.items.[INDEX].oneOf.0.fallbacks.items.[INDEX].oneOf.1.model","typeLabel":"string | null"},"key_id":{"oneOf":[{"type":"string","description":"UUID of the API key to pin for this fallback (omit for load-balanced key selection). A fallback whose pinned key is missing from the provider's pool is skipped.","uniqueKey":"targets.items.[INDEX].oneOf.0.fallbacks.items.[INDEX].oneOf.1.key_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"UUID of the API key to pin for this fallback (omit for load-balanced key selection). A fallback whose pinned key is missing from the provider's pool is skipped.","uniqueKey":"targets.items.[INDEX].oneOf.0.fallbacks.items.[INDEX].oneOf.1.key_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"targets.items.[INDEX].oneOf.0.fallbacks.items.[INDEX].oneOf.1.key_id","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"targets.items.[INDEX].oneOf.0.fallbacks.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"targets.items.[INDEX].oneOf.0.fallbacks.items.[INDEX]","typeLabel":"string | object"},"uniqueKey":"targets.items.[INDEX].oneOf.0.fallbacks","typeLabel":"(string | object)[]"}},"additionalProperties":false,"uniqueKey":"targets.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"One model for one tier of a model router. Omitting provider or model keeps the request's value, but a target sets at least one.","required":["tier","weight","model"],"conditionallyRequiredProperties":{"provider":[{"when":[[{"property":"key_id"}]]}]},"properties":{"model":{"type":"string","description":"Target model (omit to keep the request's model)","minLength":1,"isRequired":true,"uniqueKey":"targets.items.[INDEX].oneOf.1.model","typeLabel":"string"},"tier":{"type":"string","enum":["SIMPLE","MEDIUM","COMPLEX"],"isRequired":true,"uniqueKey":"targets.items.[INDEX].oneOf.1.tier","typeLabel":"enum\u003cstring>"},"weight":{"type":"number","format":"double","exclusiveMinimum":0,"description":"Probability weight within the tier; the weights of a tier sum to 1.","isRequired":true,"uniqueKey":"targets.items.[INDEX].oneOf.1.weight","typeLabel":"number\u003cdouble>"},"provider":{"oneOf":[{"type":"string","description":"Target provider (omit to keep the request's provider). Moving to another provider clears a key the routing rules pinned.","conditionalRequirements":[{"when":[[{"property":"key_id"}]]}],"uniqueKey":"targets.items.[INDEX].oneOf.1.provider.oneOf.0","typeLabel":"string"},{"type":"null","description":"Target provider (omit to keep the request's provider). Moving to another provider clears a key the routing rules pinned.","conditionalRequirements":[{"when":[[{"property":"key_id"}]]}],"uniqueKey":"targets.items.[INDEX].oneOf.1.provider.oneOf.1","typeLabel":"null"}],"conditionalRequirements":[{"when":[[{"property":"key_id"}]]}],"uniqueKey":"targets.items.[INDEX].oneOf.1.provider","typeLabel":"string | null"},"key_id":{"oneOf":[{"type":"string","description":"UUID of the API key to pin for this target","uniqueKey":"targets.items.[INDEX].oneOf.1.key_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"UUID of the API key to pin for this target","uniqueKey":"targets.items.[INDEX].oneOf.1.key_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"targets.items.[INDEX].oneOf.1.key_id","typeLabel":"string | null"},"fallbacks":{"type":"array","description":"Fallback chain used when this target is chosen. A non-empty list replaces the request's chain; omit it or send [] to keep the chain the routing rules set.","items":{"oneOf":[{"type":"string","description":"A fallback in a routing rule's chain. Either the \"provider/model\" string (\"provider/\" keeps the incoming model), or an object that additionally pins a provider key.","minLength":1,"uniqueKey":"targets.items.[INDEX].oneOf.1.fallbacks.items.[INDEX].oneOf.0","typeLabel":"string"},{"type":"object","description":"A fallback in a routing rule's chain. Either the \"provider/model\" string (\"provider/\" keeps the incoming model), or an object that additionally pins a provider key.","required":["provider"],"properties":{"provider":{"type":"string","minLength":1,"description":"Fallback provider","isRequired":true,"uniqueKey":"targets.items.[INDEX].oneOf.1.fallbacks.items.[INDEX].oneOf.1.provider","typeLabel":"string"},"model":{"oneOf":[{"type":"string","description":"Fallback model (omit or empty to use the incoming request model)","uniqueKey":"targets.items.[INDEX].oneOf.1.fallbacks.items.[INDEX].oneOf.1.model.oneOf.0","typeLabel":"string"},{"type":"null","description":"Fallback model (omit or empty to use the incoming request model)","uniqueKey":"targets.items.[INDEX].oneOf.1.fallbacks.items.[INDEX].oneOf.1.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"targets.items.[INDEX].oneOf.1.fallbacks.items.[INDEX].oneOf.1.model","typeLabel":"string | null"},"key_id":{"oneOf":[{"type":"string","description":"UUID of the API key to pin for this fallback (omit for load-balanced key selection). A fallback whose pinned key is missing from the provider's pool is skipped.","uniqueKey":"targets.items.[INDEX].oneOf.1.fallbacks.items.[INDEX].oneOf.1.key_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"UUID of the API key to pin for this fallback (omit for load-balanced key selection). A fallback whose pinned key is missing from the provider's pool is skipped.","uniqueKey":"targets.items.[INDEX].oneOf.1.fallbacks.items.[INDEX].oneOf.1.key_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"targets.items.[INDEX].oneOf.1.fallbacks.items.[INDEX].oneOf.1.key_id","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"targets.items.[INDEX].oneOf.1.fallbacks.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"targets.items.[INDEX].oneOf.1.fallbacks.items.[INDEX]","typeLabel":"string | object"},"uniqueKey":"targets.items.[INDEX].oneOf.1.fallbacks","typeLabel":"(string | object)[]"}},"additionalProperties":false,"uniqueKey":"targets.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"targets.items.[INDEX]","typeLabel":"object"},"uniqueKey":"targets","typeLabel":"object[]"},"routing":{"type":"object","description":"Which requests the router takes. Always returned. Optional on create, where omitting it starts the router off, global, with the priority after the last global router. Ignored in an update body; set it with PUT /api/routing/model-routers/{router_id}/routing.","conditionallyRequiredProperties":{"scope_id":[{}]},"properties":{"enabled":{"type":"boolean","default":false,"description":"Whether the router takes requests.","uniqueKey":"routing.enabled","typeLabel":"boolean"},"scope":{"type":"string","enum":["global","team","customer","virtual_key","user"],"default":"global","description":"Scope level. The team, customer or virtual key named by scope_id must exist (400 otherwise); a user scope_id is not checked.","uniqueKey":"routing.scope","typeLabel":"enum\u003cstring>"},"scope_id":{"oneOf":[{"type":"string","description":"ID of the scope's entity. Required when scope is not global; dropped for global.","conditionalRequirements":[{}],"uniqueKey":"routing.scope_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"ID of the scope's entity. Required when scope is not global; dropped for global.","conditionalRequirements":[{}],"uniqueKey":"routing.scope_id.oneOf.1","typeLabel":"null"}],"conditionalRequirements":[{}],"uniqueKey":"routing.scope_id","typeLabel":"string | null"},"cel_expression":{"type":"string","description":"Optional CEL condition over the request as the routing rules left it. Empty takes every request in the scope. A condition of model == \"\u003cname>\" lets apps ask for the router by that model name. Cannot use complexity_tier, which the router decides once it takes the request.","uniqueKey":"routing.cel_expression","typeLabel":"string"},"query":{"oneOf":[{"type":"object","description":"Visual condition builder state (react-querybuilder combinator and rules). Not evaluated; cel_expression is.","uniqueKey":"routing.query.oneOf.0","typeLabel":"object"},{"type":"null","description":"Visual condition builder state (react-querybuilder combinator and rules). Not evaluated; cel_expression is.","uniqueKey":"routing.query.oneOf.1","typeLabel":"null"}],"uniqueKey":"routing.query","typeLabel":"object | null"},"priority":{"type":"integer","minimum":0,"default":0,"description":"Order within the scope; lower is tried first. Unique within the same scope and scope_id among model routers, separate from routing rule priorities; a duplicate returns 409.","uniqueKey":"routing.priority","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"routing","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"name":"\u003cstring>","keywords":{"simple_keywords":["\u003cstring>"],"medium_keywords":["\u003cstring>"],"complex_keywords":["\u003cstring>"]},"id":"\u003cstring>","description":"\u003cstring>","tier_boundaries":{"simple_medium":123,"medium_complex":123},"classifier":"semantic","semantic":{"provider":"\u003cstring>","embedding_model":"\u003cstring>","timeout":"\u003cstring>","min_similarity":1,"message_history_count":5,"count_toward_budgets":true,"vector_store":"embedded","fallback":"none"},"decision":{"provider":"\u003cstring>","model":"\u003cstring>","previous_message_count":1,"timeout":"\u003cstring>","min_confidence":0,"criteria":{"SIMPLE":{"definition":"\u003cstring>","signals":["\u003cstring>"],"examples":["\u003cstring>"]},"MEDIUM":{"definition":"\u003cstring>","signals":["\u003cstring>"],"examples":["\u003cstring>"]},"COMPLEX":{"definition":"\u003cstring>","signals":["\u003cstring>"],"examples":["\u003cstring>"]}}},"llm":{"provider":"\u003cstring>","model":"\u003cstring>","timeout":"\u003cstring>","prompt":"\u003cstring>","message_history_count":5,"count_toward_budgets":true},"session":{"enabled":true},"suggestions":{"enabled":true,"sample_rate":0,"lookback_days":45,"schedule":{"every":"1d","start_at":"2026-11-12T03:00:00Z"},"max_clustered_requests":50500,"min_cluster_requests":501,"provider":"\u003cstring>","model":"\u003cstring>","instructions":"\u003cstring>","tier":{"classifier":"llm","provider":"\u003cstring>","model":"\u003cstring>","prompt":"\u003cstring>","instructions":"\u003cstring>","criteria":{"SIMPLE":{"definition":"\u003cstring>","signals":["\u003cstring>"],"examples":["\u003cstring>"]},"MEDIUM":{"definition":"\u003cstring>","signals":["\u003cstring>"],"examples":["\u003cstring>"]},"COMPLEX":{"definition":"\u003cstring>","signals":["\u003cstring>"],"examples":["\u003cstring>"]}}}},"targets":[{"provider":"\u003cstring>","tier":"SIMPLE","weight":123,"model":"\u003cstring>","key_id":"\u003cstring>","fallbacks":["\u003cstring>"]}],"routing":{"enabled":false,"scope":"global","scope_id":"\u003cstring>","cel_expression":"\u003cstring>","query":{},"priority":0}}}},"exampleType":"generated"}},"exampleType":"generated"},"d9a65f0b-075d-48e7-9c1c-b717947c3112":{"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"},"1fcfe998-3871-4826-9e03-fe402cc5ef8b":{"description":"Resource not found","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"},"37ac5253-da03-4d25-bbe9-3d7577853f9d":{"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":{"f29338c1-86db-43f2-b398-fa33f80245f3":{"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"}},"72371f95-6f25-457a-89b4-9ab87ce0337c":{"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":"Set a model router's targets - Bifrost","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-18T19:10:35.533Z","originalFileLocation":"api-reference/routing/set-a-model-routers-targets.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=\"Replaces the model each tier of the router gets, and serves the new targets without restarting the router\u0026#x27;s classifiers. A tier with no target keeps the request\u0026#x27;s model; an empty list clears them.\">\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=\"Set a model router\u0026#x27;s targets - Bifrost\">\u003cmeta data-mint-head property=\"og:description\" content=\"Replaces the model each tier of the router gets, and serves the new targets without restarting the router\u0026#x27;s classifiers. A tier with no target keeps the request\u0026#x27;s model; an empty list clears them.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Bifrost\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.getbifrost.ai/api-reference/routing/set-a-model-routers-targets\">\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=Routers\u0026amp;title=Set+a+model+router%27s+targets\u0026amp;description=Replaces+the+model+each+tier+of+the+router+gets%2C+and+serves+the+new+targets+without+restarting+the+router%27s+classifiers.+A+tier+with+no+target+keeps+the+request\u0026amp;theme=b382615b1ec5d0a74479e6c7\u0026amp;signature=a65ea733bd6dcd813423e081f91b7b4059dd80a57bf6fa308dd5fa16884c8cd7\">\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=\"Set a model router\u0026#x27;s targets - Bifrost\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Replaces the model each tier of the router gets, and serves the new targets without restarting the router\u0026#x27;s classifiers. A tier with no target keeps the request\u0026#x27;s model; an empty list clears them.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://bifrost.mintlify.site/_mintlify/api/og/v2?division=Routers\u0026amp;title=Set+a+model+router%27s+targets\u0026amp;description=Replaces+the+model+each+tier+of+the+router+gets%2C+and+serves+the+new+targets+without+restarting+the+router%27s+classifiers.+A+tier+with+no+target+keeps+the+request\u0026amp;theme=b382615b1ec5d0a74479e6c7\u0026amp;signature=a65ea733bd6dcd813423e081f91b7b4059dd80a57bf6fa308dd5fa16884c8cd7\">\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/routing/set-a-model-routers-targets\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/routing/set-a-model-routers-targets.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/routing/set-a-model-routers-targets#webpage\",\"url\":\"https://docs.getbifrost.ai/api-reference/routing/set-a-model-routers-targets\",\"name\":\"Set a model router's targets\",\"description\":\"Replaces the model each tier of the router gets, and serves the new targets without restarting the router's classifiers. A tier with no target keeps the request's model; an empty list clears them.\",\"dateModified\":\"2026-11-18T19:10:35.533Z\",\"isPartOf\":{\"@id\":\"https://docs.getbifrost.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.getbifrost.ai/api-reference/routing/set-a-model-routers-targets#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.getbifrost.ai/api-reference/routing/set-a-model-routers-targets#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Routing\",\"item\":\"https://docs.getbifrost.ai/api-reference/routing/list-routing-rules\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Routers\",\"item\":\"https://docs.getbifrost.ai/api-reference/routing/list-model-routers\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Set a model router's targets\",\"item\":\"https://docs.getbifrost.ai/api-reference/routing/set-a-model-routers-targets\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.getbifrost.ai/api-reference/routing/set-a-model-routers-targets#apireference\",\"headline\":\"Set a model router's targets\",\"name\":\"Set a model router's targets\",\"description\":\"Replaces the model each tier of the router gets, and serves the new targets without restarting the router's classifiers. A tier with no target keeps the request's model; an empty list clears them.\",\"url\":\"https://docs.getbifrost.ai/api-reference/routing/set-a-model-routers-targets\",\"mainEntityOfPage\":{\"@id\":\"https://docs.getbifrost.ai/api-reference/routing/set-a-model-routers-targets#webpage\"},\"dateModified\":\"2026-11-18T19:10:35.533Z\",\"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/routing/set-a-model-routers-targets.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","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","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","description":"Restores the router's reference phrases to the built-in defaults and hot-reloads it. Its name, classifier, targets, routing and other settings are kept.","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","description":"Changes which requests the router takes: whether it is on, its scope, its condition and its priority within the scope. Each field the body sends replaces the stored value and an omitted field keeps it, as in a routing rule update, so `{\"enabled\": false}` turns the router off and leaves the rest as it is. A `cel_expression` sent without `query` clears the stored builder state, which described the old condition. Unknown fields are refused with 400. Routers are tried after the routing rules, on the request as the routing rules left it: narrowest scope first (virtual key, user, team, customer, global), by priority within a scope. The first enabled router whose condition holds classifies the request as SIMPLE, MEDIUM or COMPLEX, and its target for that tier replaces the provider and model; no other router is tried. A condition of model == \"\u003cname>\" lets apps ask for the router by that model name. The condition cannot use complexity_tier. Priorities are unique within a scope among model routers, separate from routing rule priorities. The router's classifier and targets are left as they are.\n","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":"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.5.1"}]},{"item":"Enterprise","icon":"building","pages":[{"title":"Enterprise","href":"/changelogs/ent-v2.5.2"}]},{"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.5.1"}]}]},"basePath":"","title":"Set a model router's targets - Bifrost","deploymentId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","buildId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B6WFFOBL.js","utils-BN5um1KA.js","cloneDeep-C3md22mN.js","_Uint8Array-DLlL8L26.js","isObject-FP1Yky1u.js","utils-BSmbkXJR.js","addUniqueKeysToSchema-2tqcVnUE.js","snippetPresets-CtWfvr2J.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DkKHBy30.js","isEqual-O3q7y6pq.js","usePlaygroundInputsStore-Brc5H9UJ.js","shallow-C4L4xvbs.js","getApiPlaygroundDisplay-2bxyq_aI.js","CodeSnippet-BJu8ddd5.js","CodeSnippets-dazWmoqB.js","Page-CnLhKuUV.js","getPastedJson-Chy3Qa1S.js","icon-CyO7h3jh.js","MethodPill-Dle0_91v.js","DuplicateIcon-CVvWAf4a.js","createIcon-Di07A27B.js","DynamicMarkdown-C4w9kavL.js","SectionHeading-XiBebVYC.js","axios-vUo_bRtp.js","Markdown-DTeL0SpS.js","dist-OCScizqf.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-KcneGfMY.js"]}