{ "id": "msg_01XFDUDYJgAACzvnptvVoYEL", "type": "message", "role": "assistant", "model": "anthropic/claude-opus-5.5", "content": [ { "type": "text", "text": "Attention lets a model dynamically weight its inputs and focus on the most relevant information." } ], "stop_reason": "end_turn", "stop_sequence": null, "usage": { "input_tokens": 18, "output_tokens": 32 }}
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.
Headers
anthropic-version
string
Anthropic protocol version, e.g. 2023-06-01. Sent automatically by the Anthropic SDK. Defaults to 2023-06-01 if omitted.
Body
application/json
Request body for the Messages API. Some parameters apply only to certain models; unsupported parameters are ignored.
model
enum<string>
required
The model to use. Anthropic models also accept their native ids (e.g. claude-opus-5-5), which map to anthropic/claude-opus-5.5.
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
max_tokens
integer
required
Maximum number of tokens to generate, including thinking and visible output tokens.
Required range: x >= 1
messages
object[]
required
The conversation so far, in chronological order.
Show child attributes
system
stringobject[]
System prompt. A plain string or an array of text blocks supporting cache_control.
tools
object[]
A tool definition. One of a custom 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
object
Controls whether and how the model calls tools.
Show child attributes
stream
boolean
default:false
Whether to enable streaming output.
temperature
number
default:1
Controls randomness.
Required range: 0 <= x <= 1
top_p
number
Nucleus sampling. If unset, no nucleus truncation is applied. Set only one of temperature and top_p.
Required range: x <= 1
top_k
integer
Sample only from the top K tokens. If unset, top-k filtering is disabled.
Required range: x >= 0
stop_sequences
string[]
Stop sequences.
thinking
object
Thinking options for reasoning models.
Show child attributes
metadata
object
Request metadata.
Show child attributes
output_config
object
Controls how the model produces its output.
Show child attributes
cache_control
object
Top-level prompt caching marker. Sets a cache breakpoint on the last cacheable content block in the request, equivalent to setting cache_control on that block directly.
Show child attributes
Response
Successful message response. When stream=false, returns a single message object. When stream=true, returns an Anthropic SSE event stream.
Non-streaming
Streaming
A non-streaming response. Returned when stream=false.
id
string
required
The unique identifier for this request.
type
enum<string>
required
The response type. message on success.
Available options:
message,
error
role
enum<string>
required
Always assistant.
Available options:
assistant
model
string
required
The model used for this response.
content
object[]
required
The response content, as a list of content blocks.
Show child attributes
stop_reason
enum<string>
required
Why the model stopped.
Available options:
end_turn,
max_tokens,
stop_sequence,
tool_use,
pause_turn,
refusal
usage
object
required
Token usage information.
Show child attributes
stop_details
object
Additional detail about why the model stopped. Returned only when stop_reason is refusal.
Show child attributes
stop_sequence
string | null
The stop sequence that was hit, or null.
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":"treatment","enabled":true,"payload":{"type":"string","value":"treatment"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"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/messages","slug":"/api-reference/messages","pageMetadata":{"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","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 Anthropic Messages 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 (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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/octen-ai/1394afa843283735/tryit-button.js"],"openApiReferenceData":{"operation":{"summary":"Create a message","description":"Compatible with the Anthropic Messages protocol, with optional built-in `octen_broad_search`, `octen_search`, and `octen_multimodal_search` tools.","operationId":"messages","x-mint":{"href":"/api-reference/messages","metadata":{"title":"LLM Chat (Anthropic-Compatible) API Reference","sidebarTitle":"LLM Chat (Anthropic-Compatible)"}},"parameters":["9fa09677-ccf4-4e93-ace5-ae7a493b6a44"],"requestBody":"7e5c359b-bcd9-4c7e-9b7c-f6f2061501b9","responses":{"200":"26983ed9-50b9-4fc9-b23c-e4ee9f351637","400":"21ea1cec-06aa-4d56-a98b-ba7e56b7b1b2","401":"f67e10d5-14ba-4abb-97c9-e05c9d1cedd0","403":"3f0c36a7-7f7a-4d32-bdc4-052996f324bb","404":"c1adf4db-218f-44d5-b5a4-717de626464b","413":"268743c4-f416-4118-940f-e76f3631a4f6","429":"964cc048-eca8-47e5-bc88-129a66f7cd50","500":"ba883a4c-a147-4719-894d-ee2e87991ee5","529":"f38423b2-4e22-46fa-8ce5-f2dd719da99b"},"method":"post","type":"path","servers":["03d7c70f-bdc7-478a-b64c-693a14ca47cc"],"security":["2c74c17e-44bd-4f2c-899a-3438f71d4605","3b85a8a9-39ca-4852-80fc-87c2a2c97a39"],"path":"/v1/messages","baseUrlOptions":["https://api.octen.ai"],"title":"Create a message","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[{"body.model":"anthropic/claude-opus-5.5","body.max_tokens":2048,"body.messages.items.0.role":"user","body.messages.items.0.content.oneOf.0":"Explain attention in one sentence."},{"body.model":"anthropic/claude-sonnet-5.5","body.max_tokens":2048,"body.messages.items.0.role":"user","body.messages.items.0.content.oneOf.0":"Compare cloud GPU pricing across major providers.","body.system.oneOf.0":"You are a helpful assistant.","body.tools.items.0.oneOf.1.type":"octen_broad_search","body.tools.items.0.oneOf.1.name":"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.type":"auto"},{"body.model":"anthropic/claude-sonnet-5.5","body.max_tokens":2048,"body.messages.items.0.role":"user","body.messages.items.0.content.oneOf.0":"What's the weather in Beijing today?","body.system.oneOf.0":"You are a helpful assistant.","body.tools.items.0.oneOf.2.type":"octen_search","body.tools.items.0.oneOf.2.name":"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.type":"auto"},{"body.model":"anthropic/claude-sonnet-5.5","body.max_tokens":3000,"body.messages.items.0.role":"user","body.messages.items.0.content.oneOf.0":"Show me photos of the newest Tokyo skyscrapers.","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.max_tokens":2048,"body.messages.items.0.role":"user","body.messages.items.0.content.oneOf.0":"Create a travel reminder for 8am tomorrow.","body.messages.items.1.role":"assistant","body.messages.items.1.content.oneOf.1.items.0.type":"tool_use","body.messages.items.1.content.oneOf.1.items.0.id":"toolu_abc123","body.messages.items.1.content.oneOf.1.items.0.name":"create_reminder","body.messages.items.1.content.oneOf.1.items.0.input":{"content":"Travel reminder","time":"2026-06-11T08:00:00+08:00"},"body.messages.items.2.role":"user","body.messages.items.2.content.oneOf.1.items.0.type":"tool_result","body.messages.items.2.content.oneOf.1.items.0.tool_use_id":"toolu_abc123","body.messages.items.2.content.oneOf.1.items.0.content.oneOf.0":"Reminder created.","body.tools.items.0.oneOf.0.name":"create_reminder","body.tools.items.0.oneOf.0.description":"Create a reminder","body.tools.items.0.oneOf.0.input_schema":{"type":"object","properties":{"content":{"type":"string","description":"Reminder content"},"time":{"type":"string","description":"Reminder time, ISO 8601"}},"required":["content","time"]}}]},"dependencies":{"parameters":{"9fa09677-ccf4-4e93-ace5-ae7a493b6a44":{"name":"anthropic-version","in":"header","required":false,"schema":{"type":"string","isRequired":false,"description":"Anthropic protocol version, e.g. `2023-06-01`. Sent automatically by the Anthropic SDK. Defaults to `2023-06-01` if omitted.","uniqueKey":"","typeLabel":"string"},"description":"Anthropic protocol version, e.g. `2023-06-01`. Sent automatically by the Anthropic SDK. Defaults to `2023-06-01` if omitted."}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["model","max_tokens","messages"],"description":"Request body for the Messages API. Some parameters apply only to certain models; unsupported parameters are ignored.","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. Anthropic models also accept their native ids (e.g. `claude-opus-5-5`), which map to `anthropic/claude-opus-5.5`.","isRequired":true,"uniqueKey":"model","typeLabel":"enum\u003cstring>"},"max_tokens":{"type":"integer","minimum":1,"description":"Maximum number of tokens to generate, including thinking and visible output tokens.","isRequired":true,"uniqueKey":"max_tokens","typeLabel":"integer"},"messages":{"type":"array","items":{"type":"object","required":["role","content"],"description":"A message in the conversation. Tool results are returned via a `tool_result` content block in a `user` message.","properties":{"role":{"type":"string","enum":["user","assistant"],"description":"The role of the message author.","isRequired":true,"uniqueKey":"messages.items.[INDEX].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].content.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"object","required":["type"],"description":"A content block within a message. The fields used depend on `type`. For replaying a multi-turn conversation, blocks such as `tool_use`, `tool_result`, `thinking`, `redacted_thinking`, `server_tool_use`, and `web_search_tool_result` are returned verbatim.","properties":{"type":{"type":"string","enum":["text","image","tool_use","tool_result","thinking","redacted_thinking","server_tool_use","web_search_tool_result"],"description":"The type of content block.","isRequired":true,"uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","description":"Text content. Required when `type` is `text`.","uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].text","typeLabel":"string"},"source":{"type":"object","description":"Image source. Required when `type` is `image`.","properties":{"type":{"type":"string","enum":["url","base64"],"description":"How the image is provided.","uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].source.type","typeLabel":"enum\u003cstring>"},"url":{"type":"string","description":"Image URL. Required when `source.type` is `url`.","uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].source.url","typeLabel":"string"},"media_type":{"type":"string","enum":["image/jpeg","image/png","image/gif","image/webp"],"description":"Image MIME type. Required when `source.type` is `base64`.","uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].source.media_type","typeLabel":"enum\u003cstring>"},"data":{"type":"string","description":"Base64-encoded image. Required when `source.type` is `base64`.","uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].source.data","typeLabel":"string"}},"uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].source","typeLabel":"object"},"id":{"type":"string","description":"Block id, replayed verbatim. Used by `tool_use` and `server_tool_use` blocks.","uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"Tool name, replayed verbatim. For `server_tool_use` it is `octen_search` or `octen_multimodal_search`. Used by `tool_use` and `server_tool_use` blocks.","uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].name","typeLabel":"string"},"input":{"type":"object","description":"Tool call arguments, replayed verbatim. Used by `tool_use` and `server_tool_use` blocks.","uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].input","typeLabel":"object"},"tool_use_id":{"type":"string","description":"The id of the corresponding `tool_use` or `server_tool_use` block. Used by `tool_result` and `web_search_tool_result` blocks.","uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].tool_use_id","typeLabel":"string"},"content":{"oneOf":[{"type":"string","description":"Result content. A string or content blocks for `tool_result`; the array of `web_search_result` blocks for `web_search_tool_result`.","uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].content.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"object","uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].content.oneOf.1.items.[INDEX]","typeLabel":"object"},"description":"Result content. A string or content blocks for `tool_result`; the array of `web_search_result` blocks for `web_search_tool_result`.","uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].content.oneOf.1","typeLabel":"object[]"}],"uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].content","typeLabel":"string | object[]"},"is_error":{"type":"boolean","default":false,"description":"Whether the tool execution failed. Used by `tool_result` blocks.","uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].is_error","typeLabel":"boolean"},"thinking":{"type":"string","description":"Thinking content, replayed verbatim. Required when `type` is `thinking`.","uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].thinking","typeLabel":"string"},"signature":{"type":"string","description":"Thinking signature, replayed verbatim. Required when `type` is `thinking`.","uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].signature","typeLabel":"string"},"thought_signature":{"type":"string","description":"Encrypted reasoning state, replayed verbatim. Required when the request ends with a `tool_result`.","uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].thought_signature","typeLabel":"string"},"data":{"type":"string","description":"Encrypted thinking content, replayed verbatim. Required when `type` is `redacted_thinking`.","uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].data","typeLabel":"string"},"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].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].content.oneOf.1.items.[INDEX].cache_control.ttl","typeLabel":"enum\u003cstring>"}},"uniqueKey":"messages.items.[INDEX].content.oneOf.1.items.[INDEX].cache_control","typeLabel":"object"}},"uniqueKey":"messages.items.[INDEX].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].content.oneOf.1","typeLabel":"object[]"}],"isRequired":true,"uniqueKey":"messages.items.[INDEX].content","typeLabel":"string | object[]"}},"uniqueKey":"messages.items.[INDEX]","typeLabel":"object"},"description":"The conversation so far, in chronological order.","isRequired":true,"uniqueKey":"messages","typeLabel":"object[]"},"system":{"oneOf":[{"type":"string","description":"System prompt. A plain string or an array of text blocks supporting `cache_control`.","uniqueKey":"system.oneOf.0","typeLabel":"string"},{"type":"array","items":{"type":"object","required":["type","text"],"description":"A system prompt text block.","properties":{"type":{"type":"string","enum":["text"],"description":"The block type. Always `text`.","isRequired":true,"uniqueKey":"system.oneOf.1.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","description":"The system prompt content.","isRequired":true,"uniqueKey":"system.oneOf.1.items.[INDEX].text","typeLabel":"string"},"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":"system.oneOf.1.items.[INDEX].cache_control.type","typeLabel":"enum\u003cstring>"},"ttl":{"type":"string","enum":["5m","1h"],"default":"5m","description":"Cache lifetime.","uniqueKey":"system.oneOf.1.items.[INDEX].cache_control.ttl","typeLabel":"enum\u003cstring>"}},"uniqueKey":"system.oneOf.1.items.[INDEX].cache_control","typeLabel":"object"}},"uniqueKey":"system.oneOf.1.items.[INDEX]","typeLabel":"object"},"description":"System prompt. A plain string or an array of text blocks supporting `cache_control`.","uniqueKey":"system.oneOf.1","typeLabel":"object[]"}],"uniqueKey":"system","typeLabel":"string | object[]"},"tools":{"type":"array","items":{"oneOf":[{"type":"object","description":"A tool definition. One of a custom 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":["name"],"properties":{"name":{"type":"string","description":"The tool name.","isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.0.name","typeLabel":"string"},"description":{"type":"string","description":"A description of what the custom tool does.","uniqueKey":"tools.items.[INDEX].oneOf.0.description","typeLabel":"string"},"input_schema":{"type":"object","description":"The custom tool's parameter definition in JSON Schema format.","uniqueKey":"tools.items.[INDEX].oneOf.0.input_schema","typeLabel":"object"},"strict":{"type":"boolean","default":false,"description":"Whether to enable strict mode for a custom tool.","uniqueKey":"tools.items.[INDEX].oneOf.0.strict","typeLabel":"boolean"},"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":"tools.items.[INDEX].oneOf.0.cache_control.type","typeLabel":"enum\u003cstring>"},"ttl":{"type":"string","enum":["5m","1h"],"default":"5m","description":"Cache lifetime.","uniqueKey":"tools.items.[INDEX].oneOf.0.cache_control.ttl","typeLabel":"enum\u003cstring>"}},"uniqueKey":"tools.items.[INDEX].oneOf.0.cache_control","typeLabel":"object"}},"uniqueKey":"tools.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"A tool definition. One of a custom 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","name"],"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>"},"name":{"type":"string","enum":["octen_broad_search"],"description":"The tool name. Always `octen_broad_search`.","isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.1.name","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"},"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":"tools.items.[INDEX].oneOf.1.cache_control.type","typeLabel":"enum\u003cstring>"},"ttl":{"type":"string","enum":["5m","1h"],"default":"5m","description":"Cache lifetime.","uniqueKey":"tools.items.[INDEX].oneOf.1.cache_control.ttl","typeLabel":"enum\u003cstring>"}},"uniqueKey":"tools.items.[INDEX].oneOf.1.cache_control","typeLabel":"object"}},"uniqueKey":"tools.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"A tool definition. One of a custom 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","name"],"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>"},"name":{"type":"string","enum":["octen_search"],"description":"The tool name. Always `octen_search`.","isRequired":true,"uniqueKey":"tools.items.[INDEX].oneOf.2.name","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"},"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":"tools.items.[INDEX].oneOf.2.cache_control.type","typeLabel":"enum\u003cstring>"},"ttl":{"type":"string","enum":["5m","1h"],"default":"5m","description":"Cache lifetime.","uniqueKey":"tools.items.[INDEX].oneOf.2.cache_control.ttl","typeLabel":"enum\u003cstring>"}},"uniqueKey":"tools.items.[INDEX].oneOf.2.cache_control","typeLabel":"object"}},"uniqueKey":"tools.items.[INDEX].oneOf.2","typeLabel":"object"},{"type":"object","description":"A tool definition. One of a custom 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>"},"name":{"type":"string","enum":["octen_multimodal_search"],"description":"The tool name. Always `octen_multimodal_search`.","uniqueKey":"tools.items.[INDEX].oneOf.3.name","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":{"type":"object","description":"Controls whether and how the model calls tools.","properties":{"type":{"type":"string","enum":["auto","any","tool","none"],"default":"auto","description":"`auto`: model decides; `any`: must call a tool; `tool`: call a specific tool; `none`: no tools.","uniqueKey":"tool_choice.type","typeLabel":"enum\u003cstring>"},"name":{"type":"string","description":"The tool name to force. Required when `type` is `tool` (e.g. `octen_broad_search`, `octen_search`, or `octen_multimodal_search`).","uniqueKey":"tool_choice.name","typeLabel":"string"},"disable_parallel_tool_use":{"type":"boolean","default":false,"description":"When `true`, the model issues at most one tool call per turn.","uniqueKey":"tool_choice.disable_parallel_tool_use","typeLabel":"boolean"}},"uniqueKey":"tool_choice","typeLabel":"object"},"stream":{"type":"boolean","default":false,"description":"Whether to enable streaming output.","uniqueKey":"stream","typeLabel":"boolean"},"temperature":{"type":"number","minimum":0,"maximum":1,"default":1,"description":"Controls randomness.","uniqueKey":"temperature","typeLabel":"number"},"top_p":{"type":"number","exclusiveMinimum":0,"maximum":1,"description":"Nucleus sampling. If unset, no nucleus truncation is applied. Set only one of `temperature` and `top_p`.","uniqueKey":"top_p","typeLabel":"number"},"top_k":{"type":"integer","minimum":0,"description":"Sample only from the top K tokens. If unset, top-k filtering is disabled.","uniqueKey":"top_k","typeLabel":"integer"},"stop_sequences":{"type":"array","items":{"type":"string","uniqueKey":"stop_sequences.items.[INDEX]","typeLabel":"string"},"description":"Stop sequences.","uniqueKey":"stop_sequences","typeLabel":"string[]"},"thinking":{"type":"object","description":"Thinking options for reasoning models.","properties":{"type":{"type":"string","enum":["enabled","disabled","adaptive","between_tools"],"description":"`adaptive` lets the model decide the thinking depth.","uniqueKey":"thinking.type","typeLabel":"enum\u003cstring>"},"budget_tokens":{"type":"integer","minimum":1024,"description":"Thinking token budget. Required when `type` is `enabled`; must be less than `max_tokens`. Not allowed when `type` is `adaptive`, `disabled`, or `between_tools`.","uniqueKey":"thinking.budget_tokens","typeLabel":"integer"},"display":{"type":"string","enum":["summarized","omitted"],"default":"summarized","description":"Controls how thinking is shown. `summarized` returns thinking blocks; `omitted` returns only the signature so blocks can be replayed. Valid only when `type` is `enabled` or `adaptive`.","uniqueKey":"thinking.display","typeLabel":"enum\u003cstring>"}},"uniqueKey":"thinking","typeLabel":"object"},"metadata":{"type":"object","description":"Request metadata.","properties":{"user_id":{"type":"string","description":"A unique identifier for the end user. Use hashed or pseudonymous identifiers to avoid passing personally identifiable information.","uniqueKey":"metadata.user_id","typeLabel":"string"}},"uniqueKey":"metadata","typeLabel":"object"},"output_config":{"type":"object","description":"Controls how the model produces its output.","properties":{"effort":{"type":"string","enum":["low","medium","high","xhigh","max"],"description":"Reasoning effort for reasoning models.","uniqueKey":"output_config.effort","typeLabel":"enum\u003cstring>"},"format":{"type":"object","description":"Structured output. Constrains the model to return content matching a JSON Schema.","required":["type","schema"],"properties":{"type":{"type":"string","enum":["json_schema"],"description":"The structured output type. Always `json_schema`.","isRequired":true,"uniqueKey":"output_config.format.type","typeLabel":"enum\u003cstring>"},"schema":{"type":"object","description":"The JSON Schema the output must conform to.","isRequired":true,"uniqueKey":"output_config.format.schema","typeLabel":"object"}},"uniqueKey":"output_config.format","typeLabel":"object"}},"uniqueKey":"output_config","typeLabel":"object"},"cache_control":{"type":"object","description":"Top-level prompt caching marker. Sets a cache breakpoint on the last cacheable content block in the request, equivalent to setting `cache_control` on that block directly.","required":["type"],"properties":{"type":{"type":"string","enum":["ephemeral"],"description":"The cache control type. Always `ephemeral`.","isRequired":true,"uniqueKey":"cache_control.type","typeLabel":"enum\u003cstring>"},"ttl":{"type":"string","enum":["5m","1h"],"default":"5m","description":"Cache lifetime.","uniqueKey":"cache_control.ttl","typeLabel":"enum\u003cstring>"}},"uniqueKey":"cache_control","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"pureModel":{"title":"pureModel","summary":"Plain model call","value":{"model":"anthropic/claude-opus-5.5","max_tokens":2048,"messages":[{"role":"user","content":"Explain attention in one sentence."}]}},"withBroadSearch":{"title":"withBroadSearch","summary":"Built-in broad search tool","value":{"model":"anthropic/claude-sonnet-5.5","max_tokens":2048,"system":"You are a helpful assistant.","messages":[{"role":"user","content":"Compare cloud GPU pricing across major providers."}],"tools":[{"type":"octen_broad_search","name":"octen_broad_search","parameters":{"max_queries":5,"count":10,"highlight":{"enable":true,"max_tokens":300},"format":"markdown"}}],"tool_choice":{"type":"auto"}}},"withSearch":{"title":"withSearch","summary":"Built-in search tool","value":{"model":"anthropic/claude-sonnet-5.5","max_tokens":2048,"system":"You are a helpful assistant.","messages":[{"role":"user","content":"What's the weather in Beijing today?"}],"tools":[{"type":"octen_search","name":"octen_search","parameters":{"max_searches":3,"count":10,"highlight":{"enable":true,"max_tokens":300},"format":"markdown"}}],"tool_choice":{"type":"auto"}}},"withMultimodalSearch":{"title":"withMultimodalSearch","summary":"Built-in multimodal search tool","value":{"model":"anthropic/claude-sonnet-5.5","max_tokens":3000,"messages":[{"role":"user","content":"Show me photos of the newest Tokyo skyscrapers."}],"tools":[{"type":"octen_multimodal_search","parameters":{"max_tool_calls":3}}]}},"customTool":{"title":"customTool","summary":"Custom tool with tool_result","value":{"model":"openai/gpt-5.4","max_tokens":2048,"messages":[{"role":"user","content":"Create a travel reminder for 8am tomorrow."},{"role":"assistant","content":[{"type":"tool_use","id":"toolu_abc123","name":"create_reminder","input":{"content":"Travel reminder","time":"2026-06-11T08:00:00+08:00"}}]},{"role":"user","content":[{"type":"tool_result","tool_use_id":"toolu_abc123","content":"Reminder created."}]}],"tools":[{"name":"create_reminder","description":"Create a reminder","input_schema":{"type":"object","properties":{"content":{"type":"string","description":"Reminder content"},"time":{"type":"string","description":"Reminder time, ISO 8601"}},"required":["content","time"]}}]}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"26983ed9-50b9-4fc9-b23c-e4ee9f351637":{"description":"Successful message response. When `stream=false`, returns a single `message` object. When `stream=true`, returns an Anthropic SSE event stream.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","title":"Non-streaming","description":"A non-streaming response. Returned when `stream=false`.","required":["id","type","role","model","content","stop_reason","usage"],"properties":{"id":{"type":"string","description":"The unique identifier for this request.","isRequired":true,"uniqueKey":"oneOf.0.id","typeLabel":"string"},"type":{"type":"string","enum":["message","error"],"description":"The response type. `message` on success.","isRequired":true,"uniqueKey":"oneOf.0.type","typeLabel":"enum\u003cstring>"},"role":{"type":"string","enum":["assistant"],"description":"Always `assistant`.","isRequired":true,"uniqueKey":"oneOf.0.role","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"The model used for this response.","isRequired":true,"uniqueKey":"oneOf.0.model","typeLabel":"string"},"content":{"type":"array","items":{"type":"object","description":"A content block in the response. The fields present depend on `type`.","properties":{"type":{"type":"string","enum":["text","thinking","redacted_thinking","tool_use","server_tool_use","web_search_tool_result"],"description":"The type of content block.","uniqueKey":"oneOf.0.content.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","description":"The assistant's text content. Present when `type` is `text`.","uniqueKey":"oneOf.0.content.items.[INDEX].text","typeLabel":"string"},"citations":{"type":"array","items":{"type":"object","description":"A citation into a search result. Returned only when `octen_search` was used and the text cites a result.","properties":{"type":{"type":"string","enum":["web_search_result_location"],"description":"The citation type.","uniqueKey":"oneOf.0.content.items.[INDEX].citations.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"url":{"type":"string","description":"The URL of the cited source.","uniqueKey":"oneOf.0.content.items.[INDEX].citations.items.[INDEX].url","typeLabel":"string"},"title":{"type":"string","description":"The title of the cited source.","uniqueKey":"oneOf.0.content.items.[INDEX].citations.items.[INDEX].title","typeLabel":"string"},"cited_text":{"type":"string","description":"The cited source snippet.","uniqueKey":"oneOf.0.content.items.[INDEX].citations.items.[INDEX].cited_text","typeLabel":"string"},"encrypted_index":{"type":"string","description":"Encrypted index of the citation location. Replay verbatim when returning text blocks with citations.","uniqueKey":"oneOf.0.content.items.[INDEX].citations.items.[INDEX].encrypted_index","typeLabel":"string"}},"uniqueKey":"oneOf.0.content.items.[INDEX].citations.items.[INDEX]","typeLabel":"object"},"description":"Citation annotations for this text block. Present only when `octen_broad_search` or `octen_search` was used.","uniqueKey":"oneOf.0.content.items.[INDEX].citations","typeLabel":"object[]"},"thinking":{"type":"string","description":"Reasoning content. Present when `type` is `thinking`.","uniqueKey":"oneOf.0.content.items.[INDEX].thinking","typeLabel":"string"},"signature":{"type":"string","description":"Signature of the thinking block. Replay verbatim in multi-turn conversations.","uniqueKey":"oneOf.0.content.items.[INDEX].signature","typeLabel":"string"},"thought_signature":{"type":"string","description":"Encrypted reasoning state of the `tool_use` block. Replay verbatim in multi-turn conversations.","uniqueKey":"oneOf.0.content.items.[INDEX].thought_signature","typeLabel":"string"},"data":{"type":"string","description":"Encrypted thinking content. Present when `type` is `redacted_thinking`.","uniqueKey":"oneOf.0.content.items.[INDEX].data","typeLabel":"string"},"id":{"type":"string","description":"Block id. Present for `tool_use` and `server_tool_use` blocks.","uniqueKey":"oneOf.0.content.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","description":"Tool name. Present for `tool_use` and `server_tool_use` blocks.","uniqueKey":"oneOf.0.content.items.[INDEX].name","typeLabel":"string"},"input":{"type":"object","description":"Tool call arguments. For `server_tool_use`, contains the auto-generated `query`.","uniqueKey":"oneOf.0.content.items.[INDEX].input","typeLabel":"object"},"tool_use_id":{"type":"string","description":"The id of the matching `server_tool_use` block. Present for `web_search_tool_result` blocks.","uniqueKey":"oneOf.0.content.items.[INDEX].tool_use_id","typeLabel":"string"},"content":{"type":"array","items":{"oneOf":[{"type":"object","description":"A single search result block.","properties":{"type":{"type":"string","enum":["web_search_result"],"description":"The block type.","uniqueKey":"oneOf.0.content.items.[INDEX].content.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"result_type":{"type":"string","enum":["web"],"description":"The result type. Returned only for `octen_search` results.","uniqueKey":"oneOf.0.content.items.[INDEX].content.items.[INDEX].oneOf.0.result_type","typeLabel":"enum\u003cstring>"},"title":{"type":"string","description":"The title of the result page.","uniqueKey":"oneOf.0.content.items.[INDEX].content.items.[INDEX].oneOf.0.title","typeLabel":"string"},"url":{"type":"string","description":"The URL of the result page.","uniqueKey":"oneOf.0.content.items.[INDEX].content.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.content.items.[INDEX].content.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.content.items.[INDEX].content.items.[INDEX].oneOf.0.full_content","typeLabel":"string"},"authors":{"type":"string","description":"Website name or author.","uniqueKey":"oneOf.0.content.items.[INDEX].content.items.[INDEX].oneOf.0.authors","typeLabel":"string"},"time_published":{"type":"string","format":"date-time","description":"Publish time in ISO 8601.","uniqueKey":"oneOf.0.content.items.[INDEX].content.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.content.items.[INDEX].content.items.[INDEX].oneOf.0.time_last_crawled","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"oneOf.0.content.items.[INDEX].content.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"A single search result block from `octen_multimodal_search`.","properties":{"type":{"type":"string","enum":["web_search_result"],"description":"The block type.","uniqueKey":"oneOf.0.content.items.[INDEX].content.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"result_type":{"type":"string","enum":["web","image","video"],"description":"The result type.","uniqueKey":"oneOf.0.content.items.[INDEX].content.items.[INDEX].oneOf.1.result_type","typeLabel":"enum\u003cstring>"},"num":{"type":"integer","description":"The result number.","uniqueKey":"oneOf.0.content.items.[INDEX].content.items.[INDEX].oneOf.1.num","typeLabel":"integer"},"title":{"type":"string","description":"The title of the result.","uniqueKey":"oneOf.0.content.items.[INDEX].content.items.[INDEX].oneOf.1.title","typeLabel":"string"},"url":{"type":"string","description":"The page or media URL.","uniqueKey":"oneOf.0.content.items.[INDEX].content.items.[INDEX].oneOf.1.url","typeLabel":"string"},"highlights":{"type":"string","description":"Query-relevant highlight snippets. Present for web results.","uniqueKey":"oneOf.0.content.items.[INDEX].content.items.[INDEX].oneOf.1.highlights","typeLabel":"string"},"authors":{"type":"string","description":"Website name or author.","uniqueKey":"oneOf.0.content.items.[INDEX].content.items.[INDEX].oneOf.1.authors","typeLabel":"string"},"time_published":{"type":"string","format":"date-time","description":"Publish time in ISO 8601.","uniqueKey":"oneOf.0.content.items.[INDEX].content.items.[INDEX].oneOf.1.time_published","typeLabel":"string\u003cdate-time>"},"cover_url":{"type":"string","description":"Thumbnail URL.","uniqueKey":"oneOf.0.content.items.[INDEX].content.items.[INDEX].oneOf.1.cover_url","typeLabel":"string"},"source_page":{"type":"string","description":"URL of the original page hosting the media.","uniqueKey":"oneOf.0.content.items.[INDEX].content.items.[INDEX].oneOf.1.source_page","typeLabel":"string"},"duration_seconds":{"type":"integer","description":"Video duration in seconds.","uniqueKey":"oneOf.0.content.items.[INDEX].content.items.[INDEX].oneOf.1.duration_seconds","typeLabel":"integer"}},"uniqueKey":"oneOf.0.content.items.[INDEX].content.items.[INDEX].oneOf.1","typeLabel":"object"},{"type":"object","description":"A single place card block from `octen_search`. Fields that cannot be resolved are omitted.","properties":{"type":{"type":"string","enum":["web_search_result"],"description":"The block type.","uniqueKey":"oneOf.0.content.items.[INDEX].content.items.[INDEX].oneOf.2.type","typeLabel":"enum\u003cstring>"},"result_type":{"type":"string","enum":["place"],"description":"The result type.","uniqueKey":"oneOf.0.content.items.[INDEX].content.items.[INDEX].oneOf.2.result_type","typeLabel":"enum\u003cstring>"},"title":{"type":"string","description":"The name of the place.","uniqueKey":"oneOf.0.content.items.[INDEX].content.items.[INDEX].oneOf.2.title","typeLabel":"string"},"url":{"type":"string","description":"The official website. Empty when unknown.","uniqueKey":"oneOf.0.content.items.[INDEX].content.items.[INDEX].oneOf.2.url","typeLabel":"string"},"category":{"type":"string","description":"The category of the place.","uniqueKey":"oneOf.0.content.items.[INDEX].content.items.[INDEX].oneOf.2.category","typeLabel":"string"},"address":{"type":"string","description":"The full address.","uniqueKey":"oneOf.0.content.items.[INDEX].content.items.[INDEX].oneOf.2.address","typeLabel":"string"},"latitude":{"type":"number","description":"Latitude of the place, WGS84.","uniqueKey":"oneOf.0.content.items.[INDEX].content.items.[INDEX].oneOf.2.latitude","typeLabel":"number"},"longitude":{"type":"number","description":"Longitude of the place, WGS84.","uniqueKey":"oneOf.0.content.items.[INDEX].content.items.[INDEX].oneOf.2.longitude","typeLabel":"number"},"phone":{"type":"string","description":"Phone number in international format.","example":"+1 000-000-0000","uniqueKey":"oneOf.0.content.items.[INDEX].content.items.[INDEX].oneOf.2.phone","typeLabel":"string"},"opening_hours":{"type":"array","items":{"type":"string","uniqueKey":"oneOf.0.content.items.[INDEX].content.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.content.items.[INDEX].content.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.content.items.[INDEX].content.items.[INDEX].oneOf.2.status","typeLabel":"enum\u003cstring>"},"rating":{"type":"number","description":"User rating, out of 5.","uniqueKey":"oneOf.0.content.items.[INDEX].content.items.[INDEX].oneOf.2.rating","typeLabel":"number"},"review_count":{"type":"integer","description":"Number of reviews.","uniqueKey":"oneOf.0.content.items.[INDEX].content.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.content.items.[INDEX].content.items.[INDEX].oneOf.2.attributes","typeLabel":"object"}},"uniqueKey":"oneOf.0.content.items.[INDEX].content.items.[INDEX].oneOf.2","typeLabel":"object"}],"uniqueKey":"oneOf.0.content.items.[INDEX].content.items.[INDEX]","typeLabel":"object"},"description":"Search results. Present for `web_search_tool_result` blocks.","uniqueKey":"oneOf.0.content.items.[INDEX].content","typeLabel":"object[]"}},"uniqueKey":"oneOf.0.content.items.[INDEX]","typeLabel":"object"},"description":"The response content, as a list of content blocks.","isRequired":true,"uniqueKey":"oneOf.0.content","typeLabel":"object[]"},"stop_reason":{"type":"string","enum":["end_turn","max_tokens","stop_sequence","tool_use","pause_turn","refusal"],"description":"Why the model stopped.","isRequired":true,"uniqueKey":"oneOf.0.stop_reason","typeLabel":"enum\u003cstring>"},"usage":{"type":"object","required":["input_tokens","output_tokens"],"description":"Token usage information.","properties":{"input_tokens":{"type":"integer","description":"Number of input tokens.","isRequired":true,"uniqueKey":"oneOf.0.usage.input_tokens","typeLabel":"integer"},"output_tokens":{"type":"integer","description":"Number of output tokens (thinking tokens are included).","isRequired":true,"uniqueKey":"oneOf.0.usage.output_tokens","typeLabel":"integer"},"cache_creation_input_tokens":{"type":"integer","description":"Tokens written to the prompt cache. Returned only when `cache_control` was used and the model supports caching.","uniqueKey":"oneOf.0.usage.cache_creation_input_tokens","typeLabel":"integer"},"cache_read_input_tokens":{"type":"integer","description":"Tokens read from the prompt cache. Returned only when `cache_control` was used and the model supports caching.","uniqueKey":"oneOf.0.usage.cache_read_input_tokens","typeLabel":"integer"},"cache_creation":{"type":"object","description":"Cache writes broken down by cache lifetime (a breakdown of `cache_creation_input_tokens`). Returned only when this call wrote to the cache.","properties":{"ephemeral_5m_input_tokens":{"type":"integer","description":"Tokens written to the 5-minute cache.","uniqueKey":"oneOf.0.usage.cache_creation.ephemeral_5m_input_tokens","typeLabel":"integer"},"ephemeral_1h_input_tokens":{"type":"integer","description":"Tokens written to the 1-hour cache.","uniqueKey":"oneOf.0.usage.cache_creation.ephemeral_1h_input_tokens","typeLabel":"integer"}},"uniqueKey":"oneOf.0.usage.cache_creation","typeLabel":"object"},"output_tokens_details":{"type":"object","description":"Breakdown of output tokens. Returned only for reasoning models.","properties":{"thinking_tokens":{"type":"integer","description":"Number of thinking tokens (already included in `output_tokens`).","uniqueKey":"oneOf.0.usage.output_tokens_details.thinking_tokens","typeLabel":"integer"}},"uniqueKey":"oneOf.0.usage.output_tokens_details","typeLabel":"object"},"server_tool_use":{"type":"object","description":"Built-in tool usage. Returned only when a built-in tool was used.","properties":{"web_search_requests":{"type":"integer","description":"Number of searches executed, used for search billing.","uniqueKey":"oneOf.0.usage.server_tool_use.web_search_requests","typeLabel":"integer"}},"uniqueKey":"oneOf.0.usage.server_tool_use","typeLabel":"object"},"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"}},"isRequired":true,"uniqueKey":"oneOf.0.usage","typeLabel":"object"},"stop_details":{"type":"object","description":"Additional detail about why the model stopped. Returned only when `stop_reason` is `refusal`.","properties":{"type":{"type":"string","enum":["refusal"],"description":"The stop detail type. Always `refusal`.","uniqueKey":"oneOf.0.stop_details.type","typeLabel":"enum\u003cstring>"},"explanation":{"type":"string","description":"An explanation of why the request was refused.","uniqueKey":"oneOf.0.stop_details.explanation","typeLabel":"string"}},"uniqueKey":"oneOf.0.stop_details","typeLabel":"object"},"stop_sequence":{"oneOf":[{"type":"string","description":"The stop sequence that was hit, or `null`.","uniqueKey":"oneOf.0.stop_sequence.oneOf.0","typeLabel":"string"},{"type":"null","description":"The stop sequence that was hit, or `null`.","uniqueKey":"oneOf.0.stop_sequence.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.stop_sequence","typeLabel":"string | null"}},"uniqueKey":"oneOf.0","typeLabel":"Non-streaming · object"},{"type":"object","title":"Streaming","description":"A streaming SSE event. Returned when `stream=true`. Events arrive in order: `message_start` → `content_block_start`/`content_block_delta`/`content_block_stop` → `message_delta` → `message_stop`. `ping` may appear anywhere and can be ignored. On error, an `error` event is sent.","required":["type"],"properties":{"type":{"type":"string","enum":["message_start","content_block_start","content_block_delta","content_block_stop","message_delta","message_stop","ping","error"],"description":"The event type.","isRequired":true,"uniqueKey":"oneOf.1.type","typeLabel":"enum\u003cstring>"},"message":{"type":"object","description":"Present in `message_start`. The initial message (id, model, role, initial usage).","uniqueKey":"oneOf.1.message","typeLabel":"object"},"index":{"type":"integer","description":"Present in `content_block_*`. The content block index; concatenate deltas by index.","uniqueKey":"oneOf.1.index","typeLabel":"integer"},"content_block":{"type":"object","description":"Present in `content_block_start`. The block that is starting. For built-in search, the `web_search_tool_result` block carries the full results here.","uniqueKey":"oneOf.1.content_block","typeLabel":"object"},"delta":{"type":"object","description":"Present in `content_block_delta` (`text_delta` / `thinking_delta` / `signature_delta` / `input_json_delta`) and `message_delta` (`stop_reason`, `stop_details`, `stop_sequence`).","uniqueKey":"oneOf.1.delta","typeLabel":"object"},"usage":{"type":"object","description":"Present in `message_delta`. Cumulative token counts (not incremental).","uniqueKey":"oneOf.1.usage","typeLabel":"object"},"error":{"type":"object","description":"Present in `error` events.","uniqueKey":"oneOf.1.error","typeLabel":"object"}},"uniqueKey":"oneOf.1","typeLabel":"Streaming · object"}],"uniqueKey":"","typeLabel":"Non-streaming · object | Streaming · object"},"examples":{"pureModel":{"title":"pureModel","summary":"Non-streaming, plain model call","value":{"id":"msg_01XFDUDYJgAACzvnptvVoYEL","type":"message","role":"assistant","model":"anthropic/claude-opus-5.5","content":[{"type":"text","text":"Attention lets a model dynamically weight its inputs and focus on the most relevant information."}],"stop_reason":"end_turn","stop_sequence":null,"usage":{"input_tokens":18,"output_tokens":32}}},"promptCache":{"title":"promptCache","summary":"Non-streaming, prompt cache hit","value":{"id":"msg_01CacheHit789","type":"message","role":"assistant","model":"anthropic/claude-sonnet-5.5","content":[{"type":"text","text":"Per the manual, 7-day no-reason returns are supported."}],"stop_reason":"end_turn","stop_sequence":null,"usage":{"input_tokens":58,"output_tokens":18,"cache_creation_input_tokens":0,"cache_read_input_tokens":2048}}},"withSearch":{"title":"withSearch","summary":"Non-streaming, with built-in search","value":{"id":"msg_013Zva2CMHLNnXjNJJKqJ2EF","type":"message","role":"assistant","model":"anthropic/claude-sonnet-5.5","content":[{"type":"server_tool_use","id":"srvtoolu_01ABC123","name":"octen_search","input":{"query":"weather Beijing today"}},{"type":"web_search_tool_result","tool_use_id":"srvtoolu_01ABC123","content":[{"type":"web_search_result","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"}]},{"type":"text","text":"Beijing is partly cloudy today with a high of 32C.","citations":[{"type":"web_search_result_location","url":"https://weather.com/beijing","title":"Beijing Weather","cited_text":"Partly cloudy, high of 32C","encrypted_index":"EpEBCioIAhgBIiQ4MmJjZD..."}]}],"stop_reason":"end_turn","stop_sequence":null,"usage":{"input_tokens":1058,"output_tokens":132,"server_tool_use":{"web_search_requests":1}}}},"withMultimodalSearch":{"title":"withMultimodalSearch","summary":"Non-streaming, with built-in multimodal search","value":{"id":"msg_0123456789abcdef01234567","type":"message","role":"assistant","model":"anthropic/claude-sonnet-5.5","content":[{"type":"server_tool_use","id":"msg_0123456789abcdef01234567","name":"octen_multimodal_search","input":{"query":"Show me photos of the newest Tokyo skyscrapers."}},{"type":"web_search_tool_result","tool_use_id":"msg_0123456789abcdef01234567","content":[{"type":"web_search_result","title":"Azabudai Hills Mori JP Tower at dusk","url":"https://example.com/images/azabudai-hills.jpg","result_type":"image","num":1,"cover_url":"https://cdn.octen.ai/img?t=example","source_page":"https://example.com/tokyo-skyscrapers"},{"type":"web_search_result","title":"Twenty-first-century Tokyo architecture","url":"https://example.com/articles/tokyo-architecture","result_type":"web","num":2,"highlights":"Azabudai Hills Mori JP Tower, about 325 m tall, opened in late 2023.","authors":"Example Magazine","time_published":"2026-09-30T23:38:31Z"}]},{"type":"text","text":"The tallest of Tokyo's new skyscrapers is the Azabudai Hills Mori JP Tower, about 325 m tall.\n\n"}],"stop_reason":"end_turn","stop_sequence":null,"usage":{"input_tokens":5896,"output_tokens":727,"server_tool_use":{"web_search_requests":1},"num_web_search_queries":1,"num_image_search_queries":1}}},"toolUse":{"title":"toolUse","summary":"Non-streaming, custom tool call","value":{"id":"msg_01HJK456","type":"message","role":"assistant","model":"openai/gpt-5.4","content":[{"type":"tool_use","id":"toolu_abc123","name":"create_reminder","input":{"content":"Rain in Shanghai tomorrow, bring an umbrella","time":"2026-06-11T08:00:00+08:00"}}],"stop_reason":"tool_use","stop_sequence":null,"usage":{"input_tokens":230,"output_tokens":45}}},"streamMessageStart":{"title":"streamMessageStart","summary":"Streaming, message_start event","value":{"type":"message_start","message":{"id":"msg_01XFD...","type":"message","role":"assistant","model":"anthropic/claude-sonnet-5.5","content":[],"usage":{"input_tokens":1058,"output_tokens":0}}}},"streamContentDelta":{"title":"streamContentDelta","summary":"Streaming, content_block_delta event","value":{"type":"content_block_delta","index":2,"delta":{"type":"text_delta","text":"北京今天多云转晴,最高气温32度。"}}},"streamMessageDelta":{"title":"streamMessageDelta","summary":"Streaming, message_delta event (cumulative usage)","value":{"type":"message_delta","delta":{"stop_reason":"end_turn","stop_sequence":null},"usage":{"output_tokens":132,"server_tool_use":{"web_search_requests":1}}}},"streamMessageStop":{"title":"streamMessageStop","summary":"Streaming, message_stop event","value":{"type":"message_stop"}}},"exampleType":"examples"}},"exampleType":"examples"},"21ea1cec-06aa-4d56-a98b-ba7e56b7b1b2":{"description":"Missing or invalid parameter","content":{"application/json":{"schema":{"type":"object","description":"Error body in the Anthropic protocol format.","required":["type","error"],"properties":{"type":{"type":"string","enum":["error"],"description":"Always `error`.","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"error":{"type":"object","properties":{"type":{"type":"string","description":"The error category, e.g. `invalid_request_error`.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"message":{"type":"string","description":"A human-readable description of the error.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["type","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"type":"error","error":{"type":"invalid_request_error","message":"Missing or invalid parameter"}},"examples":{"Example":{"title":"Example","value":{"type":"error","error":{"type":"invalid_request_error","message":"Missing or invalid parameter"}}}},"exampleType":"examples"}},"exampleType":"examples"},"f67e10d5-14ba-4abb-97c9-e05c9d1cedd0":{"description":"Invalid API Key","content":{"application/json":{"schema":{"type":"object","description":"Error body in the Anthropic protocol format.","required":["type","error"],"properties":{"type":{"type":"string","enum":["error"],"description":"Always `error`.","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"error":{"type":"object","properties":{"type":{"type":"string","description":"The error category, e.g. `invalid_request_error`.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"message":{"type":"string","description":"A human-readable description of the error.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["type","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"type":"error","error":{"type":"authentication_error","message":"Invalid API Key"}},"examples":{"Example":{"title":"Example","value":{"type":"error","error":{"type":"authentication_error","message":"Invalid API Key"}}}},"exampleType":"examples"}},"exampleType":"examples"},"3f0c36a7-7f7a-4d32-bdc4-052996f324bb":{"description":"Insufficient balance in account","content":{"application/json":{"schema":{"type":"object","description":"Error body in the Anthropic protocol format.","required":["type","error"],"properties":{"type":{"type":"string","enum":["error"],"description":"Always `error`.","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"error":{"type":"object","properties":{"type":{"type":"string","description":"The error category, e.g. `invalid_request_error`.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"message":{"type":"string","description":"A human-readable description of the error.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["type","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"type":"error","error":{"type":"permission_error","message":"Insufficient balance in account"}},"examples":{"Example":{"title":"Example","value":{"type":"error","error":{"type":"permission_error","message":"Insufficient balance in account"}}}},"exampleType":"examples"}},"exampleType":"examples"},"c1adf4db-218f-44d5-b5a4-717de626464b":{"description":"Model or resource not found","content":{"application/json":{"schema":{"type":"object","description":"Error body in the Anthropic protocol format.","required":["type","error"],"properties":{"type":{"type":"string","enum":["error"],"description":"Always `error`.","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"error":{"type":"object","properties":{"type":{"type":"string","description":"The error category, e.g. `invalid_request_error`.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"message":{"type":"string","description":"A human-readable description of the error.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["type","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"type":"error","error":{"type":"not_found_error","message":"Model or resource not found"}},"examples":{"Example":{"title":"Example","value":{"type":"error","error":{"type":"not_found_error","message":"Model or resource not found"}}}},"exampleType":"examples"}},"exampleType":"examples"},"268743c4-f416-4118-940f-e76f3631a4f6":{"description":"Request exceeds the maximum allowed size","content":{"application/json":{"schema":{"type":"object","description":"Error body in the Anthropic protocol format.","required":["type","error"],"properties":{"type":{"type":"string","enum":["error"],"description":"Always `error`.","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"error":{"type":"object","properties":{"type":{"type":"string","description":"The error category, e.g. `invalid_request_error`.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"message":{"type":"string","description":"A human-readable description of the error.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["type","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"type":"error","error":{"type":"request_too_large","message":"Request exceeds the maximum allowed size"}},"examples":{"Example":{"title":"Example","value":{"type":"error","error":{"type":"request_too_large","message":"Request exceeds the maximum allowed size"}}}},"exampleType":"examples"}},"exampleType":"examples"},"964cc048-eca8-47e5-bc88-129a66f7cd50":{"description":"Exceeding the rate limit","content":{"application/json":{"schema":{"type":"object","description":"Error body in the Anthropic protocol format.","required":["type","error"],"properties":{"type":{"type":"string","enum":["error"],"description":"Always `error`.","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"error":{"type":"object","properties":{"type":{"type":"string","description":"The error category, e.g. `invalid_request_error`.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"message":{"type":"string","description":"A human-readable description of the error.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["type","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"type":"error","error":{"type":"rate_limit_error","message":"Exceeding the rate limit"}},"examples":{"Example":{"title":"Example","value":{"type":"error","error":{"type":"rate_limit_error","message":"Exceeding the rate limit"}}}},"exampleType":"examples"}},"exampleType":"examples"},"ba883a4c-a147-4719-894d-ee2e87991ee5":{"description":"Internal error","content":{"application/json":{"schema":{"type":"object","description":"Error body in the Anthropic protocol format.","required":["type","error"],"properties":{"type":{"type":"string","enum":["error"],"description":"Always `error`.","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"error":{"type":"object","properties":{"type":{"type":"string","description":"The error category, e.g. `invalid_request_error`.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"message":{"type":"string","description":"A human-readable description of the error.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["type","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"type":"error","error":{"type":"api_error","message":"Internal error"}},"examples":{"Example":{"title":"Example","value":{"type":"error","error":{"type":"api_error","message":"Internal error"}}}},"exampleType":"examples"}},"exampleType":"examples"},"f38423b2-4e22-46fa-8ce5-f2dd719da99b":{"description":"Service is temporarily overloaded, retry later","content":{"application/json":{"schema":{"type":"object","description":"Error body in the Anthropic protocol format.","required":["type","error"],"properties":{"type":{"type":"string","enum":["error"],"description":"Always `error`.","isRequired":true,"uniqueKey":"type","typeLabel":"enum\u003cstring>"},"error":{"type":"object","properties":{"type":{"type":"string","description":"The error category, e.g. `invalid_request_error`.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"message":{"type":"string","description":"A human-readable description of the error.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"}},"required":["type","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"type":"error","error":{"type":"overloaded_error","message":"Service is temporarily overloaded, retry later"}},"examples":{"Example":{"title":"Example","value":{"type":"error","error":{"type":"overloaded_error","message":"Service is temporarily overloaded, retry later"}}}},"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 (Anthropic-Compatible) API Reference - Octen Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-17T16:05:48.248Z","originalFileLocation":"api-reference/messages.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 Anthropic Messages 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 (Anthropic-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/messages\">\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 (Anthropic-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/messages\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/messages.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/messages#webpage\",\"url\":\"https://docs.octen.ai/api-reference/messages\",\"name\":\"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.\",\"dateModified\":\"2026-11-17T16:05:48.248Z\",\"isPartOf\":{\"@id\":\"https://docs.octen.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.octen.ai/api-reference/messages#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.octen.ai/api-reference/messages#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Applications\",\"item\":\"https://docs.octen.ai/api-reference/answer\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Auto Search\",\"item\":\"https://docs.octen.ai/api-reference/chat-completions\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"LLM Chat (Anthropic-Compatible) API Reference\",\"item\":\"https://docs.octen.ai/api-reference/messages\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.octen.ai/api-reference/messages#apireference\",\"headline\":\"LLM Chat (Anthropic-Compatible) API Reference\",\"name\":\"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.\",\"url\":\"https://docs.octen.ai/api-reference/messages\",\"mainEntityOfPage\":{\"@id\":\"https://docs.octen.ai/api-reference/messages#webpage\"},\"image\":\"https://octen.ai/_next/static/media/octen-cover.dc74905e.png\",\"dateModified\":\"2026-11-17T16:05:48.248Z\",\"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/messages.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","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","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","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","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","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 (Anthropic-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"]}