Choose which operations of the API callers may use, which ones are charged, and which ones stream.
A route is one operation of the API that callers may use: a method and a path, such as POST /search. A relay only forwards calls that match one of its routes. Anything else is refused with 404, so callers can reach exactly what you listed and nothing more.Each route also decides three things for the calls that match it:
Open Relays, select the relay, and select Add Route.
Pick the Method and enter the Path, such as /search.
Check Billable. It is on by default for POST and off for every other method.
Select Add Route.
The route table lists each route with its method, path, price and an Enabled switch. Use the ⋯ menu on a row to edit or delete the route.Routes are part of the relay, so over the API you send the whole relay with its routes list. See Update relay in the API reference.
This gives the web-search relay four routes: search, extract, read a result, and a delete route that is switched off:
Routes are checked from top to bottom, and the first match wins. Put a specific path above a wildcard that also covers it: GET /results/latest before GET /results/*.
Some APIs send every operation to the same path and name the operation in a header instead. AWS APIs do this: every Amazon Translate call is POST /, and the X-Amz-Target header says whether it is TranslateText or ListLanguages. To tell those apart, a route can also require headers.
Web UI
config.json
Helm
Open the route, or select Add Route.
Under Header Matchers, enter the header Name (X-Amz-Target) and the Value it must have (AWSShineFrontendService_20170701.TranslateText). Add more rows if the call must carry more than one header.
Select Save Route.
This translate relay has two routes on the same path. Translating text is charged; listing languages is free:
Header names ignore case. Values are case-sensitive and can use * and ?, as in ...List* above.
The call must carry every listed header. A route without header matchers matches on method and path alone.
If the relay sets the same header under Extra headers, the route sees the relay’s value, since that is what reaches the API.
A call that sends the same header twice with different capitalization (X-Amz-Target and x-amz-target) is refused with 400.
Some headers are removed before the route check, so a route can never match on them: credential headers (Authorization, x-api-key and similar), Bifrost’s own x-bf-* headers, Host, Content-Length and connection headers.
A call is charged only when both of these are true:
Its route is billable.
The API answers with a 2xx status.
By default only POST routes are billable. For most APIs, GET and HEAD read or list things, and PUT, PATCH and DELETE change settings or clean up, so they are usually free. Turn on Billable (billable: true) for any other method the API charges for, and turn it off to forward a POST for free.A call that is not charged still counts as one request against the caller’s request rate limit. A call that never reached the API (for example, the API could not be reached) counts nothing.
Switch off Enabled in the route table (enabled: false in config.json and Helm) to refuse a route without deleting it.
A disabled route still matches, so its calls are refused with 404 instead of falling through to a broader route below it. Here, callers can read results with GET /results/* but cannot delete them, because DELETE /results/* is switched off.
Relay Any Path on the General tab (skip_route_check: true) forwards calls that match no route instead of refusing them. Those calls use the relay’s default price, and only POST calls are charged. Disabled routes still refuse their calls.
With Relay Any Path on, callers can reach every endpoint of the API using the relay’s credential. Prefer listing routes. Use this only for an API you fully trust, or while you are still finding out which endpoints you need.
Normal: Bifrost waits for the whole reply, prices it, then returns it. This is how most calls work.
Streamed: Bifrost passes the reply to the caller piece by piece as it arrives, and prices it when it ends. Use this for server-sent events, live search results or audio.
The caller cannot choose. Sending Accept: text/event-stream or "stream": true changes nothing on its own. The relay decides, in this order:
The route’s Streaming setting: Always stream (stream: true) or Never stream (stream: false).
Always-Stream Paths on the Advanced tab (streaming.paths): calls whose path matches one of these patterns always stream.
Otherwise (Auto), the API’s reply decides. A reply with Content-Type: text/event-stream is streamed, and anything else is handled normally.
Web UI
config.json
Helm
For one route: open the route and set Streaming to Always stream or Never stream.
For a group of paths: open Edit Relay Config → Advanced and add one pattern per line under Always-Stream Paths, such as /v1/speech/*/stream.
How long a stream may stay quiet: set Stream Idle Timeout on the Network tab.
This text-to-speech relay returns ordinary audio on /v1/speech/<voice> and streams audio on /v1/speech/<voice>/stream. The streaming.paths pattern makes every .../stream call stream, and the idle timeout lets a stream pause for up to 2 minutes:
The API’s status, headers and bytes, unchanged. Bifrost adds Cache-Control: no-cache and X-Accel-Buffering: no so proxies in between do not hold the stream back.
The API has Timeout seconds to start replying. After that, the stream is closed only if it goes quiet for longer than Stream Idle Timeout (both on the Network tab).
A stream is charged when it ends, including when the caller disconnects early: what was already sent is still charged, and the log row is marked cancelled. See Streamed replies for how a stream is priced.
If the API publishes an OpenAPI (or Swagger) file, you can turn it into routes instead of typing them.
In the route table, select Import OpenAPI.
Paste the file (JSON or YAML), enter its URL and select Fetch, or upload it.
Check the preview: the API’s name, version, the number of routes found, and a suggested base URL and authentication method.
Select Import N routes, then Apply import to confirm.
What the import does:
Every operation in the file becomes a route. Path parameters such as {id} become *.
More specific routes are placed above broader ones, so the order is right.
The imported list replaces the current routes. Routes that the file still lists keep their settings. New routes use the relay’s default price.
Only the routes change. The suggested base URL and authentication are shown for you to copy, not applied.
A URL is fetched by Bifrost, not your browser, with a size limit and protection against private-network addresses. The file is read once and not stored.
Troubleshooting: a call is refused with 404 and you are not sure why.
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":"6af4287b34085e9d514c8995","clientVersion":"0.0.4111","searchFilterCounts":[{"language":"default","tag":"API","count":690},{"language":"default","tag":"Changelogs","count":325},{"language":"default","tag":"Integrations","count":252},{"language":"default","tag":"Platform","count":237},{"language":"default","tag":"Open Source","count":166},{"language":"default","tag":"OSS","count":152},{"language":"default","tag":"Governance","count":132},{"language":"default","tag":"Enterprise","count":109},{"language":"default","tag":"Helm","count":77},{"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":"llms-txt-v2","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}],"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":"relays/routes","slug":"/relays/routes","pageMetadata":{"title":"Routes","description":"Choose which operations of the API callers may use, which ones are charged, and which ones stream.","icon":"route","href":"/relays/routes"},"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: \"Choose which operations of the API callers may use, which ones are charged, and which ones stream.\"\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`,hr:`hr`,li:`li`,ol:`ol`,p:`p`,pre:`pre`,span:`span`,strong:`strong`,tbody:`tbody`,td:`td`,th:`th`,thead:`thead`,tr:`tr`,ul:`ul`,..._provideComponents(),...props.components},{CodeBlock,Frame,Heading,OptimizedImage,Tab,Table,Tabs,Warning}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Frame)_missingMdxReference(`Frame`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!OptimizedImage)_missingMdxReference(`OptimizedImage`,true);if(!Tab)_missingMdxReference(`Tab`,true);if(!Table)_missingMdxReference(`Table`,true);if(!Tabs)_missingMdxReference(`Tabs`,true);if(!Warning)_missingMdxReference(`Warning`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`A `,_jsx(_components.strong,{children:`route`}),` is one operation of the API that callers may use: a method and a path, such as `,_jsx(_components.code,{children:`POST /search`}),`. A relay only forwards calls that match one of its routes. Anything else is refused with `,_jsx(_components.code,{children:`404`}),`, so callers can reach exactly what you listed and nothing more.`]}),`\n`,_jsx(_components.p,{children:`Each route also decides three things for the calls that match it:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`whether the call is `,_jsx(_components.strong,{children:`charged`}),` (see `,_jsx(_components.a,{href:`#which-calls-are-charged`,children:`Which calls are charged`}),`)`]}),`\n`,_jsxs(_components.li,{children:[`whether the reply is `,_jsx(_components.strong,{children:`streamed`}),` (see `,_jsx(_components.a,{href:`#streaming`,children:`Streaming`}),`)`]}),`\n`,_jsxs(_components.li,{children:[`whether it uses a `,_jsx(_components.strong,{children:`different price`}),` from the rest of the relay (see `,_jsx(_components.a,{href:`/relays/pricing#price-one-route-differently`,children:`Pricing`}),`)`]}),`\n`]}),`\n`,_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-routes-table.png?fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=741eac1677f15440c88314bfa92f1f29`,alt:`The route table of the web-search relay`,\"data-og-width\":`2400`,width:`2400`,\"data-og-height\":`1596`,height:`1596`,\"data-path\":`media/relays/ui-routes-table.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-routes-table.png?w=280\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=ac984b1ee800b3568a5e64cee45c94d9 280w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-routes-table.png?w=560\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=fda895938caa511b0be4822aaf8a1977 560w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-routes-table.png?w=840\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=5055bf42f6307ee8085e5c5691d4b3fc 840w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-routes-table.png?w=1100\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=52c5a0857332ebb123b2edb647b6896c 1100w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-routes-table.png?w=1650\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=de90bbef742d2387865ae651ed3c0894 1650w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-routes-table.png?w=2500\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=04be749040aa7e8dab294c76978902e5 2500w`})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`add-a-route`,children:`Add a route`}),`\n`,_jsxs(Tabs,{group:`config-method`,children:[_jsxs(Tab,{title:`Web UI`,id:`web-ui`,children:[_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`Open `,_jsx(_components.strong,{children:`Relays`}),`, select the relay, and select `,_jsx(_components.strong,{children:`Add Route`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Pick the `,_jsx(_components.strong,{children:`Method`}),` and enter the `,_jsx(_components.strong,{children:`Path`}),`, such as `,_jsx(_components.code,{children:`/search`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Check `,_jsx(_components.strong,{children:`Billable`}),`. It is on by default for `,_jsx(_components.code,{children:`POST`}),` and off for every other method.`]}),`\n`,_jsxs(_components.li,{children:[`Select `,_jsx(_components.strong,{children:`Add Route`}),`.`]}),`\n`]}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-route-sheet.png?fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=b576ef003ecb0561044f325abb6b907c`,alt:`The Add route sheet with the method, path, header matchers, streaming, billable and pricing override fields`,style:{maxHeight:`600px`,maxWidth:`100%`,width:`auto`,margin:`0 auto`},\"data-og-width\":`1626`,width:`1626`,\"data-og-height\":`2050`,height:`2050`,\"data-path\":`media/relays/ui-route-sheet.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-route-sheet.png?w=280\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=e1d2dfb932cf61d5aaf043846c3bcf6c 280w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-route-sheet.png?w=560\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=9f64e4bf69e42560b0ea517c562720e2 560w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-route-sheet.png?w=840\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=21ff4db87d30314bad5a61d3351456db 840w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-route-sheet.png?w=1100\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=076df9ed4427e233460ab4b35c0c36fa 1100w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-route-sheet.png?w=1650\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=b0a150443460cceeff803e66f368da6a 1650w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-route-sheet.png?w=2500\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=7203e8fcc19863c36f58f71acf483e6e 2500w`})}),_jsxs(_components.p,{children:[`The route table lists each route with its method, path, price and an `,_jsx(_components.strong,{children:`Enabled`}),` switch. Use the `,_jsx(_components.strong,{children:`⋯`}),` menu on a row to edit or delete the route.`]}),_jsxs(_components.p,{children:[`Routes are part of the relay, so over the API you send the whole relay with its `,_jsx(_components.code,{children:`routes`}),` list. See `,_jsx(_components.a,{href:`/api-reference/relays/update-relay`,children:`Update relay`}),` in the API reference.`]})]}),_jsxs(Tab,{title:`config.json`,id:`config-json`,children:[_jsxs(_components.p,{children:[`This gives the `,_jsx(_components.code,{children:`web-search`}),` relay four routes: search, extract, read a result, and a delete route that is switched off:`]}),_jsx(CodeBlock,{filename:``,numberOfLines:`16`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`16`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"relays\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"web-search\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"base_url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://api.example.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"auth\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"bearer\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"credential\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"value\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"env.WEB_SEARCH_API_KEY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"routes\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"method\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"POST\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"path\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"/search\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"method\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"POST\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"path\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"/extract\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"method\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"GET\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"path\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"/results/*\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"method\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"DELETE\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"path\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"/results/*\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"enabled\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Field`}),_jsx(_components.th,{children:`Required`}),_jsx(_components.th,{children:`Description`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`method`})}),_jsx(_components.td,{children:`Yes`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`GET`}),`, `,_jsx(_components.code,{children:`POST`}),`, `,_jsx(_components.code,{children:`PUT`}),`, `,_jsx(_components.code,{children:`PATCH`}),`, `,_jsx(_components.code,{children:`DELETE`}),` or `,_jsx(_components.code,{children:`HEAD`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`path`})}),_jsx(_components.td,{children:`Yes`}),_jsxs(_components.td,{children:[`The path below the base URL. Can use wildcards; see `,_jsx(_components.a,{href:`#path-patterns`,children:`Path patterns`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`headers`})}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`Headers the call must also carry. See `,_jsx(_components.a,{href:`#match-on-a-header`,children:`Match on a header`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`enabled`})}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`false`}),` refuses matching calls. Default `,_jsx(_components.code,{children:`true`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`billable`})}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`Whether a successful call is charged. Default `,_jsx(_components.code,{children:`true`}),` for `,_jsx(_components.code,{children:`POST`}),`, `,_jsx(_components.code,{children:`false`}),` for the rest.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`stream`})}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`true`}),` always streams, `,_jsx(_components.code,{children:`false`}),` never streams. Leave it out for `,_jsx(_components.strong,{children:`Auto`}),`.`]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`usage`})}),_jsx(_components.td,{children:`No`}),_jsxs(_components.td,{children:[`A different price for this route. See `,_jsx(_components.a,{href:`/relays/pricing#price-one-route-differently`,children:`Pricing`}),`.`]})]})]})]})]}),_jsxs(Tab,{title:`Helm`,id:`helm`,children:[_jsxs(_components.p,{children:[`The same four routes under `,_jsx(_components.code,{children:`bifrost.relays`}),`:`]}),_jsx(CodeBlock,{filename:``,numberOfLines:`18`,language:`yaml`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`yaml`,children:_jsxs(_components.code,{language:`yaml`,numberOfLines:`18`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`bifrost`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` relays`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` - `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`name`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`web-search`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` base_url`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://api.example.com\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` auth`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` type`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`bearer`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` credential`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` value`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"env.WEB_SEARCH_API_KEY\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` routes`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` - `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`method`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`POST`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` path`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`/search`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` - `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`method`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`POST`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` path`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`/extract`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` - `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`method`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`GET`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` path`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"/results/*\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` - `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`method`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`DELETE`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` path`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"/results/*\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` enabled`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`})]}),`\n`]})})})]})]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`path-patterns`,children:`Path patterns`}),`\n`,_jsxs(_components.p,{children:[`A path is compared one segment (the part between two `,_jsx(_components.code,{children:`/`}),`) at a time.`]}),`\n`,_jsxs(Table,{children:[_jsx(_components.thead,{children:_jsxs(_components.tr,{children:[_jsx(_components.th,{children:`Pattern`}),_jsx(_components.th,{children:`Matches`}),_jsx(_components.th,{children:`Does not match`})]})}),_jsxs(_components.tbody,{children:[_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`/search`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/search`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`/search/`}),`, `,_jsx(_components.code,{children:`/v1/search`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`/results/*`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`/results/abc`}),`, `,_jsx(_components.code,{children:`/results/123`})]}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`/results`}),`, `,_jsx(_components.code,{children:`/results/abc/pages`})]})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`/v1/*/predict`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/v1/vision/predict`})}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/v1/a/b/predict`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{children:_jsx(_components.code,{children:`/v1/**`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`/v1`}),`, `,_jsx(_components.code,{children:`/v1/x`}),`, `,_jsx(_components.code,{children:`/v1/x/y/z`})]}),_jsx(_components.td,{children:_jsx(_components.code,{children:`/v2/x`})})]}),_jsxs(_components.tr,{children:[_jsx(_components.td,{\"data-numeric\":`true`,children:_jsx(_components.code,{children:`/`})}),_jsxs(_components.td,{children:[_jsx(_components.code,{children:`/`}),` only`]}),_jsx(_components.td,{children:`anything else`})]})]})]}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`*`}),` matches anything inside one segment. `,_jsx(_components.code,{children:`?`}),` and `,_jsx(_components.code,{children:`[abc]`}),` work as they do in a shell.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.code,{children:`**`}),` matches everything below a path. It can only be the last segment.`]}),`\n`,_jsxs(_components.li,{children:[`The path is matched after URL decoding, so `,_jsx(_components.code,{children:`/files/a%2Fb`}),` is treated as `,_jsx(_components.code,{children:`/files/a/b`}),`.`]}),`\n`]}),`\n`,_jsx(Heading,{level:`3`,id:`route-order`,children:`Route order`}),`\n`,_jsxs(_components.p,{children:[`Routes are checked from top to bottom, and the first match wins. Put a specific path above a wildcard that also covers it: `,_jsx(_components.code,{children:`GET /results/latest`}),` before `,_jsx(_components.code,{children:`GET /results/*`}),`.`]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`match-on-a-header`,children:`Match on a header`}),`\n`,_jsxs(_components.p,{children:[`Some APIs send every operation to the same path and name the operation in a header instead. AWS APIs do this: every Amazon Translate call is `,_jsx(_components.code,{children:`POST /`}),`, and the `,_jsx(_components.code,{children:`X-Amz-Target`}),` header says whether it is `,_jsx(_components.code,{children:`TranslateText`}),` or `,_jsx(_components.code,{children:`ListLanguages`}),`. To tell those apart, a route can also require headers.`]}),`\n`,_jsxs(Tabs,{group:`config-method`,children:[_jsxs(Tab,{title:`Web UI`,id:`web-ui-2`,children:[_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`Open the route, or select `,_jsx(_components.strong,{children:`Add Route`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Under `,_jsx(_components.strong,{children:`Header Matchers`}),`, enter the header `,_jsx(_components.strong,{children:`Name`}),` (`,_jsx(_components.code,{children:`X-Amz-Target`}),`) and the `,_jsx(_components.strong,{children:`Value`}),` it must have (`,_jsx(_components.code,{children:`AWSShineFrontendService_20170701.TranslateText`}),`). Add more rows if the call must carry more than one header.`]}),`\n`,_jsxs(_components.li,{children:[`Select `,_jsx(_components.strong,{children:`Save Route`}),`.`]}),`\n`]}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-route-header-matchers.png?fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=20cf19d05d8c8e8fffc989771e657eeb`,alt:`The route sheet with Header Matchers highlighted, matching X-Amz-Target`,style:{maxHeight:`480px`,maxWidth:`100%`,width:`auto`,margin:`0 auto`},\"data-og-width\":`1558`,width:`1558`,\"data-og-height\":`1254`,height:`1254`,\"data-path\":`media/relays/ui-route-header-matchers.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-route-header-matchers.png?w=280\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=871933950e39bc5b76b3532041d93587 280w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-route-header-matchers.png?w=560\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=713d394ae0e9251cae9e21d38d5655a2 560w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-route-header-matchers.png?w=840\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=fa2d3a223c11c0309a2ba9066311923b 840w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-route-header-matchers.png?w=1100\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=a0feb947ff389ed06bc44c6adaa9b846 1100w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-route-header-matchers.png?w=1650\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=411ff9d16d90c943bbffc44d6ea1daef 1650w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-route-header-matchers.png?w=2500\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=ace3edb98e645ac6b23e59bb655946c3 2500w`})})]}),_jsxs(Tab,{title:`config.json`,id:`config-json-2`,children:[_jsxs(_components.p,{children:[`This `,_jsx(_components.code,{children:`translate`}),` relay has two routes on the same path. Translating text is charged; listing languages is free:`]}),_jsx(CodeBlock,{filename:``,numberOfLines:`23`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`23`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"relays\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"translate\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"base_url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://translate.us-east-1.amazonaws.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"auth\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"aws_sigv4\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"aws\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"service\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"translate\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` } },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"credential\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"aws\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"region\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"us-east-1\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` } },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"routes\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"method\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"POST\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"path\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"/\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"headers\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"X-Amz-Target\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"AWSShineFrontendService_20170701.TranslateText\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"method\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"POST\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"path\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"/\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"headers\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"X-Amz-Target\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"AWSShineFrontendService_20170701.List*\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"billable\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})})]}),_jsxs(Tab,{title:`Helm`,id:`helm-2`,children:[_jsxs(_components.p,{children:[`The same two routes under `,_jsx(_components.code,{children:`bifrost.relays`}),`:`]}),_jsx(CodeBlock,{filename:``,numberOfLines:`21`,language:`yaml`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`yaml`,children:_jsxs(_components.code,{language:`yaml`,numberOfLines:`21`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`bifrost`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` relays`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` - `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`name`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`translate`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` base_url`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://translate.us-east-1.amazonaws.com\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` auth`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` type`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`aws_sigv4`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` aws`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` service`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`translate`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` credential`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` aws`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` region`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`us-east-1`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` routes`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` - `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`method`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`POST`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` path`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`/`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` headers`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` X-Amz-Target`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"AWSShineFrontendService_20170701.TranslateText\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` - `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`method`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`POST`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` path`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`/`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` headers`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` X-Amz-Target`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"AWSShineFrontendService_20170701.List*\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` billable`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#569CD6`},children:`false`})]}),`\n`]})})})]})]}),`\n`,_jsx(_components.p,{children:`How header matching works:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Header names ignore case. Values are case-sensitive and can use `,_jsx(_components.code,{children:`*`}),` and `,_jsx(_components.code,{children:`?`}),`, as in `,_jsx(_components.code,{children:`...List*`}),` above.`]}),`\n`,_jsx(_components.li,{children:`The call must carry every listed header. A route without header matchers matches on method and path alone.`}),`\n`,_jsxs(_components.li,{children:[`If the relay sets the same header under `,_jsx(_components.a,{href:`/relays/configuration#extra-headers`,children:`Extra headers`}),`, the route sees the relay’s value, since that is what reaches the API.`]}),`\n`,_jsxs(_components.li,{children:[`A call that sends the same header twice with different capitalization (`,_jsx(_components.code,{children:`X-Amz-Target`}),` and `,_jsx(_components.code,{children:`x-amz-target`}),`) is refused with `,_jsx(_components.code,{children:`400`}),`.`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`Some headers are removed before the route check, so a route can never match on them: credential headers (`,_jsx(_components.code,{children:`Authorization`}),`, `,_jsx(_components.code,{children:`x-api-key`}),` and similar), Bifrost’s own `,_jsx(_components.code,{children:`x-bf-*`}),` headers, `,_jsx(_components.code,{children:`Host`}),`, `,_jsx(_components.code,{children:`Content-Length`}),` and connection headers.`]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`which-calls-are-charged`,children:`Which calls are charged`}),`\n`,_jsx(_components.p,{children:`A call is charged only when both of these are true:`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`Its route is `,_jsx(_components.strong,{children:`billable`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`The API answers with a `,_jsx(_components.code,{children:`2xx`}),` status.`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`By default only `,_jsx(_components.code,{children:`POST`}),` routes are billable. For most APIs, `,_jsx(_components.code,{children:`GET`}),` and `,_jsx(_components.code,{children:`HEAD`}),` read or list things, and `,_jsx(_components.code,{children:`PUT`}),`, `,_jsx(_components.code,{children:`PATCH`}),` and `,_jsx(_components.code,{children:`DELETE`}),` change settings or clean up, so they are usually free. Turn on `,_jsx(_components.strong,{children:`Billable`}),` (`,_jsx(_components.code,{children:`billable: true`}),`) for any other method the API charges for, and turn it off to forward a `,_jsx(_components.code,{children:`POST`}),` for free.`]}),`\n`,_jsx(_components.p,{children:`A call that is not charged still counts as one request against the caller’s request rate limit. A call that never reached the API (for example, the API could not be reached) counts nothing.`}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`turn-a-route-off`,children:`Turn a route off`}),`\n`,_jsxs(_components.p,{children:[`Switch off `,_jsx(_components.strong,{children:`Enabled`}),` in the route table (`,_jsx(_components.code,{children:`enabled: false`}),` in `,_jsx(_components.code,{children:`config.json`}),` and Helm) to refuse a route without deleting it.`]}),`\n`,_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-route-off.png?fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=f6f4a2d6864571426bdafd4f1de036e2`,alt:`The route table with the disabled DELETE /results/* route highlighted`,style:{maxHeight:`380px`,maxWidth:`100%`,width:`auto`,margin:`0 auto`},\"data-og-width\":`1994`,width:`1994`,\"data-og-height\":`1004`,height:`1004`,\"data-path\":`media/relays/ui-route-off.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-route-off.png?w=280\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=e3478f984ffd0f313a3b2f06d5869c0a 280w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-route-off.png?w=560\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=becbee20b89646e038b9c0011567b491 560w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-route-off.png?w=840\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=679e06a49c9786eb00a3b644a623aa00 840w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-route-off.png?w=1100\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=5083c83fce77789fd6f378e66f61f702 1100w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-route-off.png?w=1650\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=91e3f95e7e53542c79f978e630c12376 1650w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-route-off.png?w=2500\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=3b3bd5bd35f501f908e715573d478547 2500w`})}),`\n`,_jsxs(_components.p,{children:[`A disabled route still matches, so its calls are refused with `,_jsx(_components.code,{children:`404`}),` instead of falling through to a broader route below it. Here, callers can read results with `,_jsx(_components.code,{children:`GET /results/*`}),` but cannot delete them, because `,_jsx(_components.code,{children:`DELETE /results/*`}),` is switched off.`]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`relay-any-path`,children:`Relay any path`}),`\n`,_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Relay Any Path`}),` on the `,_jsx(_components.strong,{children:`General`}),` tab (`,_jsx(_components.code,{children:`skip_route_check: true`}),`) forwards calls that match no route instead of refusing them. Those calls use the relay’s default price, and only `,_jsx(_components.code,{children:`POST`}),` calls are charged. Disabled routes still refuse their calls.`]}),`\n`,_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-relay-any-path.png?fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=975ccfeeae67e73abb403a2c824d4ebf`,alt:`The General tab with the Relay Any Path switch highlighted`,style:{maxHeight:`380px`,maxWidth:`100%`,width:`auto`,margin:`0 auto`},\"data-og-width\":`1670`,width:`1670`,\"data-og-height\":`954`,height:`954`,\"data-path\":`media/relays/ui-relay-any-path.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-relay-any-path.png?w=280\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=dd5df12e8a1105df8e8cc04646f7ab4f 280w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-relay-any-path.png?w=560\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=b73349906453afb1994e3d2931e7d619 560w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-relay-any-path.png?w=840\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=96f2f2be40ca01bad487c6e85bd5f2bf 840w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-relay-any-path.png?w=1100\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=a8c0fa0fe27fb31596a2dc77055ecd55 1100w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-relay-any-path.png?w=1650\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=379265c866c875d8530fe311237b337f 1650w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-relay-any-path.png?w=2500\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=283e2fd46601f88dd315ec855c27160f 2500w`})}),`\n`,_jsx(Warning,{children:_jsx(_components.p,{children:`With Relay Any Path on, callers can reach every endpoint of the API using the relay’s credential. Prefer listing routes. Use this only for an API you fully trust, or while you are still finding out which endpoints you need.`})}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`streaming`,children:`Streaming`}),`\n`,_jsx(_components.p,{children:`A relay sends back a reply in one of two ways:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Normal:`}),` Bifrost waits for the whole reply, prices it, then returns it. This is how most calls work.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Streamed:`}),` Bifrost passes the reply to the caller piece by piece as it arrives, and prices it when it ends. Use this for server-sent events, live search results or audio.`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`The caller cannot choose. Sending `,_jsx(_components.code,{children:`Accept: text/event-stream`}),` or `,_jsx(_components.code,{children:`\"stream\": true`}),` changes nothing on its own. The relay decides, in this order:`]}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`The route’s `,_jsx(_components.strong,{children:`Streaming`}),` setting: `,_jsx(_components.strong,{children:`Always stream`}),` (`,_jsx(_components.code,{children:`stream: true`}),`) or `,_jsx(_components.strong,{children:`Never stream`}),` (`,_jsx(_components.code,{children:`stream: false`}),`).`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Always-Stream Paths`}),` on the `,_jsx(_components.strong,{children:`Advanced`}),` tab (`,_jsx(_components.code,{children:`streaming.paths`}),`): calls whose path matches one of these patterns always stream.`]}),`\n`,_jsxs(_components.li,{children:[`Otherwise (`,_jsx(_components.strong,{children:`Auto`}),`), the API’s reply decides. A reply with `,_jsx(_components.code,{children:`Content-Type: text/event-stream`}),` is streamed, and anything else is handled normally.`]}),`\n`]}),`\n`,_jsxs(Tabs,{group:`config-method`,children:[_jsxs(Tab,{title:`Web UI`,id:`web-ui-3`,children:[_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`For one route:`}),` open the route and set `,_jsx(_components.strong,{children:`Streaming`}),` to `,_jsx(_components.strong,{children:`Always stream`}),` or `,_jsx(_components.strong,{children:`Never stream`}),`.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`For a group of paths:`}),` open `,_jsx(_components.strong,{children:`Edit Relay Config → Advanced`}),` and add one pattern per line under `,_jsx(_components.strong,{children:`Always-Stream Paths`}),`, such as `,_jsx(_components.code,{children:`/v1/speech/*/stream`}),`.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`How long a stream may stay quiet:`}),` set `,_jsx(_components.strong,{children:`Stream Idle Timeout`}),` on the `,_jsx(_components.a,{href:`/relays/configuration#network`,children:`Network`}),` tab.`]}),`\n`]}),_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-always-stream.png?fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=d662acbfb520b879e0803ea86282429b`,alt:`The Advanced tab with Always-Stream Paths highlighted`,style:{maxHeight:`340px`,maxWidth:`100%`,width:`auto`,margin:`0 auto`},\"data-og-width\":`1670`,width:`1670`,\"data-og-height\":`890`,height:`890`,\"data-path\":`media/relays/ui-always-stream.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-always-stream.png?w=280\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=bb174539764c5012e574f98e6626e2fd 280w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-always-stream.png?w=560\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=169d1411837d69165e3575673444d4e1 560w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-always-stream.png?w=840\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=73a145b66c297b92fbcf552417668c20 840w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-always-stream.png?w=1100\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=1442bd91d40517d8cc0608c21a75db02 1100w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-always-stream.png?w=1650\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=1224599f36c9966bb3f9a53834e42d62 1650w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-always-stream.png?w=2500\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=f91bbac1689178d5cedc144c6331038e 2500w`})})]}),_jsxs(Tab,{title:`config.json`,id:`config-json-3`,children:[_jsxs(_components.p,{children:[`This `,_jsx(_components.code,{children:`text-to-speech`}),` relay returns ordinary audio on `,_jsx(_components.code,{children:`/v1/speech/\u003cvoice>`}),` and streams audio on `,_jsx(_components.code,{children:`/v1/speech/\u003cvoice>/stream`}),`. The `,_jsx(_components.code,{children:`streaming.paths`}),` pattern makes every `,_jsx(_components.code,{children:`.../stream`}),` call stream, and the idle timeout lets a stream pause for up to 2 minutes:`]}),_jsx(CodeBlock,{filename:``,numberOfLines:`16`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`16`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"relays\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` {`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"text-to-speech\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"base_url\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://speech.example.com\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`,`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"auth\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"type\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"header\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"header_name\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"X-Api-Key\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"credential\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"value\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"env.TTS_API_KEY\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"streaming\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"paths\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"/v1/speech/*/stream\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`] },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"network\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"stream_idle_timeout_in_seconds\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`120`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"routes\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: [`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"method\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"POST\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"path\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"/v1/speech/*\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` },`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` { `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"method\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"POST\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`, `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:`\"path\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"/v1/speech/*/stream\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` }`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` ]`})}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),_jsxs(_components.p,{children:[`To force one route instead, set `,_jsx(_components.code,{children:`\"stream\": true`}),` (or `,_jsx(_components.code,{children:`false`}),`) on that route.`]})]}),_jsxs(Tab,{title:`Helm`,id:`helm-3`,children:[_jsxs(_components.p,{children:[`The same relay under `,_jsx(_components.code,{children:`bifrost.relays`}),`:`]}),_jsx(CodeBlock,{filename:``,numberOfLines:`19`,language:`yaml`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`yaml`,children:_jsxs(_components.code,{language:`yaml`,numberOfLines:`19`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`bifrost`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` relays`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` - `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`name`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`text-to-speech`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` base_url`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://speech.example.com\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` auth`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` type`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`header`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` header_name`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`X-Api-Key`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` credential`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` value`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"env.TTS_API_KEY\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` streaming`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` paths`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` - `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"/v1/speech/*/stream\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` network`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` stream_idle_timeout_in_seconds`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#B5CEA8`},children:`120`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` routes`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`:`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` - `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`method`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`POST`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` path`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"/v1/speech/*\"`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:` - `}),_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:`method`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`POST`})]}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#569CD6`},children:` path`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"/v1/speech/*/stream\"`})]}),`\n`]})})})]})]}),`\n`,_jsx(_components.p,{children:`What the caller receives:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`The API’s status, headers and bytes, unchanged. Bifrost adds `,_jsx(_components.code,{children:`Cache-Control: no-cache`}),` and `,_jsx(_components.code,{children:`X-Accel-Buffering: no`}),` so proxies in between do not hold the stream back.`]}),`\n`,_jsxs(_components.li,{children:[`The API has `,_jsx(_components.strong,{children:`Timeout`}),` seconds to start replying. After that, the stream is closed only if it goes quiet for longer than `,_jsx(_components.strong,{children:`Stream Idle Timeout`}),` (both on the `,_jsx(_components.a,{href:`/relays/configuration#network`,children:`Network`}),` tab).`]}),`\n`]}),`\n`,_jsxs(_components.p,{children:[`A stream is charged when it ends, including when the caller disconnects early: what was already sent is still charged, and the log row is marked `,_jsx(_components.code,{children:`cancelled`}),`. See `,_jsx(_components.a,{href:`/relays/pricing#streamed-replies`,children:`Streamed replies`}),` for how a stream is priced.`]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`import-routes-from-openapi`,children:`Import routes from OpenAPI`}),`\n`,_jsx(_components.p,{children:`If the API publishes an OpenAPI (or Swagger) file, you can turn it into routes instead of typing them.`}),`\n`,_jsxs(_components.ol,{children:[`\n`,_jsxs(_components.li,{children:[`In the route table, select `,_jsx(_components.strong,{children:`Import OpenAPI`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`Paste the file (JSON or YAML), enter its URL and select `,_jsx(_components.strong,{children:`Fetch`}),`, or upload it.`]}),`\n`,_jsx(_components.li,{children:`Check the preview: the API’s name, version, the number of routes found, and a suggested base URL and authentication method.`}),`\n`,_jsxs(_components.li,{children:[`Select `,_jsx(_components.strong,{children:`Import N routes`}),`, then `,_jsx(_components.strong,{children:`Apply import`}),` to confirm.`]}),`\n`]}),`\n`,_jsx(Frame,{children:_jsx(OptimizedImage,{src:`https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-import-openapi.png?fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=ea8efcfef1bfc6ca046d2d5f9c93adb2`,alt:`Import routes from OpenAPI with a pasted document and its preview highlighted`,style:{maxHeight:`520px`,maxWidth:`100%`,width:`auto`,margin:`0 auto`},\"data-og-width\":`1558`,width:`1558`,\"data-og-height\":`1370`,height:`1370`,\"data-path\":`media/relays/ui-import-openapi.png`,\"data-optimize\":`true`,\"data-opv\":`3`,srcset:`https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-import-openapi.png?w=280\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=6c2e31370132b9ca53df5d4368cd9209 280w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-import-openapi.png?w=560\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=02ed0bef511df41251ecf30d3e4531fe 560w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-import-openapi.png?w=840\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=3dc8df52acc2c8938fb7182cd414b859 840w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-import-openapi.png?w=1100\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=462eeb26e6ae0c771d495f6b29656db3 1100w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-import-openapi.png?w=1650\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=2f766c449e3ece4d2f9aefb273e3efda 1650w, https://mintcdn.com/bifrost/ioGXmapS8IURo8hz/media/relays/ui-import-openapi.png?w=2500\u0026fit=max\u0026auto=format\u0026n=ioGXmapS8IURo8hz\u0026q=85\u0026s=1740c79e583ff8a5f101e3f385df3d3d 2500w`})}),`\n`,_jsx(_components.p,{children:`What the import does:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[`Every operation in the file becomes a route. Path parameters such as `,_jsx(_components.code,{children:`{id}`}),` become `,_jsx(_components.code,{children:`*`}),`.`]}),`\n`,_jsxs(_components.li,{children:[`More specific routes are placed above broader ones, so the `,_jsx(_components.a,{href:`#route-order`,children:`order`}),` is right.`]}),`\n`,_jsxs(_components.li,{children:[`The imported list `,_jsx(_components.strong,{children:`replaces`}),` the current routes. Routes that the file still lists keep their settings. New routes use the relay’s default price.`]}),`\n`,_jsx(_components.li,{children:`Only the routes change. The suggested base URL and authentication are shown for you to copy, not applied.`}),`\n`,_jsx(_components.li,{children:`A URL is fetched by Bifrost, not your browser, with a size limit and protection against private-network addresses. The file is read once and not stored.`}),`\n`]}),`\n`,_jsx(_components.hr,{}),`\n`,_jsx(Heading,{level:`2`,id:`next-steps`,children:`Next steps`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:_jsx(_components.a,{href:`/relays/pricing`,children:`Pricing`})}),`: set the price of the routes you listed.`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:_jsx(_components.a,{href:`/relays/troubleshooting`,children:`Troubleshooting`})}),`: a call is refused with `,_jsx(_components.code,{children:`404`}),` and you are not sure why.`]}),`\n`]})]})}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":"Routes","description":"Choose which operations of the API callers may use, which ones are charged, and which ones stream.","icon":"route","href":"/relays/routes"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Add a route","slug":"add-a-route","depth":2,"children":[]},{"title":"Path patterns","slug":"path-patterns","depth":2,"children":[{"title":"Route order","slug":"route-order","depth":3,"children":[]}]},{"title":"Match on a header","slug":"match-on-a-header","depth":2,"children":[]},{"title":"Which calls are charged","slug":"which-calls-are-charged","depth":2,"children":[]},{"title":"Turn a route off","slug":"turn-a-route-off","depth":2,"children":[]},{"title":"Relay any path","slug":"relay-any-path","depth":2,"children":[]},{"title":"Streaming","slug":"streaming","depth":2,"children":[]},{"title":"Import routes from OpenAPI","slug":"import-routes-from-openapi","depth":2,"children":[]},{"title":"Next steps","slug":"next-steps","depth":2,"children":[]}],"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"],"subdomain":"bifrost","siteName":"Bifrost","title":"Routes - Bifrost","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-30T16:52:54.072Z","originalFileLocation":"relays/routes.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=\"Choose which operations of the API callers may use, which ones are charged, and which ones stream.\">\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=\"Routes - Bifrost\">\u003cmeta data-mint-head property=\"og:description\" content=\"Choose which operations of the API callers may use, which ones are charged, and which ones stream.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Bifrost\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.getbifrost.ai/relays/routes\">\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=Relays\u0026amp;title=Routes\u0026amp;description=Choose+which+operations+of+the+API+callers+may+use%2C+which+ones+are+charged%2C+and+which+ones+stream.\u0026amp;theme=b382615b1ec5d0a74479e6c7\u0026amp;signature=f87ce3a945e7a055bb6a5856681dc21f003c90d954d8bae3be734d715f694540\">\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=\"Routes - Bifrost\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Choose which operations of the API callers may use, which ones are charged, and which ones stream.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://bifrost.mintlify.site/_mintlify/api/og/v2?division=Relays\u0026amp;title=Routes\u0026amp;description=Choose+which+operations+of+the+API+callers+may+use%2C+which+ones+are+charged%2C+and+which+ones+stream.\u0026amp;theme=b382615b1ec5d0a74479e6c7\u0026amp;signature=f87ce3a945e7a055bb6a5856681dc21f003c90d954d8bae3be734d715f694540\">\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/relays/routes\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/relays/routes.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/relays/routes#webpage\",\"url\":\"https://docs.getbifrost.ai/relays/routes\",\"name\":\"Routes\",\"description\":\"Choose which operations of the API callers may use, which ones are charged, and which ones stream.\",\"dateModified\":\"2026-10-30T16:52:54.072Z\",\"isPartOf\":{\"@id\":\"https://docs.getbifrost.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.getbifrost.ai/relays/routes#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.getbifrost.ai/relays/routes#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Relays\",\"item\":\"https://docs.getbifrost.ai/relays/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Routes\",\"item\":\"https://docs.getbifrost.ai/relays/routes\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.getbifrost.ai/relays/routes#article\",\"headline\":\"Routes\",\"name\":\"Routes\",\"description\":\"Choose which operations of the API callers may use, which ones are charged, and which ones stream.\",\"url\":\"https://docs.getbifrost.ai/relays/routes\",\"mainEntityOfPage\":{\"@id\":\"https://docs.getbifrost.ai/relays/routes#webpage\"},\"dateModified\":\"2026-10-30T16:52:54.072Z\",\"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":"/relays/routes.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","groups":[{"group":"Overview","icon":"book-open-cover","pages":[{"title":"Bifrost AI Gateway","icon":"bridge","href":"/overview"}]},{"group":"Quick Start","icon":"rocket","pages":[{"group":"Gateway","icon":"server","pages":[{"title":"Setting Up","icon":"play","href":"/quickstart/gateway/setting-up"},{"title":"Setting up auth","icon":"lock","href":"/quickstart/gateway/setting-up-auth"},{"title":"Provider Configuration","icon":"sliders","href":"/quickstart/gateway/provider-configuration"},{"title":"Streaming Responses","icon":"water","href":"/quickstart/gateway/streaming"},{"title":"Tool Calling","icon":"wrench","href":"/quickstart/gateway/tool-calling"},{"title":"Multimodal Support","icon":"images","href":"/quickstart/gateway/multimodal"},{"title":"Reranking","icon":"book-open-cover","href":"/quickstart/gateway/reranking"},{"title":"Decisions","icon":"scale-balanced","href":"/quickstart/gateway/decisions"},{"title":"Integrations","icon":"plug","href":"/quickstart/gateway/integrations"}]},{"group":"Bifrost CLI","icon":"laptop-code","pages":[{"title":"Bifrost CLI","sidebarTitle":"Overview","icon":"laptop-code","href":"/quickstart/cli/getting-started"},{"title":"OSS setup","icon":"server","href":"/quickstart/cli/oss-setup"},{"title":"Enterprise setup","icon":"building","href":"/quickstart/cli/enterprise-setup"},{"title":"Contexts and credentials","icon":"layer-group","href":"/quickstart/cli/contexts"},{"title":"Coding agents","icon":"terminal","href":"/quickstart/cli/coding-agents"},{"title":"Commands","icon":"list","href":"/quickstart/cli/commands"},{"title":"Troubleshooting","icon":"screwdriver-wrench","href":"/quickstart/cli/troubleshooting"}]},{"group":"Use as Go SDK","icon":"code","pages":[{"title":"Setting Up","icon":"play","href":"/quickstart/go-sdk/setting-up"},{"title":"Provider Configuration","icon":"sliders","href":"/quickstart/go-sdk/provider-configuration"},{"title":"Context Keys","icon":"key","href":"/quickstart/go-sdk/context-keys"},{"title":"Streaming Responses","icon":"water","href":"/quickstart/go-sdk/streaming"},{"title":"Tool Calling","icon":"wrench","href":"/quickstart/go-sdk/tool-calling"},{"title":"Multimodal Support","icon":"images","href":"/quickstart/go-sdk/multimodal"},{"title":"Reranking","icon":"book-open-cover","href":"/quickstart/go-sdk/reranking"},{"title":"Decisions","icon":"scale-balanced","href":"/quickstart/go-sdk/decisions"},{"title":"Logging","icon":"file-lines","href":"/quickstart/go-sdk/logger"}]}]},{"group":"Release Cadence","icon":"calendar","pages":[{"title":"Release Cadence","icon":"box-open","href":"/release-cadence"}]},{"group":"Migration Guides","icon":"arrow-up-right-dots","pages":[{"title":"Migrating to v2.0.0","href":"/migration-guides/v2.0.0"},{"title":"Migrating to v1.5.0","href":"/migration-guides/v1.5.0"}]},{"group":"Migrate from other Gateway","icon":"arrow-up","pages":[{"title":"Migrating from LiteLLM","icon":"train","href":"/migration-guides/litellm"}]},{"group":"SDK Integrations","icon":"plug","pages":[{"title":"What is an integration?","icon":"box","href":"/integrations/what-is-an-integration"}]},{"group":"Providers \u0026 Guides","icon":"solar-system","pages":[{"group":"Supported Providers","icon":"bars-progress","pages":[{"title":"Overview","icon":"circle-info","href":"/providers/supported-providers/overview"},{"title":"Anthropic","icon":"asterisk","href":"/providers/supported-providers/anthropic"},{"title":"Azure","icon":"microsoft","href":"/providers/supported-providers/azure"},{"title":"Azure Model Router","icon":"microsoft","href":"/providers/supported-providers/azure-model-router"},{"title":"AWS Bedrock","icon":"aws","href":"/providers/supported-providers/bedrock"},{"title":"AWS Bedrock Mantle","icon":"aws","href":"/providers/supported-providers/bedrock-mantle"},{"title":"BytePlus","icon":"b","href":"/providers/supported-providers/byteplus"},{"title":"Cerebras","icon":"c","href":"/providers/supported-providers/cerebras"},{"title":"Cloudflare","icon":"cloud","href":"/providers/supported-providers/cloudflare"},{"title":"Cohere","icon":"c","href":"/providers/supported-providers/cohere"},{"title":"Databricks","icon":"database","href":"/providers/supported-providers/databricks"},{"title":"DeepSeek","icon":"d","href":"/providers/supported-providers/deepseek"},{"title":"ElevenLabs","icon":"pause","href":"/providers/supported-providers/elevenlabs"},{"title":"Fireworks","icon":"sparkles","href":"/providers/supported-providers/fireworks"},{"title":"Google Gemini","icon":"diamond","href":"/providers/supported-providers/gemini"},{"title":"GitHub Copilot","icon":"github","href":"/providers/supported-providers/github-copilot"},{"title":"Groq","icon":"bolt","href":"/providers/supported-providers/groq"},{"title":"Hugging Face","icon":"face-smiling-hands","href":"/providers/supported-providers/huggingface"},{"title":"MiniMax","icon":"m","href":"/providers/supported-providers/minimax"},{"title":"Mistral","icon":"m","href":"/providers/supported-providers/mistral"},{"title":"Nebius","icon":"n","href":"/providers/supported-providers/nebius"},{"title":"Ollama","icon":"o","href":"/providers/supported-providers/ollama"},{"title":"OpenCode","icon":"code","href":"/providers/supported-providers/opencode"},{"title":"OpenAI","icon":"openai","href":"/providers/supported-providers/openai"},{"title":"OpenRouter","icon":"split","href":"/providers/supported-providers/openrouter"},{"title":"Parasail","icon":"p","href":"/providers/supported-providers/parasail"},{"title":"Perplexity","icon":"hexagon-nodes","href":"/providers/supported-providers/perplexity"},{"title":"Replicate","icon":"R","href":"/providers/supported-providers/replicate"},{"title":"Runware","icon":"https://mintlify.s3.us-west-1.amazonaws.com/bifrost/media/runware-nav.svg","href":"/providers/supported-providers/runware"},{"title":"Runway ML","icon":"film","href":"/providers/supported-providers/runway"},{"title":"AWS SageMaker","icon":"aws","href":"/providers/supported-providers/sagemaker"},{"title":"Sarvam AI","icon":"s","href":"/providers/supported-providers/sarvam"},{"title":"SGLang","icon":"s","href":"/providers/supported-providers/sgl"},{"title":"TypeSafe","icon":"scale-balanced","href":"/providers/supported-providers/typesafe"},{"title":"Vertex AI","icon":"v","href":"/providers/supported-providers/vertex"},{"title":"vLLM","icon":"v","href":"/providers/supported-providers/vllm"},{"title":"Wafer","icon":"w","href":"/providers/supported-providers/wafer"},{"title":"xAI","icon":"x","href":"/providers/supported-providers/xai"}]},{"title":"Routing Rules","icon":"chart-diagram","href":"/providers/routing-rules"},{"title":"Provider Routing","icon":"route","href":"/providers/provider-routing"},{"title":"Session Affinity","icon":"link","href":"/providers/session-affinity"},{"title":"Aliasing Models","icon":"tag","href":"/providers/aliasing-models"},{"title":"Reasoning","icon":"brain","href":"/providers/reasoning"},{"title":"Performance Tuning","icon":"gauge-high","href":"/providers/performance"},{"title":"Custom Providers","icon":"gear","href":"/providers/custom-providers"},{"title":"Self-Hosted Decision Models","icon":"server","href":"/providers/self-hosted-decision-models"},{"title":"Custom Pricing","icon":"circle-dollar-to-slot","href":"/providers/custom-pricing"},{"title":"Request Options","icon":"list","href":"/providers/request-options"},{"title":"Response Headers","icon":"arrow-left-to-line","href":"/providers/response-headers"},{"title":"Test Harness Coverage","icon":"list-check","href":"/providers/test-harness-coverage"}]},{"group":"MCP Gateway","icon":"toolbox","pages":[{"title":"Overview","sidebarTitle":"Overview","icon":"circle-info","href":"/mcp/overview"},{"title":"Connecting to MCP Servers","sidebarTitle":"Connecting to Servers","icon":"plug","href":"/mcp/connecting-to-servers"},{"title":"OpenAPI Servers","sidebarTitle":"OpenAPI Specs","icon":"file-code","href":"/mcp/openapi-servers"},{"title":"Connections, States \u0026 Lifecycles","sidebarTitle":"Connections \u0026 States","icon":"diagram-project","href":"/mcp/connections"},{"title":"Virtual MCPs","icon":"layer-group","href":"/mcp/virtual-mcps"},{"group":"Authentication","icon":"shield-check","pages":[{"title":"MCP Authentication","sidebarTitle":"Overview","icon":"shield-check","href":"/mcp/auth/overview"},{"title":"No Authentication","sidebarTitle":"None","icon":"globe","href":"/mcp/auth/none"},{"title":"Header-Based Authentication","sidebarTitle":"Headers","icon":"key","href":"/mcp/auth/headers"},{"title":"Per-User Headers","sidebarTitle":"Per-User Headers","icon":"user-pen","href":"/mcp/auth/per-user-headers"},{"title":"OAuth 2.0 Authentication","sidebarTitle":"OAuth 2.0","icon":"lock","href":"/mcp/auth/oauth"},{"title":"Per-User OAuth","sidebarTitle":"Per-User OAuth","icon":"user-shield","href":"/mcp/auth/per-user-oauth"},{"title":"Token Exchange (On-Behalf-Of)","sidebarTitle":"Token Exchange","icon":"right-left","href":"/mcp/auth/token-exchange"},{"title":"Cross App Access (ID-JAG)","sidebarTitle":"Cross App Access","icon":"building-lock","href":"/mcp/auth/cross-app-access"}]},{"title":"Per-Caller Discovery","icon":"users-viewfinder","href":"/mcp/per-caller-discovery"},{"title":"MCP Sessions","sidebarTitle":"Sessions","icon":"table","href":"/mcp/sessions"},{"title":"Tool Execution","sidebarTitle":"Tool Execution","icon":"play","href":"/mcp/tool-execution"},{"title":"Resources and Prompts","sidebarTitle":"Resources \u0026 Prompts","icon":"book-open","href":"/mcp/resources-and-prompts"},{"title":"Agent Mode (Auto-Execution)","sidebarTitle":"Agent Mode","icon":"robot","href":"/mcp/agent-mode"},{"title":"Code Mode","sidebarTitle":"Code Mode","icon":"code","href":"/mcp/code-mode"},{"title":"Gateway Authentication","icon":"key","href":"/mcp/gateway-auth"},{"title":"Tool Hosting","sidebarTitle":"Tool Hosting","icon":"toolbox","href":"/mcp/tool-hosting"},{"title":"Tool Filtering","sidebarTitle":"Filtering","icon":"filter","href":"/mcp/filtering"}]},{"group":"Agent Gateway","icon":"robot","pages":[{"title":"Agent Gateway","sidebarTitle":"Overview","icon":"robot","href":"/features/agent-gateway/overview"},{"title":"Register your first agent","icon":"plus","href":"/features/agent-gateway/registration"},{"title":"Authentication","icon":"key","href":"/features/agent-gateway/authentication"},{"title":"Agent access","icon":"shield-check","href":"/features/agent-gateway/access-control"},{"title":"Messages, tasks, and events","icon":"comments","href":"/features/agent-gateway/messages-and-tasks"},{"title":"Connect model and tool calls","icon":"link","href":"/features/agent-gateway/integrating-your-agent"},{"title":"Read Agent Logs","icon":"magnifying-glass","href":"/features/agent-gateway/observability"},{"title":"Gateway settings and transports","icon":"gear","href":"/features/agent-gateway/configuration"},{"title":"Transport selection and recovery","icon":"arrows-rotate","href":"/features/agent-gateway/transports-and-recovery"},{"title":"Push notifications","icon":"bell","href":"/features/agent-gateway/push-notifications"},{"title":"Export agent telemetry","icon":"chart-line","href":"/features/agent-gateway/connectors"},{"title":"Troubleshooting","icon":"wrench","href":"/features/agent-gateway/troubleshooting"}]},{"group":"Relays","icon":"https://mintlify.s3.us-west-1.amazonaws.com/bifrost/media/relays-icon.svg","pages":[{"title":"Relays","sidebarTitle":"Overview","icon":"circle-info","href":"/relays/overview"},{"title":"Create a relay","description":"Register an API with its base URL and secret, then set how Bifrost signs in, which headers it adds, its timeouts and its proxy.","icon":"plus","href":"/relays/configuration"},{"title":"Routes","icon":"route","href":"/relays/routes"},{"title":"Pricing","description":"Price each relayed call with a fee per call, a price per unit read from the call, or the cost the API reports, and test it before callers see it.","icon":"calculator","href":"/relays/pricing"},{"title":"Troubleshooting","icon":"wrench","href":"/relays/troubleshooting"}]},{"group":"Custom plugins","icon":"puzzle-piece","pages":[{"title":"Getting Started","icon":"book","href":"/plugins/getting-started"},{"title":"Building Dynamically Linked Bifrost Binary","icon":"hammer","href":"/plugins/building-dynamic-binary"},{"title":"Plugin Sequencing","icon":"arrow-down-1-9","href":"/plugins/sequencing"},{"group":"Writing Plugins","icon":"code","pages":[{"title":"Writing Go Plugins","icon":"golang","href":"/plugins/writing-go-plugin"},{"title":"Writing WASM Plugins (Deprecated)","icon":"puzzle-piece","href":"/plugins/writing-wasm-plugin"}]},{"title":"Plugin Migration Guide","icon":"arrow-up-right-dots","href":"/plugins/migration-guide"}]},{"group":"Open Source Features","icon":"bolt","pages":[{"title":"Drop-in Replacement","icon":"shuffle","href":"/features/drop-in-replacement"},{"title":"Retries \u0026 Fallbacks","icon":"list-check","href":"/features/retries-and-fallbacks"},{"title":"Complexity Router","tag":"Beta","icon":"sliders","href":"/features/complexity-router"},{"title":"Warp","tag":"Alpha","icon":"sparkles","href":"/features/warp"},{"title":"Compatibility Plugin","icon":"train","href":"/features/compat-plugin"},{"title":"Load Balance","icon":"scale-balanced","href":"/features/keys-management"},{"title":"Async Inference","icon":"clock","href":"/features/async-inference"},{"title":"Webhooks","icon":"webhook","href":"/features/webhooks"},{"title":"News Feeds","icon":"newspaper","href":"/features/news-feeds"},{"group":"Governance","icon":"user-lock","pages":[{"title":"Virtual Keys","icon":"key","href":"/features/governance/virtual-keys"},{"title":"Routing","icon":"arrow-progress","href":"/features/governance/routing"},{"title":"Budget and Limits","icon":"money-bills","href":"/features/governance/budget-and-limits"},{"title":"Model Limits","icon":"sliders","href":"/features/governance/model-limits"},{"title":"MCP Tool Filtering","icon":"grid-2","href":"/features/governance/mcp-tools"},{"title":"Required Headers","icon":"shield-check","href":"/features/governance/required-headers"}]},{"title":"Telemetry","icon":"gauge","href":"/features/telemetry"},{"title":"OpenTelemetry","icon":"telescope","href":"/features/otel"},{"title":"Content Logging","icon":"eye-slash","href":"/features/observability/content-logging"},{"title":"Latency \u0026 Overhead Breakdown","icon":"gauge","href":"/features/observability/latency-breakdown"},{"title":"Semantic Caching","icon":"database","href":"/features/semantic-caching"},{"title":"Auto Prompt Caching","icon":"zap","href":"/features/prompt-caching"},{"title":"Skills Repository","icon":"book","href":"/features/skills-repository"},{"group":"Prompt Repository","icon":"folder","pages":[{"title":"Playground","icon":"square-terminal","href":"/features/prompt-repository/playground"},{"title":"Prompts plugin","icon":"puzzle-piece","href":"/features/prompt-repository/prompts-plugin"}]},{"group":"Plugins","icon":"puzzle-piece","pages":[{"title":"Mocker","icon":"mask","href":"/features/plugins/mocker"},{"title":"JSON Parser","icon":"code-branch","href":"/features/plugins/jsonparser"}]}]}]},{"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","pages":[{"title":"API","href":"/api/procuring-api-keys"}]},{"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.1"}]},{"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.48"}]}],"pages":[{"title":"Changelogs","href":"/changelogs/v2.5.1"}]}]},"basePath":"","title":"Routes - Bifrost","buildId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","deploymentId":"dpl_DqYu5MPb49gWBBbUGgpHQUmCHY3P","dynamics":["07c022d89b","a74be98ba7"],"chunks":["Frame-u3J1-UOn.js","DynamicMarkdown-B-f2cqXQ.js","zoom-image-lightbox-DTFzvaXJ.js","lightbox-handle-r17bVUz3.js"]}