Auriko routes the request to the optimal provider based on your routing preferences (cost, latency, throughput, etc.). For guide-level documentation, see the Response API overview.
The Response API is in preview. The interface may change before GA.
Auriko extensions
Auriko adds these capabilities to the standard Response API:
Multi-model routing: Use gateway.models[] instead of model to route across multiple models
Routing options: Control provider selection with the gateway.routing object
Provider extensions: Pass provider-specific parameters with extensions
Cost transparency: Response includes routing_metadata with cost breakdown
Authorizations
Authorization
string
header
required
API key authentication.
Keys start with ak_ prefix.
Example: Authorization: Bearer ak_live_xxxxxxxxxxxx
Body
application/json
Option 1
Option 2
Request body for creating a response via the Response API.
model
string
required
Model ID to use (e.g., "gpt-4o", "claude-sonnet-4-20250514").
Whether the model can make multiple tool calls in parallel.
max_output_tokens
integer
Maximum number of output tokens.
temperature
number
Sampling temperature.
Required range: 0 <= x <= 2
top_p
number
Nucleus sampling parameter.
Required range: 0 <= x <= 1
top_k
integer
Top-k sampling parameter.
top_logprobs
integer
Number of top logprobs to return per token position. Requires provider logprobs support.
Required range: 0 <= x <= 20
stream
boolean
Whether to stream the response.
text
object
Text generation configuration.
Show child attributes
reasoning
object
Reasoning/thinking configuration.
Show child attributes
truncation
string
Truncation strategy for long inputs.
metadata
object
Arbitrary key-value metadata.
Show child attributes
include
string[]
Additional data to include in the response.
user
string
End-user identifier for abuse detection.
store
enum<boolean>
Omit this field or set to false. Sending true returns 400.
Available options:
false
gateway
object
Auriko gateway directives.
Show child attributes
extensions
object
Auriko extensions for provider-specific passthrough.
For reasoning control, use the top-level reasoning_effort parameter
instead of extensions.
Provider Passthrough
Pass provider-specific parameters directly:
anthropic: Anthropic-specific parameters
openai: OpenAI-specific parameters
google: Google/Gemini-specific parameters
deepseek: DeepSeek-specific parameters
Passthrough parameters are forwarded as-is to the target provider.
Show child attributes
prompt_cache_key
string
Key for prompt caching.
safety_identifier
string
Safety policy identifier.
frequency_penalty
number
Penalizes new tokens based on their frequency in the text so far.
presence_penalty
number
Penalizes new tokens based on whether they appear in the text so far.
max_tool_calls
integer
Maximum number of built-in tool calls (e.g., web_search, code_interpreter) allowed in a response.
Required range: x >= 1
Response
Successful response.
For non-streaming requests, returns a ResponseObject.
For streaming (stream: true), returns Server-Sent Events in
the Response API format: event: <type>\ndata: <json>\n\n.
A completed Response API response.
id
string
required
Unique response identifier.
object
string
required
Allowed value: "response"
created_at
integer
required
Unix timestamp of creation.
model
string
required
Model used for generation.
status
enum<string>
required
Response status.
Available options:
completed,
failed,
incomplete,
in_progress
output
object[]
required
Output items generated by the model. Known types include
message, function_call, and reasoning. Additional types
from the provider (e.g., web_search_call, file_search_call)
are passed through verbatim.
An output item from the model. Discriminated on type.
Known types: message, function_call, reasoning, image_generation_call.
Unknown types from the provider are preserved verbatim.
Option 1
Option 2
Option 3
Option 4
Option 5
Show child attributes
output_text
string
Concatenated text output for convenience.
parallel_tool_calls
boolean
Whether parallel tool calls were enabled.
tool_choice
any
Tool choice setting used.
tools
any[]
Tools that were available.
usage
object
Token usage for a Response API request.
Show child attributes
error
object | null
Error details if status is "failed".
Show child attributes
incomplete_details
object | null
Details if status is "incomplete".
Show child attributes
metadata
object | null
Show child attributes
routing_metadata
object
Routing decision metadata included in successful responses.
8 STABLE fields (4 required + 4 optional) in the current public contract.
Show child attributes
temperature
number
Sampling temperature used.
top_p
number
Nucleus sampling parameter used.
max_output_tokens
integer | null
Maximum output tokens setting.
frequency_penalty
number
Frequency penalty setting.
presence_penalty
number
Presence penalty setting.
top_logprobs
integer
Number of top logprobs returned.
instructions
string | null
System instructions used.
truncation
string
Truncation strategy used.
reasoning
object | null
Reasoning configuration used.
text
object
Text generation configuration used.
user
string | null
End-user identifier.
prompt_cache_key
string | null
Prompt cache key used.
safety_identifier
string | null
Safety policy identifier used.
max_tool_calls
integer | null
Maximum number of built-in tool calls allowed in a response.
store
boolean
Whether the response is stored.
previous_response_id
string | null
Previous response ID for conversation continuity.
background
boolean
Whether this was a background response.
completed_at
integer | null
Unix timestamp when the response completed.
service_tier
string | null
Service tier used by the provider.
tool_usage
object | null
Built-in tool consumption metrics from the provider (e.g. image generation tokens, web search request counts). Present on OpenAI responses; absent for other providers.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Auriko","colors":{"primary":"#4779EA","light":"#5A8AF0","dark":"#457CFD"},"logo":{"light":"https://mintcdn.com/auriko/ZctT69z8zlG3FLhm/logo/light.svg?fit=max\u0026auto=format\u0026n=ZctT69z8zlG3FLhm\u0026q=85\u0026s=9160396833137f89a62e6297d0da13e3","dark":"https://mintcdn.com/auriko/ZctT69z8zlG3FLhm/logo/dark.svg?fit=max\u0026auto=format\u0026n=ZctT69z8zlG3FLhm\u0026q=85\u0026s=a4b0a27dddb8e89f557c88810e83c0d6","href":"https://www.auriko.ai"},"favicon":"https://mintcdn.com/auriko/yhqJ6Vvvah9BLEHr/favicon.svg?fit=max\u0026auto=format\u0026n=yhqJ6Vvvah9BLEHr\u0026q=85\u0026s=c69b6b12a2be60ef2e4ca140b765fb07","api":{"openapi":"openapi.yaml","playground":{"display":"simple"},"examples":{"languages":["python","javascript","bash"]}},"appearance":{"default":"light"},"background":{"color":{"light":"#FCFCFC","dark":"#121212"}},"navbar":{"links":[{"href":"https://auriko.ai/dashboard","label":"Dashboard"},{"href":"https://status.auriko.ai/","label":"Status"}],"primary":{"type":"button","label":"Get API Key","href":"https://auriko.ai/signup?redirectTo=%2Fdashboard%3Ftab%3Dapi-keys"}},"footer":{"socials":{"linkedin":"https://linkedin.com/company/auriko"}},"seo":{},"fonts":{"family":"Geist"},"integrations":{"ga4":{"measurementId":"G-T9E92EL136"},"posthog":{"apiKey":"phc_vN8XY29aw4p545BJEggF3maB23C8tRqidG5hpUP4Et6J","apiHost":"https://us.i.posthog.com"}},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"auriko","hasAudioNarration":false,"actualSubdomain":"auriko","customDomains":["docs.auriko.ai"],"gitSource":{"type":"github","owner":"auriko-ai","repo":"auriko","deployBranch":"main","contentDirectory":"docs-site","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6abd4cc98c699ce8aa4321dc","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"Documentation","count":105},{"language":"default","tag":"Specifications","count":68},{"language":"default","tag":"Error code reference","count":63},{"language":"default","tag":"API Reference","count":50},{"language":"default","tag":"Guides","count":11},{"language":"default","tag":"SDK","count":10},{"language":"default","tag":"BYOK","count":7},{"language":"default","tag":"Frameworks","count":7},{"language":"default","tag":"API Keys","count":6},{"language":"default","tag":"Integrations","count":6}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":true},"customCss":[{"filePath":"style.css","content":"img.nav-logo{height:1.25rem!important}"}]}
{"page":{"pagePath":"api-reference/create-response","slug":"/api-reference/create-response","pageMetadata":{"title":"Create response","description":"Create a model response using the OpenAI Response API format","openapi":"POST /v1/responses","last_verified":"2026-05-18","href":"/api-reference/create-response"},"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: \"Create a model response using the OpenAI Response API format\"\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`,li:`li`,p:`p`,strong:`strong`,ul:`ul`,..._provideComponents(),...props.components},{Heading,Note}=_components;if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsxs(_components.p,{children:[`Auriko routes the request to the optimal provider based on your routing preferences (cost, latency, throughput, etc.). For guide-level documentation, see the `,_jsx(_components.a,{href:`/response-api/overview`,children:`Response API overview`}),`.`]}),`\n`,_jsx(Note,{children:_jsx(_components.p,{children:`The Response API is in preview. The interface may change before GA.`})}),`\n`,_jsx(Heading,{level:`2`,id:`auriko-extensions`,children:`Auriko extensions`}),`\n`,_jsx(_components.p,{children:`Auriko adds these capabilities to the standard Response API:`}),`\n`,_jsxs(_components.ul,{children:[`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Multi-model routing`}),`: Use `,_jsx(_components.code,{children:`gateway.models[]`}),` instead of `,_jsx(_components.code,{children:`model`}),` to route across multiple models`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Routing options`}),`: Control provider selection with the `,_jsx(_components.code,{children:`gateway.routing`}),` object`]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Provider extensions`}),`: Pass provider-specific parameters with `,_jsx(_components.code,{children:`extensions`})]}),`\n`,_jsxs(_components.li,{children:[_jsx(_components.strong,{children:`Cost transparency`}),`: Response includes `,_jsx(_components.code,{children:`routing_metadata`}),` with cost breakdown`]}),`\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":"Create response","description":"Create a model response using the OpenAI Response API format","openapi":"POST /v1/responses","last_verified":"2026-05-18","href":"/api-reference/create-response"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Auriko extensions","slug":"auriko-extensions","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"createResponse","x-stability":"preview","summary":"Create a response (OpenAI Response API)","description":"Create a model response using the OpenAI Response API format","security":["b7828fa8-fa64-4476-8641-15be98bd8946"],"tags":["Responses"],"x-codeSamples":[{"lang":"bash","label":"curl","source":"curl https://api.auriko.ai/v1/responses \\\n -H \"Authorization: Bearer $AURIKO_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"model\": \"gpt-4o\",\n \"input\": \"Hello!\"\n }'\n"},{"lang":"python","label":"Python (OpenAI-compatible)","source":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ[\"AURIKO_API_KEY\"],\n base_url=\"https://api.auriko.ai/v1\"\n)\nresponse = client.responses.create(\n model=\"gpt-4o\",\n input=\"Hello!\"\n)\nprint(response.output_text)\n"},{"lang":"typescript","label":"TypeScript (OpenAI-compatible)","source":"import OpenAI from \"openai\";\n\nconst client = new OpenAI({\n apiKey: process.env.AURIKO_API_KEY,\n baseURL: \"https://api.auriko.ai/v1\",\n});\nconst response = await client.responses.create({\n model: \"gpt-4o\",\n input: \"Hello!\",\n});\nconsole.log(response.output_text);\n"},{"lang":"python","label":"Python","source":"from auriko import Client\n\nclient = Client()\nresponse = client.responses.create(\n model=\"gpt-4o\",\n input=\"Hello!\"\n)\nprint(response.output_text)\n"},{"lang":"typescript","label":"TypeScript","source":"import { Client } from \"@auriko/sdk\";\n\nconst client = new Client();\nconst response = await client.responses.create({\n model: \"gpt-4o\",\n input: \"Hello!\",\n});\nconsole.log(response.output_text);\n"}],"requestBody":"49079445-8f0f-4453-90f7-8b79dcecdce2","responses":{"200":"fd62711b-51c1-4f33-8d39-a45904a414d8","400":"bb6f308e-ba06-40e9-9ea0-658944c4fdcc","401":"def9b573-a19d-4944-9aad-75fcad8ad259","404":"70be0802-6da1-460d-85a4-30a32fac0e88","429":"1bda0cbe-8fad-4626-8797-c7a4d3844ccb","500":"794e6e69-7da0-4411-b8b5-a1cd2b957fb5","502":"9556f397-d92a-4179-bb18-3267ee14cbad","503":"c543cbda-6e9d-40f2-a714-82924bd02eaa","504":"a423f98a-f5e6-4fb1-a1b3-d1a3d78390a9"},"method":"post","type":"path","servers":["7a684522-107c-44d9-947d-4e0fc7defa27"],"path":"/v1/responses","baseUrlOptions":["https://api.auriko.ai"],"title":"Create a response (OpenAI Response API)","codeSamples":[{"label":"curl","lang":"bash","source":"curl https://api.auriko.ai/v1/responses \\\n -H \"Authorization: Bearer $AURIKO_API_KEY\" \\\n -H \"Content-Type: application/json\" \\\n -d '{\n \"model\": \"gpt-4o\",\n \"input\": \"Hello!\"\n }'\n"},{"label":"Python (OpenAI-compatible)","lang":"python","source":"import os\nfrom openai import OpenAI\n\nclient = OpenAI(\n api_key=os.environ[\"AURIKO_API_KEY\"],\n base_url=\"https://api.auriko.ai/v1\"\n)\nresponse = client.responses.create(\n model=\"gpt-4o\",\n input=\"Hello!\"\n)\nprint(response.output_text)\n"},{"label":"TypeScript (OpenAI-compatible)","lang":"typescript","source":"import OpenAI from \"openai\";\n\nconst client = new OpenAI({\n apiKey: process.env.AURIKO_API_KEY,\n baseURL: \"https://api.auriko.ai/v1\",\n});\nconst response = await client.responses.create({\n model: \"gpt-4o\",\n input: \"Hello!\",\n});\nconsole.log(response.output_text);\n"},{"label":"Python","lang":"python","source":"from auriko import Client\n\nclient = Client()\nresponse = client.responses.create(\n model=\"gpt-4o\",\n input=\"Hello!\"\n)\nprint(response.output_text)\n"},{"label":"TypeScript","lang":"typescript","source":"import { Client } from \"@auriko/sdk\";\n\nconst client = new Client();\nconst response = await client.responses.create({\n model: \"gpt-4o\",\n input: \"Hello!\",\n});\nconsole.log(response.output_text);\n"}],"requestExampleLanguages":["python","javascript","bash"],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","description":"Request body for creating a response via the Response API.","required":["input","model"],"properties":{"model":{"type":"string","description":"Model ID to use (e.g., \"gpt-4o\", \"claude-sonnet-4-20250514\").","isRequired":true,"uniqueKey":"oneOf.0.model","typeLabel":"string"},"input":{"oneOf":[{"type":"string","description":"The input to generate a response for.","isRequired":true,"uniqueKey":"oneOf.0.input.oneOf.0","typeLabel":"string"},{"type":"array","items":{"oneOf":[{"type":"object","description":"An input item in the conversation history.","required":["role","content"],"properties":{"role":{"type":"string","enum":["user","assistant","system","developer"],"isRequired":true,"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.0.role","typeLabel":"enum\u003cstring>"},"content":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.0.content.oneOf.0","typeLabel":"string"},{"type":"array","items":{"oneOf":[{"type":"object","description":"A content part in a message.","required":["type","text"],"properties":{"type":{"type":"string","const":"input_text","isRequired":true,"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].oneOf.0.type","typeLabel":"string"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].oneOf.0.text","typeLabel":"string"}},"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"A content part in a message.","required":["type"],"properties":{"type":{"type":"string","const":"input_image","isRequired":true,"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].oneOf.1.type","typeLabel":"string"},"image_url":{"type":"string","uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].oneOf.1.image_url","typeLabel":"string"},"detail":{"type":"string","enum":["auto","low","high"],"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].oneOf.1.detail","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"A content part in a message.","required":["type","text"],"properties":{"type":{"type":"string","const":"output_text","isRequired":true,"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].oneOf.2.type","typeLabel":"string"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].oneOf.2.text","typeLabel":"string"},"annotations":{"type":"array","items":{"oneOf":[{}],"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].oneOf.2.annotations.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].oneOf.2.annotations","typeLabel":"any[]"}},"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].oneOf.2","typeLabel":"object"}],"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.0.content.oneOf.1","typeLabel":"object[]"}],"isRequired":true,"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.0.content","typeLabel":"string | object[]"},"type":{"type":"string","description":"Optional, defaults to \"message\".","uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.0.type","typeLabel":"string"}},"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"An input item in the conversation history.","required":["type","call_id","name","arguments"],"properties":{"type":{"type":"string","const":"function_call","isRequired":true,"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.1.type","typeLabel":"string"},"call_id":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.1.call_id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.1.name","typeLabel":"string"},"arguments":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.1.arguments","typeLabel":"string"}},"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"An input item in the conversation history.","required":["type","call_id","output"],"properties":{"type":{"type":"string","const":"function_call_output","isRequired":true,"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.2.type","typeLabel":"string"},"call_id":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.2.call_id","typeLabel":"string"},"output":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.2.output","typeLabel":"string"}},"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"An input item in the conversation history.","required":["type"],"properties":{"type":{"type":"string","const":"reasoning","isRequired":true,"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.3.type","typeLabel":"string"},"id":{"type":"string","uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.3.id","typeLabel":"string"},"summary":{"type":"array","items":{"type":"object","required":["type","text"],"properties":{"type":{"type":"string","const":"summary_text","isRequired":true,"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.3.summary.items.[INDEX].type","typeLabel":"string"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.3.summary.items.[INDEX].text","typeLabel":"string"}},"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.3.summary.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.3.summary","typeLabel":"object[]"},"encrypted_content":{"type":"string","uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.3.encrypted_content","typeLabel":"string"}},"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX].oneOf.3","typeLabel":"object"}],"uniqueKey":"oneOf.0.input.oneOf.1.items.[INDEX]","typeLabel":"object"},"description":"The input to generate a response for.","isRequired":true,"uniqueKey":"oneOf.0.input.oneOf.1","typeLabel":"object[]"}],"isRequired":true,"uniqueKey":"oneOf.0.input","typeLabel":"string | object[]"},"instructions":{"type":"string","description":"System instructions for the model.","uniqueKey":"oneOf.0.instructions","typeLabel":"string"},"tools":{"type":"array","items":{"oneOf":[{"type":"object","description":"A tool available to the model.","required":["type","name"],"properties":{"type":{"type":"string","const":"function","isRequired":true,"uniqueKey":"oneOf.0.tools.items.[INDEX].oneOf.0.type","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.tools.items.[INDEX].oneOf.0.name","typeLabel":"string"},"description":{"type":"string","uniqueKey":"oneOf.0.tools.items.[INDEX].oneOf.0.description","typeLabel":"string"},"parameters":{"type":"any","uniqueKey":"oneOf.0.tools.items.[INDEX].oneOf.0.parameters","typeLabel":"any"},"strict":{"type":"boolean","uniqueKey":"oneOf.0.tools.items.[INDEX].oneOf.0.strict","typeLabel":"boolean"}},"uniqueKey":"oneOf.0.tools.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"A tool available to the model.","required":["type"],"properties":{"type":{"type":"string","description":"Tool type identifier.","isRequired":true,"uniqueKey":"oneOf.0.tools.items.[INDEX].oneOf.1.type","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"oneOf.0.tools.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.0.tools.items.[INDEX]","typeLabel":"object"},"description":"Tools available to the model.","uniqueKey":"oneOf.0.tools","typeLabel":"object[]"},"tool_choice":{"oneOf":[{"type":"string","description":"How the model should use tools.","enum":["auto","none","required"],"uniqueKey":"oneOf.0.tool_choice.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"object","description":"How the model should use tools.","required":["type","name"],"properties":{"type":{"type":"string","const":"function","isRequired":true,"uniqueKey":"oneOf.0.tool_choice.oneOf.1.type","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.tool_choice.oneOf.1.name","typeLabel":"string"}},"uniqueKey":"oneOf.0.tool_choice.oneOf.1","typeLabel":"object"},{"type":"object","description":"How the model should use tools.","required":["type"],"properties":{"type":{"type":"string","not":{"enum":["function"]},"isRequired":true,"uniqueKey":"oneOf.0.tool_choice.oneOf.2.type","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"oneOf.0.tool_choice.oneOf.2","typeLabel":"object"}],"uniqueKey":"oneOf.0.tool_choice","typeLabel":"enum\u003cstring> · object · object"},"parallel_tool_calls":{"type":"boolean","description":"Whether the model can make multiple tool calls in parallel.","uniqueKey":"oneOf.0.parallel_tool_calls","typeLabel":"boolean"},"max_output_tokens":{"type":"integer","description":"Maximum number of output tokens.","uniqueKey":"oneOf.0.max_output_tokens","typeLabel":"integer"},"temperature":{"type":"number","minimum":0,"maximum":2,"description":"Sampling temperature.","uniqueKey":"oneOf.0.temperature","typeLabel":"number"},"top_p":{"type":"number","minimum":0,"maximum":1,"description":"Nucleus sampling parameter.","uniqueKey":"oneOf.0.top_p","typeLabel":"number"},"top_k":{"type":"integer","description":"Top-k sampling parameter.","uniqueKey":"oneOf.0.top_k","typeLabel":"integer"},"top_logprobs":{"type":"integer","minimum":0,"maximum":20,"description":"Number of top logprobs to return per token position. Requires provider logprobs support.","uniqueKey":"oneOf.0.top_logprobs","typeLabel":"integer"},"stream":{"type":"boolean","description":"Whether to stream the response.","uniqueKey":"oneOf.0.stream","typeLabel":"boolean"},"text":{"type":"object","description":"Text generation configuration.","properties":{"format":{"oneOf":[{"type":"object","description":"Text output format configuration.","required":["type"],"properties":{"type":{"type":"string","const":"text","isRequired":true,"uniqueKey":"oneOf.0.text.format.oneOf.0.type","typeLabel":"string"}},"uniqueKey":"oneOf.0.text.format.oneOf.0","typeLabel":"object"},{"type":"object","description":"Text output format configuration.","required":["type"],"properties":{"type":{"type":"string","const":"json_object","isRequired":true,"uniqueKey":"oneOf.0.text.format.oneOf.1.type","typeLabel":"string"}},"uniqueKey":"oneOf.0.text.format.oneOf.1","typeLabel":"object"},{"type":"object","description":"Text output format configuration.","required":["type","name","schema"],"properties":{"type":{"type":"string","const":"json_schema","isRequired":true,"uniqueKey":"oneOf.0.text.format.oneOf.2.type","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.text.format.oneOf.2.name","typeLabel":"string"},"schema":{"type":"object","isRequired":true,"uniqueKey":"oneOf.0.text.format.oneOf.2.schema","typeLabel":"object"},"strict":{"type":"boolean","uniqueKey":"oneOf.0.text.format.oneOf.2.strict","typeLabel":"boolean"}},"uniqueKey":"oneOf.0.text.format.oneOf.2","typeLabel":"object"}],"uniqueKey":"oneOf.0.text.format","typeLabel":"object"}},"uniqueKey":"oneOf.0.text","typeLabel":"object"},"reasoning":{"type":"object","description":"Reasoning/thinking configuration.","properties":{"effort":{"type":"string","enum":["none","minimal","low","medium","high","xhigh","max","off"],"description":"Level of reasoning effort.","uniqueKey":"oneOf.0.reasoning.effort","typeLabel":"enum\u003cstring>"},"summary":{"type":"string","enum":["auto","concise","detailed"],"description":"Reasoning summary format.","uniqueKey":"oneOf.0.reasoning.summary","typeLabel":"enum\u003cstring>"},"generate_summary":{"type":"string","enum":["auto","concise","detailed"],"description":"Reasoning summary format (alternative field name).","uniqueKey":"oneOf.0.reasoning.generate_summary","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.0.reasoning","typeLabel":"object"},"truncation":{"type":"string","description":"Truncation strategy for long inputs.","uniqueKey":"oneOf.0.truncation","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"oneOf.0.metadata.additionalProperties","typeLabel":"string"},"description":"Arbitrary key-value metadata.","uniqueKey":"oneOf.0.metadata","typeLabel":"object"},"include":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.include.items.[INDEX]","typeLabel":"string"},"description":"Additional data to include in the response.","uniqueKey":"oneOf.0.include","typeLabel":"string[]"},"user":{"type":"string","description":"End-user identifier for abuse detection.","uniqueKey":"oneOf.0.user","typeLabel":"string"},"store":{"type":"boolean","enum":[false],"description":"Omit this field or set to false. Sending true returns 400.","uniqueKey":"oneOf.0.store","typeLabel":"enum\u003cboolean>"},"gateway":{"type":"object","description":"Auriko gateway directives.","properties":{"routing":{"type":"object","description":"Auriko routing configuration (20 fields).\n\nControls how Auriko selects providers for your request.\nAll fields are optional. Setting a field to `null` is equivalent to omitting it.\n","properties":{"optimize":{"oneOf":[{"type":"string","enum":["cost","cost-focus","ttft","ttft-focus","tps","tps-focus","balanced",null],"default":"cost-focus","description":"Optimization strategy:\n- `cost`: Minimize cost per token (well-rounded)\n- `cost-focus`: Aggressively minimize cost (default)\n- `ttft`: Minimize time to first token (well-rounded)\n- `ttft-focus`: Aggressively minimize time to first token\n- `tps`: Maximize tokens per second (well-rounded)\n- `tps-focus`: Aggressively maximize tokens per second\n- `balanced`: All dimensions weighted evenly\n","uniqueKey":"oneOf.0.gateway.routing.optimize.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["cost","cost-focus","ttft","ttft-focus","tps","tps-focus","balanced",null],"default":"cost-focus","description":"Optimization strategy:\n- `cost`: Minimize cost per token (well-rounded)\n- `cost-focus`: Aggressively minimize cost (default)\n- `ttft`: Minimize time to first token (well-rounded)\n- `ttft-focus`: Aggressively minimize time to first token\n- `tps`: Maximize tokens per second (well-rounded)\n- `tps-focus`: Aggressively maximize tokens per second\n- `balanced`: All dimensions weighted evenly\n","uniqueKey":"oneOf.0.gateway.routing.optimize.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.gateway.routing.optimize","typeLabel":"enum\u003cstring> | null"},"weights":{"oneOf":[{"type":"object","additionalProperties":false,"description":"Custom scoring weights for routing optimization.\nWhen provided, overrides the `optimize` preset coefficients.\nAll values must be non-negative. At least one dimension must be > 0.\nUnspecified dimensions default to 0. Server normalizes to sum to 1.0.\n","properties":{"cost":{"oneOf":[{"type":"number","minimum":0,"description":"Weight for cost minimization.","uniqueKey":"oneOf.0.gateway.routing.weights.oneOf.0.cost.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"description":"Weight for cost minimization.","uniqueKey":"oneOf.0.gateway.routing.weights.oneOf.0.cost.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.gateway.routing.weights.oneOf.0.cost","typeLabel":"number | null"},"ttft":{"oneOf":[{"type":"number","minimum":0,"description":"Weight for time-to-first-token optimization.","uniqueKey":"oneOf.0.gateway.routing.weights.oneOf.0.ttft.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"description":"Weight for time-to-first-token optimization.","uniqueKey":"oneOf.0.gateway.routing.weights.oneOf.0.ttft.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.gateway.routing.weights.oneOf.0.ttft","typeLabel":"number | null"},"throughput":{"oneOf":[{"type":"number","minimum":0,"description":"Weight for tokens-per-second optimization.","uniqueKey":"oneOf.0.gateway.routing.weights.oneOf.0.throughput.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"description":"Weight for tokens-per-second optimization.","uniqueKey":"oneOf.0.gateway.routing.weights.oneOf.0.throughput.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.gateway.routing.weights.oneOf.0.throughput","typeLabel":"number | null"}},"uniqueKey":"oneOf.0.gateway.routing.weights.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":false,"description":"Custom scoring weights for routing optimization.\nWhen provided, overrides the `optimize` preset coefficients.\nAll values must be non-negative. At least one dimension must be > 0.\nUnspecified dimensions default to 0. Server normalizes to sum to 1.0.\n","properties":{"cost":{"oneOf":[{"type":"number","minimum":0,"description":"Weight for cost minimization."},{"type":"null","minimum":0,"description":"Weight for cost minimization."}]},"ttft":{"oneOf":[{"type":"number","minimum":0,"description":"Weight for time-to-first-token optimization."},{"type":"null","minimum":0,"description":"Weight for time-to-first-token optimization."}]},"throughput":{"oneOf":[{"type":"number","minimum":0,"description":"Weight for tokens-per-second optimization."},{"type":"null","minimum":0,"description":"Weight for tokens-per-second optimization."}]}},"uniqueKey":"oneOf.0.gateway.routing.weights.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.gateway.routing.weights","typeLabel":"object | null"},"ttft_percentile":{"oneOf":[{"type":"string","enum":["p50","p95",null],"default":"p50","description":"Which percentile to use for TTFT metrics in scoring and constraint filtering.\np50 uses median, p95 uses worst-case. Default: p50.\n","uniqueKey":"oneOf.0.gateway.routing.ttft_percentile.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["p50","p95",null],"default":"p50","description":"Which percentile to use for TTFT metrics in scoring and constraint filtering.\np50 uses median, p95 uses worst-case. Default: p50.\n","uniqueKey":"oneOf.0.gateway.routing.ttft_percentile.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.gateway.routing.ttft_percentile","typeLabel":"enum\u003cstring> | null"},"throughput_percentile":{"oneOf":[{"type":"string","enum":["p50","p95",null],"default":"p50","description":"Which percentile to use for throughput metrics in scoring and constraint filtering.\np50 uses median, p95 uses worst-case. Default: p50.\n","uniqueKey":"oneOf.0.gateway.routing.throughput_percentile.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["p50","p95",null],"default":"p50","description":"Which percentile to use for throughput metrics in scoring and constraint filtering.\np50 uses median, p95 uses worst-case. Default: p50.\n","uniqueKey":"oneOf.0.gateway.routing.throughput_percentile.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.gateway.routing.throughput_percentile","typeLabel":"enum\u003cstring> | null"},"max_cost_per_1m":{"oneOf":[{"type":"number","exclusiveMinimum":0,"description":"Maximum cost per 1 million tokens (USD).\nProviders exceeding this cost are excluded from selection.\n","uniqueKey":"oneOf.0.gateway.routing.max_cost_per_1m.oneOf.0","typeLabel":"number"},{"type":"null","exclusiveMinimum":0,"description":"Maximum cost per 1 million tokens (USD).\nProviders exceeding this cost are excluded from selection.\n","uniqueKey":"oneOf.0.gateway.routing.max_cost_per_1m.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.gateway.routing.max_cost_per_1m","typeLabel":"number | null"},"max_ttft_ms":{"oneOf":[{"type":"integer","exclusiveMinimum":0,"description":"Maximum time to first token in milliseconds.\nProviders with estimated TTFT above this threshold are excluded.\n","uniqueKey":"oneOf.0.gateway.routing.max_ttft_ms.oneOf.0","typeLabel":"integer"},{"type":"null","exclusiveMinimum":0,"description":"Maximum time to first token in milliseconds.\nProviders with estimated TTFT above this threshold are excluded.\n","uniqueKey":"oneOf.0.gateway.routing.max_ttft_ms.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.gateway.routing.max_ttft_ms","typeLabel":"integer | null"},"min_throughput_tps":{"oneOf":[{"type":"number","exclusiveMinimum":0,"description":"Minimum throughput in tokens per second.\nProviders with estimated throughput below this threshold are excluded.\n","uniqueKey":"oneOf.0.gateway.routing.min_throughput_tps.oneOf.0","typeLabel":"number"},{"type":"null","exclusiveMinimum":0,"description":"Minimum throughput in tokens per second.\nProviders with estimated throughput below this threshold are excluded.\n","uniqueKey":"oneOf.0.gateway.routing.min_throughput_tps.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.gateway.routing.min_throughput_tps","typeLabel":"number | null"},"providers":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.gateway.routing.providers.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Provider allowlist. Only consider these providers.\n\nExamples: `[\"openai\", \"anthropic\", \"fireworks_ai\"]`\n","uniqueKey":"oneOf.0.gateway.routing.providers.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Provider allowlist. Only consider these providers.\n\nExamples: `[\"openai\", \"anthropic\", \"fireworks_ai\"]`\n","uniqueKey":"oneOf.0.gateway.routing.providers.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.gateway.routing.providers","typeLabel":"string[] | null"},"exclude_providers":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.gateway.routing.exclude_providers.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Provider blocklist. Exclude these providers.\n\nExamples: `[\"together_ai\"]`\n","uniqueKey":"oneOf.0.gateway.routing.exclude_providers.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Provider blocklist. Exclude these providers.\n\nExamples: `[\"together_ai\"]`\n","uniqueKey":"oneOf.0.gateway.routing.exclude_providers.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.gateway.routing.exclude_providers","typeLabel":"string[] | null"},"prefer":{"oneOf":[{"type":"string","description":"Preference boost for this provider.\nProvider will be selected if it meets constraints.\n","uniqueKey":"oneOf.0.gateway.routing.prefer.oneOf.0","typeLabel":"string"},{"type":"null","description":"Preference boost for this provider.\nProvider will be selected if it meets constraints.\n","uniqueKey":"oneOf.0.gateway.routing.prefer.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.gateway.routing.prefer","typeLabel":"string | null"},"mode":{"oneOf":[{"type":"string","enum":["pool","fallback",null],"default":"pool","description":"How to interpret `gateway.models[]` array:\n- `pool` (default): Route to best provider across all models\n- `fallback`: Try models in order until one succeeds\n","uniqueKey":"oneOf.0.gateway.routing.mode.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["pool","fallback",null],"default":"pool","description":"How to interpret `gateway.models[]` array:\n- `pool` (default): Route to best provider across all models\n- `fallback`: Try models in order until one succeeds\n","uniqueKey":"oneOf.0.gateway.routing.mode.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.gateway.routing.mode","typeLabel":"enum\u003cstring> | null"},"allow_fallbacks":{"oneOf":[{"type":"boolean","default":true,"description":"Enable automatic fallback to alternative providers on failure","uniqueKey":"oneOf.0.gateway.routing.allow_fallbacks.oneOf.0","typeLabel":"boolean"},{"type":"null","default":true,"description":"Enable automatic fallback to alternative providers on failure","uniqueKey":"oneOf.0.gateway.routing.allow_fallbacks.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.gateway.routing.allow_fallbacks","typeLabel":"boolean | null"},"max_fallback_attempts":{"oneOf":[{"type":"integer","minimum":1,"maximum":19,"default":19,"description":"Maximum fallback attempts before giving up (chain length 20 = primary + 19 fallbacks). Range: 1-19.","uniqueKey":"oneOf.0.gateway.routing.max_fallback_attempts.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"maximum":19,"default":19,"description":"Maximum fallback attempts before giving up (chain length 20 = primary + 19 fallbacks). Range: 1-19.","uniqueKey":"oneOf.0.gateway.routing.max_fallback_attempts.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.gateway.routing.max_fallback_attempts","typeLabel":"integer | null"},"timeout_ms":{"oneOf":[{"type":"integer","minimum":1,"description":"Per-attempt timeout in milliseconds. For streaming requests: time to first SSE byte. For non-streaming requests: time to complete response. Default: 120000 (120s streaming first-byte), 300000 (5min non-streaming total).\n","uniqueKey":"oneOf.0.gateway.routing.timeout_ms.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"description":"Per-attempt timeout in milliseconds. For streaming requests: time to first SSE byte. For non-streaming requests: time to complete response. Default: 120000 (120s streaming first-byte), 300000 (5min non-streaming total).\n","uniqueKey":"oneOf.0.gateway.routing.timeout_ms.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.gateway.routing.timeout_ms","typeLabel":"integer | null"},"deadline_ms":{"oneOf":[{"type":"integer","minimum":1,"description":"Request deadline in milliseconds. Hard wall-clock cap across all fallback attempts. Must be >= timeout_ms when both are set. Non-streaming requests default to 1080000 (18 minutes); streaming has no default.\n","uniqueKey":"oneOf.0.gateway.routing.deadline_ms.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"description":"Request deadline in milliseconds. Hard wall-clock cap across all fallback attempts. Must be >= timeout_ms when both are set. Non-streaming requests default to 1080000 (18 minutes); streaming has no default.\n","uniqueKey":"oneOf.0.gateway.routing.deadline_ms.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.gateway.routing.deadline_ms","typeLabel":"integer | null"},"data_policy":{"oneOf":[{"type":"string","enum":["none","no_training","zdr",null],"default":"none","description":"Data retention policy requirement:\n- `none`: No restrictions (default)\n- `no_training`: Provider must not use data for training\n- `zdr`: Zero Data Retention (strictest)\n","uniqueKey":"oneOf.0.gateway.routing.data_policy.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["none","no_training","zdr",null],"default":"none","description":"Data retention policy requirement:\n- `none`: No restrictions (default)\n- `no_training`: Provider must not use data for training\n- `zdr`: Zero Data Retention (strictest)\n","uniqueKey":"oneOf.0.gateway.routing.data_policy.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.gateway.routing.data_policy","typeLabel":"enum\u003cstring> | null"},"only_byok":{"oneOf":[{"type":"boolean","default":false,"description":"Only use Bring Your Own Key (BYOK) providers.\nMutually exclusive with `only_platform`. Returns 400 if both are set.\n","uniqueKey":"oneOf.0.gateway.routing.only_byok.oneOf.0","typeLabel":"boolean"},{"type":"null","default":false,"description":"Only use Bring Your Own Key (BYOK) providers.\nMutually exclusive with `only_platform`. Returns 400 if both are set.\n","uniqueKey":"oneOf.0.gateway.routing.only_byok.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.gateway.routing.only_byok","typeLabel":"boolean | null"},"only_platform":{"oneOf":[{"type":"boolean","default":false,"description":"Only use platform-managed API keys.\nMutually exclusive with `only_byok`. Returns 400 if both are set.\n","uniqueKey":"oneOf.0.gateway.routing.only_platform.oneOf.0","typeLabel":"boolean"},{"type":"null","default":false,"description":"Only use platform-managed API keys.\nMutually exclusive with `only_byok`. Returns 400 if both are set.\n","uniqueKey":"oneOf.0.gateway.routing.only_platform.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.gateway.routing.only_platform","typeLabel":"boolean | null"},"require_parameters":{"oneOf":[{"type":"boolean","default":false,"description":"When true, only route to providers whose accepted_params includes\nall optional parameters sent in this request. Default: false.\n","uniqueKey":"oneOf.0.gateway.routing.require_parameters.oneOf.0","typeLabel":"boolean"},{"type":"null","default":false,"description":"When true, only route to providers whose accepted_params includes\nall optional parameters sent in this request. Default: false.\n","uniqueKey":"oneOf.0.gateway.routing.require_parameters.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.gateway.routing.require_parameters","typeLabel":"boolean | null"},"tier":{"oneOf":[{"type":"string","description":"Opt in to a pricing tier. Currently supported: `priority` (Anthropic fast mode — 2.5x speed at 6x cost).\nNote: Auriko's \"priority\" tier refers to Anthropic Fast Mode, not Anthropic's separate Priority Tier (committed capacity SLA).\nOmitting this field (default) excludes premium-tier offerings from routing.\n","enum":["priority",null],"uniqueKey":"oneOf.0.gateway.routing.tier.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Opt in to a pricing tier. Currently supported: `priority` (Anthropic fast mode — 2.5x speed at 6x cost).\nNote: Auriko's \"priority\" tier refers to Anthropic Fast Mode, not Anthropic's separate Priority Tier (committed capacity SLA).\nOmitting this field (default) excludes premium-tier offerings from routing.\n","enum":["priority",null],"uniqueKey":"oneOf.0.gateway.routing.tier.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.gateway.routing.tier","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"oneOf.0.gateway.routing","typeLabel":"object"},"metadata":{"type":"object","description":"Optional request metadata for tracking and observability.\nAttached via the `gateway.metadata` field on chat completion requests.\n","properties":{"tags":{"type":"array","items":{"type":"string","maxLength":50,"uniqueKey":"oneOf.0.gateway.metadata.tags.items.[INDEX]","typeLabel":"string"},"maxItems":100,"description":"Tags for categorizing requests (max 100 items, each ≤50 chars)","uniqueKey":"oneOf.0.gateway.metadata.tags","typeLabel":"string[]"},"user_id":{"type":"string","maxLength":255,"description":"Your application's user identifier for per-user analytics","uniqueKey":"oneOf.0.gateway.metadata.user_id","typeLabel":"string"},"trace_id":{"type":"string","maxLength":255,"description":"Distributed tracing identifier to correlate with your observability stack","uniqueKey":"oneOf.0.gateway.metadata.trace_id","typeLabel":"string"},"custom_fields":{"type":"object","maxProperties":10,"additionalProperties":{"type":"string","maxLength":200,"uniqueKey":"oneOf.0.gateway.metadata.custom_fields.additionalProperties","typeLabel":"string"},"description":"Arbitrary key-value pairs (max 10 keys, keys ≤50 chars, values ≤200 chars)\n","uniqueKey":"oneOf.0.gateway.metadata.custom_fields","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"oneOf.0.gateway.metadata","typeLabel":"object"},"models":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.gateway.models.items.[INDEX]","typeLabel":"string"},"description":"Model pool for multi-model routing.","uniqueKey":"oneOf.0.gateway.models","typeLabel":"string[]"}},"uniqueKey":"oneOf.0.gateway","typeLabel":"object"},"extensions":{"type":"object","description":"Auriko extensions for provider-specific passthrough.\n\nFor reasoning control, use the top-level `reasoning_effort` parameter\ninstead of extensions.\n\n## Provider Passthrough\n\nPass provider-specific parameters directly:\n- `anthropic`: Anthropic-specific parameters\n- `openai`: OpenAI-specific parameters\n- `google`: Google/Gemini-specific parameters\n- `deepseek`: DeepSeek-specific parameters\n\nPassthrough parameters are forwarded as-is to the target provider.\n","properties":{"anthropic":{"type":"object","additionalProperties":true,"description":"Anthropic-specific parameters (passed through)","uniqueKey":"oneOf.0.extensions.anthropic","typeLabel":"object"},"openai":{"type":"object","additionalProperties":true,"description":"OpenAI-specific parameters (passed through)","uniqueKey":"oneOf.0.extensions.openai","typeLabel":"object"},"google":{"type":"object","additionalProperties":true,"description":"Google/Gemini-specific parameters (passed through)","uniqueKey":"oneOf.0.extensions.google","typeLabel":"object"},"deepseek":{"type":"object","additionalProperties":true,"description":"DeepSeek-specific parameters (passed through)","uniqueKey":"oneOf.0.extensions.deepseek","typeLabel":"object"}},"additionalProperties":{"type":"object","description":"Other provider-specific passthrough","uniqueKey":"oneOf.0.extensions.additionalProperties","typeLabel":"object"},"not":{"required":["thinking"]},"uniqueKey":"oneOf.0.extensions","typeLabel":"object"},"prompt_cache_key":{"type":"string","description":"Key for prompt caching.","uniqueKey":"oneOf.0.prompt_cache_key","typeLabel":"string"},"safety_identifier":{"type":"string","description":"Safety policy identifier.","uniqueKey":"oneOf.0.safety_identifier","typeLabel":"string"},"frequency_penalty":{"type":"number","description":"Penalizes new tokens based on their frequency in the text so far.","uniqueKey":"oneOf.0.frequency_penalty","typeLabel":"number"},"presence_penalty":{"type":"number","description":"Penalizes new tokens based on whether they appear in the text so far.","uniqueKey":"oneOf.0.presence_penalty","typeLabel":"number"},"max_tool_calls":{"type":"integer","minimum":1,"description":"Maximum number of built-in tool calls (e.g., web_search, code_interpreter) allowed in a response.","uniqueKey":"oneOf.0.max_tool_calls","typeLabel":"integer"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","description":"Request body for creating a response via the Response API.","required":["input","gateway"],"properties":{"gateway":{"type":"object","description":"Auriko gateway directives.","required":["models"],"properties":{"models":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.gateway.models.items.[INDEX]","typeLabel":"string"},"description":"Model pool for multi-model routing.","isRequired":true,"uniqueKey":"oneOf.1.gateway.models","typeLabel":"string[]"},"routing":{"type":"object","description":"Auriko routing configuration (20 fields).\n\nControls how Auriko selects providers for your request.\nAll fields are optional. Setting a field to `null` is equivalent to omitting it.\n","properties":{"optimize":{"oneOf":[{"type":"string","enum":["cost","cost-focus","ttft","ttft-focus","tps","tps-focus","balanced",null],"default":"cost-focus","description":"Optimization strategy:\n- `cost`: Minimize cost per token (well-rounded)\n- `cost-focus`: Aggressively minimize cost (default)\n- `ttft`: Minimize time to first token (well-rounded)\n- `ttft-focus`: Aggressively minimize time to first token\n- `tps`: Maximize tokens per second (well-rounded)\n- `tps-focus`: Aggressively maximize tokens per second\n- `balanced`: All dimensions weighted evenly\n","uniqueKey":"oneOf.1.gateway.routing.optimize.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["cost","cost-focus","ttft","ttft-focus","tps","tps-focus","balanced",null],"default":"cost-focus","description":"Optimization strategy:\n- `cost`: Minimize cost per token (well-rounded)\n- `cost-focus`: Aggressively minimize cost (default)\n- `ttft`: Minimize time to first token (well-rounded)\n- `ttft-focus`: Aggressively minimize time to first token\n- `tps`: Maximize tokens per second (well-rounded)\n- `tps-focus`: Aggressively maximize tokens per second\n- `balanced`: All dimensions weighted evenly\n","uniqueKey":"oneOf.1.gateway.routing.optimize.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.gateway.routing.optimize","typeLabel":"enum\u003cstring> | null"},"weights":{"oneOf":[{"type":"object","additionalProperties":false,"description":"Custom scoring weights for routing optimization.\nWhen provided, overrides the `optimize` preset coefficients.\nAll values must be non-negative. At least one dimension must be > 0.\nUnspecified dimensions default to 0. Server normalizes to sum to 1.0.\n","properties":{"cost":{"oneOf":[{"type":"number","minimum":0,"description":"Weight for cost minimization.","uniqueKey":"oneOf.1.gateway.routing.weights.oneOf.0.cost.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"description":"Weight for cost minimization.","uniqueKey":"oneOf.1.gateway.routing.weights.oneOf.0.cost.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.gateway.routing.weights.oneOf.0.cost","typeLabel":"number | null"},"ttft":{"oneOf":[{"type":"number","minimum":0,"description":"Weight for time-to-first-token optimization.","uniqueKey":"oneOf.1.gateway.routing.weights.oneOf.0.ttft.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"description":"Weight for time-to-first-token optimization.","uniqueKey":"oneOf.1.gateway.routing.weights.oneOf.0.ttft.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.gateway.routing.weights.oneOf.0.ttft","typeLabel":"number | null"},"throughput":{"oneOf":[{"type":"number","minimum":0,"description":"Weight for tokens-per-second optimization.","uniqueKey":"oneOf.1.gateway.routing.weights.oneOf.0.throughput.oneOf.0","typeLabel":"number"},{"type":"null","minimum":0,"description":"Weight for tokens-per-second optimization.","uniqueKey":"oneOf.1.gateway.routing.weights.oneOf.0.throughput.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.gateway.routing.weights.oneOf.0.throughput","typeLabel":"number | null"}},"uniqueKey":"oneOf.1.gateway.routing.weights.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":false,"description":"Custom scoring weights for routing optimization.\nWhen provided, overrides the `optimize` preset coefficients.\nAll values must be non-negative. At least one dimension must be > 0.\nUnspecified dimensions default to 0. Server normalizes to sum to 1.0.\n","properties":{"cost":{"oneOf":[{"type":"number","minimum":0,"description":"Weight for cost minimization."},{"type":"null","minimum":0,"description":"Weight for cost minimization."}]},"ttft":{"oneOf":[{"type":"number","minimum":0,"description":"Weight for time-to-first-token optimization."},{"type":"null","minimum":0,"description":"Weight for time-to-first-token optimization."}]},"throughput":{"oneOf":[{"type":"number","minimum":0,"description":"Weight for tokens-per-second optimization."},{"type":"null","minimum":0,"description":"Weight for tokens-per-second optimization."}]}},"uniqueKey":"oneOf.1.gateway.routing.weights.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.gateway.routing.weights","typeLabel":"object | null"},"ttft_percentile":{"oneOf":[{"type":"string","enum":["p50","p95",null],"default":"p50","description":"Which percentile to use for TTFT metrics in scoring and constraint filtering.\np50 uses median, p95 uses worst-case. Default: p50.\n","uniqueKey":"oneOf.1.gateway.routing.ttft_percentile.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["p50","p95",null],"default":"p50","description":"Which percentile to use for TTFT metrics in scoring and constraint filtering.\np50 uses median, p95 uses worst-case. Default: p50.\n","uniqueKey":"oneOf.1.gateway.routing.ttft_percentile.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.gateway.routing.ttft_percentile","typeLabel":"enum\u003cstring> | null"},"throughput_percentile":{"oneOf":[{"type":"string","enum":["p50","p95",null],"default":"p50","description":"Which percentile to use for throughput metrics in scoring and constraint filtering.\np50 uses median, p95 uses worst-case. Default: p50.\n","uniqueKey":"oneOf.1.gateway.routing.throughput_percentile.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["p50","p95",null],"default":"p50","description":"Which percentile to use for throughput metrics in scoring and constraint filtering.\np50 uses median, p95 uses worst-case. Default: p50.\n","uniqueKey":"oneOf.1.gateway.routing.throughput_percentile.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.gateway.routing.throughput_percentile","typeLabel":"enum\u003cstring> | null"},"max_cost_per_1m":{"oneOf":[{"type":"number","exclusiveMinimum":0,"description":"Maximum cost per 1 million tokens (USD).\nProviders exceeding this cost are excluded from selection.\n","uniqueKey":"oneOf.1.gateway.routing.max_cost_per_1m.oneOf.0","typeLabel":"number"},{"type":"null","exclusiveMinimum":0,"description":"Maximum cost per 1 million tokens (USD).\nProviders exceeding this cost are excluded from selection.\n","uniqueKey":"oneOf.1.gateway.routing.max_cost_per_1m.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.gateway.routing.max_cost_per_1m","typeLabel":"number | null"},"max_ttft_ms":{"oneOf":[{"type":"integer","exclusiveMinimum":0,"description":"Maximum time to first token in milliseconds.\nProviders with estimated TTFT above this threshold are excluded.\n","uniqueKey":"oneOf.1.gateway.routing.max_ttft_ms.oneOf.0","typeLabel":"integer"},{"type":"null","exclusiveMinimum":0,"description":"Maximum time to first token in milliseconds.\nProviders with estimated TTFT above this threshold are excluded.\n","uniqueKey":"oneOf.1.gateway.routing.max_ttft_ms.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.gateway.routing.max_ttft_ms","typeLabel":"integer | null"},"min_throughput_tps":{"oneOf":[{"type":"number","exclusiveMinimum":0,"description":"Minimum throughput in tokens per second.\nProviders with estimated throughput below this threshold are excluded.\n","uniqueKey":"oneOf.1.gateway.routing.min_throughput_tps.oneOf.0","typeLabel":"number"},{"type":"null","exclusiveMinimum":0,"description":"Minimum throughput in tokens per second.\nProviders with estimated throughput below this threshold are excluded.\n","uniqueKey":"oneOf.1.gateway.routing.min_throughput_tps.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.gateway.routing.min_throughput_tps","typeLabel":"number | null"},"providers":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.gateway.routing.providers.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Provider allowlist. Only consider these providers.\n\nExamples: `[\"openai\", \"anthropic\", \"fireworks_ai\"]`\n","uniqueKey":"oneOf.1.gateway.routing.providers.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Provider allowlist. Only consider these providers.\n\nExamples: `[\"openai\", \"anthropic\", \"fireworks_ai\"]`\n","uniqueKey":"oneOf.1.gateway.routing.providers.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.gateway.routing.providers","typeLabel":"string[] | null"},"exclude_providers":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.gateway.routing.exclude_providers.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Provider blocklist. Exclude these providers.\n\nExamples: `[\"together_ai\"]`\n","uniqueKey":"oneOf.1.gateway.routing.exclude_providers.oneOf.0","typeLabel":"string[]"},{"type":"null","items":{"type":"string"},"description":"Provider blocklist. Exclude these providers.\n\nExamples: `[\"together_ai\"]`\n","uniqueKey":"oneOf.1.gateway.routing.exclude_providers.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.gateway.routing.exclude_providers","typeLabel":"string[] | null"},"prefer":{"oneOf":[{"type":"string","description":"Preference boost for this provider.\nProvider will be selected if it meets constraints.\n","uniqueKey":"oneOf.1.gateway.routing.prefer.oneOf.0","typeLabel":"string"},{"type":"null","description":"Preference boost for this provider.\nProvider will be selected if it meets constraints.\n","uniqueKey":"oneOf.1.gateway.routing.prefer.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.gateway.routing.prefer","typeLabel":"string | null"},"mode":{"oneOf":[{"type":"string","enum":["pool","fallback",null],"default":"pool","description":"How to interpret `gateway.models[]` array:\n- `pool` (default): Route to best provider across all models\n- `fallback`: Try models in order until one succeeds\n","uniqueKey":"oneOf.1.gateway.routing.mode.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["pool","fallback",null],"default":"pool","description":"How to interpret `gateway.models[]` array:\n- `pool` (default): Route to best provider across all models\n- `fallback`: Try models in order until one succeeds\n","uniqueKey":"oneOf.1.gateway.routing.mode.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.gateway.routing.mode","typeLabel":"enum\u003cstring> | null"},"allow_fallbacks":{"oneOf":[{"type":"boolean","default":true,"description":"Enable automatic fallback to alternative providers on failure","uniqueKey":"oneOf.1.gateway.routing.allow_fallbacks.oneOf.0","typeLabel":"boolean"},{"type":"null","default":true,"description":"Enable automatic fallback to alternative providers on failure","uniqueKey":"oneOf.1.gateway.routing.allow_fallbacks.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.gateway.routing.allow_fallbacks","typeLabel":"boolean | null"},"max_fallback_attempts":{"oneOf":[{"type":"integer","minimum":1,"maximum":19,"default":19,"description":"Maximum fallback attempts before giving up (chain length 20 = primary + 19 fallbacks). Range: 1-19.","uniqueKey":"oneOf.1.gateway.routing.max_fallback_attempts.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"maximum":19,"default":19,"description":"Maximum fallback attempts before giving up (chain length 20 = primary + 19 fallbacks). Range: 1-19.","uniqueKey":"oneOf.1.gateway.routing.max_fallback_attempts.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.gateway.routing.max_fallback_attempts","typeLabel":"integer | null"},"timeout_ms":{"oneOf":[{"type":"integer","minimum":1,"description":"Per-attempt timeout in milliseconds. For streaming requests: time to first SSE byte. For non-streaming requests: time to complete response. Default: 120000 (120s streaming first-byte), 300000 (5min non-streaming total).\n","uniqueKey":"oneOf.1.gateway.routing.timeout_ms.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"description":"Per-attempt timeout in milliseconds. For streaming requests: time to first SSE byte. For non-streaming requests: time to complete response. Default: 120000 (120s streaming first-byte), 300000 (5min non-streaming total).\n","uniqueKey":"oneOf.1.gateway.routing.timeout_ms.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.gateway.routing.timeout_ms","typeLabel":"integer | null"},"deadline_ms":{"oneOf":[{"type":"integer","minimum":1,"description":"Request deadline in milliseconds. Hard wall-clock cap across all fallback attempts. Must be >= timeout_ms when both are set. Non-streaming requests default to 1080000 (18 minutes); streaming has no default.\n","uniqueKey":"oneOf.1.gateway.routing.deadline_ms.oneOf.0","typeLabel":"integer"},{"type":"null","minimum":1,"description":"Request deadline in milliseconds. Hard wall-clock cap across all fallback attempts. Must be >= timeout_ms when both are set. Non-streaming requests default to 1080000 (18 minutes); streaming has no default.\n","uniqueKey":"oneOf.1.gateway.routing.deadline_ms.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.gateway.routing.deadline_ms","typeLabel":"integer | null"},"data_policy":{"oneOf":[{"type":"string","enum":["none","no_training","zdr",null],"default":"none","description":"Data retention policy requirement:\n- `none`: No restrictions (default)\n- `no_training`: Provider must not use data for training\n- `zdr`: Zero Data Retention (strictest)\n","uniqueKey":"oneOf.1.gateway.routing.data_policy.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["none","no_training","zdr",null],"default":"none","description":"Data retention policy requirement:\n- `none`: No restrictions (default)\n- `no_training`: Provider must not use data for training\n- `zdr`: Zero Data Retention (strictest)\n","uniqueKey":"oneOf.1.gateway.routing.data_policy.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.gateway.routing.data_policy","typeLabel":"enum\u003cstring> | null"},"only_byok":{"oneOf":[{"type":"boolean","default":false,"description":"Only use Bring Your Own Key (BYOK) providers.\nMutually exclusive with `only_platform`. Returns 400 if both are set.\n","uniqueKey":"oneOf.1.gateway.routing.only_byok.oneOf.0","typeLabel":"boolean"},{"type":"null","default":false,"description":"Only use Bring Your Own Key (BYOK) providers.\nMutually exclusive with `only_platform`. Returns 400 if both are set.\n","uniqueKey":"oneOf.1.gateway.routing.only_byok.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.gateway.routing.only_byok","typeLabel":"boolean | null"},"only_platform":{"oneOf":[{"type":"boolean","default":false,"description":"Only use platform-managed API keys.\nMutually exclusive with `only_byok`. Returns 400 if both are set.\n","uniqueKey":"oneOf.1.gateway.routing.only_platform.oneOf.0","typeLabel":"boolean"},{"type":"null","default":false,"description":"Only use platform-managed API keys.\nMutually exclusive with `only_byok`. Returns 400 if both are set.\n","uniqueKey":"oneOf.1.gateway.routing.only_platform.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.gateway.routing.only_platform","typeLabel":"boolean | null"},"require_parameters":{"oneOf":[{"type":"boolean","default":false,"description":"When true, only route to providers whose accepted_params includes\nall optional parameters sent in this request. Default: false.\n","uniqueKey":"oneOf.1.gateway.routing.require_parameters.oneOf.0","typeLabel":"boolean"},{"type":"null","default":false,"description":"When true, only route to providers whose accepted_params includes\nall optional parameters sent in this request. Default: false.\n","uniqueKey":"oneOf.1.gateway.routing.require_parameters.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.gateway.routing.require_parameters","typeLabel":"boolean | null"},"tier":{"oneOf":[{"type":"string","description":"Opt in to a pricing tier. Currently supported: `priority` (Anthropic fast mode — 2.5x speed at 6x cost).\nNote: Auriko's \"priority\" tier refers to Anthropic Fast Mode, not Anthropic's separate Priority Tier (committed capacity SLA).\nOmitting this field (default) excludes premium-tier offerings from routing.\n","enum":["priority",null],"uniqueKey":"oneOf.1.gateway.routing.tier.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Opt in to a pricing tier. Currently supported: `priority` (Anthropic fast mode — 2.5x speed at 6x cost).\nNote: Auriko's \"priority\" tier refers to Anthropic Fast Mode, not Anthropic's separate Priority Tier (committed capacity SLA).\nOmitting this field (default) excludes premium-tier offerings from routing.\n","enum":["priority",null],"uniqueKey":"oneOf.1.gateway.routing.tier.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.gateway.routing.tier","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"oneOf.1.gateway.routing","typeLabel":"object"},"metadata":{"type":"object","description":"Optional request metadata for tracking and observability.\nAttached via the `gateway.metadata` field on chat completion requests.\n","properties":{"tags":{"type":"array","items":{"type":"string","maxLength":50,"uniqueKey":"oneOf.1.gateway.metadata.tags.items.[INDEX]","typeLabel":"string"},"maxItems":100,"description":"Tags for categorizing requests (max 100 items, each ≤50 chars)","uniqueKey":"oneOf.1.gateway.metadata.tags","typeLabel":"string[]"},"user_id":{"type":"string","maxLength":255,"description":"Your application's user identifier for per-user analytics","uniqueKey":"oneOf.1.gateway.metadata.user_id","typeLabel":"string"},"trace_id":{"type":"string","maxLength":255,"description":"Distributed tracing identifier to correlate with your observability stack","uniqueKey":"oneOf.1.gateway.metadata.trace_id","typeLabel":"string"},"custom_fields":{"type":"object","maxProperties":10,"additionalProperties":{"type":"string","maxLength":200,"uniqueKey":"oneOf.1.gateway.metadata.custom_fields.additionalProperties","typeLabel":"string"},"description":"Arbitrary key-value pairs (max 10 keys, keys ≤50 chars, values ≤200 chars)\n","uniqueKey":"oneOf.1.gateway.metadata.custom_fields","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"oneOf.1.gateway.metadata","typeLabel":"object"}},"isRequired":true,"uniqueKey":"oneOf.1.gateway","typeLabel":"object"},"input":{"oneOf":[{"type":"string","description":"The input to generate a response for.","isRequired":true,"uniqueKey":"oneOf.1.input.oneOf.0","typeLabel":"string"},{"type":"array","items":{"oneOf":[{"type":"object","description":"An input item in the conversation history.","required":["role","content"],"properties":{"role":{"type":"string","enum":["user","assistant","system","developer"],"isRequired":true,"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.0.role","typeLabel":"enum\u003cstring>"},"content":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.0.content.oneOf.0","typeLabel":"string"},{"type":"array","items":{"oneOf":[{"type":"object","description":"A content part in a message.","required":["type","text"],"properties":{"type":{"type":"string","const":"input_text","isRequired":true,"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].oneOf.0.type","typeLabel":"string"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].oneOf.0.text","typeLabel":"string"}},"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"A content part in a message.","required":["type"],"properties":{"type":{"type":"string","const":"input_image","isRequired":true,"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].oneOf.1.type","typeLabel":"string"},"image_url":{"type":"string","uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].oneOf.1.image_url","typeLabel":"string"},"detail":{"type":"string","enum":["auto","low","high"],"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].oneOf.1.detail","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"A content part in a message.","required":["type","text"],"properties":{"type":{"type":"string","const":"output_text","isRequired":true,"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].oneOf.2.type","typeLabel":"string"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].oneOf.2.text","typeLabel":"string"},"annotations":{"type":"array","items":{"oneOf":[{}],"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].oneOf.2.annotations.items.[INDEX]","typeLabel":"any"},"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].oneOf.2.annotations","typeLabel":"any[]"}},"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].oneOf.2","typeLabel":"object"}],"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.0.content.oneOf.1","typeLabel":"object[]"}],"isRequired":true,"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.0.content","typeLabel":"string | object[]"},"type":{"type":"string","description":"Optional, defaults to \"message\".","uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.0.type","typeLabel":"string"}},"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"An input item in the conversation history.","required":["type","call_id","name","arguments"],"properties":{"type":{"type":"string","const":"function_call","isRequired":true,"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.1.type","typeLabel":"string"},"call_id":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.1.call_id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.1.name","typeLabel":"string"},"arguments":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.1.arguments","typeLabel":"string"}},"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"An input item in the conversation history.","required":["type","call_id","output"],"properties":{"type":{"type":"string","const":"function_call_output","isRequired":true,"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.2.type","typeLabel":"string"},"call_id":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.2.call_id","typeLabel":"string"},"output":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.2.output","typeLabel":"string"}},"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"An input item in the conversation history.","required":["type"],"properties":{"type":{"type":"string","const":"reasoning","isRequired":true,"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.3.type","typeLabel":"string"},"id":{"type":"string","uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.3.id","typeLabel":"string"},"summary":{"type":"array","items":{"type":"object","required":["type","text"],"properties":{"type":{"type":"string","const":"summary_text","isRequired":true,"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.3.summary.items.[INDEX].type","typeLabel":"string"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.3.summary.items.[INDEX].text","typeLabel":"string"}},"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.3.summary.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.3.summary","typeLabel":"object[]"},"encrypted_content":{"type":"string","uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.3.encrypted_content","typeLabel":"string"}},"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX].oneOf.3","typeLabel":"object"}],"uniqueKey":"oneOf.1.input.oneOf.1.items.[INDEX]","typeLabel":"object"},"description":"The input to generate a response for.","isRequired":true,"uniqueKey":"oneOf.1.input.oneOf.1","typeLabel":"object[]"}],"isRequired":true,"uniqueKey":"oneOf.1.input","typeLabel":"string | object[]"},"model":{"type":"string","description":"Model ID to use (e.g., \"gpt-4o\", \"claude-sonnet-4-20250514\").","uniqueKey":"oneOf.1.model","typeLabel":"string"},"instructions":{"type":"string","description":"System instructions for the model.","uniqueKey":"oneOf.1.instructions","typeLabel":"string"},"tools":{"type":"array","items":{"oneOf":[{"type":"object","description":"A tool available to the model.","required":["type","name"],"properties":{"type":{"type":"string","const":"function","isRequired":true,"uniqueKey":"oneOf.1.tools.items.[INDEX].oneOf.0.type","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.tools.items.[INDEX].oneOf.0.name","typeLabel":"string"},"description":{"type":"string","uniqueKey":"oneOf.1.tools.items.[INDEX].oneOf.0.description","typeLabel":"string"},"parameters":{"type":"any","uniqueKey":"oneOf.1.tools.items.[INDEX].oneOf.0.parameters","typeLabel":"any"},"strict":{"type":"boolean","uniqueKey":"oneOf.1.tools.items.[INDEX].oneOf.0.strict","typeLabel":"boolean"}},"uniqueKey":"oneOf.1.tools.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"A tool available to the model.","required":["type"],"properties":{"type":{"type":"string","description":"Tool type identifier.","isRequired":true,"uniqueKey":"oneOf.1.tools.items.[INDEX].oneOf.1.type","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"oneOf.1.tools.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.1.tools.items.[INDEX]","typeLabel":"object"},"description":"Tools available to the model.","uniqueKey":"oneOf.1.tools","typeLabel":"object[]"},"tool_choice":{"oneOf":[{"type":"string","description":"How the model should use tools.","enum":["auto","none","required"],"uniqueKey":"oneOf.1.tool_choice.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"object","description":"How the model should use tools.","required":["type","name"],"properties":{"type":{"type":"string","const":"function","isRequired":true,"uniqueKey":"oneOf.1.tool_choice.oneOf.1.type","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.tool_choice.oneOf.1.name","typeLabel":"string"}},"uniqueKey":"oneOf.1.tool_choice.oneOf.1","typeLabel":"object"},{"type":"object","description":"How the model should use tools.","required":["type"],"properties":{"type":{"type":"string","not":{"enum":["function"]},"isRequired":true,"uniqueKey":"oneOf.1.tool_choice.oneOf.2.type","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"oneOf.1.tool_choice.oneOf.2","typeLabel":"object"}],"uniqueKey":"oneOf.1.tool_choice","typeLabel":"enum\u003cstring> · object · object"},"parallel_tool_calls":{"type":"boolean","description":"Whether the model can make multiple tool calls in parallel.","uniqueKey":"oneOf.1.parallel_tool_calls","typeLabel":"boolean"},"max_output_tokens":{"type":"integer","description":"Maximum number of output tokens.","uniqueKey":"oneOf.1.max_output_tokens","typeLabel":"integer"},"temperature":{"type":"number","minimum":0,"maximum":2,"description":"Sampling temperature.","uniqueKey":"oneOf.1.temperature","typeLabel":"number"},"top_p":{"type":"number","minimum":0,"maximum":1,"description":"Nucleus sampling parameter.","uniqueKey":"oneOf.1.top_p","typeLabel":"number"},"top_k":{"type":"integer","description":"Top-k sampling parameter.","uniqueKey":"oneOf.1.top_k","typeLabel":"integer"},"top_logprobs":{"type":"integer","minimum":0,"maximum":20,"description":"Number of top logprobs to return per token position. Requires provider logprobs support.","uniqueKey":"oneOf.1.top_logprobs","typeLabel":"integer"},"stream":{"type":"boolean","description":"Whether to stream the response.","uniqueKey":"oneOf.1.stream","typeLabel":"boolean"},"text":{"type":"object","description":"Text generation configuration.","properties":{"format":{"oneOf":[{"type":"object","description":"Text output format configuration.","required":["type"],"properties":{"type":{"type":"string","const":"text","isRequired":true,"uniqueKey":"oneOf.1.text.format.oneOf.0.type","typeLabel":"string"}},"uniqueKey":"oneOf.1.text.format.oneOf.0","typeLabel":"object"},{"type":"object","description":"Text output format configuration.","required":["type"],"properties":{"type":{"type":"string","const":"json_object","isRequired":true,"uniqueKey":"oneOf.1.text.format.oneOf.1.type","typeLabel":"string"}},"uniqueKey":"oneOf.1.text.format.oneOf.1","typeLabel":"object"},{"type":"object","description":"Text output format configuration.","required":["type","name","schema"],"properties":{"type":{"type":"string","const":"json_schema","isRequired":true,"uniqueKey":"oneOf.1.text.format.oneOf.2.type","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.text.format.oneOf.2.name","typeLabel":"string"},"schema":{"type":"object","isRequired":true,"uniqueKey":"oneOf.1.text.format.oneOf.2.schema","typeLabel":"object"},"strict":{"type":"boolean","uniqueKey":"oneOf.1.text.format.oneOf.2.strict","typeLabel":"boolean"}},"uniqueKey":"oneOf.1.text.format.oneOf.2","typeLabel":"object"}],"uniqueKey":"oneOf.1.text.format","typeLabel":"object"}},"uniqueKey":"oneOf.1.text","typeLabel":"object"},"reasoning":{"type":"object","description":"Reasoning/thinking configuration.","properties":{"effort":{"type":"string","enum":["none","minimal","low","medium","high","xhigh","max","off"],"description":"Level of reasoning effort.","uniqueKey":"oneOf.1.reasoning.effort","typeLabel":"enum\u003cstring>"},"summary":{"type":"string","enum":["auto","concise","detailed"],"description":"Reasoning summary format.","uniqueKey":"oneOf.1.reasoning.summary","typeLabel":"enum\u003cstring>"},"generate_summary":{"type":"string","enum":["auto","concise","detailed"],"description":"Reasoning summary format (alternative field name).","uniqueKey":"oneOf.1.reasoning.generate_summary","typeLabel":"enum\u003cstring>"}},"uniqueKey":"oneOf.1.reasoning","typeLabel":"object"},"truncation":{"type":"string","description":"Truncation strategy for long inputs.","uniqueKey":"oneOf.1.truncation","typeLabel":"string"},"metadata":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"oneOf.1.metadata.additionalProperties","typeLabel":"string"},"description":"Arbitrary key-value metadata.","uniqueKey":"oneOf.1.metadata","typeLabel":"object"},"include":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.include.items.[INDEX]","typeLabel":"string"},"description":"Additional data to include in the response.","uniqueKey":"oneOf.1.include","typeLabel":"string[]"},"user":{"type":"string","description":"End-user identifier for abuse detection.","uniqueKey":"oneOf.1.user","typeLabel":"string"},"store":{"type":"boolean","enum":[false],"description":"Omit this field or set to false. Sending true returns 400.","uniqueKey":"oneOf.1.store","typeLabel":"enum\u003cboolean>"},"extensions":{"type":"object","description":"Auriko extensions for provider-specific passthrough.\n\nFor reasoning control, use the top-level `reasoning_effort` parameter\ninstead of extensions.\n\n## Provider Passthrough\n\nPass provider-specific parameters directly:\n- `anthropic`: Anthropic-specific parameters\n- `openai`: OpenAI-specific parameters\n- `google`: Google/Gemini-specific parameters\n- `deepseek`: DeepSeek-specific parameters\n\nPassthrough parameters are forwarded as-is to the target provider.\n","properties":{"anthropic":{"type":"object","additionalProperties":true,"description":"Anthropic-specific parameters (passed through)","uniqueKey":"oneOf.1.extensions.anthropic","typeLabel":"object"},"openai":{"type":"object","additionalProperties":true,"description":"OpenAI-specific parameters (passed through)","uniqueKey":"oneOf.1.extensions.openai","typeLabel":"object"},"google":{"type":"object","additionalProperties":true,"description":"Google/Gemini-specific parameters (passed through)","uniqueKey":"oneOf.1.extensions.google","typeLabel":"object"},"deepseek":{"type":"object","additionalProperties":true,"description":"DeepSeek-specific parameters (passed through)","uniqueKey":"oneOf.1.extensions.deepseek","typeLabel":"object"}},"additionalProperties":{"type":"object","description":"Other provider-specific passthrough","uniqueKey":"oneOf.1.extensions.additionalProperties","typeLabel":"object"},"not":{"required":["thinking"]},"uniqueKey":"oneOf.1.extensions","typeLabel":"object"},"prompt_cache_key":{"type":"string","description":"Key for prompt caching.","uniqueKey":"oneOf.1.prompt_cache_key","typeLabel":"string"},"safety_identifier":{"type":"string","description":"Safety policy identifier.","uniqueKey":"oneOf.1.safety_identifier","typeLabel":"string"},"frequency_penalty":{"type":"number","description":"Penalizes new tokens based on their frequency in the text so far.","uniqueKey":"oneOf.1.frequency_penalty","typeLabel":"number"},"presence_penalty":{"type":"number","description":"Penalizes new tokens based on whether they appear in the text so far.","uniqueKey":"oneOf.1.presence_penalty","typeLabel":"number"},"max_tool_calls":{"type":"integer","minimum":1,"description":"Maximum number of built-in tool calls (e.g., web_search, code_interpreter) allowed in a response.","uniqueKey":"oneOf.1.max_tool_calls","typeLabel":"integer"}},"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"basic":{"title":"basic","summary":"Basic text response","value":{"model":"gpt-4o","input":"Hello!"}},"with_tools":{"title":"with_tools","summary":"With function tools","value":{"model":"gpt-4o","input":[{"type":"message","role":"user","content":"What's the weather in NYC?"}],"tools":[{"type":"function","name":"get_weather","parameters":{"type":"object","properties":{"city":{"type":"string"}}}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"fd62711b-51c1-4f33-8d39-a45904a414d8":{"description":"Successful response.\n\nFor non-streaming requests, returns a `ResponseObject`.\nFor streaming (`stream: true`), returns Server-Sent Events in\nthe Response API format: `event: \u003ctype>\\ndata: \u003cjson>\\n\\n`.\n","headers":{"X-Request-ID":{"description":"Unique request identifier for debugging and support.\nInclude this in support requests for fast resolution.\n","schema":{"type":"string"},"example":"req_abc123def456"}},"content":{"application/json":{"schema":{"type":"object","description":"A completed Response API response.","required":["id","object","created_at","model","status","output"],"properties":{"id":{"type":"string","description":"Unique response identifier.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"object":{"type":"string","const":"response","isRequired":true,"uniqueKey":"object","typeLabel":"string"},"created_at":{"type":"integer","description":"Unix timestamp of creation.","isRequired":true,"uniqueKey":"created_at","typeLabel":"integer"},"model":{"type":"string","description":"Model used for generation.","isRequired":true,"uniqueKey":"model","typeLabel":"string"},"status":{"type":"string","enum":["completed","failed","incomplete","in_progress"],"description":"Response status.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"output":{"type":"array","items":{"oneOf":[{"type":"object","description":"An output item from the model. Discriminated on `type`.\nKnown types: `message`, `function_call`, `reasoning`, `image_generation_call`.\nUnknown types from the provider are preserved verbatim.\n","required":["type","id","role","status","content"],"properties":{"type":{"type":"string","const":"message","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.0.type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.0.id","typeLabel":"string"},"role":{"type":"string","const":"assistant","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.0.role","typeLabel":"string"},"status":{"type":"string","enum":["in_progress","completed","incomplete"],"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.0.status","typeLabel":"enum\u003cstring>"},"content":{"type":"array","items":{"type":"object","required":["type","text"],"properties":{"type":{"type":"string","const":"output_text","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.0.content.items.[INDEX].type","typeLabel":"string"},"text":{"type":"string","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.0.content.items.[INDEX].text","typeLabel":"string"},"annotations":{"type":"array","items":{"oneOf":[{}],"uniqueKey":"output.items.[INDEX].oneOf.0.content.items.[INDEX].annotations.items.[INDEX]","typeLabel":"any"},"uniqueKey":"output.items.[INDEX].oneOf.0.content.items.[INDEX].annotations","typeLabel":"any[]"},"logprobs":{"type":"array","items":{"oneOf":[{}],"uniqueKey":"output.items.[INDEX].oneOf.0.content.items.[INDEX].logprobs.items.[INDEX]","typeLabel":"any"},"description":"Token-level log probabilities. Present when top_logprobs is set.","uniqueKey":"output.items.[INDEX].oneOf.0.content.items.[INDEX].logprobs","typeLabel":"any[]"}},"uniqueKey":"output.items.[INDEX].oneOf.0.content.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.0.content","typeLabel":"object[]"},"phase":{"type":"string","description":"Message phase label (\"commentary\" or \"final_answer\") emitted by gpt-5.4+ OpenAI models; absent otherwise — never synthesized for providers that did not emit it. Preserve it when resending output items as input.","uniqueKey":"output.items.[INDEX].oneOf.0.phase","typeLabel":"string"}},"uniqueKey":"output.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"An output item from the model. Discriminated on `type`.\nKnown types: `message`, `function_call`, `reasoning`, `image_generation_call`.\nUnknown types from the provider are preserved verbatim.\n","required":["type","id","call_id","name","arguments","status"],"properties":{"type":{"type":"string","const":"function_call","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.1.type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.1.id","typeLabel":"string"},"call_id":{"type":"string","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.1.call_id","typeLabel":"string"},"name":{"type":"string","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.1.name","typeLabel":"string"},"arguments":{"type":"string","description":"JSON-encoded function arguments.","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.1.arguments","typeLabel":"string"},"status":{"type":"string","enum":["in_progress","completed","incomplete"],"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.1.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"output.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"An output item from the model. Discriminated on `type`.\nKnown types: `message`, `function_call`, `reasoning`, `image_generation_call`.\nUnknown types from the provider are preserved verbatim.\n","required":["type","id","summary"],"properties":{"type":{"type":"string","const":"reasoning","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.2.type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.2.id","typeLabel":"string"},"summary":{"type":"array","items":{"type":"object","required":["type","text"],"properties":{"type":{"type":"string","const":"summary_text","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.2.summary.items.[INDEX].type","typeLabel":"string"},"text":{"type":"string","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.2.summary.items.[INDEX].text","typeLabel":"string"}},"uniqueKey":"output.items.[INDEX].oneOf.2.summary.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.2.summary","typeLabel":"object[]"},"status":{"type":"string","enum":["in_progress","completed","incomplete"],"uniqueKey":"output.items.[INDEX].oneOf.2.status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"output.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"An output item from the model. Discriminated on `type`.\nKnown types: `message`, `function_call`, `reasoning`, `image_generation_call`.\nUnknown types from the provider are preserved verbatim.\n","required":["type","id","status","result"],"properties":{"type":{"type":"string","const":"image_generation_call","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.3.type","typeLabel":"string"},"id":{"type":"string","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.3.id","typeLabel":"string"},"status":{"type":"string","enum":["in_progress","completed","generating","failed"],"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.3.status","typeLabel":"enum\u003cstring>"},"result":{"oneOf":[{"type":"string","description":"Base64-encoded image data, or null while in progress.","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.3.result.oneOf.0","typeLabel":"string"},{"type":"null","description":"Base64-encoded image data, or null while in progress.","isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.3.result.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.3.result","typeLabel":"string | null"}},"uniqueKey":"output.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","description":"An output item from the model. Discriminated on `type`.\nKnown types: `message`, `function_call`, `reasoning`, `image_generation_call`.\nUnknown types from the provider are preserved verbatim.\n","required":["type"],"properties":{"type":{"type":"string","not":{"enum":["message","function_call","reasoning","image_generation_call"]},"isRequired":true,"uniqueKey":"output.items.[INDEX].oneOf.4.type","typeLabel":"string"}},"additionalProperties":true,"uniqueKey":"output.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"output.items.[INDEX]","typeLabel":"object"},"description":"Output items generated by the model. Known types include\n`message`, `function_call`, and `reasoning`. Additional types\nfrom the provider (e.g., `web_search_call`, `file_search_call`)\nare passed through verbatim.\n","isRequired":true,"uniqueKey":"output","typeLabel":"object[]"},"output_text":{"type":"string","description":"Concatenated text output for convenience.","uniqueKey":"output_text","typeLabel":"string"},"parallel_tool_calls":{"type":"boolean","description":"Whether parallel tool calls were enabled.","uniqueKey":"parallel_tool_calls","typeLabel":"boolean"},"tool_choice":{"description":"Tool choice setting used.","uniqueKey":"tool_choice","typeLabel":"any"},"tools":{"type":"array","items":{"oneOf":[{}],"uniqueKey":"tools.items.[INDEX]","typeLabel":"any"},"description":"Tools that were available.","uniqueKey":"tools","typeLabel":"any[]"},"usage":{"type":"object","description":"Token usage for a Response API request.","required":["input_tokens","output_tokens","total_tokens"],"properties":{"input_tokens":{"type":"integer","isRequired":true,"uniqueKey":"usage.input_tokens","typeLabel":"integer"},"output_tokens":{"type":"integer","isRequired":true,"uniqueKey":"usage.output_tokens","typeLabel":"integer"},"total_tokens":{"type":"integer","isRequired":true,"uniqueKey":"usage.total_tokens","typeLabel":"integer"},"input_tokens_details":{"type":"object","description":"Detailed breakdown of input tokens for a Response API request.","properties":{"cached_tokens":{"type":"integer","uniqueKey":"usage.input_tokens_details.cached_tokens","typeLabel":"integer"},"cache_write_tokens":{"type":"integer","description":"Tokens written to prompt cache. Provider-dependent: present when the upstream provider reports cache write details, absent otherwise.","uniqueKey":"usage.input_tokens_details.cache_write_tokens","typeLabel":"integer"}},"uniqueKey":"usage.input_tokens_details","typeLabel":"object"},"output_tokens_details":{"type":"object","description":"Detailed breakdown of output tokens for a Response API request.","properties":{"reasoning_tokens":{"type":"integer","uniqueKey":"usage.output_tokens_details.reasoning_tokens","typeLabel":"integer"},"image_tokens":{"type":"integer","uniqueKey":"usage.output_tokens_details.image_tokens","typeLabel":"integer"}},"uniqueKey":"usage.output_tokens_details","typeLabel":"object"}},"uniqueKey":"usage","typeLabel":"object"},"error":{"oneOf":[{"type":"object","properties":{"code":{"type":"string","uniqueKey":"error.oneOf.0.code","typeLabel":"string"},"message":{"type":"string","uniqueKey":"error.oneOf.0.message","typeLabel":"string"}},"description":"Error details if status is \"failed\".","uniqueKey":"error.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"code":{"type":"string"},"message":{"type":"string"}},"description":"Error details if status is \"failed\".","uniqueKey":"error.oneOf.1","typeLabel":"null"}],"uniqueKey":"error","typeLabel":"object | null"},"incomplete_details":{"oneOf":[{"type":"object","properties":{"reason":{"type":"string","uniqueKey":"incomplete_details.oneOf.0.reason","typeLabel":"string"}},"description":"Details if status is \"incomplete\".","uniqueKey":"incomplete_details.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"reason":{"type":"string"}},"description":"Details if status is \"incomplete\".","uniqueKey":"incomplete_details.oneOf.1","typeLabel":"null"}],"uniqueKey":"incomplete_details","typeLabel":"object | null"},"metadata":{"oneOf":[{"type":"object","additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.0.additionalProperties","typeLabel":"string"},"uniqueKey":"metadata.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"string","uniqueKey":"metadata.oneOf.1.additionalProperties","typeLabel":"string"},"uniqueKey":"metadata.oneOf.1","typeLabel":"null"}],"uniqueKey":"metadata","typeLabel":"object | null"},"routing_metadata":{"type":"object","description":"Routing decision metadata included in successful responses.\n8 STABLE fields (4 required + 4 optional) in the current public contract.\n","required":["provider","provider_model_id","model_canonical","routing_strategy"],"properties":{"provider":{"type":"string","description":"Provider name (e.g., \"fireworks_ai\", \"anthropic\")","isRequired":true,"uniqueKey":"routing_metadata.provider","typeLabel":"string"},"provider_model_id":{"type":"string","description":"Provider's model ID","isRequired":true,"uniqueKey":"routing_metadata.provider_model_id","typeLabel":"string"},"model_canonical":{"type":"string","description":"Canonical model ID requested","isRequired":true,"uniqueKey":"routing_metadata.model_canonical","typeLabel":"string"},"routing_strategy":{"type":"string","description":"Strategy used for routing. Known values:\n`cost`, `cost-focus`, `ttft`, `ttft-focus`, `tps`, `tps-focus`, `balanced`, `custom`.\n`custom` is returned when explicit `routing.weights` are provided.\nAdditional strategies may be added in future versions.\n","isRequired":true,"uniqueKey":"routing_metadata.routing_strategy","typeLabel":"string"},"ttft_ms":{"type":"number","description":"Time to first token (streaming only)","uniqueKey":"routing_metadata.ttft_ms","typeLabel":"number"},"throughput_tps":{"type":"number","description":"Output throughput (tokens per second)","uniqueKey":"routing_metadata.throughput_tps","typeLabel":"number"},"cost":{"type":"object","description":"Cost for the request","required":["usd"],"properties":{"usd":{"type":"number","description":"Billable cost in USD","isRequired":true,"uniqueKey":"routing_metadata.cost.usd","typeLabel":"number"},"cache_savings_percent":{"type":"integer","description":"Cache savings as integer percentage (0-100). Present only when savings > 0.","uniqueKey":"routing_metadata.cost.cache_savings_percent","typeLabel":"integer"},"cache_savings_usd":{"type":"number","description":"Cache savings in USD. Present only when savings > 0.","uniqueKey":"routing_metadata.cost.cache_savings_usd","typeLabel":"number"},"hosted_tool_usd":{"type":"number","description":"Hosted tool cost in USD (e.g., web search, code interpreter, image generation). Present only when hosted tools were used.","uniqueKey":"routing_metadata.cost.hosted_tool_usd","typeLabel":"number"}},"uniqueKey":"routing_metadata.cost","typeLabel":"object"},"warnings":{"type":"array","items":{"type":"object","description":"Structured warning emitted in routing_metadata.warnings when the\ngateway modifies or ignores part of the request.\n","required":["type","code","message"],"properties":{"type":{"type":"string","enum":["unsupported_parameter","unsupported_feature","unsupported_field","ignored_extension","unknown_provider","blocked_field","provider_timeout"],"description":"Warning category","isRequired":true,"uniqueKey":"routing_metadata.warnings.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"code":{"type":"string","description":"Concrete identifier (parameter name, feature name, provider name, or field name)","isRequired":true,"uniqueKey":"routing_metadata.warnings.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable explanation","isRequired":true,"uniqueKey":"routing_metadata.warnings.items.[INDEX].message","typeLabel":"string"}},"uniqueKey":"routing_metadata.warnings.items.[INDEX]","typeLabel":"object"},"description":"Structured warnings emitted when the gateway modifies or ignores\npart of the request (e.g., unsupported parameters, blocked fields).\n","uniqueKey":"routing_metadata.warnings","typeLabel":"object[]"}},"uniqueKey":"routing_metadata","typeLabel":"object"},"temperature":{"type":"number","description":"Sampling temperature used.","uniqueKey":"temperature","typeLabel":"number"},"top_p":{"type":"number","description":"Nucleus sampling parameter used.","uniqueKey":"top_p","typeLabel":"number"},"max_output_tokens":{"oneOf":[{"type":"integer","description":"Maximum output tokens setting.","uniqueKey":"max_output_tokens.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Maximum output tokens setting.","uniqueKey":"max_output_tokens.oneOf.1","typeLabel":"null"}],"uniqueKey":"max_output_tokens","typeLabel":"integer | null"},"frequency_penalty":{"type":"number","description":"Frequency penalty setting.","uniqueKey":"frequency_penalty","typeLabel":"number"},"presence_penalty":{"type":"number","description":"Presence penalty setting.","uniqueKey":"presence_penalty","typeLabel":"number"},"top_logprobs":{"type":"integer","description":"Number of top logprobs returned.","uniqueKey":"top_logprobs","typeLabel":"integer"},"instructions":{"oneOf":[{"type":"string","description":"System instructions used.","uniqueKey":"instructions.oneOf.0","typeLabel":"string"},{"type":"null","description":"System instructions used.","uniqueKey":"instructions.oneOf.1","typeLabel":"null"}],"uniqueKey":"instructions","typeLabel":"string | null"},"truncation":{"type":"string","description":"Truncation strategy used.","uniqueKey":"truncation","typeLabel":"string"},"reasoning":{"oneOf":[{"type":"object","description":"Reasoning configuration used.","uniqueKey":"reasoning.oneOf.0","typeLabel":"object"},{"type":"null","description":"Reasoning configuration used.","uniqueKey":"reasoning.oneOf.1","typeLabel":"null"}],"uniqueKey":"reasoning","typeLabel":"object | null"},"text":{"type":"object","description":"Text generation configuration used.","uniqueKey":"text","typeLabel":"object"},"user":{"oneOf":[{"type":"string","description":"End-user identifier.","uniqueKey":"user.oneOf.0","typeLabel":"string"},{"type":"null","description":"End-user identifier.","uniqueKey":"user.oneOf.1","typeLabel":"null"}],"uniqueKey":"user","typeLabel":"string | null"},"prompt_cache_key":{"oneOf":[{"type":"string","description":"Prompt cache key used.","uniqueKey":"prompt_cache_key.oneOf.0","typeLabel":"string"},{"type":"null","description":"Prompt cache key used.","uniqueKey":"prompt_cache_key.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt_cache_key","typeLabel":"string | null"},"safety_identifier":{"oneOf":[{"type":"string","description":"Safety policy identifier used.","uniqueKey":"safety_identifier.oneOf.0","typeLabel":"string"},{"type":"null","description":"Safety policy identifier used.","uniqueKey":"safety_identifier.oneOf.1","typeLabel":"null"}],"uniqueKey":"safety_identifier","typeLabel":"string | null"},"max_tool_calls":{"oneOf":[{"type":"integer","description":"Maximum number of built-in tool calls allowed in a response.","uniqueKey":"max_tool_calls.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Maximum number of built-in tool calls allowed in a response.","uniqueKey":"max_tool_calls.oneOf.1","typeLabel":"null"}],"uniqueKey":"max_tool_calls","typeLabel":"integer | null"},"store":{"type":"boolean","description":"Whether the response is stored.","uniqueKey":"store","typeLabel":"boolean"},"previous_response_id":{"oneOf":[{"type":"string","description":"Previous response ID for conversation continuity.","uniqueKey":"previous_response_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"Previous response ID for conversation continuity.","uniqueKey":"previous_response_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"previous_response_id","typeLabel":"string | null"},"background":{"type":"boolean","description":"Whether this was a background response.","uniqueKey":"background","typeLabel":"boolean"},"completed_at":{"oneOf":[{"type":"integer","description":"Unix timestamp when the response completed.","uniqueKey":"completed_at.oneOf.0","typeLabel":"integer"},{"type":"null","description":"Unix timestamp when the response completed.","uniqueKey":"completed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"completed_at","typeLabel":"integer | null"},"service_tier":{"oneOf":[{"type":"string","description":"Service tier used by the provider.","uniqueKey":"service_tier.oneOf.0","typeLabel":"string"},{"type":"null","description":"Service tier used by the provider.","uniqueKey":"service_tier.oneOf.1","typeLabel":"null"}],"uniqueKey":"service_tier","typeLabel":"string | null"},"tool_usage":{"oneOf":[{"type":"object","description":"Built-in tool consumption metrics from the provider (e.g. image generation tokens, web search request counts). Present on OpenAI responses; absent for other providers.","uniqueKey":"tool_usage.oneOf.0","typeLabel":"object"},{"type":"null","description":"Built-in tool consumption metrics from the provider (e.g. image generation tokens, web search request counts). Present on OpenAI responses; absent for other providers.","uniqueKey":"tool_usage.oneOf.1","typeLabel":"null"}],"uniqueKey":"tool_usage","typeLabel":"object | null"}},"uniqueKey":"","typeLabel":"object"},"example":{"id":"resp_abc123def456","object":"response","created_at":1779308695,"model":"gpt-4o-2024-08-06","status":"completed","output":[{"type":"message","id":"msg_abc123","role":"assistant","status":"completed","content":[{"type":"output_text","text":"Hi there! How can I assist you today?","annotations":[]}]}],"output_text":"Hi there! How can I assist you today?","usage":{"input_tokens":9,"output_tokens":11,"total_tokens":20,"input_tokens_details":{"cached_tokens":0,"cache_write_tokens":0},"output_tokens_details":{"reasoning_tokens":0}},"routing_metadata":{"provider":"openai","provider_model_id":"gpt-4o-2024-08-06","model_canonical":"gpt-4o","routing_strategy":"cost-focus","throughput_tps":48.3,"cost":{"usd":0.000133}}},"examples":{"Example":{"title":"Example","value":{"id":"resp_abc123def456","object":"response","created_at":1779308695,"model":"gpt-4o-2024-08-06","status":"completed","output":[{"type":"message","id":"msg_abc123","role":"assistant","status":"completed","content":[{"type":"output_text","text":"Hi there! How can I assist you today?","annotations":[]}]}],"output_text":"Hi there! How can I assist you today?","usage":{"input_tokens":9,"output_tokens":11,"total_tokens":20,"input_tokens_details":{"cached_tokens":0,"cache_write_tokens":0},"output_tokens_details":{"reasoning_tokens":0}},"routing_metadata":{"provider":"openai","provider_model_id":"gpt-4o-2024-08-06","model_canonical":"gpt-4o","routing_strategy":"cost-focus","throughput_tps":48.3,"cost":{"usd":0.000133}}}}},"exampleType":"examples"},"text/event-stream":{"schema":{"type":"string","description":"Response API SSE stream. Events use the format:\n`event: \u003ctype>\\ndata: \u003cjson>\\n\\n`\n\nNo `data: [DONE]` terminator is used.\n","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"\u003cstring>"}},"exampleType":"generated"}},"exampleType":"examples"},"bb6f308e-ba06-40e9-9ea0-658944c4fdcc":{"description":"Bad request - invalid parameters","headers":{"X-Request-ID":{"description":"Unique request identifier for debugging and support.\nInclude this in support requests for fast resolution.\n","schema":{"type":"string"},"example":"req_abc123def456"},"X-Error-Type":{"description":"Same value as the `error.type` field in the response body, exposed as a\nheader for programmatic routing without body parsing.\n","schema":{"type":"string","enum":["invalid_request_error","rate_limit_error","api_error","authentication_error","not_found_error","permission_error"]},"example":"invalid_request_error"},"X-Error-Retryable":{"description":"Whether the client should retry this request.\n'true' for api_error and rate_limit_error types; 'false' for all others.\n","schema":{"type":"string","enum":["true","false"]},"example":"false"}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","description":"OpenAI-compatible error format","required":["message","type","param","code"],"properties":{"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"Error category per guide §4.","enum":["invalid_request_error","authentication_error","permission_error","not_found_error","rate_limit_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"param":{"oneOf":[{"type":"string","description":"Parameter that caused the error (null if not applicable)","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"Parameter that caused the error (null if not applicable)","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"type":"string","description":"Canonical code per guide §5 and docs/reference/error_codes.json.","enum":["invalid_api_key","expired_api_key","insufficient_permissions","feature_disabled","mfa_required","invalid_recovery_code","mfa_verification_failed","invalid_request","missing_required_parameter","invalid_parameter_value","payload_too_large","context_length_exceeded","content_filtered","idempotency_conflict","idempotency_replay_unavailable","field_immutable","operation_not_allowed","unknown_field","state_precondition_failed","duplicate_resource","method_not_allowed","payment_declined","payment_method_invalid","tools_not_supported","json_mode_not_supported","structured_output_not_supported","tools_with_structured_output_not_supported","vision_not_supported","reasoning_not_supported","thinking_disable_not_supported","streaming_not_supported","non_streaming_not_supported","batch_only","tier_opt_in_required","tool_choice_required_not_supported","cost_constraint_exceeded","latency_constraint_exceeded","throughput_constraint_not_met","provider_not_in_allowlist","provider_blocked","required_params_not_supported","byok_keys_required","platform_keys_unavailable","unsupported_modalities","no_compatible_endpoint","no_responses_endpoint","input_requires_responses_endpoint","response_api_only","hosted_tool_not_supported","no_tools_on_endpoint","model_not_found","resource_not_found","rate_limit_exceeded","budget_exhausted","insufficient_quota","no_provider_available","upstream_error","upstream_timeout","client_disconnected","stream_duration_exceeded","model_unavailable","internal_error","service_unavailable"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","description":"Link to the canonical documentation page for this error code.","uniqueKey":"error.doc_url","typeLabel":"string"},"provider":{"oneOf":[{"type":"string","description":"Upstream provider that generated the error (e.g., \"google_ai_studio\", \"openai\"). Null for errors not attributable to an upstream provider (local validation, auth, internal config).","uniqueKey":"error.provider.oneOf.0","typeLabel":"string"},{"type":"null","description":"Upstream provider that generated the error (e.g., \"google_ai_studio\", \"openai\"). Null for errors not attributable to an upstream provider (local validation, auth, internal config).","uniqueKey":"error.provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.provider","typeLabel":"string | null"},"suggestion":{"type":"string","description":"Actionable fix hint for routing, capability, or model-not-found errors. Absent for other error types.","uniqueKey":"error.suggestion","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"missing_model":{"title":"missing_model","summary":"Missing model parameter","value":{"error":{"message":"Missing required parameter: 'model'.","type":"invalid_request_error","param":"model","code":"missing_required_parameter"}}},"invalid_models":{"title":"invalid_models","summary":"Invalid models array","value":{"error":{"message":"gateway.models array cannot exceed 10 models","type":"invalid_request_error","param":"gateway.models","code":"invalid_request"}}},"vision_not_supported":{"title":"vision_not_supported","summary":"Model doesn't support requested capability","value":{"error":{"message":"Model 'gpt-4.1-mini' does not support vision/image input.","type":"invalid_request_error","param":null,"code":"vision_not_supported"}}},"cost_constraint_exceeded":{"title":"cost_constraint_exceeded","summary":"Routing constraints excluded all providers","value":{"error":{"message":"No provider meets the cost constraint for model 'gpt-4o'.","type":"invalid_request_error","param":"gateway.routing.max_cost_per_1m","code":"cost_constraint_exceeded"}}}},"exampleType":"examples"}},"exampleType":"examples"},"def9b573-a19d-4944-9aad-75fcad8ad259":{"description":"Authentication failed","headers":{"X-Request-ID":{"description":"Unique request identifier for debugging and support.\nInclude this in support requests for fast resolution.\n","schema":{"type":"string"},"example":"req_abc123def456"},"X-Error-Type":{"description":"Same value as the `error.type` field in the response body, exposed as a\nheader for programmatic routing without body parsing.\n","schema":{"type":"string","enum":["invalid_request_error","rate_limit_error","api_error","authentication_error","not_found_error","permission_error"]},"example":"invalid_request_error"},"X-Error-Retryable":{"description":"Whether the client should retry this request.\n'true' for api_error and rate_limit_error types; 'false' for all others.\n","schema":{"type":"string","enum":["true","false"]},"example":"false"}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","description":"OpenAI-compatible error format","required":["message","type","param","code"],"properties":{"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"Error category per guide §4.","enum":["invalid_request_error","authentication_error","permission_error","not_found_error","rate_limit_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"param":{"oneOf":[{"type":"string","description":"Parameter that caused the error (null if not applicable)","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"Parameter that caused the error (null if not applicable)","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"type":"string","description":"Canonical code per guide §5 and docs/reference/error_codes.json.","enum":["invalid_api_key","expired_api_key","insufficient_permissions","feature_disabled","mfa_required","invalid_recovery_code","mfa_verification_failed","invalid_request","missing_required_parameter","invalid_parameter_value","payload_too_large","context_length_exceeded","content_filtered","idempotency_conflict","idempotency_replay_unavailable","field_immutable","operation_not_allowed","unknown_field","state_precondition_failed","duplicate_resource","method_not_allowed","payment_declined","payment_method_invalid","tools_not_supported","json_mode_not_supported","structured_output_not_supported","tools_with_structured_output_not_supported","vision_not_supported","reasoning_not_supported","thinking_disable_not_supported","streaming_not_supported","non_streaming_not_supported","batch_only","tier_opt_in_required","tool_choice_required_not_supported","cost_constraint_exceeded","latency_constraint_exceeded","throughput_constraint_not_met","provider_not_in_allowlist","provider_blocked","required_params_not_supported","byok_keys_required","platform_keys_unavailable","unsupported_modalities","no_compatible_endpoint","no_responses_endpoint","input_requires_responses_endpoint","response_api_only","hosted_tool_not_supported","no_tools_on_endpoint","model_not_found","resource_not_found","rate_limit_exceeded","budget_exhausted","insufficient_quota","no_provider_available","upstream_error","upstream_timeout","client_disconnected","stream_duration_exceeded","model_unavailable","internal_error","service_unavailable"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","description":"Link to the canonical documentation page for this error code.","uniqueKey":"error.doc_url","typeLabel":"string"},"provider":{"oneOf":[{"type":"string","description":"Upstream provider that generated the error (e.g., \"google_ai_studio\", \"openai\"). Null for errors not attributable to an upstream provider (local validation, auth, internal config).","uniqueKey":"error.provider.oneOf.0","typeLabel":"string"},{"type":"null","description":"Upstream provider that generated the error (e.g., \"google_ai_studio\", \"openai\"). Null for errors not attributable to an upstream provider (local validation, auth, internal config).","uniqueKey":"error.provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.provider","typeLabel":"string | null"},"suggestion":{"type":"string","description":"Actionable fix hint for routing, capability, or model-not-found errors. Absent for other error types.","uniqueKey":"error.suggestion","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"message":"API key is invalid.","type":"authentication_error","param":null,"code":"invalid_api_key"}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"API key is invalid.","type":"authentication_error","param":null,"code":"invalid_api_key"}}}},"exampleType":"examples"}},"exampleType":"examples"},"70be0802-6da1-460d-85a4-30a32fac0e88":{"description":"Model not found","headers":{"X-Request-ID":{"description":"Unique request identifier for debugging and support.\nInclude this in support requests for fast resolution.\n","schema":{"type":"string"},"example":"req_abc123def456"},"X-Error-Type":{"description":"Same value as the `error.type` field in the response body, exposed as a\nheader for programmatic routing without body parsing.\n","schema":{"type":"string","enum":["invalid_request_error","rate_limit_error","api_error","authentication_error","not_found_error","permission_error"]},"example":"invalid_request_error"},"X-Error-Retryable":{"description":"Whether the client should retry this request.\n'true' for api_error and rate_limit_error types; 'false' for all others.\n","schema":{"type":"string","enum":["true","false"]},"example":"false"}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","description":"OpenAI-compatible error format","required":["message","type","param","code"],"properties":{"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"Error category per guide §4.","enum":["invalid_request_error","authentication_error","permission_error","not_found_error","rate_limit_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"param":{"oneOf":[{"type":"string","description":"Parameter that caused the error (null if not applicable)","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"Parameter that caused the error (null if not applicable)","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"type":"string","description":"Canonical code per guide §5 and docs/reference/error_codes.json.","enum":["invalid_api_key","expired_api_key","insufficient_permissions","feature_disabled","mfa_required","invalid_recovery_code","mfa_verification_failed","invalid_request","missing_required_parameter","invalid_parameter_value","payload_too_large","context_length_exceeded","content_filtered","idempotency_conflict","idempotency_replay_unavailable","field_immutable","operation_not_allowed","unknown_field","state_precondition_failed","duplicate_resource","method_not_allowed","payment_declined","payment_method_invalid","tools_not_supported","json_mode_not_supported","structured_output_not_supported","tools_with_structured_output_not_supported","vision_not_supported","reasoning_not_supported","thinking_disable_not_supported","streaming_not_supported","non_streaming_not_supported","batch_only","tier_opt_in_required","tool_choice_required_not_supported","cost_constraint_exceeded","latency_constraint_exceeded","throughput_constraint_not_met","provider_not_in_allowlist","provider_blocked","required_params_not_supported","byok_keys_required","platform_keys_unavailable","unsupported_modalities","no_compatible_endpoint","no_responses_endpoint","input_requires_responses_endpoint","response_api_only","hosted_tool_not_supported","no_tools_on_endpoint","model_not_found","resource_not_found","rate_limit_exceeded","budget_exhausted","insufficient_quota","no_provider_available","upstream_error","upstream_timeout","client_disconnected","stream_duration_exceeded","model_unavailable","internal_error","service_unavailable"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","description":"Link to the canonical documentation page for this error code.","uniqueKey":"error.doc_url","typeLabel":"string"},"provider":{"oneOf":[{"type":"string","description":"Upstream provider that generated the error (e.g., \"google_ai_studio\", \"openai\"). Null for errors not attributable to an upstream provider (local validation, auth, internal config).","uniqueKey":"error.provider.oneOf.0","typeLabel":"string"},{"type":"null","description":"Upstream provider that generated the error (e.g., \"google_ai_studio\", \"openai\"). Null for errors not attributable to an upstream provider (local validation, auth, internal config).","uniqueKey":"error.provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.provider","typeLabel":"string | null"},"suggestion":{"type":"string","description":"Actionable fix hint for routing, capability, or model-not-found errors. Absent for other error types.","uniqueKey":"error.suggestion","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"message":"Model 'unknown-model' is not in the catalog. See https://api.auriko.ai/v1/directory/models for available models.","type":"not_found_error","param":"model","code":"model_not_found"}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"Model 'unknown-model' is not in the catalog. See https://api.auriko.ai/v1/directory/models for available models.","type":"not_found_error","param":"model","code":"model_not_found"}}}},"exampleType":"examples"}},"exampleType":"examples"},"1bda0cbe-8fad-4626-8797-c7a4d3844ccb":{"description":"Rate limit exceeded. Two sub-causes share this status:\n- `rate_limit_exceeded`: throughput-based rate limit.\n- `budget_exhausted`: account or project budget reached (self-service;\n not auto-retried by SDKs — requires adding credits or raising the limit).\n","headers":{"X-Request-ID":{"description":"Unique request identifier for debugging and support.\nInclude this in support requests for fast resolution.\n","schema":{"type":"string"},"example":"req_abc123def456"},"X-Error-Type":{"description":"Same value as the `error.type` field in the response body, exposed as a\nheader for programmatic routing without body parsing.\n","schema":{"type":"string","enum":["invalid_request_error","rate_limit_error","api_error","authentication_error","not_found_error","permission_error"]},"example":"invalid_request_error"},"X-Error-Retryable":{"description":"Whether the client should retry this request.\n'true' for api_error and rate_limit_error types; 'false' for all others.\n","schema":{"type":"string","enum":["true","false"]},"example":"false"},"Retry-After":{"description":"Seconds until rate limit resets. Standard HTTP header for retry backoff.","schema":{"type":"integer"},"example":60},"X-Rate-Limit-Source":{"description":"Identifies the origin of the rate limit: upstream provider, Auriko's routing layer, an API key's configured limit (key), or the account tier default (tier).\n","schema":{"type":"string","enum":["provider","routing","key","tier"]},"required":false,"example":"provider"},"X-RateLimit-Limit-Requests":{"description":"Request limit per window (present on throughput-based rate limits)","schema":{"type":"integer"},"required":false,"example":60},"X-RateLimit-Remaining-Requests":{"description":"Remaining requests in window (present on throughput-based rate limits)","schema":{"type":"integer"},"required":false,"example":0},"X-RateLimit-Reset-Requests":{"description":"When limit resets (ISO 8601 format; present on throughput-based rate limits)","schema":{"type":"string","format":"date-time"},"required":false,"example":"2026-06-15T12:01:00.000Z"},"X-Budget-Exceeded":{"description":"Present on budget-exhaustion 429s.","schema":{"type":"string","enum":["true","false"]},"required":false,"example":"true"},"X-Budget-Exceeded-Period":{"description":"Period of the exceeded budget (present on budget-exhaustion 429s).","schema":{"type":"string","enum":["daily","weekly","monthly"]},"required":false,"example":"monthly"},"X-Budget-Exceeded-Scope":{"description":"Scope of the exceeded budget (present on budget-exhaustion 429s).","schema":{"type":"string","enum":["workspace","api_key","byok_provider"]},"required":false,"example":"workspace"}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","description":"OpenAI-compatible error format","required":["message","type","param","code"],"properties":{"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"Error category per guide §4.","enum":["invalid_request_error","authentication_error","permission_error","not_found_error","rate_limit_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"param":{"oneOf":[{"type":"string","description":"Parameter that caused the error (null if not applicable)","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"Parameter that caused the error (null if not applicable)","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"type":"string","description":"Canonical code per guide §5 and docs/reference/error_codes.json.","enum":["invalid_api_key","expired_api_key","insufficient_permissions","feature_disabled","mfa_required","invalid_recovery_code","mfa_verification_failed","invalid_request","missing_required_parameter","invalid_parameter_value","payload_too_large","context_length_exceeded","content_filtered","idempotency_conflict","idempotency_replay_unavailable","field_immutable","operation_not_allowed","unknown_field","state_precondition_failed","duplicate_resource","method_not_allowed","payment_declined","payment_method_invalid","tools_not_supported","json_mode_not_supported","structured_output_not_supported","tools_with_structured_output_not_supported","vision_not_supported","reasoning_not_supported","thinking_disable_not_supported","streaming_not_supported","non_streaming_not_supported","batch_only","tier_opt_in_required","tool_choice_required_not_supported","cost_constraint_exceeded","latency_constraint_exceeded","throughput_constraint_not_met","provider_not_in_allowlist","provider_blocked","required_params_not_supported","byok_keys_required","platform_keys_unavailable","unsupported_modalities","no_compatible_endpoint","no_responses_endpoint","input_requires_responses_endpoint","response_api_only","hosted_tool_not_supported","no_tools_on_endpoint","model_not_found","resource_not_found","rate_limit_exceeded","budget_exhausted","insufficient_quota","no_provider_available","upstream_error","upstream_timeout","client_disconnected","stream_duration_exceeded","model_unavailable","internal_error","service_unavailable"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","description":"Link to the canonical documentation page for this error code.","uniqueKey":"error.doc_url","typeLabel":"string"},"provider":{"oneOf":[{"type":"string","description":"Upstream provider that generated the error (e.g., \"google_ai_studio\", \"openai\"). Null for errors not attributable to an upstream provider (local validation, auth, internal config).","uniqueKey":"error.provider.oneOf.0","typeLabel":"string"},{"type":"null","description":"Upstream provider that generated the error (e.g., \"google_ai_studio\", \"openai\"). Null for errors not attributable to an upstream provider (local validation, auth, internal config).","uniqueKey":"error.provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.provider","typeLabel":"string | null"},"suggestion":{"type":"string","description":"Actionable fix hint for routing, capability, or model-not-found errors. Absent for other error types.","uniqueKey":"error.suggestion","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"rate_limit_exceeded":{"title":"rate_limit_exceeded","summary":"Throughput-based rate limit","value":{"error":{"message":"Rate limit exceeded. Retry after 60 seconds.","type":"rate_limit_error","param":null,"code":"rate_limit_exceeded"}}},"budget_exhausted":{"title":"budget_exhausted","summary":"Account budget exhausted","value":{"error":{"message":"Account budget exhausted. Add credits to continue.","type":"rate_limit_error","param":null,"code":"budget_exhausted"}}}},"exampleType":"examples"}},"exampleType":"examples"},"794e6e69-7da0-4411-b8b5-a1cd2b957fb5":{"description":"Internal server error","headers":{"X-Request-ID":{"description":"Unique request identifier for debugging and support.\nInclude this in support requests for fast resolution.\n","schema":{"type":"string"},"example":"req_abc123def456"},"X-Error-Type":{"description":"Same value as the `error.type` field in the response body, exposed as a\nheader for programmatic routing without body parsing.\n","schema":{"type":"string","enum":["invalid_request_error","rate_limit_error","api_error","authentication_error","not_found_error","permission_error"]},"example":"invalid_request_error"},"X-Error-Retryable":{"description":"Whether the client should retry this request.\n'true' for api_error and rate_limit_error types; 'false' for all others.\n","schema":{"type":"string","enum":["true","false"]},"example":"false"}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","description":"OpenAI-compatible error format","required":["message","type","param","code"],"properties":{"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"Error category per guide §4.","enum":["invalid_request_error","authentication_error","permission_error","not_found_error","rate_limit_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"param":{"oneOf":[{"type":"string","description":"Parameter that caused the error (null if not applicable)","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"Parameter that caused the error (null if not applicable)","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"type":"string","description":"Canonical code per guide §5 and docs/reference/error_codes.json.","enum":["invalid_api_key","expired_api_key","insufficient_permissions","feature_disabled","mfa_required","invalid_recovery_code","mfa_verification_failed","invalid_request","missing_required_parameter","invalid_parameter_value","payload_too_large","context_length_exceeded","content_filtered","idempotency_conflict","idempotency_replay_unavailable","field_immutable","operation_not_allowed","unknown_field","state_precondition_failed","duplicate_resource","method_not_allowed","payment_declined","payment_method_invalid","tools_not_supported","json_mode_not_supported","structured_output_not_supported","tools_with_structured_output_not_supported","vision_not_supported","reasoning_not_supported","thinking_disable_not_supported","streaming_not_supported","non_streaming_not_supported","batch_only","tier_opt_in_required","tool_choice_required_not_supported","cost_constraint_exceeded","latency_constraint_exceeded","throughput_constraint_not_met","provider_not_in_allowlist","provider_blocked","required_params_not_supported","byok_keys_required","platform_keys_unavailable","unsupported_modalities","no_compatible_endpoint","no_responses_endpoint","input_requires_responses_endpoint","response_api_only","hosted_tool_not_supported","no_tools_on_endpoint","model_not_found","resource_not_found","rate_limit_exceeded","budget_exhausted","insufficient_quota","no_provider_available","upstream_error","upstream_timeout","client_disconnected","stream_duration_exceeded","model_unavailable","internal_error","service_unavailable"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","description":"Link to the canonical documentation page for this error code.","uniqueKey":"error.doc_url","typeLabel":"string"},"provider":{"oneOf":[{"type":"string","description":"Upstream provider that generated the error (e.g., \"google_ai_studio\", \"openai\"). Null for errors not attributable to an upstream provider (local validation, auth, internal config).","uniqueKey":"error.provider.oneOf.0","typeLabel":"string"},{"type":"null","description":"Upstream provider that generated the error (e.g., \"google_ai_studio\", \"openai\"). Null for errors not attributable to an upstream provider (local validation, auth, internal config).","uniqueKey":"error.provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.provider","typeLabel":"string | null"},"suggestion":{"type":"string","description":"Actionable fix hint for routing, capability, or model-not-found errors. Absent for other error types.","uniqueKey":"error.suggestion","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"message":"An unexpected error occurred. Contact support with the request ID.","type":"api_error","param":null,"code":"internal_error"}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"An unexpected error occurred. Contact support with the request ID.","type":"api_error","param":null,"code":"internal_error"}}}},"exampleType":"examples"}},"exampleType":"examples"},"9556f397-d92a-4179-bb18-3267ee14cbad":{"description":"Upstream provider failure (Bad Gateway).\n\nAll non-timeout 5xx errors from upstream providers are normalized to 502 (code: `upstream_error`).\nUpstream failures may also surface as:\n- 429: Provider rate limit (code: `rate_limit_exceeded`)\n- 504: Provider timed out (code: `upstream_timeout`)\n\nThese use their respective status codes with the same `ErrorResponse` body format.\n","headers":{"X-Request-ID":{"description":"Unique request identifier for debugging and support.\nInclude this in support requests for fast resolution.\n","schema":{"type":"string"},"example":"req_abc123def456"},"X-Error-Type":{"description":"Canonical error type (one of the X-Error-Type enum values)","schema":{"type":"string"},"required":false},"X-Error-Retryable":{"description":"Whether the error is retryable ('true' or 'false')","schema":{"type":"string","enum":["true","false"]},"required":false},"Retry-After":{"description":"Seconds to wait before retrying (present on rate limit errors)","schema":{"type":"integer"},"required":false}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","description":"OpenAI-compatible error format","required":["message","type","param","code"],"properties":{"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"Error category per guide §4.","enum":["invalid_request_error","authentication_error","permission_error","not_found_error","rate_limit_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"param":{"oneOf":[{"type":"string","description":"Parameter that caused the error (null if not applicable)","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"Parameter that caused the error (null if not applicable)","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"type":"string","description":"Canonical code per guide §5 and docs/reference/error_codes.json.","enum":["invalid_api_key","expired_api_key","insufficient_permissions","feature_disabled","mfa_required","invalid_recovery_code","mfa_verification_failed","invalid_request","missing_required_parameter","invalid_parameter_value","payload_too_large","context_length_exceeded","content_filtered","idempotency_conflict","idempotency_replay_unavailable","field_immutable","operation_not_allowed","unknown_field","state_precondition_failed","duplicate_resource","method_not_allowed","payment_declined","payment_method_invalid","tools_not_supported","json_mode_not_supported","structured_output_not_supported","tools_with_structured_output_not_supported","vision_not_supported","reasoning_not_supported","thinking_disable_not_supported","streaming_not_supported","non_streaming_not_supported","batch_only","tier_opt_in_required","tool_choice_required_not_supported","cost_constraint_exceeded","latency_constraint_exceeded","throughput_constraint_not_met","provider_not_in_allowlist","provider_blocked","required_params_not_supported","byok_keys_required","platform_keys_unavailable","unsupported_modalities","no_compatible_endpoint","no_responses_endpoint","input_requires_responses_endpoint","response_api_only","hosted_tool_not_supported","no_tools_on_endpoint","model_not_found","resource_not_found","rate_limit_exceeded","budget_exhausted","insufficient_quota","no_provider_available","upstream_error","upstream_timeout","client_disconnected","stream_duration_exceeded","model_unavailable","internal_error","service_unavailable"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","description":"Link to the canonical documentation page for this error code.","uniqueKey":"error.doc_url","typeLabel":"string"},"provider":{"oneOf":[{"type":"string","description":"Upstream provider that generated the error (e.g., \"google_ai_studio\", \"openai\"). Null for errors not attributable to an upstream provider (local validation, auth, internal config).","uniqueKey":"error.provider.oneOf.0","typeLabel":"string"},{"type":"null","description":"Upstream provider that generated the error (e.g., \"google_ai_studio\", \"openai\"). Null for errors not attributable to an upstream provider (local validation, auth, internal config).","uniqueKey":"error.provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.provider","typeLabel":"string | null"},"suggestion":{"type":"string","description":"Actionable fix hint for routing, capability, or model-not-found errors. Absent for other error types.","uniqueKey":"error.suggestion","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"message":"Model 'gpt-4o' is temporarily unavailable. Retry in a few seconds.","type":"api_error","param":null,"code":"upstream_error"}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"Model 'gpt-4o' is temporarily unavailable. Retry in a few seconds.","type":"api_error","param":null,"code":"upstream_error"}}}},"exampleType":"examples"}},"exampleType":"examples"},"c543cbda-6e9d-40f2-a714-82924bd02eaa":{"description":"Service unavailable — transient issue. Possible causes:\n- All providers for the model are rate-limited or temporarily unavailable (`no_provider_available`)\n- Transient infrastructure issue (`service_unavailable`)\n\nNote: If the model doesn't support a requested capability (e.g., reasoning),\nthe response is 400 with a specific code (e.g., `reasoning_not_supported`), not 503.\nIf routing constraints excluded all providers, the response is 400 with a\nspecific constraint code (e.g., `cost_constraint_exceeded`).\n","headers":{"X-Request-ID":{"description":"Unique request identifier for debugging and support.\nInclude this in support requests for fast resolution.\n","schema":{"type":"string"},"example":"req_abc123def456"},"X-Error-Type":{"description":"Same value as the `error.type` field in the response body, exposed as a\nheader for programmatic routing without body parsing.\n","schema":{"type":"string","enum":["invalid_request_error","rate_limit_error","api_error","authentication_error","not_found_error","permission_error"]},"example":"invalid_request_error"},"X-Error-Retryable":{"description":"Whether the client should retry this request.\n'true' for api_error and rate_limit_error types; 'false' for all others.\n","schema":{"type":"string","enum":["true","false"]},"example":"false"},"Retry-After":{"description":"Seconds to wait before retrying (present on transient failures)","schema":{"type":"integer"},"required":false}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","description":"OpenAI-compatible error format","required":["message","type","param","code"],"properties":{"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"Error category per guide §4.","enum":["invalid_request_error","authentication_error","permission_error","not_found_error","rate_limit_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"param":{"oneOf":[{"type":"string","description":"Parameter that caused the error (null if not applicable)","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"Parameter that caused the error (null if not applicable)","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"type":"string","description":"Canonical code per guide §5 and docs/reference/error_codes.json.","enum":["invalid_api_key","expired_api_key","insufficient_permissions","feature_disabled","mfa_required","invalid_recovery_code","mfa_verification_failed","invalid_request","missing_required_parameter","invalid_parameter_value","payload_too_large","context_length_exceeded","content_filtered","idempotency_conflict","idempotency_replay_unavailable","field_immutable","operation_not_allowed","unknown_field","state_precondition_failed","duplicate_resource","method_not_allowed","payment_declined","payment_method_invalid","tools_not_supported","json_mode_not_supported","structured_output_not_supported","tools_with_structured_output_not_supported","vision_not_supported","reasoning_not_supported","thinking_disable_not_supported","streaming_not_supported","non_streaming_not_supported","batch_only","tier_opt_in_required","tool_choice_required_not_supported","cost_constraint_exceeded","latency_constraint_exceeded","throughput_constraint_not_met","provider_not_in_allowlist","provider_blocked","required_params_not_supported","byok_keys_required","platform_keys_unavailable","unsupported_modalities","no_compatible_endpoint","no_responses_endpoint","input_requires_responses_endpoint","response_api_only","hosted_tool_not_supported","no_tools_on_endpoint","model_not_found","resource_not_found","rate_limit_exceeded","budget_exhausted","insufficient_quota","no_provider_available","upstream_error","upstream_timeout","client_disconnected","stream_duration_exceeded","model_unavailable","internal_error","service_unavailable"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","description":"Link to the canonical documentation page for this error code.","uniqueKey":"error.doc_url","typeLabel":"string"},"provider":{"oneOf":[{"type":"string","description":"Upstream provider that generated the error (e.g., \"google_ai_studio\", \"openai\"). Null for errors not attributable to an upstream provider (local validation, auth, internal config).","uniqueKey":"error.provider.oneOf.0","typeLabel":"string"},{"type":"null","description":"Upstream provider that generated the error (e.g., \"google_ai_studio\", \"openai\"). Null for errors not attributable to an upstream provider (local validation, auth, internal config).","uniqueKey":"error.provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.provider","typeLabel":"string | null"},"suggestion":{"type":"string","description":"Actionable fix hint for routing, capability, or model-not-found errors. Absent for other error types.","uniqueKey":"error.suggestion","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"no_providers":{"title":"no_providers","summary":"No providers available for the model","value":{"error":{"message":"No provider available for model 'gpt-4o'. Try a different model.","type":"api_error","param":null,"code":"no_provider_available"}}},"service_unavailable":{"title":"service_unavailable","summary":"Transient infrastructure issue","value":{"error":{"message":"Service is temporarily unavailable. Retry in a few seconds.","type":"api_error","param":null,"code":"service_unavailable"}}}},"exampleType":"examples"}},"exampleType":"examples"},"a423f98a-f5e6-4fb1-a1b3-d1a3d78390a9":{"description":"Upstream provider timed out. The client may retry with a longer timeout.\n","headers":{"X-Request-ID":{"description":"Unique request identifier for debugging and support.\nInclude this in support requests for fast resolution.\n","schema":{"type":"string"},"example":"req_abc123def456"},"X-Error-Type":{"description":"Error type (always 'api_error' for timeout responses)","schema":{"type":"string"},"required":false},"X-Error-Retryable":{"description":"Whether the error is retryable ('true' or 'false')","schema":{"type":"string","enum":["true","false"]},"required":false}},"content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","description":"OpenAI-compatible error format","required":["message","type","param","code"],"properties":{"message":{"type":"string","description":"Human-readable error message","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"Error category per guide §4.","enum":["invalid_request_error","authentication_error","permission_error","not_found_error","rate_limit_error","api_error"],"isRequired":true,"uniqueKey":"error.type","typeLabel":"enum\u003cstring>"},"param":{"oneOf":[{"type":"string","description":"Parameter that caused the error (null if not applicable)","isRequired":true,"uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"Parameter that caused the error (null if not applicable)","isRequired":true,"uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"type":"string","description":"Canonical code per guide §5 and docs/reference/error_codes.json.","enum":["invalid_api_key","expired_api_key","insufficient_permissions","feature_disabled","mfa_required","invalid_recovery_code","mfa_verification_failed","invalid_request","missing_required_parameter","invalid_parameter_value","payload_too_large","context_length_exceeded","content_filtered","idempotency_conflict","idempotency_replay_unavailable","field_immutable","operation_not_allowed","unknown_field","state_precondition_failed","duplicate_resource","method_not_allowed","payment_declined","payment_method_invalid","tools_not_supported","json_mode_not_supported","structured_output_not_supported","tools_with_structured_output_not_supported","vision_not_supported","reasoning_not_supported","thinking_disable_not_supported","streaming_not_supported","non_streaming_not_supported","batch_only","tier_opt_in_required","tool_choice_required_not_supported","cost_constraint_exceeded","latency_constraint_exceeded","throughput_constraint_not_met","provider_not_in_allowlist","provider_blocked","required_params_not_supported","byok_keys_required","platform_keys_unavailable","unsupported_modalities","no_compatible_endpoint","no_responses_endpoint","input_requires_responses_endpoint","response_api_only","hosted_tool_not_supported","no_tools_on_endpoint","model_not_found","resource_not_found","rate_limit_exceeded","budget_exhausted","insufficient_quota","no_provider_available","upstream_error","upstream_timeout","client_disconnected","stream_duration_exceeded","model_unavailable","internal_error","service_unavailable"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"doc_url":{"type":"string","description":"Link to the canonical documentation page for this error code.","uniqueKey":"error.doc_url","typeLabel":"string"},"provider":{"oneOf":[{"type":"string","description":"Upstream provider that generated the error (e.g., \"google_ai_studio\", \"openai\"). Null for errors not attributable to an upstream provider (local validation, auth, internal config).","uniqueKey":"error.provider.oneOf.0","typeLabel":"string"},{"type":"null","description":"Upstream provider that generated the error (e.g., \"google_ai_studio\", \"openai\"). Null for errors not attributable to an upstream provider (local validation, auth, internal config).","uniqueKey":"error.provider.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.provider","typeLabel":"string | null"},"suggestion":{"type":"string","description":"Actionable fix hint for routing, capability, or model-not-found errors. Absent for other error types.","uniqueKey":"error.suggestion","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"message":"Model 'gpt-4o' timed out. Retry or use a smaller input.","type":"api_error","param":null,"code":"upstream_timeout"}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"Model 'gpt-4o' timed out. Retry or use a smaller input.","type":"api_error","param":null,"code":"upstream_timeout"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"b7828fa8-fa64-4476-8641-15be98bd8946":{"ApiKeyAuth":{"type":"http","scheme":"bearer","description":"API key authentication.\nKeys start with `ak_` prefix.\nExample: `Authorization: Bearer ak_live_xxxxxxxxxxxx`\n","scopes":[]}}},"servers":{"7a684522-107c-44d9-947d-4e0fc7defa27":{"url":"https://api.auriko.ai","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"API key authentication.\nKeys start with `ak_` prefix.\nExample: `Authorization: Bearer ak_live_xxxxxxxxxxxx`\n","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"API key authentication.\nKeys start with `ak_` prefix.\nExample: `Authorization: Bearer ak_live_xxxxxxxxxxxx`\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ApiKeyAuth","name":"Authorization"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi.yaml"},"subdomain":"auriko","siteName":"Auriko","title":"Create response - Auriko","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-05-27T02:24:36.381Z","originalFileLocation":"api-reference/create-response.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=\"light\"}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=\"Create a model response using the OpenAI Response API format\">\u003cmeta data-mint-head name=\"application-name\" content=\"Auriko\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/auriko/7DJ_JVLmhIccRobw/_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/auriko/7DJ_JVLmhIccRobw/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/auriko/7DJ_JVLmhIccRobw/_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/auriko/7DJ_JVLmhIccRobw/_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/auriko/7DJ_JVLmhIccRobw/_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/auriko/7DJ_JVLmhIccRobw/_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/auriko/7DJ_JVLmhIccRobw/_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/auriko/7DJ_JVLmhIccRobw/_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/auriko/7DJ_JVLmhIccRobw/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create response - Auriko\">\u003cmeta data-mint-head property=\"og:description\" content=\"Create a model response using the OpenAI Response API format\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Auriko\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.auriko.ai/api-reference/create-response\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://auriko.mintlify.site/_mintlify/api/og/v2?division=Inference\u0026amp;title=Create+response\u0026amp;description=Create+a+model+response+using+the+OpenAI+Response+API+format\u0026amp;theme=6c346e3dbc150029ebd144bc\u0026amp;signature=7b299c8ff6064b6795fda1a3b049388eba5a60d6f5af71d0c3cbbc8b7a1ea66e\">\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=\"Create response - Auriko\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Create a model response using the OpenAI Response API format\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://auriko.mintlify.site/_mintlify/api/og/v2?division=Inference\u0026amp;title=Create+response\u0026amp;description=Create+a+model+response+using+the+OpenAI+Response+API+format\u0026amp;theme=6c346e3dbc150029ebd144bc\u0026amp;signature=7b299c8ff6064b6795fda1a3b049388eba5a60d6f5af71d0c3cbbc8b7a1ea66e\">\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/auriko/7DJ_JVLmhIccRobw/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Auriko\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#4779EA\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.auriko.ai/api-reference/create-response\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/create-response.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.auriko.ai/#organization\",\"name\":\"Auriko\",\"url\":\"https://docs.auriko.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/auriko/ZctT69z8zlG3FLhm/logo/light.svg?fit=max\u0026auto=format\u0026n=ZctT69z8zlG3FLhm\u0026q=85\u0026s=9160396833137f89a62e6297d0da13e3\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.auriko.ai#website\",\"name\":\"Auriko\",\"url\":\"https://docs.auriko.ai\",\"publisher\":{\"@id\":\"https://docs.auriko.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.auriko.ai/api-reference/create-response#webpage\",\"url\":\"https://docs.auriko.ai/api-reference/create-response\",\"name\":\"Create response\",\"description\":\"Create a model response using the OpenAI Response API format\",\"dateModified\":\"2026-05-27T02:24:36.381Z\",\"isPartOf\":{\"@id\":\"https://docs.auriko.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.auriko.ai/api-reference/create-response#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.auriko.ai/api-reference/create-response#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://docs.auriko.ai/api-reference/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Inference\",\"item\":\"https://docs.auriko.ai/api-reference/chat-completions\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Create response\",\"item\":\"https://docs.auriko.ai/api-reference/create-response\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.auriko.ai/api-reference/create-response#apireference\",\"headline\":\"Create response\",\"name\":\"Create response\",\"description\":\"Create a model response using the OpenAI Response API format\",\"url\":\"https://docs.auriko.ai/api-reference/create-response\",\"mainEntityOfPage\":{\"@id\":\"https://docs.auriko.ai/api-reference/create-response#webpage\"},\"dateModified\":\"2026-05-27T02:24:36.381Z\",\"publisher\":{\"@id\":\"https://docs.auriko.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.auriko.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Auriko\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Auriko\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/create-response.md","siteName":"Auriko","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","groups":[{"group":"API Reference","pages":[{"title":"API Overview","href":"/api-reference/overview"},{"title":"Authentication","href":"/api-reference/authentication"},{"title":"Errors","href":"/api-reference/errors"},{"group":"Inference","pages":[{"title":"Create Chat Completion","description":"Create a model response for a chat conversation with intelligent routing","openapi":"POST /v1/chat/completions","href":"/api-reference/chat-completions"},{"title":"Create response","openapi":"POST /v1/responses","href":"/api-reference/create-response"}]},{"group":"Models","pages":[{"title":"List callable models","description":"Lists model IDs you can use with authenticated Auriko inference requests.","openapi":"GET /v1/models","href":"/api-reference/list-callable-models"},{"title":"Retrieve callable model","openapi":"GET /v1/models/{model_id}","href":"/api-reference/retrieve-callable-model"}]},{"group":"Model Catalog","pages":[{"title":"Model directory","openapi":"GET /v1/directory/models","href":"/api-reference/model-directory"},{"title":"Canonical model records","openapi":"GET /v1/registry/models","href":"/api-reference/canonical-model-records"},{"title":"Provider catalog","openapi":"GET /v1/registry/providers","href":"/api-reference/provider-catalog"}]},{"group":"Account","pages":[{"title":"Get API key identity","openapi":"GET /v1/me","href":"/api-reference/get-api-key-identity"}]},{"group":"API Keys","pages":[{"title":"List API keys","openapi":"GET /v1/workspaces/{workspace_id}/api-keys","href":"/api-reference/list-api-keys"},{"title":"Get API key","openapi":"GET /v1/workspaces/{workspace_id}/api-keys/{api_key_id}","href":"/api-reference/get-api-key"},{"title":"Get API key usage","openapi":"GET /v1/workspaces/{workspace_id}/api-keys/{api_key_id}/usage","href":"/api-reference/get-api-key-usage"},{"title":"Create API key","openapi":"POST /v1/workspaces/{workspace_id}/api-keys","href":"/api-reference/create-api-key"},{"title":"Update API key","openapi":"PATCH /v1/workspaces/{workspace_id}/api-keys/{api_key_id}","href":"/api-reference/update-api-key"},{"title":"Revoke API key","openapi":"DELETE /v1/workspaces/{workspace_id}/api-keys/{api_key_id}","href":"/api-reference/delete-api-key"}]},{"group":"BYOK","pages":[{"title":"List BYOK providers","openapi":"GET /v1/byok/providers","href":"/api-reference/list-byok-providers"},{"title":"List provider account tiers","openapi":"GET /v1/byok/providers/{provider}/tiers","href":"/api-reference/get-byok-provider-tiers"},{"title":"List BYOK keys","openapi":"GET /v1/workspaces/{workspace_id}/byok-keys","href":"/api-reference/list-byok-keys"},{"title":"Create BYOK key","openapi":"POST /v1/workspaces/{workspace_id}/byok-keys","href":"/api-reference/create-byok-key"},{"title":"Get BYOK key","openapi":"GET /v1/workspaces/{workspace_id}/byok-keys/{byok_key_id}","href":"/api-reference/get-byok-key"},{"title":"Update BYOK key","openapi":"PATCH /v1/workspaces/{workspace_id}/byok-keys/{byok_key_id}","href":"/api-reference/update-byok-key"},{"title":"Delete BYOK key","openapi":"DELETE /v1/workspaces/{workspace_id}/byok-keys/{byok_key_id}","href":"/api-reference/delete-byok-key"}]},{"group":"Billing","pages":[{"title":"Get credit balance","openapi":"GET /v1/workspaces/{workspace_id}/billing/balance","href":"/api-reference/get-credit-balance"}]}]}]},{"tab":"SDK","pages":[{"title":"SDK","href":"/sdk/integration-guide"}]}]},"basePath":"","title":"Create response - Auriko","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","CodeSnippet-D_HwgQO_.js","getApiPlaygroundDisplay-CmCoerhe.js","Page-CVJ-f_k1.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}