{ "id": "gen-1749812456-xyz7890", "object": "chat.completion", "created": 1749812456, "model": "anthropic/claude-opus-5.5", "choices": [ { "index": 0, "finish_reason": "stop", "message": { "role": "assistant", "content": "Attention lets a model dynamically weight its inputs and focus on the most relevant information.", "refusal": null, "reasoning": null } } ], "usage": { "prompt_tokens": 18, "completion_tokens": 32, "total_tokens": 50 }}
Authorizations
bearerAuthapiKeyAuth
Authorization
string
header
required
Bearer token used for request authentication. Alternatively, you can send the API key in the x-api-key header. Note: A payment method is required to use the API.
Body
application/json
Request body for the Chat Completions API. Some parameters apply only to certain models; unsupported parameters are ignored for the selected model.
model
enum<string>
required
The model to use for chat completion.
Available options:
openai/gpt-6.1-sol,
openai/gpt-6.1-terra,
openai/gpt-6-astra,
openai/gpt-5.6-sol,
openai/gpt-5.6-terra,
openai/gpt-5.6-luna,
openai/gpt-5.4,
anthropic/claude-fable-5.2,
anthropic/claude-opus-5.5,
anthropic/claude-opus-5,
anthropic/claude-sonnet-5.5,
anthropic/claude-sonnet-5,
anthropic/claude-haiku-5.5,
google/gemini-4-carbon,
google/gemini-4-argon,
google/gemini-4-hydrogen,
google/gemini-3.8-flash,
google/gemini-3.5-flash,
google/gemini-3.5-flash-lite,
google/gemini-3.1-pro-preview,
google/gemini-3.1-flash-lite,
google/gemini-3-flash-preview,
moonshotai/kimi-k3.1-pro,
moonshotai/kimi-k3,
minimax/minimax-m3.1-flash,
minimax/minimax-m3,
qwen/qwen3.6-plus,
deepseek/deepseek-v4.1-flash-1017,
deepseek/deepseek-v4-pro-0813,
deepseek/deepseek-v4-pro,
deepseek/deepseek-v4-flash-0731
messages
object[]
required
The conversation so far. System prompt plus user and assistant messages in chronological order.
Option 1
Option 2
Option 3
Option 4
Option 5
Show child attributes
tools
object[]
A tool definition. One of a custom function tool, the built-in octen_broad_search tool, the octen_search tool, or the octen_multimodal_search tool.
With octen_search, the model may also run a place search for local questions.
Do not declare octen_multimodal_search together with octen_search: the web searches overlap and are billed separately.
Option 1
Option 2
Option 3
Option 4
Show child attributes
tool_choice
enum<string>object
Controls tool invocation. none: never call tools; auto: model decides (default); required: must call a tool. Can also be an object to force a specific tool. Only valid when tools is set.
Available options:
none,
auto,
required
parallel_tool_calls
boolean
default:true
Whether the model may issue multiple tool calls in one reply. When false, at most one tool call per turn.
stream
boolean
default:false
Whether to enable streaming output. When true, returns chat.completion.chunk objects incrementally.
max_tokens
integer
Maximum number of tokens the model can output. If not set, the model's internal default limit is used.
Required range: x >= 1
max_completion_tokens
integer
Maximum completion tokens, including reasoning and visible output tokens. If not set, the model's internal default limit is used.
Required range: x >= 1
temperature
number
default:1
Controls randomness in generation. Higher values produce more diverse output; lower values produce more deterministic output.
Required range: 0 <= x <= 2
top_p
number
default:1
Nucleus sampling. Only tokens with cumulative probability up to top_p are considered.
Required range: x <= 1
top_k
integer
default:0
Sample only from the top K most probable tokens. 0 disables it.
Required range: x >= 0
min_p
number
default:0
Minimum probability threshold relative to the most probable token. Tokens below it are filtered out. 0 disables it.
Required range: 0 <= x <= 1
top_a
number
default:0
Dynamic filtering threshold based on the most probable token. 0 disables it.
Required range: 0 <= x <= 1
repetition_penalty
number
default:1
Penalizes tokens already present in the input. Above 1 suppresses repetition; below 1 encourages it.
Required range: x <= 2
frequency_penalty
number
default:0
Penalizes tokens by their frequency in the output so far. Positive values reduce repetition.
Required range: -2 <= x <= 2
presence_penalty
number
default:0
Penalizes tokens that have already appeared. Positive values encourage new topics.
Required range: -2 <= x <= 2
response_format
object
Controls the output format. Some models may not support structured output and will automatically fall back to text.
Show child attributes
stop
string[]
Stop sequences. Generation stops when any of these strings is encountered.
seed
integer
Seed for reproducibility. With the same parameters and model version, output should be as consistent as possible.
reasoning
object
Options for reasoning models. Turns thinking on or off and sets the effort and budget.
Show child attributes
reasoning_effort
enum<string>
Top-level alias for reasoning.effort. If both are set, reasoning takes precedence.
Available options:
none,
minimal,
low,
medium,
high,
xhigh,
max
verbosity
enum<string>
default:medium
Controls how verbose the reply is.
Available options:
low,
medium,
high
logit_bias
object
A JSON object mapping token IDs to bias values (-100 to 100), added to the logits before sampling.
Show child attributes
logprobs
boolean
default:false
Whether to return the log probabilities of the output tokens.
top_logprobs
integer
Number of most likely tokens to return at each position. Requires logprobs to be true.
Required range: 0 <= x <= 20
user
string
A unique identifier for the end user. Use hashed or pseudonymous identifiers to avoid passing personally identifiable information.
modalities
string[]
Requested output modalities.
prompt_cache_key
string
Cache key for prompt caching.
prompt_cache_options
object
Prompt caching controls.
Show child attributes
prompt_cache_retention
enum<string>
Prompt cache retention policy.
Available options:
in_memory,
24h
previous_response_id
string
The id of a previous response, used to chain state across turns.
Response
Successful chat completion. When stream=false, returns a single chat.completion object. When stream=true, returns a stream of chat.completion.chunk objects (search_done, content, finish, usage), followed by data: [DONE].
Non-streaming
Streaming
A non-streaming chat completion response. Returned when stream=false.
id
string
required
The unique identifier for this request.
object
enum<string>
required
The object type, always chat.completion for non-streaming responses.
Available options:
chat.completion
created
integer
required
Unix timestamp (in seconds) of when the completion was created.
model
string
required
The model used for this completion.
choices
object[]
required
A list of completion choices.
Show child attributes
search_results
object[]
Search results. Present only when octen_search, octen_broad_search, or octen_multimodal_search was actually triggered.
Show child attributes
usage
object
Token usage information. When stream=true, returned only in the final usage chunk.
Show child attributes
warning
string
Warning message, if any.
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Octen Docs","description":"The search infrastructure for AI. Real-time web search foundation that empowers LLMs to reason with the world's latest information. Engineered for AI Agents, Copilots, and Chatbots with real-time indexing, sub-100ms latency, and high reliability.","colors":{"primary":"#039855","light":"#FFFFFF","dark":"#0F1117"},"logo":{"light":"https://mintcdn.com/octen-ai/7a_UtFqtHVRx7z9z/logo/logo.svg?fit=max\u0026auto=format\u0026n=7a_UtFqtHVRx7z9z\u0026q=85\u0026s=26d2a863c023b0211afa7c6c0bce2d8e","dark":"https://mintcdn.com/octen-ai/7a_UtFqtHVRx7z9z/logo/logo-dark.svg?fit=max\u0026auto=format\u0026n=7a_UtFqtHVRx7z9z\u0026q=85\u0026s=bfbe0113ad39cf82fe68dd515c2091bf","href":"https://octen.ai"},"favicon":"https://mintcdn.com/octen-ai/R4_y7aW-VxkGajbE/logo/favicon.svg?fit=max\u0026auto=format\u0026n=R4_y7aW-VxkGajbE\u0026q=85\u0026s=f60d8117581e937a7e3cab4ecf74aa22","api":{"playground":{"display":"interactive"},"examples":{"prefill":true}},"navbar":{"links":[{"href":"mailto:support@octen.ai","label":"Support"}],"primary":{"type":"button","label":"API Platform","href":"https://octen.ai/platform"}},"footer":{},"seo":{"metatags":{"canonical":"https://docs.octen.ai","keywords":"octen,octen.ai,ai search infrastructure,real-time web search,search api,ai search engine,search for ai agents,retrieval layer for llms,llm grounding,real-time indexing,low latency retrieval,agentic search engine,live web data,sota embedding model,octen-8b,ai search api,web search api,api,search,ai,llms","og:description":"The search infrastructure for AI. Real-time web search foundation that empowers LLMs to reason with the world's latest information. Engineered for AI Agents, Copilots, and Chatbots with real-time indexing, sub-100ms latency, and high reliability.","og:image":"https://octen.ai/_next/static/media/octen-cover.dc74905e.png","og:url":"https://docs.octen.ai","og:site_name":"Octen Docs","twitter:card":"summary_large_image","twitter:description":"The search infrastructure for AI. Real-time web search foundation that empowers LLMs to reason with the world's latest information. Engineered for AI Agents, Copilots, and Chatbots with real-time indexing, sub-100ms latency, and high reliability.","twitter:image":"https://octen.ai/_next/static/media/octen-cover.dc74905e.png","google-site-verification":"WomFSLfAsZAC_vWB_WcRDmkF_IPlrOw-VHZROUA1LFE"},"indexing":"all"},"integrations":{"posthog":{"apiKey":"phc_S3tyhNZM8KsgXjF0kw1LYLgTQ8D2amhZNFA4vz1yHRo","sessionRecording":false}},"contextual":{"options":["copy","view"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"octen-ai","hasAudioNarration":false,"actualSubdomain":"octen-ai","customDomains":["docs.octen.ai"],"gitSource":{"type":"github","owner":"ai-apitech","repo":"apt_docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6afc7b5766df45c10c490945","clientVersion":"0.0.4177","searchFilterCounts":[{"language":"default","tag":"Documentation","count":38},{"language":"default","tag":"API Reference","count":32},{"language":"default","tag":"APIs","count":21},{"language":"default","tag":"Capabilities","count":17},{"language":"default","tag":"Applications","count":16},{"language":"default","tag":"Monitor","count":10},{"language":"default","tag":"Resources","count":9},{"language":"default","tag":"Octen Fast","count":8},{"language":"default","tag":"Octen Premier","count":6},{"language":"default","tag":"Integrations","count":6}],"searchSettings":{"maxResults":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":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"fix-copy-page.css","content":"#page-context-menu.hidden{display:flex!important}#header>#page-context-menu.mt-3{display:none!important}"}],"page":{"pagePath":"api-reference/chat-completions","slug":"/api-reference/chat-completions","pageMetadata":{"title":"LLM Chat (OpenAI-Compatible) API Reference","description":"Compatible with the OpenAI Chat Completions protocol, with optional built-in `octen_broad_search`, `octen_search`, and `octen_multimodal_search` tools.","deprecated":null,"version":null,"sidebarTitle":"LLM Chat (OpenAI-Compatible)","openapi":"/api-reference/openapi.json post /v1/chat/completions","href":"/api-reference/chat-completions","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Compatible with the OpenAI Chat Completions protocol, with optional built-in \", _jsx(_components.code, {\n children: \"octen_broad_search\"\n }), \", \", _jsx(_components.code, {\n children: \"octen_search\"\n }), \", and \", _jsx(_components.code, {\n children: \"octen_multimodal_search\"\n }), \" tools.\"]\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}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"LLM Chat (OpenAI-Compatible) API Reference","description":"Compatible with the OpenAI Chat Completions protocol, with optional built-in `octen_broad_search`, `octen_search`, and `octen_multimodal_search` tools.","deprecated":null,"version":null,"sidebarTitle":"LLM Chat (OpenAI-Compatible)","openapi":"/api-reference/openapi.json post /v1/chat/completions","href":"/api-reference/chat-completions","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/octen-ai/1394afa843283735/tryit-button.js"],"openApiReferenceData":{"operation":{"summary":"Create a chat completion","description":"Compatible with the OpenAI Chat Completions protocol, with optional built-in `octen_broad_search`, `octen_search`, and `octen_multimodal_search` tools.","operationId":"chat-completions","x-mint":{"href":"/api-reference/chat-completions","metadata":{"title":"LLM Chat (OpenAI-Compatible) API Reference","sidebarTitle":"LLM Chat (OpenAI-Compatible)"}},"requestBody":"67ec67ea-90a6-49f9-a972-9decdfce5d1f","responses":{"200":"b94453f9-c478-4e04-86c2-b35a416703ef","400":"617da2f7-e610-44b1-b9a9-6356bc87e00b","401":"b8f2b9f7-513b-41a7-a869-7cf5cf2cb034","403":"d9d93e30-edc1-45ee-9171-abd44d677d1c","404":"06aff291-c983-43a8-83d4-30c7194c0576","429":"b6549738-c068-4341-8b13-f29c54ae826d","500":"7a2268a5-5894-4f04-8225-33579dd2ffc1"},"method":"post","type":"path","servers":["03d7c70f-bdc7-478a-b64c-693a14ca47cc"],"security":["2c74c17e-44bd-4f2c-899a-3438f71d4605","3b85a8a9-39ca-4852-80fc-87c2a2c97a39"],"path":"/v1/chat/completions","baseUrlOptions":["https://api.octen.ai"],"title":"Create a chat completion","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.model":"anthropic/claude-opus-5.5","body.messages.items.0.oneOf.2.role":"user","body.messages.items.0.oneOf.2.content.oneOf.0":"Explain attention in one sentence.","body.stream":false,"body.max_tokens":2048,"body.temperature":1},{"body.model":"anthropic/claude-sonnet-5.5","body.messages.items.0.oneOf.0.role":"system","body.messages.items.0.oneOf.0.content.oneOf.0":"You are a helpful assistant.","body.messages.items.1.oneOf.2.role":"user","body.messages.items.1.oneOf.2.content.oneOf.0":"Compare cloud GPU pricing across major providers.","body.tools.items.0.oneOf.1.type":"octen_broad_search","body.tools.items.0.oneOf.1.parameters.max_queries":5,"body.tools.items.0.oneOf.1.parameters.count":10,"body.tools.items.0.oneOf.1.parameters.highlight.enable":true,"body.tools.items.0.oneOf.1.parameters.highlight.max_tokens":300,"body.tools.items.0.oneOf.1.parameters.format":"markdown","body.tool_choice.oneOf.0":"auto","body.stream":false},{"body.model":"anthropic/claude-sonnet-5.5","body.messages.items.0.oneOf.0.role":"system","body.messages.items.0.oneOf.0.content.oneOf.0":"You are a helpful assistant.","body.messages.items.1.oneOf.2.role":"user","body.messages.items.1.oneOf.2.content.oneOf.0":"What's the weather in Beijing today?","body.tools.items.0.oneOf.2.type":"octen_search","body.tools.items.0.oneOf.2.parameters.max_searches":3,"body.tools.items.0.oneOf.2.parameters.count":10,"body.tools.items.0.oneOf.2.parameters.highlight.enable":true,"body.tools.items.0.oneOf.2.parameters.highlight.max_tokens":300,"body.tools.items.0.oneOf.2.parameters.format":"markdown","body.tool_choice.oneOf.0":"auto","body.stream":false},{"body.model":"openai/gpt-6.1-terra","body.messages.items.0.oneOf.2.role":"user","body.messages.items.0.oneOf.2.content.oneOf.0":"What does the Sagrada Familia look like today?","body.tools.items.0.oneOf.3.type":"octen_multimodal_search","body.tools.items.0.oneOf.3.parameters.max_tool_calls":3},{"body.model":"openai/gpt-5.4","body.messages.items.0.oneOf.2.role":"user","body.messages.items.0.oneOf.2.content.oneOf.0":"Check tomorrow's weather in Shanghai, then create a travel reminder.","body.tools.items.0.oneOf.2.type":"octen_search","body.tools.items.1.oneOf.0.type":"function","body.tools.items.1.oneOf.0.function.name":"create_reminder","body.tools.items.1.oneOf.0.function.description":"Create a reminder","body.tools.items.1.oneOf.0.function.parameters":{"type":"object","properties":{"content":{"type":"string","description":"Reminder content"},"time":{"type":"string","description":"Reminder time, ISO 8601"}},"required":["content","time"]},"body.tool_choice.oneOf.0":"auto"},{"body.model":"anthropic/claude-sonnet-5.5","body.messages.items.0.oneOf.0.role":"system","body.messages.items.0.oneOf.0.content.oneOf.1.items.0.type":"text","body.messages.items.0.oneOf.0.content.oneOf.1.items.0.text":"Product manual (long stable prefix)...","body.messages.items.0.oneOf.0.content.oneOf.1.items.0.cache_control.type":"ephemeral","body.messages.items.0.oneOf.0.content.oneOf.1.items.0.cache_control.ttl":"5m","body.messages.items.1.oneOf.2.role":"user","body.messages.items.1.oneOf.2.content.oneOf.0":"What is the return policy?","body.max_tokens":1024}]},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["model","messages"],"description":"Request body for the Chat Completions API. Some parameters apply only to certain models; unsupported parameters are ignored for the selected model.","properties":{"model":{"type":"string","enum":["openai/gpt-6.1-sol","openai/gpt-6.1-terra","openai/gpt-6-astra","openai/gpt-5.6-sol","openai/gpt-5.6-terra","openai/gpt-5.6-luna","openai/gpt-5.4","anthropic/claude-fable-5.2","anthropic/claude-opus-5.5","anthropic/claude-opus-5","anthropic/claude-sonnet-5.5","anthropic/claude-sonnet-5","anthropic/claude-haiku-5.5","google/gemini-4-carbon","google/gemini-4-argon","google/gemini-4-hydrogen","google/gemini-3.8-flash","google/gemini-3.5-flash","google/gemini-3.5-flash-lite","google/gemini-3.1-pro-preview","google/gemini-3.1-flash-lite","google/gemini-3-flash-preview","moonshotai/kimi-k3.1-pro","moonshotai/kimi-k3","minimax/minimax-m3.1-flash","minimax/minimax-m3","qwen/qwen3.6-plus","deepseek/deepseek-v4.1-flash-1017","deepseek/deepseek-v4-pro-0813","deepseek/deepseek-v4-pro","deepseek/deepseek-v4-flash-0731"],"description":"The model to use for chat completion.","isRequired":true,"uniqueKey":"model","typeLabel":"enum\u003cstring>"},"messages":{"type":"array","items":{"oneOf":[{"type":"object","required":["role","content"],"properties":{"role":{"type":"string","enum":["system"],"description":"The role of the message author. Always `system`.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.0.role","typeLabel":"enum\u003cstring>"},"content":{"oneOf":[{"type":"string","description":"The system prompt content. A plain string or an array of content blocks.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.0.content.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"object","description":"A content block within a message.","required":["type"],"properties":{"type":{"type":"string","enum":["text","image","image_url"],"description":"The type of content block.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","description":"The text content. Required when `type` is `text`.","uniqueKey":"messages.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].text","typeLabel":"string"},"image":{"type":"string","description":"Base64-encoded image. Required when `type` is `image`.","uniqueKey":"messages.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].image","typeLabel":"string"},"image_url":{"type":"object","description":"Image URL object. Required when `type` is `image_url`.","required":["url"],"properties":{"url":{"type":"string","description":"The URL of the image.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].image_url.url","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].image_url","typeLabel":"object"},"cache_control":{"type":"object","description":"Prompt caching marker. Sets a cache breakpoint so the stable prefix up to this block can be reused.","required":["type"],"properties":{"type":{"type":"string","enum":["ephemeral"],"description":"The cache control type. Always `ephemeral`.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].cache_control.type","typeLabel":"enum\u003cstring>"},"ttl":{"type":"string","enum":["5m","1h"],"default":"5m","description":"Cache lifetime.","uniqueKey":"messages.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].cache_control.ttl","typeLabel":"enum\u003cstring>"}},"uniqueKey":"messages.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX].cache_control","typeLabel":"object"}},"uniqueKey":"messages.items.[INDEX].oneOf.0.content.oneOf.1.items.[INDEX]","typeLabel":"object"},"description":"The system prompt content. A plain string or an array of content blocks.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.0.content.oneOf.1","typeLabel":"object[]"}],"isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.0.content","typeLabel":"string | object[]"}},"uniqueKey":"messages.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"A developer message. The OpenAI-protocol equivalent of `system` (sent by newer OpenAI SDKs); handled as `system`.","required":["role","content"],"properties":{"role":{"type":"string","enum":["developer"],"description":"The role of the message author. Always `developer`.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.1.role","typeLabel":"enum\u003cstring>"},"content":{"oneOf":[{"type":"string","description":"The content. A plain string or an array of content blocks.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.1.content.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"object","description":"A content block within a message.","required":["type"],"properties":{"type":{"type":"string","enum":["text","image","image_url"],"description":"The type of content block.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","description":"The text content. Required when `type` is `text`.","uniqueKey":"messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].text","typeLabel":"string"},"image":{"type":"string","description":"Base64-encoded image. Required when `type` is `image`.","uniqueKey":"messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].image","typeLabel":"string"},"image_url":{"type":"object","description":"Image URL object. Required when `type` is `image_url`.","required":["url"],"properties":{"url":{"type":"string","description":"The URL of the image.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].image_url.url","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].image_url","typeLabel":"object"},"cache_control":{"type":"object","description":"Prompt caching marker. Sets a cache breakpoint so the stable prefix up to this block can be reused.","required":["type"],"properties":{"type":{"type":"string","enum":["ephemeral"],"description":"The cache control type. Always `ephemeral`.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].cache_control.type","typeLabel":"enum\u003cstring>"},"ttl":{"type":"string","enum":["5m","1h"],"default":"5m","description":"Cache lifetime.","uniqueKey":"messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].cache_control.ttl","typeLabel":"enum\u003cstring>"}},"uniqueKey":"messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX].cache_control","typeLabel":"object"}},"uniqueKey":"messages.items.[INDEX].oneOf.1.content.oneOf.1.items.[INDEX]","typeLabel":"object"},"description":"The content. A plain string or an array of content blocks.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.1.content.oneOf.1","typeLabel":"object[]"}],"isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.1.content","typeLabel":"string | object[]"}},"uniqueKey":"messages.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","required":["role","content"],"properties":{"role":{"type":"string","enum":["user"],"description":"The role of the message author. Always `user`.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.role","typeLabel":"enum\u003cstring>"},"content":{"oneOf":[{"type":"string","description":"The content of the message. A plain string or an array of content blocks.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"object","description":"A content block within a message.","required":["type"],"properties":{"type":{"type":"string","enum":["text","image","image_url"],"description":"The type of content block.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","description":"The text content. Required when `type` is `text`.","uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].text","typeLabel":"string"},"image":{"type":"string","description":"Base64-encoded image. Required when `type` is `image`.","uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].image","typeLabel":"string"},"image_url":{"type":"object","description":"Image URL object. Required when `type` is `image_url`.","required":["url"],"properties":{"url":{"type":"string","description":"The URL of the image.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].image_url.url","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].image_url","typeLabel":"object"},"cache_control":{"type":"object","description":"Prompt caching marker. Sets a cache breakpoint so the stable prefix up to this block can be reused.","required":["type"],"properties":{"type":{"type":"string","enum":["ephemeral"],"description":"The cache control type. Always `ephemeral`.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].cache_control.type","typeLabel":"enum\u003cstring>"},"ttl":{"type":"string","enum":["5m","1h"],"default":"5m","description":"Cache lifetime.","uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].cache_control.ttl","typeLabel":"enum\u003cstring>"}},"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX].cache_control","typeLabel":"object"}},"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1.items.[INDEX]","typeLabel":"object"},"description":"The content of the message. A plain string or an array of content blocks.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.content.oneOf.1","typeLabel":"object[]"}],"isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.2.content","typeLabel":"string | object[]"}},"uniqueKey":"messages.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","required":["role"],"properties":{"role":{"type":"string","enum":["assistant"],"description":"The role of the message author. Always `assistant`.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.role","typeLabel":"enum\u003cstring>"},"content":{"oneOf":[{"type":"string","description":"The assistant's text content. May be `null` or omitted when the assistant only produces tool calls.","uniqueKey":"messages.items.[INDEX].oneOf.3.content.oneOf.0","typeLabel":"string"},{"type":"null","description":"The assistant's text content. May be `null` or omitted when the assistant only produces tool calls.","uniqueKey":"messages.items.[INDEX].oneOf.3.content.oneOf.1","typeLabel":"null"}],"uniqueKey":"messages.items.[INDEX].oneOf.3.content","typeLabel":"string | null"},"tool_calls":{"type":"array","items":{"type":"object","required":["id","type","function"],"description":"A custom function call generated by the model.","properties":{"id":{"type":"string","description":"A unique identifier for this tool call. Referenced by the corresponding `tool` message's `tool_call_id`.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.tool_calls.items.[INDEX].id","typeLabel":"string"},"type":{"type":"string","enum":["function"],"description":"The type of tool call. Always `function`.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.tool_calls.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"function":{"type":"object","required":["name","arguments"],"description":"The function invocation details within a tool call.","properties":{"name":{"type":"string","description":"The name of the function to call.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.tool_calls.items.[INDEX].function.name","typeLabel":"string"},"arguments":{"type":"string","description":"The arguments to the function, as a JSON string generated by the model.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.tool_calls.items.[INDEX].function.arguments","typeLabel":"string"}},"isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.3.tool_calls.items.[INDEX].function","typeLabel":"object"},"index":{"type":"integer","description":"The index of this tool call in the array.","uniqueKey":"messages.items.[INDEX].oneOf.3.tool_calls.items.[INDEX].index","typeLabel":"integer"},"thought_signature":{"type":"string","description":"Encrypted reasoning state, replayed verbatim. Required when the request ends with a `tool` message.","uniqueKey":"messages.items.[INDEX].oneOf.3.tool_calls.items.[INDEX].thought_signature","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.3.tool_calls.items.[INDEX]","typeLabel":"object"},"description":"Tool calls generated by the model in a previous turn, replayed verbatim. Only valid when `role` is `assistant`.","uniqueKey":"messages.items.[INDEX].oneOf.3.tool_calls","typeLabel":"object[]"}},"uniqueKey":"messages.items.[INDEX].oneOf.3","typeLabel":"object"},{"type":"object","required":["role","tool_call_id","content"],"properties":{"role":{"type":"string","enum":["tool"],"description":"The role of the message author. Always `tool`.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.4.role","typeLabel":"enum\u003cstring>"},"tool_call_id":{"type":"string","description":"The ID of the tool call this message responds to.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.4.tool_call_id","typeLabel":"string"},"content":{"type":"string","description":"The tool output, typically a JSON string with the function result.","isRequired":true,"uniqueKey":"messages.items.[INDEX].oneOf.4.content","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].oneOf.4","typeLabel":"object"}],"uniqueKey":"messages.items.[INDEX]","typeLabel":"object"},"description":"The conversation so far. System prompt plus user and assistant messages in chronological order.","isRequired":true,"uniqueKey":"messages","typeLabel":"object[]"},"tools":{"type":"array","items":{"oneOf":[{"type":"object","description":"A tool definition. One of a custom `function` tool, the built-in `octen_broad_search` tool, the `octen_search` tool, or the `octen_multimodal_search` tool.\n\nWith `octen_search`, the model may also run a place search for local questions.\n\nDo not declare `octen_multimodal_search` together with `octen_search`: the web searches overlap and are billed separately.","required":["type","function"],"properties":{"type":{"type":"string","enum":["function"],"description":"The type of tool. Always `function` for a custom tool.","isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"function":{"type":"object","description":"The function definition.","required":["name"],"properties":{"name":{"type":"string","description":"The name of the function.","isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.0.function.name","typeLabel":"string"},"description":{"type":"string","description":"A description of what the function does.","uniqueKey":"tools.items.[INDEX].oneOf.0.function.description","typeLabel":"string"},"parameters":{"type":"object","description":"The function's parameter definition in JSON Schema format.","uniqueKey":"tools.items.[INDEX].oneOf.0.function.parameters","typeLabel":"object"},"strict":{"type":"boolean","default":false,"description":"Whether to enable strict mode. When enabled, generated arguments strictly conform to `parameters`.","uniqueKey":"tools.items.[INDEX].oneOf.0.function.strict","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.0.function","typeLabel":"object"}},"uniqueKey":"tools.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"A tool definition. One of a custom `function` tool, the built-in `octen_broad_search` tool, the `octen_search` tool, or the `octen_multimodal_search` tool.\n\nWith `octen_search`, the model may also run a place search for local questions.\n\nDo not declare `octen_multimodal_search` together with `octen_search`: the web searches overlap and are billed separately.","required":["type"],"properties":{"type":{"type":"string","enum":["octen_broad_search"],"description":"The type of tool. Always `octen_broad_search`.","isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"parameters":{"type":"object","description":"Broad search behavior configuration. Optional.","properties":{"max_queries":{"type":"integer","minimum":1,"maximum":30,"default":5,"description":"Upper bound on the number of sub-queries generated.","uniqueKey":"tools.items.[INDEX].oneOf.1.parameters.max_queries","typeLabel":"integer"},"result_type":{"type":"string","enum":["standard","dynamic"],"default":"standard","description":"Determines how results are returned. `standard` returns results as your parameters specify; `dynamic` returns only relevant results, up to `count`, and adjusts highlight length per result.","uniqueKey":"tools.items.[INDEX].oneOf.1.parameters.result_type","typeLabel":"enum\u003cstring>"},"count":{"type":"integer","default":5,"minimum":1,"maximum":100,"description":"Number of results to return. When `result_type` is `dynamic`, this is the maximum number of results.","uniqueKey":"tools.items.[INDEX].oneOf.1.parameters.count","typeLabel":"integer"},"include_domains":{"type":"array","items":{"type":"string","maxLength":60,"uniqueKey":"tools.items.[INDEX].oneOf.1.parameters.include_domains.items.[INDEX]","typeLabel":"string"},"maxItems":1200,"description":"A list of domains to specifically include in the search results. The `site:` query operator adds to this list.","example":["octen.ai","wikipedia.org"],"uniqueKey":"tools.items.[INDEX].oneOf.1.parameters.include_domains","typeLabel":"string[]"},"exclude_domains":{"type":"array","items":{"type":"string","maxLength":60,"uniqueKey":"tools.items.[INDEX].oneOf.1.parameters.exclude_domains.items.[INDEX]","typeLabel":"string"},"maxItems":1200,"description":"A list of domains to specifically exclude from the search results. The `-site:` query operator adds to this list. If a domain appears in both `include_domains` and `exclude_domains`, `exclude_domains` takes precedence.","example":["spam.com","ads.example.net"],"uniqueKey":"tools.items.[INDEX].oneOf.1.parameters.exclude_domains","typeLabel":"string[]"},"include_text":{"type":"array","items":{"type":"string","maxLength":30,"uniqueKey":"tools.items.[INDEX].oneOf.1.parameters.include_text.items.[INDEX]","typeLabel":"string"},"maxItems":5,"description":"Strings that must appear in the result page text.","uniqueKey":"tools.items.[INDEX].oneOf.1.parameters.include_text","typeLabel":"string[]"},"exclude_text":{"type":"array","items":{"type":"string","maxLength":30,"uniqueKey":"tools.items.[INDEX].oneOf.1.parameters.exclude_text.items.[INDEX]","typeLabel":"string"},"maxItems":5,"description":"Strings that must not appear in the result page text.","uniqueKey":"tools.items.[INDEX].oneOf.1.parameters.exclude_text","typeLabel":"string[]"},"time_basis":{"type":"string","enum":["auto","published","crawled"],"default":"auto","description":"Determines which time field is used for time filtering. `published` uses time_published; `crawled` uses time_last_crawled. Results missing this field are excluded when filtering by time.","uniqueKey":"tools.items.[INDEX].oneOf.1.parameters.time_basis","typeLabel":"enum\u003cstring>"},"time_range":{"type":"string","enum":["day","week","month","year","d","w","m","y"],"description":"Relative time window counting back from the current time based on `time_basis`. Mutually exclusive with `start_time`/`end_time` — if both are provided, `start_time`/`end_time` take precedence.","uniqueKey":"tools.items.[INDEX].oneOf.1.parameters.time_range","typeLabel":"enum\u003cstring>"},"start_time":{"type":"string","format":"date-time","description":"Start time for filtering results. ISO 8601 format.","example":"2025-01-01T00:00:00+08:00","uniqueKey":"tools.items.[INDEX].oneOf.1.parameters.start_time","typeLabel":"string\u003cdate-time>"},"end_time":{"type":"string","format":"date-time","description":"End time for filtering results. ISO 8601 format.","example":"2025-01-01T00:00:00+08:00","uniqueKey":"tools.items.[INDEX].oneOf.1.parameters.end_time","typeLabel":"string\u003cdate-time>"},"language":{"type":"array","items":{"type":"string","enum":["ar","de","en","es","fr","hi","id","it","ja","ko","nl","pl","pt","ru","th","tr","vi","zh"],"uniqueKey":"tools.items.[INDEX].oneOf.1.parameters.language.items.[INDEX]","typeLabel":"enum\u003cstring>"},"default":[],"description":"A list of languages to restrict results to, as ISO 639-1 codes. By default, no language filter is applied.","example":["en","zh"],"uniqueKey":"tools.items.[INDEX].oneOf.1.parameters.language","typeLabel":"enum\u003cstring>[]"},"highlight":{"type":"object","description":"Controls highlight extraction from result pages.","properties":{"enable":{"type":"boolean","default":true,"description":"If true, returns query-relevant highlight in each result.","uniqueKey":"tools.items.[INDEX].oneOf.1.parameters.highlight.enable","typeLabel":"boolean"},"max_tokens":{"type":"integer","default":512,"minimum":100,"maximum":20000,"description":"Max tokens returned per highlight. When `result_type` is `dynamic`, Octen may adjust this per result.","uniqueKey":"tools.items.[INDEX].oneOf.1.parameters.highlight.max_tokens","typeLabel":"integer"}},"uniqueKey":"tools.items.[INDEX].oneOf.1.parameters.highlight","typeLabel":"object"},"full_content":{"type":"object","description":"Controls whether to return the full raw content of each result page.","properties":{"enable":{"type":"boolean","default":false,"description":"If true, returns full_content for each result.","uniqueKey":"tools.items.[INDEX].oneOf.1.parameters.full_content.enable","typeLabel":"boolean"},"max_tokens":{"type":"integer","default":2048,"minimum":100,"maximum":100000,"description":"Maximum tokens of full content included per result.","uniqueKey":"tools.items.[INDEX].oneOf.1.parameters.full_content.max_tokens","typeLabel":"integer"}},"uniqueKey":"tools.items.[INDEX].oneOf.1.parameters.full_content","typeLabel":"object"},"format":{"type":"string","enum":["markdown","text"],"default":"text","description":"Controls the formatting of highlight outputs.","uniqueKey":"tools.items.[INDEX].oneOf.1.parameters.format","typeLabel":"enum\u003cstring>"},"safesearch":{"type":"string","enum":["off","strict"],"default":"strict","description":"Controls filtering of explicit/adult content. `off` disables filtering; `strict` drops all adult content.","uniqueKey":"tools.items.[INDEX].oneOf.1.parameters.safesearch","typeLabel":"enum\u003cstring>"},"include_images":{"type":"boolean","default":false,"description":"Whether to include images in each result.","uniqueKey":"tools.items.[INDEX].oneOf.1.parameters.include_images","typeLabel":"boolean"}},"uniqueKey":"tools.items.[INDEX].oneOf.1.parameters","typeLabel":"object"}},"uniqueKey":"tools.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"A tool definition. One of a custom `function` tool, the built-in `octen_broad_search` tool, the `octen_search` tool, or the `octen_multimodal_search` tool.\n\nWith `octen_search`, the model may also run a place search for local questions.\n\nDo not declare `octen_multimodal_search` together with `octen_search`: the web searches overlap and are billed separately.","required":["type"],"properties":{"type":{"type":"string","enum":["octen_search"],"description":"The type of tool. Always `octen_search`.","isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"parameters":{"type":"object","description":"Search behavior configuration. Optional.","properties":{"max_searches":{"type":"integer","default":5,"description":"Maximum number of searches allowed in a single request.","uniqueKey":"tools.items.[INDEX].oneOf.2.parameters.max_searches","typeLabel":"integer"},"result_type":{"type":"string","enum":["standard","dynamic"],"default":"standard","description":"Determines how results are returned. `standard` returns results as your parameters specify; `dynamic` returns only relevant results, up to `count`, and adjusts highlight length per result.","uniqueKey":"tools.items.[INDEX].oneOf.2.parameters.result_type","typeLabel":"enum\u003cstring>"},"count":{"type":"integer","default":5,"minimum":1,"maximum":100,"description":"Number of results to return. When `result_type` is `dynamic`, this is the maximum number of results.","uniqueKey":"tools.items.[INDEX].oneOf.2.parameters.count","typeLabel":"integer"},"include_domains":{"type":"array","items":{"type":"string","maxLength":60,"uniqueKey":"tools.items.[INDEX].oneOf.2.parameters.include_domains.items.[INDEX]","typeLabel":"string"},"maxItems":1200,"description":"A list of domains to specifically include in the search results. The `site:` query operator adds to this list.","example":["octen.ai","wikipedia.org"],"uniqueKey":"tools.items.[INDEX].oneOf.2.parameters.include_domains","typeLabel":"string[]"},"exclude_domains":{"type":"array","items":{"type":"string","maxLength":60,"uniqueKey":"tools.items.[INDEX].oneOf.2.parameters.exclude_domains.items.[INDEX]","typeLabel":"string"},"maxItems":1200,"description":"A list of domains to specifically exclude from the search results. The `-site:` query operator adds to this list. If a domain appears in both `include_domains` and `exclude_domains`, `exclude_domains` takes precedence.","example":["spam.com","ads.example.net"],"uniqueKey":"tools.items.[INDEX].oneOf.2.parameters.exclude_domains","typeLabel":"string[]"},"include_text":{"type":"array","items":{"type":"string","maxLength":30,"uniqueKey":"tools.items.[INDEX].oneOf.2.parameters.include_text.items.[INDEX]","typeLabel":"string"},"maxItems":5,"description":"Strings that must appear in the result page text.","uniqueKey":"tools.items.[INDEX].oneOf.2.parameters.include_text","typeLabel":"string[]"},"exclude_text":{"type":"array","items":{"type":"string","maxLength":30,"uniqueKey":"tools.items.[INDEX].oneOf.2.parameters.exclude_text.items.[INDEX]","typeLabel":"string"},"maxItems":5,"description":"Strings that must not appear in the result page text.","uniqueKey":"tools.items.[INDEX].oneOf.2.parameters.exclude_text","typeLabel":"string[]"},"time_basis":{"type":"string","enum":["auto","published","crawled"],"default":"auto","description":"Determines which time field is used for time filtering. `published` uses time_published; `crawled` uses time_last_crawled. Results missing this field are excluded when filtering by time.","uniqueKey":"tools.items.[INDEX].oneOf.2.parameters.time_basis","typeLabel":"enum\u003cstring>"},"time_range":{"type":"string","enum":["day","week","month","year","d","w","m","y"],"description":"Relative time window counting back from the current time based on `time_basis`. Mutually exclusive with `start_time`/`end_time` — if both are provided, `start_time`/`end_time` take precedence.","uniqueKey":"tools.items.[INDEX].oneOf.2.parameters.time_range","typeLabel":"enum\u003cstring>"},"start_time":{"type":"string","format":"date-time","description":"Start time for filtering results. ISO 8601 format.","example":"2025-01-01T00:00:00+08:00","uniqueKey":"tools.items.[INDEX].oneOf.2.parameters.start_time","typeLabel":"string\u003cdate-time>"},"end_time":{"type":"string","format":"date-time","description":"End time for filtering results. ISO 8601 format.","example":"2025-01-01T00:00:00+08:00","uniqueKey":"tools.items.[INDEX].oneOf.2.parameters.end_time","typeLabel":"string\u003cdate-time>"},"language":{"type":"array","items":{"type":"string","enum":["ar","de","en","es","fr","hi","id","it","ja","ko","nl","pl","pt","ru","th","tr","vi","zh"],"uniqueKey":"tools.items.[INDEX].oneOf.2.parameters.language.items.[INDEX]","typeLabel":"enum\u003cstring>"},"default":[],"description":"A list of languages to restrict results to, as ISO 639-1 codes. By default, no language filter is applied.","example":["en","zh"],"uniqueKey":"tools.items.[INDEX].oneOf.2.parameters.language","typeLabel":"enum\u003cstring>[]"},"highlight":{"type":"object","description":"Controls highlight extraction from result pages.","properties":{"enable":{"type":"boolean","default":true,"description":"If true, returns query-relevant highlight in each result.","uniqueKey":"tools.items.[INDEX].oneOf.2.parameters.highlight.enable","typeLabel":"boolean"},"max_tokens":{"type":"integer","default":512,"minimum":100,"maximum":20000,"description":"Max tokens returned per highlight. When `result_type` is `dynamic`, Octen may adjust this per result.","uniqueKey":"tools.items.[INDEX].oneOf.2.parameters.highlight.max_tokens","typeLabel":"integer"}},"uniqueKey":"tools.items.[INDEX].oneOf.2.parameters.highlight","typeLabel":"object"},"full_content":{"type":"object","description":"Controls whether to return the full raw content of each result page.","properties":{"enable":{"type":"boolean","default":false,"description":"If true, returns full_content for each result.","uniqueKey":"tools.items.[INDEX].oneOf.2.parameters.full_content.enable","typeLabel":"boolean"},"max_tokens":{"type":"integer","default":2048,"minimum":100,"maximum":100000,"description":"Maximum tokens of full content included per result.","uniqueKey":"tools.items.[INDEX].oneOf.2.parameters.full_content.max_tokens","typeLabel":"integer"}},"uniqueKey":"tools.items.[INDEX].oneOf.2.parameters.full_content","typeLabel":"object"},"format":{"type":"string","enum":["markdown","text"],"default":"text","description":"Controls the formatting of highlight outputs.","uniqueKey":"tools.items.[INDEX].oneOf.2.parameters.format","typeLabel":"enum\u003cstring>"},"safesearch":{"type":"string","enum":["off","strict"],"default":"strict","description":"Controls filtering of explicit/adult content. `off` disables filtering; `strict` drops all adult content.","uniqueKey":"tools.items.[INDEX].oneOf.2.parameters.safesearch","typeLabel":"enum\u003cstring>"},"include_images":{"type":"boolean","default":false,"description":"Whether to include images in each result.","uniqueKey":"tools.items.[INDEX].oneOf.2.parameters.include_images","typeLabel":"boolean"}},"uniqueKey":"tools.items.[INDEX].oneOf.2.parameters","typeLabel":"object"}},"uniqueKey":"tools.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"A tool definition. One of a custom `function` tool, the built-in `octen_broad_search` tool, the `octen_search` tool, or the `octen_multimodal_search` tool.\n\nWith `octen_search`, the model may also run a place search for local questions.\n\nDo not declare `octen_multimodal_search` together with `octen_search`: the web searches overlap and are billed separately.","required":["type"],"properties":{"type":{"type":"string","enum":["octen_multimodal_search"],"description":"The type of tool. Always `octen_multimodal_search`.","isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.3.type","typeLabel":"enum\u003cstring>"},"parameters":{"type":"object","description":"Search behavior configuration. Optional.","properties":{"max_tool_calls":{"type":"integer","minimum":1,"maximum":10,"default":5,"description":"Maximum number of tool calls allowed in a single request.","uniqueKey":"tools.items.[INDEX].oneOf.3.parameters.max_tool_calls","typeLabel":"integer"},"count":{"type":"integer","minimum":1,"maximum":10,"default":10,"description":"Number of results to return for each search type.","uniqueKey":"tools.items.[INDEX].oneOf.3.parameters.count","typeLabel":"integer"}},"uniqueKey":"tools.items.[INDEX].oneOf.3.parameters","typeLabel":"object"}},"uniqueKey":"tools.items.[INDEX].oneOf.3","typeLabel":"object"}],"uniqueKey":"tools.items.[INDEX]","typeLabel":"object"},"uniqueKey":"tools","typeLabel":"object[]"},"tool_choice":{"oneOf":[{"type":"string","description":"Controls tool invocation. `none`: never call tools; `auto`: model decides (default); `required`: must call a tool. Can also be an object to force a specific tool. Only valid when `tools` is set.","enum":["none","auto","required"],"uniqueKey":"tool_choice.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"object","description":"Controls tool invocation. `none`: never call tools; `auto`: model decides (default); `required`: must call a tool. Can also be an object to force a specific tool. Only valid when `tools` is set.","required":["type"],"properties":{"type":{"type":"string","enum":["function","octen_broad_search","octen_search","octen_multimodal_search"],"description":"The type of tool to force.","isRequired":true,"uniqueKey":"tool_choice.oneOf.1.type","typeLabel":"enum\u003cstring>"},"function":{"type":"object","description":"The function to call. Required when `type` is `function`.","required":["name"],"properties":{"name":{"type":"string","description":"The name of the function to call.","isRequired":true,"uniqueKey":"tool_choice.oneOf.1.function.name","typeLabel":"string"}},"uniqueKey":"tool_choice.oneOf.1.function","typeLabel":"object"}},"uniqueKey":"tool_choice.oneOf.1","typeLabel":"object"}],"uniqueKey":"tool_choice","typeLabel":"enum\u003cstring> | object"},"parallel_tool_calls":{"type":"boolean","default":true,"description":"Whether the model may issue multiple tool calls in one reply. When `false`, at most one tool call per turn.","uniqueKey":"parallel_tool_calls","typeLabel":"boolean"},"stream":{"type":"boolean","default":false,"description":"Whether to enable streaming output. When `true`, returns `chat.completion.chunk` objects incrementally.","uniqueKey":"stream","typeLabel":"boolean"},"max_tokens":{"type":"integer","minimum":1,"description":"Maximum number of tokens the model can output. If not set, the model's internal default limit is used.","uniqueKey":"max_tokens","typeLabel":"integer"},"max_completion_tokens":{"type":"integer","minimum":1,"description":"Maximum completion tokens, including reasoning and visible output tokens. If not set, the model's internal default limit is used.","uniqueKey":"max_completion_tokens","typeLabel":"integer"},"temperature":{"type":"number","minimum":0,"maximum":2,"default":1,"description":"Controls randomness in generation. Higher values produce more diverse output; lower values produce more deterministic output.","uniqueKey":"temperature","typeLabel":"number"},"top_p":{"type":"number","exclusiveMinimum":0,"maximum":1,"default":1,"description":"Nucleus sampling. Only tokens with cumulative probability up to `top_p` are considered.","uniqueKey":"top_p","typeLabel":"number"},"top_k":{"type":"integer","minimum":0,"default":0,"description":"Sample only from the top K most probable tokens. `0` disables it.","uniqueKey":"top_k","typeLabel":"integer"},"min_p":{"type":"number","minimum":0,"maximum":1,"default":0,"description":"Minimum probability threshold relative to the most probable token. Tokens below it are filtered out. `0` disables it.","uniqueKey":"min_p","typeLabel":"number"},"top_a":{"type":"number","minimum":0,"maximum":1,"default":0,"description":"Dynamic filtering threshold based on the most probable token. `0` disables it.","uniqueKey":"top_a","typeLabel":"number"},"repetition_penalty":{"type":"number","exclusiveMinimum":0,"maximum":2,"default":1,"description":"Penalizes tokens already present in the input. Above 1 suppresses repetition; below 1 encourages it.","uniqueKey":"repetition_penalty","typeLabel":"number"},"frequency_penalty":{"type":"number","minimum":-2,"maximum":2,"default":0,"description":"Penalizes tokens by their frequency in the output so far. Positive values reduce repetition.","uniqueKey":"frequency_penalty","typeLabel":"number"},"presence_penalty":{"type":"number","minimum":-2,"maximum":2,"default":0,"description":"Penalizes tokens that have already appeared. Positive values encourage new topics.","uniqueKey":"presence_penalty","typeLabel":"number"},"response_format":{"type":"object","description":"Controls the output format. Some models may not support structured output and will automatically fall back to `text`.","properties":{"type":{"type":"string","enum":["text","json_object","json_schema"],"default":"text","description":"The output format type.","uniqueKey":"response_format.type","typeLabel":"enum\u003cstring>"},"json_schema":{"type":"object","required":["name"],"description":"JSON Schema specification for structured output. Required when `response_format.type` is `json_schema`.","properties":{"name":{"type":"string","description":"A user-defined name for the schema.","isRequired":true,"uniqueKey":"response_format.json_schema.name","typeLabel":"string"},"strict":{"type":"boolean","default":true,"description":"Whether the model output must strictly conform to the schema.","uniqueKey":"response_format.json_schema.strict","typeLabel":"boolean"},"description":{"type":"string","description":"A description of the schema.","uniqueKey":"response_format.json_schema.description","typeLabel":"string"},"schema":{"type":"object","description":"The JSON Schema definition object. May contain `type`, `properties`, `required`, `additionalProperties`, etc.","uniqueKey":"response_format.json_schema.schema","typeLabel":"object"}},"uniqueKey":"response_format.json_schema","typeLabel":"object"}},"uniqueKey":"response_format","typeLabel":"object"},"stop":{"type":"array","items":{"type":"string","uniqueKey":"stop.items.[INDEX]","typeLabel":"string"},"description":"Stop sequences. Generation stops when any of these strings is encountered.","uniqueKey":"stop","typeLabel":"string[]"},"seed":{"type":"integer","description":"Seed for reproducibility. With the same parameters and model version, output should be as consistent as possible.","uniqueKey":"seed","typeLabel":"integer"},"reasoning":{"type":"object","description":"Options for reasoning models. Turns thinking on or off and sets the effort and budget.","properties":{"enabled":{"type":"boolean","description":"Set to `false` to turn off thinking. Overrides `effort` and `max_tokens`.","uniqueKey":"reasoning.enabled","typeLabel":"boolean"},"effort":{"type":"string","enum":["max","xhigh","high","medium","low","minimal","none"],"description":"The reasoning effort level.","uniqueKey":"reasoning.effort","typeLabel":"enum\u003cstring>"},"max_tokens":{"type":"integer","minimum":1024,"description":"Thinking token budget.","uniqueKey":"reasoning.max_tokens","typeLabel":"integer"}},"uniqueKey":"reasoning","typeLabel":"object"},"reasoning_effort":{"type":"string","enum":["none","minimal","low","medium","high","xhigh","max"],"description":"Top-level alias for `reasoning.effort`. If both are set, `reasoning` takes precedence.","uniqueKey":"reasoning_effort","typeLabel":"enum\u003cstring>"},"verbosity":{"type":"string","enum":["low","medium","high"],"default":"medium","description":"Controls how verbose the reply is.","uniqueKey":"verbosity","typeLabel":"enum\u003cstring>"},"logit_bias":{"type":"object","additionalProperties":{"type":"number","minimum":-100,"maximum":100,"uniqueKey":"logit_bias.additionalProperties","typeLabel":"number"},"description":"A JSON object mapping token IDs to bias values (-100 to 100), added to the logits before sampling.","uniqueKey":"logit_bias","typeLabel":"object"},"logprobs":{"type":"boolean","default":false,"description":"Whether to return the log probabilities of the output tokens.","uniqueKey":"logprobs","typeLabel":"boolean"},"top_logprobs":{"type":"integer","minimum":0,"maximum":20,"description":"Number of most likely tokens to return at each position. Requires `logprobs` to be `true`.","uniqueKey":"top_logprobs","typeLabel":"integer"},"user":{"type":"string","description":"A unique identifier for the end user. Use hashed or pseudonymous identifiers to avoid passing personally identifiable information.","uniqueKey":"user","typeLabel":"string"},"modalities":{"type":"array","items":{"type":"string","uniqueKey":"modalities.items.[INDEX]","typeLabel":"string"},"default":["text"],"description":"Requested output modalities.","uniqueKey":"modalities","typeLabel":"string[]"},"prompt_cache_key":{"type":"string","description":"Cache key for prompt caching.","uniqueKey":"prompt_cache_key","typeLabel":"string"},"prompt_cache_options":{"type":"object","description":"Prompt caching controls.","properties":{"mode":{"type":"string","enum":["implicit","explicit"],"description":"`implicit` caches automatically; `explicit` caches only prefixes marked with a cache breakpoint.","uniqueKey":"prompt_cache_options.mode","typeLabel":"enum\u003cstring>"},"ttl":{"type":"string","enum":["30m"],"description":"How long a cache entry is retained.","uniqueKey":"prompt_cache_options.ttl","typeLabel":"enum\u003cstring>"}},"uniqueKey":"prompt_cache_options","typeLabel":"object"},"prompt_cache_retention":{"type":"string","enum":["in_memory","24h"],"description":"Prompt cache retention policy.","uniqueKey":"prompt_cache_retention","typeLabel":"enum\u003cstring>"},"previous_response_id":{"type":"string","description":"The `id` of a previous response, used to chain state across turns.","uniqueKey":"previous_response_id","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"pureModel":{"title":"pureModel","summary":"Plain model call","value":{"model":"anthropic/claude-opus-5.5","messages":[{"role":"user","content":"Explain attention in one sentence."}],"stream":false,"max_tokens":2048,"temperature":1}},"withBroadSearch":{"title":"withBroadSearch","summary":"Built-in broad search tool","value":{"model":"anthropic/claude-sonnet-5.5","messages":[{"role":"system","content":"You are a helpful assistant."},{"role":"user","content":"Compare cloud GPU pricing across major providers."}],"tools":[{"type":"octen_broad_search","parameters":{"max_queries":5,"count":10,"highlight":{"enable":true,"max_tokens":300},"format":"markdown"}}],"tool_choice":"auto","stream":false}},"withSearch":{"title":"withSearch","summary":"Built-in search tool","value":{"model":"anthropic/claude-sonnet-5.5","messages":[{"role":"system","content":"You are a helpful assistant."},{"role":"user","content":"What's the weather in Beijing today?"}],"tools":[{"type":"octen_search","parameters":{"max_searches":3,"count":10,"highlight":{"enable":true,"max_tokens":300},"format":"markdown"}}],"tool_choice":"auto","stream":false}},"withMultimodalSearch":{"title":"withMultimodalSearch","summary":"Built-in multimodal search tool","value":{"model":"openai/gpt-6.1-terra","messages":[{"role":"user","content":"What does the Sagrada Familia look like today?"}],"tools":[{"type":"octen_multimodal_search","parameters":{"max_tool_calls":3}}]}},"functionAndSearch":{"title":"functionAndSearch","summary":"Custom function + built-in search","value":{"model":"openai/gpt-5.4","messages":[{"role":"user","content":"Check tomorrow's weather in Shanghai, then create a travel reminder."}],"tools":[{"type":"octen_search"},{"type":"function","function":{"name":"create_reminder","description":"Create a reminder","parameters":{"type":"object","properties":{"content":{"type":"string","description":"Reminder content"},"time":{"type":"string","description":"Reminder time, ISO 8601"}},"required":["content","time"]}}}],"tool_choice":"auto"}},"promptCaching":{"title":"promptCaching","summary":"Prompt caching","value":{"model":"anthropic/claude-sonnet-5.5","messages":[{"role":"system","content":[{"type":"text","text":"Product manual (long stable prefix)...","cache_control":{"type":"ephemeral","ttl":"5m"}}]},{"role":"user","content":"What is the return policy?"}],"max_tokens":1024}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"b94453f9-c478-4e04-86c2-b35a416703ef":{"description":"Successful chat completion. When `stream=false`, returns a single `chat.completion` object. When `stream=true`, returns a stream of `chat.completion.chunk` objects (`search_done`, `content`, `finish`, `usage`), followed by `data: [DONE]`.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Non-streaming","description":"A non-streaming chat completion response. Returned when `stream=false`.","required":["id","object","created","model","choices"],"properties":{"id":{"type":"string","description":"The unique identifier for this request.","isRequired":true,"uniqueKey":"oneOf.0.id","typeLabel":"string"},"object":{"type":"string","enum":["chat.completion"],"description":"The object type, always `chat.completion` for non-streaming responses.","isRequired":true,"uniqueKey":"oneOf.0.object","typeLabel":"enum\u003cstring>"},"created":{"type":"integer","description":"Unix timestamp (in seconds) of when the completion was created.","isRequired":true,"uniqueKey":"oneOf.0.created","typeLabel":"integer"},"model":{"type":"string","description":"The model used for this completion.","isRequired":true,"uniqueKey":"oneOf.0.model","typeLabel":"string"},"choices":{"type":"array","items":{"type":"object","description":"A single completion choice in a non-streaming response.","properties":{"index":{"type":"integer","description":"The index of this choice. Usually 0.","uniqueKey":"oneOf.0.choices.items.[INDEX].index","typeLabel":"integer"},"finish_reason":{"type":"string","enum":["stop","length","tool_calls","content_filter","error"],"description":"The reason the model stopped generating. `stop` indicates normal completion.","uniqueKey":"oneOf.0.choices.items.[INDEX].finish_reason","typeLabel":"enum\u003cstring>"},"message":{"type":"object","description":"The assistant's response message.","properties":{"role":{"type":"string","enum":["assistant"],"description":"The role of the message author. Always `assistant`.","uniqueKey":"oneOf.0.choices.items.[INDEX].message.role","typeLabel":"enum\u003cstring>"},"content":{"oneOf":[{"type":"string","description":"The assistant's text content. May be `null` when the model only produces tool calls or refuses.","uniqueKey":"oneOf.0.choices.items.[INDEX].message.content.oneOf.0","typeLabel":"string"},{"type":"null","description":"The assistant's text content. May be `null` when the model only produces tool calls or refuses.","uniqueKey":"oneOf.0.choices.items.[INDEX].message.content.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.choices.items.[INDEX].message.content","typeLabel":"string | null"},"tool_calls":{"type":"array","items":{"type":"object","required":["id","type","function"],"description":"A custom function call generated by the model.","properties":{"id":{"type":"string","description":"A unique identifier for this tool call. Referenced by the corresponding `tool` message's `tool_call_id`.","isRequired":true,"uniqueKey":"oneOf.0.choices.items.[INDEX].message.tool_calls.items.[INDEX].id","typeLabel":"string"},"type":{"type":"string","enum":["function"],"description":"The type of tool call. Always `function`.","isRequired":true,"uniqueKey":"oneOf.0.choices.items.[INDEX].message.tool_calls.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"function":{"type":"object","required":["name","arguments"],"description":"The function invocation details within a tool call.","properties":{"name":{"type":"string","description":"The name of the function to call.","isRequired":true,"uniqueKey":"oneOf.0.choices.items.[INDEX].message.tool_calls.items.[INDEX].function.name","typeLabel":"string"},"arguments":{"type":"string","description":"The arguments to the function, as a JSON string generated by the model.","isRequired":true,"uniqueKey":"oneOf.0.choices.items.[INDEX].message.tool_calls.items.[INDEX].function.arguments","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.0.choices.items.[INDEX].message.tool_calls.items.[INDEX].function","typeLabel":"object"},"index":{"type":"integer","description":"The index of this tool call in the array.","uniqueKey":"oneOf.0.choices.items.[INDEX].message.tool_calls.items.[INDEX].index","typeLabel":"integer"},"thought_signature":{"type":"string","description":"Encrypted reasoning state, replayed verbatim. Required when the request ends with a `tool` message.","uniqueKey":"oneOf.0.choices.items.[INDEX].message.tool_calls.items.[INDEX].thought_signature","typeLabel":"string"}},"uniqueKey":"oneOf.0.choices.items.[INDEX].message.tool_calls.items.[INDEX]","typeLabel":"object"},"description":"Custom function calls generated by the model. Present only when `finish_reason` is `tool_calls`.","uniqueKey":"oneOf.0.choices.items.[INDEX].message.tool_calls","typeLabel":"object[]"},"annotations":{"type":"array","items":{"type":"object","description":"A citation annotation. Returned only when `octen_search` was used, currently only for `anthropic/` models. For other models, results are still available in `search_results`.","properties":{"type":{"type":"string","enum":["url_citation"],"description":"The annotation type.","uniqueKey":"oneOf.0.choices.items.[INDEX].message.annotations.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"url_citation":{"type":"object","properties":{"url":{"type":"string","description":"The URL of the cited source.","uniqueKey":"oneOf.0.choices.items.[INDEX].message.annotations.items.[INDEX].url_citation.url","typeLabel":"string"},"title":{"type":"string","description":"The title of the cited source.","uniqueKey":"oneOf.0.choices.items.[INDEX].message.annotations.items.[INDEX].url_citation.title","typeLabel":"string"},"start_index":{"type":"integer","description":"Start position of the cited span in `content`.","uniqueKey":"oneOf.0.choices.items.[INDEX].message.annotations.items.[INDEX].url_citation.start_index","typeLabel":"integer"},"end_index":{"type":"integer","description":"End position of the cited span in `content`.","uniqueKey":"oneOf.0.choices.items.[INDEX].message.annotations.items.[INDEX].url_citation.end_index","typeLabel":"integer"}},"uniqueKey":"oneOf.0.choices.items.[INDEX].message.annotations.items.[INDEX].url_citation","typeLabel":"object"}},"uniqueKey":"oneOf.0.choices.items.[INDEX].message.annotations.items.[INDEX]","typeLabel":"object"},"description":"Citation annotations. Present only when `octen_broad_search` or `octen_search` was used.","uniqueKey":"oneOf.0.choices.items.[INDEX].message.annotations","typeLabel":"object[]"},"refusal":{"oneOf":[{"type":"string","description":"A model-generated refusal message, or `null`.","uniqueKey":"oneOf.0.choices.items.[INDEX].message.refusal.oneOf.0","typeLabel":"string"},{"type":"null","description":"A model-generated refusal message, or `null`.","uniqueKey":"oneOf.0.choices.items.[INDEX].message.refusal.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.choices.items.[INDEX].message.refusal","typeLabel":"string | null"},"reasoning":{"oneOf":[{"type":"string","description":"Reasoning text. Present only for reasoning models, otherwise `null`.","uniqueKey":"oneOf.0.choices.items.[INDEX].message.reasoning.oneOf.0","typeLabel":"string"},{"type":"null","description":"Reasoning text. Present only for reasoning models, otherwise `null`.","uniqueKey":"oneOf.0.choices.items.[INDEX].message.reasoning.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.choices.items.[INDEX].message.reasoning","typeLabel":"string | null"},"reasoning_details":{"type":"array","items":{"type":"object","description":"Detailed reasoning information. Returned only for reasoning models.","properties":{"format":{"type":"string","enum":["unknown","openai-responses-v1","azure-openai-responses-v1","xai-responses-v1","anthropic-claude-v1","google-gemini-v1"],"description":"The format of the reasoning information.","uniqueKey":"oneOf.0.choices.items.[INDEX].message.reasoning_details.items.[INDEX].format","typeLabel":"enum\u003cstring>"},"index":{"type":"integer","description":"The position of this entry in the output. Usually 0.","uniqueKey":"oneOf.0.choices.items.[INDEX].message.reasoning_details.items.[INDEX].index","typeLabel":"integer"},"type":{"type":"string","enum":["reasoning.text","reasoning.summary","reasoning.encrypted"],"description":"The kind of reasoning information.","uniqueKey":"oneOf.0.choices.items.[INDEX].message.reasoning_details.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","description":"Reasoning text. Present only when `type` is `reasoning.text`.","uniqueKey":"oneOf.0.choices.items.[INDEX].message.reasoning_details.items.[INDEX].text","typeLabel":"string"},"summary":{"type":"string","description":"Reasoning summary. Present only when `type` is `reasoning.summary`.","uniqueKey":"oneOf.0.choices.items.[INDEX].message.reasoning_details.items.[INDEX].summary","typeLabel":"string"},"data":{"type":"string","description":"Encrypted reasoning. Present only when `type` is `reasoning.encrypted`.","uniqueKey":"oneOf.0.choices.items.[INDEX].message.reasoning_details.items.[INDEX].data","typeLabel":"string"}},"uniqueKey":"oneOf.0.choices.items.[INDEX].message.reasoning_details.items.[INDEX]","typeLabel":"object"},"description":"Detailed reasoning information. Present only for reasoning models.","uniqueKey":"oneOf.0.choices.items.[INDEX].message.reasoning_details","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.choices.items.[INDEX].message","typeLabel":"object"},"logprobs":{"oneOf":[{"type":"object","description":"Log probability information for the output tokens. Present only when `logprobs` is `true`, otherwise `null`.","properties":{"content":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"token":{"type":"string","description":"The token text.","uniqueKey":"oneOf.0.choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].token","typeLabel":"string"},"logprob":{"type":"number","description":"The log probability of this token.","uniqueKey":"oneOf.0.choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].logprob","typeLabel":"number"},"bytes":{"oneOf":[{"type":"array","items":{"type":"integer","uniqueKey":"oneOf.0.choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].bytes.oneOf.0.items.[INDEX]","typeLabel":"integer"},"description":"UTF-8 byte representation.","uniqueKey":"oneOf.0.choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].bytes.oneOf.0","typeLabel":"integer[]"},{"type":"null","items":{"type":"integer"},"description":"UTF-8 byte representation.","uniqueKey":"oneOf.0.choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].bytes.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].bytes","typeLabel":"integer[] | null"},"top_logprobs":{"type":"array","description":"The top candidate tokens at this position, same structure.","items":{"type":"object","uniqueKey":"oneOf.0.choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].top_logprobs.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].top_logprobs","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.0.choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"token":{"type":"string","description":"The token text."},"logprob":{"type":"number","description":"The log probability of this token."},"bytes":{"oneOf":[{"type":"array","items":{"type":"integer"},"description":"UTF-8 byte representation."},{"type":"null","items":{"type":"integer"},"description":"UTF-8 byte representation."}]},"top_logprobs":{"type":"array","description":"The top candidate tokens at this position, same structure.","items":{"type":"object"}}}},"uniqueKey":"oneOf.0.choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.choices.items.[INDEX].logprobs.oneOf.0.content","typeLabel":"object[] | null"}},"uniqueKey":"oneOf.0.choices.items.[INDEX].logprobs.oneOf.0","typeLabel":"object"},{"type":"null","description":"Log probability information for the output tokens. Present only when `logprobs` is `true`, otherwise `null`.","properties":{"content":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"token":{"type":"string","description":"The token text."},"logprob":{"type":"number","description":"The log probability of this token."},"bytes":{"oneOf":[{"type":"array","items":{"type":"integer"},"description":"UTF-8 byte representation."},{"type":"null","items":{"type":"integer"},"description":"UTF-8 byte representation."}]},"top_logprobs":{"type":"array","description":"The top candidate tokens at this position, same structure.","items":{"type":"object"}}}}},{"type":"null","items":{"type":"object","properties":{"token":{"type":"string","description":"The token text."},"logprob":{"type":"number","description":"The log probability of this token."},"bytes":{"oneOf":[{"type":"array","items":{"type":"integer"},"description":"UTF-8 byte representation."},{"type":"null","items":{"type":"integer"},"description":"UTF-8 byte representation."}]},"top_logprobs":{"type":"array","description":"The top candidate tokens at this position, same structure.","items":{"type":"object"}}}}}]}},"uniqueKey":"oneOf.0.choices.items.[INDEX].logprobs.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.choices.items.[INDEX].logprobs","typeLabel":"object | null"}},"uniqueKey":"oneOf.0.choices.items.[INDEX]","typeLabel":"object"},"description":"A list of completion choices.","isRequired":true,"uniqueKey":"oneOf.0.choices","typeLabel":"object[]"},"search_results":{"type":"array","items":{"type":"object","description":"Search results for a single auto-generated query. One element per search.","properties":{"query":{"type":"string","description":"The query the model actually searched for. One message may produce multiple queries.","uniqueKey":"oneOf.0.search_results.items.[INDEX].query","typeLabel":"string"},"results":{"type":"array","items":{"oneOf":[{"type":"object","description":"A single search result.","properties":{"type":{"type":"string","enum":["web"],"description":"The result type. Returned only for `octen_search` results.","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"title":{"type":"string","description":"The title of the result page.","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.0.title","typeLabel":"string"},"url":{"type":"string","description":"The URL of the result page.","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.0.url","typeLabel":"string"},"highlights":{"type":"string","description":"Query-relevant highlight snippets. Returned only if `highlight.enable` is true.","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.0.highlights","typeLabel":"string"},"full_content":{"type":"string","description":"Full raw page content. Returned only if `full_content.enable` is true.","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.0.full_content","typeLabel":"string"},"authors":{"type":"string","description":"Website name or author.","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.0.authors","typeLabel":"string"},"time_published":{"type":"string","format":"date-time","description":"Publish time in ISO 8601.","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.0.time_published","typeLabel":"string\u003cdate-time>"},"time_last_crawled":{"type":"string","format":"date-time","description":"Last crawl time in ISO 8601.","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.0.time_last_crawled","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"A single search result from `octen_multimodal_search`.","properties":{"type":{"type":"string","enum":["web","image","video"],"description":"The result type.","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"num":{"type":"integer","description":"The result number.","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.1.num","typeLabel":"integer"},"title":{"type":"string","description":"The title of the result.","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.1.title","typeLabel":"string"},"url":{"type":"string","description":"The page or media URL.","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.1.url","typeLabel":"string"},"highlights":{"type":"string","description":"Query-relevant highlight snippets. Present for web results.","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.1.highlights","typeLabel":"string"},"authors":{"type":"string","description":"Website name or author.","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.1.authors","typeLabel":"string"},"time_published":{"type":"string","format":"date-time","description":"Publish time in ISO 8601.","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.1.time_published","typeLabel":"string\u003cdate-time>"},"cover_url":{"type":"string","description":"Thumbnail URL.","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.1.cover_url","typeLabel":"string"},"source_page":{"type":"string","description":"URL of the original page hosting the media.","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.1.source_page","typeLabel":"string"},"duration_seconds":{"type":"integer","description":"Video duration in seconds.","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.1.duration_seconds","typeLabel":"integer"}},"uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"A single place card from `octen_search`. Fields that cannot be resolved are omitted.","properties":{"type":{"type":"string","enum":["place"],"description":"The result type.","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"title":{"type":"string","description":"The name of the place.","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.2.title","typeLabel":"string"},"url":{"type":"string","description":"The official website. Empty when unknown.","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.2.url","typeLabel":"string"},"category":{"type":"string","description":"The category of the place.","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.2.category","typeLabel":"string"},"address":{"type":"string","description":"The full address.","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.2.address","typeLabel":"string"},"latitude":{"type":"number","description":"Latitude of the place, WGS84.","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.2.latitude","typeLabel":"number"},"longitude":{"type":"number","description":"Longitude of the place, WGS84.","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.2.longitude","typeLabel":"number"},"phone":{"type":"string","description":"Phone number in international format.","example":"+1 000-000-0000","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.2.phone","typeLabel":"string"},"opening_hours":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.2.opening_hours.items.[INDEX]","typeLabel":"string"},"description":"Opening hours in the local time of the place.","example":["Open · Closes 10 PM"],"uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.2.opening_hours","typeLabel":"string[]"},"status":{"type":"string","enum":["open","closed","temporarily_closed","permanently_closed"],"description":"Opening state at the time of the request, in the local time of the place.","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.2.status","typeLabel":"enum\u003cstring>"},"rating":{"type":"number","description":"User rating, out of 5.","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.2.rating","typeLabel":"number"},"review_count":{"type":"integer","description":"Number of reviews.","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.2.review_count","typeLabel":"integer"},"attributes":{"type":"object","description":"Amenities and services, as key-value pairs with boolean values.","uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.2.attributes","typeLabel":"object"}},"uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX].oneOf.2","typeLabel":"object"}],"uniqueKey":"oneOf.0.search_results.items.[INDEX].results.items.[INDEX]","typeLabel":"object"},"description":"The search results for this query.","uniqueKey":"oneOf.0.search_results.items.[INDEX].results","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.search_results.items.[INDEX]","typeLabel":"object"},"description":"Search results. Present only when `octen_search`, `octen_broad_search`, or `octen_multimodal_search` was actually triggered.","uniqueKey":"oneOf.0.search_results","typeLabel":"object[]"},"usage":{"type":"object","required":["prompt_tokens","completion_tokens","total_tokens"],"description":"Token usage information. When `stream=true`, returned only in the final `usage` chunk.","properties":{"prompt_tokens":{"type":"integer","description":"Number of input tokens. Cache read and write tokens are included here, not listed separately.","isRequired":true,"uniqueKey":"oneOf.0.usage.prompt_tokens","typeLabel":"integer"},"completion_tokens":{"type":"integer","description":"Number of output tokens (reasoning tokens are included).","isRequired":true,"uniqueKey":"oneOf.0.usage.completion_tokens","typeLabel":"integer"},"total_tokens":{"type":"integer","description":"Total tokens (prompt_tokens + completion_tokens).","isRequired":true,"uniqueKey":"oneOf.0.usage.total_tokens","typeLabel":"integer"},"num_search_queries":{"type":"integer","description":"Number of searches executed. Returned only when search was used.","uniqueKey":"oneOf.0.usage.num_search_queries","typeLabel":"integer"},"num_web_search_queries":{"type":"integer","description":"Number of web search queries executed. Returned only when web search was used.","uniqueKey":"oneOf.0.usage.num_web_search_queries","typeLabel":"integer"},"num_image_search_queries":{"type":"integer","description":"Number of image search queries executed. Returned only when `octen_multimodal_search` ran an image search.","uniqueKey":"oneOf.0.usage.num_image_search_queries","typeLabel":"integer"},"num_video_search_queries":{"type":"integer","description":"Number of video search queries executed. Returned only when `octen_multimodal_search` ran a video search.","uniqueKey":"oneOf.0.usage.num_video_search_queries","typeLabel":"integer"},"num_place_search_queries":{"type":"integer","description":"Number of billed place search queries. Returned only when `octen_search` returned place cards.","uniqueKey":"oneOf.0.usage.num_place_search_queries","typeLabel":"integer"},"full_content_extra_count":{"type":"integer","description":"Billable full_content results beyond the free allowance. Returned only when `full_content` is enabled.","uniqueKey":"oneOf.0.usage.full_content_extra_count","typeLabel":"integer"},"prompt_tokens_details":{"type":"object","description":"Breakdown of input tokens. Returned only when the prompt cache is hit or written to.","properties":{"cached_tokens":{"type":"integer","description":"Portion of `prompt_tokens` served from cache (a subset of `prompt_tokens`).","uniqueKey":"oneOf.0.usage.prompt_tokens_details.cached_tokens","typeLabel":"integer"},"cache_write_tokens":{"type":"integer","description":"Tokens written to cache (a subset of `prompt_tokens`). Returned only when `cache_control` was used and the model supports cache writes.","uniqueKey":"oneOf.0.usage.prompt_tokens_details.cache_write_tokens","typeLabel":"integer"},"cache_write_5m_tokens":{"type":"integer","description":"Tokens written to the 5-minute cache (a subset of `cache_write_tokens`). Only the field matching the TTL used is returned.","uniqueKey":"oneOf.0.usage.prompt_tokens_details.cache_write_5m_tokens","typeLabel":"integer"},"cache_write_1h_tokens":{"type":"integer","description":"Tokens written to the 1-hour cache (a subset of `cache_write_tokens`). Only the field matching the TTL used is returned.","uniqueKey":"oneOf.0.usage.prompt_tokens_details.cache_write_1h_tokens","typeLabel":"integer"}},"uniqueKey":"oneOf.0.usage.prompt_tokens_details","typeLabel":"object"},"completion_tokens_details":{"type":"object","description":"Breakdown of output tokens. Returned only for reasoning models.","properties":{"reasoning_tokens":{"type":"integer","description":"Number of reasoning tokens (already included in `completion_tokens`).","uniqueKey":"oneOf.0.usage.completion_tokens_details.reasoning_tokens","typeLabel":"integer"}},"uniqueKey":"oneOf.0.usage.completion_tokens_details","typeLabel":"object"}},"uniqueKey":"oneOf.0.usage","typeLabel":"object"},"warning":{"type":"string","description":"Warning message, if any.","uniqueKey":"oneOf.0.warning","typeLabel":"string"}},"uniqueKey":"oneOf.0","typeLabel":"Non-streaming · object"},{"type":"object","title":"Streaming","description":"A streaming chunk. Returned when `stream=true`. The `type` field indicates the chunk kind: `search_done`, `content`, `finish`, `usage`. After the last chunk, `data: [DONE]` is sent.","required":["object","created","model"],"properties":{"object":{"type":"string","enum":["chat.completion.chunk"],"description":"The object type, always `chat.completion.chunk` for streaming responses.","isRequired":true,"uniqueKey":"oneOf.1.object","typeLabel":"enum\u003cstring>"},"created":{"type":"integer","description":"Unix timestamp (in seconds) of when the chunk was created.","isRequired":true,"uniqueKey":"oneOf.1.created","typeLabel":"integer"},"model":{"type":"string","description":"The model used for this completion.","isRequired":true,"uniqueKey":"oneOf.1.model","typeLabel":"string"},"type":{"type":"string","enum":["search_done","content","finish","usage"],"description":"The type of this streaming chunk.","uniqueKey":"oneOf.1.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","description":"The unique identifier for this request.","uniqueKey":"oneOf.1.id","typeLabel":"string"},"choices":{"type":"array","items":{"type":"object","description":"A single choice in a streaming chunk.","properties":{"index":{"type":"integer","description":"The index of this choice. Usually 0.","uniqueKey":"oneOf.1.choices.items.[INDEX].index","typeLabel":"integer"},"delta":{"type":"object","description":"Incremental content in a streaming chunk. Contains only the new fields for this chunk.","properties":{"role":{"type":"string","enum":["assistant"],"description":"The role. Typically included in the first chunk.","uniqueKey":"oneOf.1.choices.items.[INDEX].delta.role","typeLabel":"enum\u003cstring>"},"content":{"type":"string","description":"Incremental text content.","uniqueKey":"oneOf.1.choices.items.[INDEX].delta.content","typeLabel":"string"},"tool_calls":{"type":"array","items":{"type":"object","description":"Incremental tool call data in a streaming chunk. The first chunk for a tool call includes `id`, `type`, and `function.name`. Subsequent chunks append to `function.arguments`.","properties":{"index":{"type":"number","description":"The index of this tool call in the tool_calls array.","uniqueKey":"oneOf.1.choices.items.[INDEX].delta.tool_calls.items.[INDEX].index","typeLabel":"number"},"id":{"type":"string","description":"The tool call ID. Only present in the first chunk for this tool call.","uniqueKey":"oneOf.1.choices.items.[INDEX].delta.tool_calls.items.[INDEX].id","typeLabel":"string"},"type":{"type":"string","enum":["function"],"description":"The type of tool call.","uniqueKey":"oneOf.1.choices.items.[INDEX].delta.tool_calls.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"function":{"type":"object","description":"Incremental function call data.","properties":{"name":{"type":"string","description":"The function name. Only present in the first chunk for this tool call.","uniqueKey":"oneOf.1.choices.items.[INDEX].delta.tool_calls.items.[INDEX].function.name","typeLabel":"string"},"arguments":{"type":"string","description":"Incremental JSON string of the function arguments. Concatenate across chunks to build the complete arguments.","uniqueKey":"oneOf.1.choices.items.[INDEX].delta.tool_calls.items.[INDEX].function.arguments","typeLabel":"string"}},"uniqueKey":"oneOf.1.choices.items.[INDEX].delta.tool_calls.items.[INDEX].function","typeLabel":"object"},"thought_signature":{"type":"string","description":"Encrypted reasoning state, replayed verbatim.","uniqueKey":"oneOf.1.choices.items.[INDEX].delta.tool_calls.items.[INDEX].thought_signature","typeLabel":"string"}},"uniqueKey":"oneOf.1.choices.items.[INDEX].delta.tool_calls.items.[INDEX]","typeLabel":"object"},"description":"Incremental tool call data.","uniqueKey":"oneOf.1.choices.items.[INDEX].delta.tool_calls","typeLabel":"object[]"}},"uniqueKey":"oneOf.1.choices.items.[INDEX].delta","typeLabel":"object"},"finish_reason":{"oneOf":[{"type":"string","enum":["stop","length","tool_calls","content_filter","error",null],"description":"The reason generation stopped. `null` for intermediate chunks; set in the `finish` chunk.","uniqueKey":"oneOf.1.choices.items.[INDEX].finish_reason.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["stop","length","tool_calls","content_filter","error",null],"description":"The reason generation stopped. `null` for intermediate chunks; set in the `finish` chunk.","uniqueKey":"oneOf.1.choices.items.[INDEX].finish_reason.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.choices.items.[INDEX].finish_reason","typeLabel":"enum\u003cstring> | null"},"logprobs":{"oneOf":[{"type":"object","description":"Log probability information for the output tokens. Present only when `logprobs` is `true`, otherwise `null`.","properties":{"content":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"token":{"type":"string","description":"The token text.","uniqueKey":"oneOf.1.choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].token","typeLabel":"string"},"logprob":{"type":"number","description":"The log probability of this token.","uniqueKey":"oneOf.1.choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].logprob","typeLabel":"number"},"bytes":{"oneOf":[{"type":"array","items":{"type":"integer","uniqueKey":"oneOf.1.choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].bytes.oneOf.0.items.[INDEX]","typeLabel":"integer"},"description":"UTF-8 byte representation.","uniqueKey":"oneOf.1.choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].bytes.oneOf.0","typeLabel":"integer[]"},{"type":"null","items":{"type":"integer"},"description":"UTF-8 byte representation.","uniqueKey":"oneOf.1.choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].bytes.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].bytes","typeLabel":"integer[] | null"},"top_logprobs":{"type":"array","description":"The top candidate tokens at this position, same structure.","items":{"type":"object","uniqueKey":"oneOf.1.choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].top_logprobs.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX].top_logprobs","typeLabel":"object[]"}},"uniqueKey":"oneOf.1.choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0.items.[INDEX]","typeLabel":"object"},"uniqueKey":"oneOf.1.choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"type":"object","properties":{"token":{"type":"string","description":"The token text."},"logprob":{"type":"number","description":"The log probability of this token."},"bytes":{"oneOf":[{"type":"array","items":{"type":"integer"},"description":"UTF-8 byte representation."},{"type":"null","items":{"type":"integer"},"description":"UTF-8 byte representation."}]},"top_logprobs":{"type":"array","description":"The top candidate tokens at this position, same structure.","items":{"type":"object"}}}},"uniqueKey":"oneOf.1.choices.items.[INDEX].logprobs.oneOf.0.content.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.choices.items.[INDEX].logprobs.oneOf.0.content","typeLabel":"object[] | null"}},"uniqueKey":"oneOf.1.choices.items.[INDEX].logprobs.oneOf.0","typeLabel":"object"},{"type":"null","description":"Log probability information for the output tokens. Present only when `logprobs` is `true`, otherwise `null`.","properties":{"content":{"oneOf":[{"type":"array","items":{"type":"object","properties":{"token":{"type":"string","description":"The token text."},"logprob":{"type":"number","description":"The log probability of this token."},"bytes":{"oneOf":[{"type":"array","items":{"type":"integer"},"description":"UTF-8 byte representation."},{"type":"null","items":{"type":"integer"},"description":"UTF-8 byte representation."}]},"top_logprobs":{"type":"array","description":"The top candidate tokens at this position, same structure.","items":{"type":"object"}}}}},{"type":"null","items":{"type":"object","properties":{"token":{"type":"string","description":"The token text."},"logprob":{"type":"number","description":"The log probability of this token."},"bytes":{"oneOf":[{"type":"array","items":{"type":"integer"},"description":"UTF-8 byte representation."},{"type":"null","items":{"type":"integer"},"description":"UTF-8 byte representation."}]},"top_logprobs":{"type":"array","description":"The top candidate tokens at this position, same structure.","items":{"type":"object"}}}}}]}},"uniqueKey":"oneOf.1.choices.items.[INDEX].logprobs.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.choices.items.[INDEX].logprobs","typeLabel":"object | null"}},"uniqueKey":"oneOf.1.choices.items.[INDEX]","typeLabel":"object"},"description":"Incremental choices. Present in `content` and `finish` chunks.","uniqueKey":"oneOf.1.choices","typeLabel":"object[]"},"search_results":{"type":"array","items":{"type":"object","description":"Search results for a single auto-generated query. One element per search.","properties":{"query":{"type":"string","description":"The query the model actually searched for. One message may produce multiple queries.","uniqueKey":"oneOf.1.search_results.items.[INDEX].query","typeLabel":"string"},"results":{"type":"array","items":{"oneOf":[{"type":"object","description":"A single search result.","properties":{"type":{"type":"string","enum":["web"],"description":"The result type. Returned only for `octen_search` results.","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"title":{"type":"string","description":"The title of the result page.","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.0.title","typeLabel":"string"},"url":{"type":"string","description":"The URL of the result page.","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.0.url","typeLabel":"string"},"highlights":{"type":"string","description":"Query-relevant highlight snippets. Returned only if `highlight.enable` is true.","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.0.highlights","typeLabel":"string"},"full_content":{"type":"string","description":"Full raw page content. Returned only if `full_content.enable` is true.","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.0.full_content","typeLabel":"string"},"authors":{"type":"string","description":"Website name or author.","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.0.authors","typeLabel":"string"},"time_published":{"type":"string","format":"date-time","description":"Publish time in ISO 8601.","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.0.time_published","typeLabel":"string\u003cdate-time>"},"time_last_crawled":{"type":"string","format":"date-time","description":"Last crawl time in ISO 8601.","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.0.time_last_crawled","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"A single search result from `octen_multimodal_search`.","properties":{"type":{"type":"string","enum":["web","image","video"],"description":"The result type.","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"num":{"type":"integer","description":"The result number.","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.1.num","typeLabel":"integer"},"title":{"type":"string","description":"The title of the result.","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.1.title","typeLabel":"string"},"url":{"type":"string","description":"The page or media URL.","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.1.url","typeLabel":"string"},"highlights":{"type":"string","description":"Query-relevant highlight snippets. Present for web results.","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.1.highlights","typeLabel":"string"},"authors":{"type":"string","description":"Website name or author.","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.1.authors","typeLabel":"string"},"time_published":{"type":"string","format":"date-time","description":"Publish time in ISO 8601.","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.1.time_published","typeLabel":"string\u003cdate-time>"},"cover_url":{"type":"string","description":"Thumbnail URL.","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.1.cover_url","typeLabel":"string"},"source_page":{"type":"string","description":"URL of the original page hosting the media.","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.1.source_page","typeLabel":"string"},"duration_seconds":{"type":"integer","description":"Video duration in seconds.","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.1.duration_seconds","typeLabel":"integer"}},"uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"A single place card from `octen_search`. Fields that cannot be resolved are omitted.","properties":{"type":{"type":"string","enum":["place"],"description":"The result type.","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"title":{"type":"string","description":"The name of the place.","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.2.title","typeLabel":"string"},"url":{"type":"string","description":"The official website. Empty when unknown.","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.2.url","typeLabel":"string"},"category":{"type":"string","description":"The category of the place.","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.2.category","typeLabel":"string"},"address":{"type":"string","description":"The full address.","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.2.address","typeLabel":"string"},"latitude":{"type":"number","description":"Latitude of the place, WGS84.","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.2.latitude","typeLabel":"number"},"longitude":{"type":"number","description":"Longitude of the place, WGS84.","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.2.longitude","typeLabel":"number"},"phone":{"type":"string","description":"Phone number in international format.","example":"+1 000-000-0000","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.2.phone","typeLabel":"string"},"opening_hours":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.2.opening_hours.items.[INDEX]","typeLabel":"string"},"description":"Opening hours in the local time of the place.","example":["Open · Closes 10 PM"],"uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.2.opening_hours","typeLabel":"string[]"},"status":{"type":"string","enum":["open","closed","temporarily_closed","permanently_closed"],"description":"Opening state at the time of the request, in the local time of the place.","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.2.status","typeLabel":"enum\u003cstring>"},"rating":{"type":"number","description":"User rating, out of 5.","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.2.rating","typeLabel":"number"},"review_count":{"type":"integer","description":"Number of reviews.","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.2.review_count","typeLabel":"integer"},"attributes":{"type":"object","description":"Amenities and services, as key-value pairs with boolean values.","uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.2.attributes","typeLabel":"object"}},"uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX].oneOf.2","typeLabel":"object"}],"uniqueKey":"oneOf.1.search_results.items.[INDEX].results.items.[INDEX]","typeLabel":"object"},"description":"The search results for this query.","uniqueKey":"oneOf.1.search_results.items.[INDEX].results","typeLabel":"object[]"}},"uniqueKey":"oneOf.1.search_results.items.[INDEX]","typeLabel":"object"},"description":"Search results. Present in `search_done` chunks.","uniqueKey":"oneOf.1.search_results","typeLabel":"object[]"},"usage":{"type":"object","required":["prompt_tokens","completion_tokens","total_tokens"],"description":"Token usage information. When `stream=true`, returned only in the final `usage` chunk.","properties":{"prompt_tokens":{"type":"integer","description":"Number of input tokens. Cache read and write tokens are included here, not listed separately.","isRequired":true,"uniqueKey":"oneOf.1.usage.prompt_tokens","typeLabel":"integer"},"completion_tokens":{"type":"integer","description":"Number of output tokens (reasoning tokens are included).","isRequired":true,"uniqueKey":"oneOf.1.usage.completion_tokens","typeLabel":"integer"},"total_tokens":{"type":"integer","description":"Total tokens (prompt_tokens + completion_tokens).","isRequired":true,"uniqueKey":"oneOf.1.usage.total_tokens","typeLabel":"integer"},"num_search_queries":{"type":"integer","description":"Number of searches executed. Returned only when search was used.","uniqueKey":"oneOf.1.usage.num_search_queries","typeLabel":"integer"},"num_web_search_queries":{"type":"integer","description":"Number of web search queries executed. Returned only when web search was used.","uniqueKey":"oneOf.1.usage.num_web_search_queries","typeLabel":"integer"},"num_image_search_queries":{"type":"integer","description":"Number of image search queries executed. Returned only when `octen_multimodal_search` ran an image search.","uniqueKey":"oneOf.1.usage.num_image_search_queries","typeLabel":"integer"},"num_video_search_queries":{"type":"integer","description":"Number of video search queries executed. Returned only when `octen_multimodal_search` ran a video search.","uniqueKey":"oneOf.1.usage.num_video_search_queries","typeLabel":"integer"},"num_place_search_queries":{"type":"integer","description":"Number of billed place search queries. Returned only when `octen_search` returned place cards.","uniqueKey":"oneOf.1.usage.num_place_search_queries","typeLabel":"integer"},"full_content_extra_count":{"type":"integer","description":"Billable full_content results beyond the free allowance. Returned only when `full_content` is enabled.","uniqueKey":"oneOf.1.usage.full_content_extra_count","typeLabel":"integer"},"prompt_tokens_details":{"type":"object","description":"Breakdown of input tokens. Returned only when the prompt cache is hit or written to.","properties":{"cached_tokens":{"type":"integer","description":"Portion of `prompt_tokens` served from cache (a subset of `prompt_tokens`).","uniqueKey":"oneOf.1.usage.prompt_tokens_details.cached_tokens","typeLabel":"integer"},"cache_write_tokens":{"type":"integer","description":"Tokens written to cache (a subset of `prompt_tokens`). Returned only when `cache_control` was used and the model supports cache writes.","uniqueKey":"oneOf.1.usage.prompt_tokens_details.cache_write_tokens","typeLabel":"integer"},"cache_write_5m_tokens":{"type":"integer","description":"Tokens written to the 5-minute cache (a subset of `cache_write_tokens`). Only the field matching the TTL used is returned.","uniqueKey":"oneOf.1.usage.prompt_tokens_details.cache_write_5m_tokens","typeLabel":"integer"},"cache_write_1h_tokens":{"type":"integer","description":"Tokens written to the 1-hour cache (a subset of `cache_write_tokens`). Only the field matching the TTL used is returned.","uniqueKey":"oneOf.1.usage.prompt_tokens_details.cache_write_1h_tokens","typeLabel":"integer"}},"uniqueKey":"oneOf.1.usage.prompt_tokens_details","typeLabel":"object"},"completion_tokens_details":{"type":"object","description":"Breakdown of output tokens. Returned only for reasoning models.","properties":{"reasoning_tokens":{"type":"integer","description":"Number of reasoning tokens (already included in `completion_tokens`).","uniqueKey":"oneOf.1.usage.completion_tokens_details.reasoning_tokens","typeLabel":"integer"}},"uniqueKey":"oneOf.1.usage.completion_tokens_details","typeLabel":"object"}},"uniqueKey":"oneOf.1.usage","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"Streaming · object"}],"uniqueKey":"","typeLabel":"Non-streaming · object | Streaming · object"},"examples":{"nonStreaming":{"title":"nonStreaming","summary":"Non-streaming, plain model call","value":{"id":"gen-1749812456-xyz7890","object":"chat.completion","created":1749812456,"model":"anthropic/claude-opus-5.5","choices":[{"index":0,"finish_reason":"stop","message":{"role":"assistant","content":"Attention lets a model dynamically weight its inputs and focus on the most relevant information.","refusal":null,"reasoning":null}}],"usage":{"prompt_tokens":18,"completion_tokens":32,"total_tokens":50}}},"promptCache":{"title":"promptCache","summary":"Non-streaming, prompt cache hit","value":{"id":"gen-1749812999-cache01","object":"chat.completion","created":1749812999,"model":"anthropic/claude-sonnet-5.5","choices":[{"index":0,"finish_reason":"stop","message":{"role":"assistant","content":"Per the manual, 7-day no-reason returns are supported.","refusal":null,"reasoning":null}}],"usage":{"prompt_tokens":2106,"completion_tokens":18,"total_tokens":2124,"prompt_tokens_details":{"cached_tokens":2048}}}},"withSearch":{"title":"withSearch","summary":"Non-streaming, with built-in search","value":{"id":"gen-1749812345-abcd1234","object":"chat.completion","created":1749812345,"model":"anthropic/claude-sonnet-5.5","choices":[{"index":0,"finish_reason":"stop","message":{"role":"assistant","content":"OpenRouter is a unified platform aggregating multiple LLM providers behind one API.","refusal":null,"reasoning":null,"annotations":[{"type":"url_citation","url_citation":{"url":"https://openrouter.ai/docs","title":"OpenRouter Documentation","start_index":0,"end_index":31}}]}}],"search_results":[{"query":"What is OpenRouter AI","results":[{"title":"OpenRouter Documentation","url":"https://openrouter.ai/docs","highlights":"OpenRouter provides a unified API for multiple LLM providers","authors":"OpenRouter","time_published":"2024-11-02T00:00:00Z","time_last_crawled":"2025-01-10T12:30:00Z"}]}],"usage":{"num_search_queries":1,"prompt_tokens":1058,"completion_tokens":132,"total_tokens":1190}}},"withMultimodalSearch":{"title":"withMultimodalSearch","summary":"Non-streaming, with built-in multimodal search","value":{"id":"20261106083100000ABCD1234EF","object":"chat.completion","created":1793953860,"model":"openai/gpt-6.1-terra","choices":[{"index":0,"finish_reason":"stop","message":{"role":"assistant","content":"The central Tower of Jesus Christ now rises above the other spires, crowned by a large cross.\n\n\n\nFor a look inside, watch [Inside the Sagrada Familia](https://www.youtube.com/watch?v=example).","refusal":null,"reasoning":null}}],"search_results":[{"query":"What does the Sagrada Familia look like today?","results":[{"title":"The Sagrada Familia with its completed central tower","url":"https://example.com/images/sagrada-familia.jpg","type":"image","num":1,"cover_url":"https://cdn.octen.ai/img?t=example","source_page":"https://example.com/sagrada-familia-today"},{"title":"Sagrada Familia completes its central tower","url":"https://example.com/news/sagrada-familia-tower","type":"web","num":2,"highlights":"The Tower of Jesus Christ has reached its full height of 172.5 metres.","authors":"Example News","time_published":"2026-02-20T00:00:00Z"}]},{"query":"Sagrada Familia interior video tour","results":[{"title":"Inside the Sagrada Familia","url":"https://www.youtube.com/watch?v=example","type":"video","num":3,"cover_url":"https://i.ytimg.com/vi/example/hqdefault.jpg","source_page":"https://www.youtube.com/watch?v=example","duration_seconds":313}]}],"usage":{"num_search_queries":3,"num_web_search_queries":1,"num_image_search_queries":1,"num_video_search_queries":1,"prompt_tokens":10947,"completion_tokens":487,"total_tokens":11434}}},"toolCall":{"title":"toolCall","summary":"Non-streaming, custom function call","value":{"id":"gen-1749812800-tool0001","object":"chat.completion","created":1749812800,"model":"openai/gpt-5.4","choices":[{"index":0,"finish_reason":"tool_calls","message":{"role":"assistant","content":null,"tool_calls":[{"id":"call_abc123","type":"function","function":{"name":"create_reminder","arguments":"{\"content\": \"Rain in Shanghai tomorrow, bring an umbrella\", \"time\": \"2026-06-11T08:00:00+08:00\"}"}}],"refusal":null,"reasoning":null}}],"usage":{"prompt_tokens":230,"completion_tokens":45,"total_tokens":275}}},"streamSearchDone":{"title":"streamSearchDone","summary":"Streaming, search_done chunk","value":{"type":"search_done","id":"20260318143837845RJQ9P28ZEC","object":"chat.completion.chunk","created":1773844717,"model":"anthropic/claude-opus-5.5","search_results":[{"query":"weather Beijing today","results":[{"title":"Beijing Weather","url":"https://weather.com/beijing","highlights":"Partly cloudy, high of 32C","authors":"weather.com","time_published":"2026-06-10T00:00:00Z","time_last_crawled":"2026-06-10T06:00:00Z"}]}]}},"streamContent":{"title":"streamContent","summary":"Streaming, content chunk","value":{"type":"content","id":"gen-1749812600-stream001","object":"chat.completion.chunk","created":1749812600,"model":"openai/gpt-5.4","choices":[{"index":0,"delta":{"role":"assistant","content":"OpenRouter is "},"finish_reason":null}]}},"streamFinish":{"title":"streamFinish","summary":"Streaming, finish chunk","value":{"type":"finish","id":"gen-1749812600-stream001","object":"chat.completion.chunk","created":1749812600,"model":"openai/gpt-5.4","choices":[{"index":0,"delta":{},"finish_reason":"stop"}]}},"streamUsage":{"title":"streamUsage","summary":"Streaming, usage chunk","value":{"type":"usage","id":"20260318143837845RJQ9P28ZEC","object":"chat.completion.chunk","created":1773844727,"model":"anthropic/claude-opus-5.5","usage":{"num_search_queries":2,"full_content_extra_count":5,"prompt_tokens":1841,"completion_tokens":638,"total_tokens":2479,"completion_tokens_details":{"reasoning_tokens":30}}}},"refusal":{"title":"refusal","summary":"Safety refusal","value":{"id":"gen-1749812700-refusal","object":"chat.completion","created":1749812700,"model":"openai/gpt-5.4","choices":[{"index":0,"finish_reason":"stop","message":{"role":"assistant","content":null,"refusal":"I can't help with that request.","reasoning":null}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"617da2f7-e610-44b1-b9a9-6356bc87e00b":{"description":"Missing or invalid parameter","content":{"application/json":{"schema":{"type":"object","description":"Error body in the OpenAI protocol format.","required":["error"],"properties":{"error":{"type":"object","properties":{"message":{"type":"string","description":"A human-readable description of the error.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"The error category, e.g. `invalid_request_error`.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"param":{"oneOf":[{"type":"string","description":"The parameter related to the error, if any.","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"The parameter related to the error, if any.","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","description":"The error code, if any.","uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The error code, if any.","uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.code","typeLabel":"string | null"}},"required":["message","type"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"message":"Missing or invalid parameter","type":"invalid_request_error","param":null,"code":null}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"Missing or invalid parameter","type":"invalid_request_error","param":null,"code":null}}}},"exampleType":"examples"}},"exampleType":"examples"},"b8f2b9f7-513b-41a7-a869-7cf5cf2cb034":{"description":"Invalid API Key","content":{"application/json":{"schema":{"type":"object","description":"Error body in the OpenAI protocol format.","required":["error"],"properties":{"error":{"type":"object","properties":{"message":{"type":"string","description":"A human-readable description of the error.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"The error category, e.g. `invalid_request_error`.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"param":{"oneOf":[{"type":"string","description":"The parameter related to the error, if any.","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"The parameter related to the error, if any.","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","description":"The error code, if any.","uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The error code, if any.","uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.code","typeLabel":"string | null"}},"required":["message","type"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"message":"Invalid API Key","type":"authentication_error","param":null,"code":null}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"Invalid API Key","type":"authentication_error","param":null,"code":null}}}},"exampleType":"examples"}},"exampleType":"examples"},"d9d93e30-edc1-45ee-9171-abd44d677d1c":{"description":"Insufficient balance in account","content":{"application/json":{"schema":{"type":"object","description":"Error body in the OpenAI protocol format.","required":["error"],"properties":{"error":{"type":"object","properties":{"message":{"type":"string","description":"A human-readable description of the error.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"The error category, e.g. `invalid_request_error`.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"param":{"oneOf":[{"type":"string","description":"The parameter related to the error, if any.","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"The parameter related to the error, if any.","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","description":"The error code, if any.","uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The error code, if any.","uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.code","typeLabel":"string | null"}},"required":["message","type"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"message":"Insufficient balance in account","type":"permission_error","param":null,"code":null}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"Insufficient balance in account","type":"permission_error","param":null,"code":null}}}},"exampleType":"examples"}},"exampleType":"examples"},"06aff291-c983-43a8-83d4-30c7194c0576":{"description":"Model or resource not found","content":{"application/json":{"schema":{"type":"object","description":"Error body in the OpenAI protocol format.","required":["error"],"properties":{"error":{"type":"object","properties":{"message":{"type":"string","description":"A human-readable description of the error.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"The error category, e.g. `invalid_request_error`.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"param":{"oneOf":[{"type":"string","description":"The parameter related to the error, if any.","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"The parameter related to the error, if any.","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","description":"The error code, if any.","uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The error code, if any.","uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.code","typeLabel":"string | null"}},"required":["message","type"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"message":"Model or resource not found","type":"not_found_error","param":null,"code":null}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"Model or resource not found","type":"not_found_error","param":null,"code":null}}}},"exampleType":"examples"}},"exampleType":"examples"},"b6549738-c068-4341-8b13-f29c54ae826d":{"description":"Exceeding the rate limit","content":{"application/json":{"schema":{"type":"object","description":"Error body in the OpenAI protocol format.","required":["error"],"properties":{"error":{"type":"object","properties":{"message":{"type":"string","description":"A human-readable description of the error.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"The error category, e.g. `invalid_request_error`.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"param":{"oneOf":[{"type":"string","description":"The parameter related to the error, if any.","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"The parameter related to the error, if any.","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","description":"The error code, if any.","uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The error code, if any.","uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.code","typeLabel":"string | null"}},"required":["message","type"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"message":"Exceeding the rate limit","type":"rate_limit_error","param":null,"code":null}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"Exceeding the rate limit","type":"rate_limit_error","param":null,"code":null}}}},"exampleType":"examples"}},"exampleType":"examples"},"7a2268a5-5894-4f04-8225-33579dd2ffc1":{"description":"Internal error","content":{"application/json":{"schema":{"type":"object","description":"Error body in the OpenAI protocol format.","required":["error"],"properties":{"error":{"type":"object","properties":{"message":{"type":"string","description":"A human-readable description of the error.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"The error category, e.g. `invalid_request_error`.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"param":{"oneOf":[{"type":"string","description":"The parameter related to the error, if any.","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"The parameter related to the error, if any.","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","description":"The error code, if any.","uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","description":"The error code, if any.","uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.code","typeLabel":"string | null"}},"required":["message","type"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"message":"Internal error","type":"api_error","param":null,"code":null}},"examples":{"Example":{"title":"Example","value":{"error":{"message":"Internal error","type":"api_error","param":null,"code":null}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"2c74c17e-44bd-4f2c-899a-3438f71d4605":{"bearerAuth":{"type":"http","scheme":"bearer","description":"Bearer token used for request authentication. Alternatively, you can send the API key in the `x-api-key` header. Note: A payment method is required to use the API.","scopes":[],"schemeName":"bearerAuth"}},"3b85a8a9-39ca-4852-80fc-87c2a2c97a39":{"apiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key used for request authentication. Alternatively, you can send the key as a Bearer token in the `Authorization` header. Note: A payment method is required to use the API.","scopes":[],"schemeName":"apiKeyAuth"}}},"servers":{"03d7c70f-bdc7-478a-b64c-693a14ca47cc":{"url":"https://api.octen.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"Bearer token used for request authentication. Alternatively, you can send the API key in the `x-api-key` header. Note: A payment method is required to use the API.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer token used for request authentication. Alternatively, you can send the API key in the `x-api-key` header. Note: A payment method is required to use the API.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key used for request authentication. Alternatively, you can send the key as a Bearer token in the `Authorization` header. Note: A payment method is required to use the API.","scopes":[],"schemeName":"apiKeyAuth"},"schema":{"title":"x-api-key","type":"string","description":"API key used for request authentication. Alternatively, you can send the key as a Bearer token in the `Authorization` header. Note: A payment method is required to use the API.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKeyAuth","name":"x-api-key"}],"title":"apiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"octen-ai","siteName":"Octen Docs","title":"LLM Chat (OpenAI-Compatible) API Reference - Octen Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-17T16:05:48.235Z","originalFileLocation":"api-reference/chat-completions.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Compatible with the OpenAI Chat Completions protocol, with optional built-in octen_broad_search, octen_search, and octen_multimodal_search tools.\">\u003cmeta data-mint-head name=\"keywords\" content=\"octen,octen.ai,ai search infrastructure,real-time web search,search api,ai search engine,search for ai agents,retrieval layer for llms,llm grounding,real-time indexing,low latency retrieval,agentic search engine,live web data,sota embedding model,octen-8b,ai search api,web search api,api,search,ai,llms\">\u003cmeta data-mint-head name=\"application-name\" content=\"Octen Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/octen-ai/XhyhRRvOpTIxrcMy/_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/octen-ai/XhyhRRvOpTIxrcMy/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/octen-ai/XhyhRRvOpTIxrcMy/_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/octen-ai/XhyhRRvOpTIxrcMy/_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/octen-ai/XhyhRRvOpTIxrcMy/_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/octen-ai/XhyhRRvOpTIxrcMy/_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/octen-ai/XhyhRRvOpTIxrcMy/_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/octen-ai/XhyhRRvOpTIxrcMy/_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/octen-ai/XhyhRRvOpTIxrcMy/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"LLM Chat (OpenAI-Compatible) API Reference - Octen Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"The search infrastructure for AI. Real-time web search foundation that empowers LLMs to reason with the world\u0026#x27;s latest information. Engineered for AI Agents, Copilots, and Chatbots with real-time indexing, sub-100ms latency, and high reliability.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Octen Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.octen.ai/api-reference/chat-completions\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://octen.ai/_next/static/media/octen-cover.dc74905e.png\">\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=\"LLM Chat (OpenAI-Compatible) API Reference - Octen Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"The search infrastructure for AI. Real-time web search foundation that empowers LLMs to reason with the world\u0026#x27;s latest information. Engineered for AI Agents, Copilots, and Chatbots with real-time indexing, sub-100ms latency, and high reliability.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://octen.ai/_next/static/media/octen-cover.dc74905e.png\">\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/octen-ai/XhyhRRvOpTIxrcMy/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Octen Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#039855\">\u003cmeta data-mint-head name=\"google-site-verification\" content=\"WomFSLfAsZAC_vWB_WcRDmkF_IPlrOw-VHZROUA1LFE\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.octen.ai/api-reference/chat-completions\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/chat-completions.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.octen.ai/#organization\",\"name\":\"Octen Docs\",\"url\":\"https://docs.octen.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/octen-ai/7a_UtFqtHVRx7z9z/logo/logo.svg?fit=max\u0026auto=format\u0026n=7a_UtFqtHVRx7z9z\u0026q=85\u0026s=26d2a863c023b0211afa7c6c0bce2d8e\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.octen.ai#website\",\"name\":\"Octen Docs\",\"url\":\"https://docs.octen.ai\",\"publisher\":{\"@id\":\"https://docs.octen.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.octen.ai/api-reference/chat-completions#webpage\",\"url\":\"https://docs.octen.ai/api-reference/chat-completions\",\"name\":\"LLM Chat (OpenAI-Compatible) API Reference\",\"description\":\"Compatible with the OpenAI Chat Completions protocol, with optional built-in octen_broad_search, octen_search, and octen_multimodal_search tools.\",\"dateModified\":\"2026-11-17T16:05:48.235Z\",\"isPartOf\":{\"@id\":\"https://docs.octen.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.octen.ai/api-reference/chat-completions#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.octen.ai/api-reference/chat-completions#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Applications\",\"item\":\"https://docs.octen.ai/api-reference/answer\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"LLM Chat (OpenAI-Compatible) API Reference\",\"item\":\"https://docs.octen.ai/api-reference/chat-completions\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.octen.ai/api-reference/chat-completions#apireference\",\"headline\":\"LLM Chat (OpenAI-Compatible) API Reference\",\"name\":\"LLM Chat (OpenAI-Compatible) API Reference\",\"description\":\"Compatible with the OpenAI Chat Completions protocol, with optional built-in octen_broad_search, octen_search, and octen_multimodal_search tools.\",\"url\":\"https://docs.octen.ai/api-reference/chat-completions\",\"mainEntityOfPage\":{\"@id\":\"https://docs.octen.ai/api-reference/chat-completions#webpage\"},\"image\":\"https://octen.ai/_next/static/media/octen-cover.dc74905e.png\",\"dateModified\":\"2026-11-17T16:05:48.235Z\",\"publisher\":{\"@id\":\"https://docs.octen.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.octen.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Octen Docs\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Octen Docs\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/chat-completions.md","siteName":"Octen Docs","nav":{"global":null,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/overview/welcome"}]},{"tab":"API Reference","groups":[{"group":"APIs","pages":[{"group":"Octen Pulse","pages":[{"title":"Pulse Search API Reference","deprecated":null,"version":null,"sidebarTitle":"Pulse Search","openapi":"/api-reference/openapi.json post /pulse-search","href":"/api-reference/pulse-search"}]},{"group":"Octen Fast","pages":[{"title":"Broad Search API Reference","deprecated":null,"version":null,"sidebarTitle":"Broad Search","openapi":"/api-reference/openapi.json post /broad-search","href":"/api-reference/broad-search"},{"title":"Web Search API Reference","deprecated":null,"version":null,"sidebarTitle":"Web Search","openapi":"/api-reference/openapi.json post /search","href":"/api-reference/search"},{"title":"Image Search API Reference","deprecated":null,"version":null,"sidebarTitle":"Image Search","openapi":"/api-reference/openapi.json post /image-search","href":"/api-reference/image-search"},{"title":"Video Search API Reference","deprecated":null,"version":null,"sidebarTitle":"Video Search","openapi":"/api-reference/openapi.json post /video-search","href":"/api-reference/video-search"}]},{"group":"Octen Premier","pages":[{"title":"News Search API Reference","deprecated":null,"version":null,"sidebarTitle":"News Search","openapi":"/api-reference/openapi.json post /news-search","href":"/api-reference/news-search"},{"title":"Business Search API Reference","deprecated":null,"version":null,"sidebarTitle":"Business Search","openapi":"/api-reference/openapi.json post /business-search","href":"/api-reference/business-search"},{"title":"Place Search API Reference","deprecated":null,"version":null,"sidebarTitle":"Place Search","openapi":"/api-reference/openapi.json post /place-search","href":"/api-reference/place-search"}]},{"title":"Extract API Reference","deprecated":null,"version":null,"sidebarTitle":"Extract","openapi":"/api-reference/openapi.json post /extract","href":"/api-reference/extract"},{"group":"Monitor","pages":[{"title":"Create Monitor API Reference","deprecated":null,"version":null,"sidebarTitle":"Create Monitor","openapi":"/api-reference/openapi.json post /monitors","href":"/api-reference/post-monitor"},{"title":"List Monitors API Reference","deprecated":null,"version":null,"sidebarTitle":"List Monitors","openapi":"/api-reference/openapi.json get /monitors","href":"/api-reference/get-monitors"},{"title":"Get Monitor API Reference","deprecated":null,"version":null,"sidebarTitle":"Get Monitor","openapi":"/api-reference/openapi.json get /monitors/{id}","href":"/api-reference/get-monitor"},{"title":"Update Monitor API Reference","deprecated":null,"version":null,"sidebarTitle":"Update Monitor","openapi":"/api-reference/openapi.json patch /monitors/{id}","href":"/api-reference/patch-monitor"},{"title":"Delete Monitor API Reference","deprecated":null,"version":null,"sidebarTitle":"Delete Monitor","openapi":"/api-reference/openapi.json delete /monitors/{id}","href":"/api-reference/delete-monitor"},{"title":"Trigger Monitor Run API Reference","deprecated":null,"version":null,"sidebarTitle":"Trigger Monitor Run","openapi":"/api-reference/openapi.json post /monitors/{id}/trigger","href":"/api-reference/post-monitor-trigger"},{"title":"List Monitor Runs API Reference","deprecated":null,"version":null,"sidebarTitle":"List Monitor Runs","openapi":"/api-reference/openapi.json get /monitors/{id}/runs","href":"/api-reference/get-monitor-runs"},{"title":"Get Monitor Run API Reference","deprecated":null,"version":null,"sidebarTitle":"Get Monitor Run","openapi":"/api-reference/openapi.json get /monitors/{id}/runs/{run_id}","href":"/api-reference/get-monitor-run"},{"title":"List Monitor Events API Reference","deprecated":null,"version":null,"sidebarTitle":"List Monitor Events","openapi":"/api-reference/openapi.json get /monitors/{id}/events","href":"/api-reference/get-monitor-events"},{"title":"Monitor Webhooks API Reference","sidebarTitle":"Monitor Webhooks","href":"/api-reference/monitor-webhooks"}]},{"title":"Embedding API Reference","deprecated":null,"version":null,"sidebarTitle":"Embedding","openapi":"/api-reference/openapi.json post /embedding","href":"/api-reference/embedding"},{"title":"VL Embedding API Reference","deprecated":null,"version":null,"sidebarTitle":"VL Embedding","openapi":"/api-reference/openapi.json post /vl-embedding","href":"/api-reference/vl-embedding"}]},{"group":"Applications","pages":[{"title":"Answer API Reference","deprecated":null,"version":null,"sidebarTitle":"Answer","openapi":"/api-reference/openapi.json post /answer","href":"/api-reference/answer"},{"title":"Search Agent API Reference","deprecated":null,"version":null,"sidebarTitle":"Search Agent","openapi":"/api-reference/openapi.json post /v1/agent","href":"/api-reference/post-search-agent"},{"title":"Search Agent Result API Reference","deprecated":null,"version":null,"sidebarTitle":"Search Agent Result","openapi":"/api-reference/openapi.json get /v1/agent/{task_id}","href":"/api-reference/get-search-agent"},{"title":"Deep Research API Reference","deprecated":null,"version":null,"sidebarTitle":"Deep Research","openapi":"/api-reference/openapi.json post /v1/research","href":"/api-reference/deep-research"},{"title":"Grounded Generation API Reference","deprecated":null,"version":null,"sidebarTitle":"Grounded Generation","openapi":"/api-reference/openapi.json post /v1/grounded-generation","href":"/api-reference/post-grounded-generation"},{"title":"Generation Result API Reference","description":"Returns a grounded generation task by id.","deprecated":null,"version":null,"sidebarTitle":"Generation Result","openapi":"/api-reference/openapi.json get /v1/grounded-generation/{generation_id}","href":"/api-reference/get-grounded-generation"},{"group":"Auto Search","root":{"title":"LLM Chat (OpenAI-Compatible) API Reference","description":"Compatible with the OpenAI Chat Completions protocol, with optional built-in `octen_broad_search`, `octen_search`, and `octen_multimodal_search` tools.","deprecated":null,"version":null,"sidebarTitle":"LLM Chat (OpenAI-Compatible)","openapi":"/api-reference/openapi.json post /v1/chat/completions","href":"/api-reference/chat-completions"},"pages":[{"title":"LLM Chat (OpenAI-Compatible) API Reference","description":"Compatible with the OpenAI Chat Completions protocol, with optional built-in `octen_broad_search`, `octen_search`, and `octen_multimodal_search` tools.","deprecated":null,"version":null,"sidebarTitle":"LLM Chat (OpenAI-Compatible)","openapi":"/api-reference/openapi.json post /v1/chat/completions","href":"/api-reference/chat-completions"},{"title":"LLM Chat (Anthropic-Compatible) API Reference","description":"Compatible with the Anthropic Messages protocol, with optional built-in `octen_broad_search`, `octen_search`, and `octen_multimodal_search` tools.","deprecated":null,"version":null,"sidebarTitle":"LLM Chat (Anthropic-Compatible)","openapi":"/api-reference/openapi.json post /v1/messages","href":"/api-reference/messages"},{"title":"Image Generation API Reference","description":"Compatible with the OpenAI Images protocol. Text-to-image when no image is provided; image editing when an image is provided.","deprecated":null,"version":null,"sidebarTitle":"Image Generation","openapi":"/api-reference/openapi.json post /v1/images/generations","href":"/api-reference/images-generations"},{"title":"Video Generation API Reference","description":"Generates a video from a text prompt, optionally guided by reference images.","deprecated":null,"version":null,"sidebarTitle":"Video Generation","openapi":"/api-reference/openapi.json post /v1/videos","href":"/api-reference/post-video"},{"title":"Video Download API Reference","description":"Returns a video generation task by id.","deprecated":null,"version":null,"sidebarTitle":"Video Download","openapi":"/api-reference/openapi.json get /v1/videos/{id}","href":"/api-reference/get-video"}]}]}]}]},"basePath":"","title":"LLM Chat (OpenAI-Compatible) API Reference - Octen Docs","deploymentId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","buildId":"dpl_HhUetB7eHHDAmK9T1Teip38TgFx9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-jJHA3WSo.js","utils-DbZn3Mjn.js","cloneDeep-CnBnaSyy.js","_Uint8Array-CMQtTgBR.js","isObject-FP1Yky1u.js","utils-Bl2DvzOJ.js","addUniqueKeysToSchema-BwOLo9p1.js","snippetPresets-BBiPpKa-.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-C0px4Tml.js","isEqual-zAyttAAO.js","usePlaygroundInputsStore-Dell6dGw.js","shallow-0VKqkSqN.js","getApiPlaygroundDisplay-CP_ctPEB.js","CodeSnippet-5L35ic0s.js","CodeSnippets-DOXbNhJw.js","Page-DRLI_2Ue.js","getPastedJson-VhzT9m2P.js","icon-CD8_AtCO.js","MethodPill-DGgOMftG.js","DuplicateIcon-DZ6A_EtN.js","createIcon-DUl4oM5f.js","DynamicMarkdown-BGHukeRM.js","SectionHeading-ChrEUs8u.js","axios-vUo_bRtp.js","Markdown-Dj-na-_-.js","dist-C5gjFYHe.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-DEBW87tT.js"]}