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.
Metering for the task. Present only when status is succeeded.
Show child attributes
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":"6af1f60ef9312b54bbd3e5f8","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"Documentation","count":37},{"language":"default","tag":"API Reference","count":22},{"language":"default","tag":"Capabilities","count":16},{"language":"default","tag":"Applications","count":16},{"language":"default","tag":"APIs","count":11},{"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},{"language":"default","tag":"Overview","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":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"comment-mode","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/get-grounded-generation","slug":"/api-reference/get-grounded-generation","pageMetadata":{"title":"Generation Result API Reference","description":"Returns a grounded generation task by id.","deprecated":null,"version":null,"sidebarTitle":"Generation Result","openapi":"/api-reference/openapi.json get /v1/grounded-generation/{generation_id}","href":"/api-reference/get-grounded-generation","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Returns a grounded generation task by id.\"\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":"Generation Result API Reference","description":"Returns a grounded generation task by id.","deprecated":null,"version":null,"sidebarTitle":"Generation Result","openapi":"/api-reference/openapi.json get /v1/grounded-generation/{generation_id}","href":"/api-reference/get-grounded-generation","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/octen-ai/1394afa843283735/tryit-button.js"],"openApiReferenceData":{"operation":{"summary":"Get a generation result","description":"Returns a grounded generation task by id.","operationId":"get-grounded-generation","x-mint":{"href":"/api-reference/get-grounded-generation","metadata":{"title":"Generation Result API Reference","sidebarTitle":"Generation Result"}},"parameters":["a39a251c-5032-44c6-9d19-0e841a5461d5"],"responses":{"200":"5161dce0-2ee8-4b0e-919a-68f49a96075b","401":"869d0054-4dcd-4ad2-b3bb-c17f106eb453","404":"4a5b4f94-19dd-4b60-a1b8-48734adf90eb","429":"d7df64db-b97c-4a89-89aa-ceeacdfc4ae7","500":"8ac12ed2-cd74-4313-a028-74debef514a2"},"method":"get","type":"path","servers":["5fd65740-f929-41da-9bbb-1cbf6f244b41"],"security":["3641a170-0933-482a-8caf-16197fc63f1c","7fec3a23-89db-45ea-998a-1e809310f48b"],"path":"/v1/grounded-generation/{generation_id}","baseUrlOptions":["https://api.octen.ai"],"title":"Get a generation result","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{"a39a251c-5032-44c6-9d19-0e841a5461d5":{"name":"generation_id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"The task id returned by the Grounded Generation API.","uniqueKey":"","typeLabel":"string"},"example":"mm-3ca3c4ff37c546b6b59f2e9cde09f2f6","description":"The task id returned by the Grounded Generation API."}},"responses":{"5161dce0-2ee8-4b0e-919a-68f49a96075b":{"description":"Successful grounded generation task response","content":{"application/json":{"schema":{"type":"object","required":["request_id","generation_id","modality","status","created_at","updated_at"],"properties":{"request_id":{"type":"string","description":"Unique identifier for the request.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"},"generation_id":{"type":"string","description":"Unique task id.","isRequired":true,"uniqueKey":"generation_id","typeLabel":"string"},"modality":{"type":"string","enum":["image","video"],"description":"The type of output this task generates.","isRequired":true,"uniqueKey":"modality","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["queued","running","succeeded","failed"],"description":"Task state.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"created_at":{"type":"integer","description":"Unix timestamp in seconds when the task was created.","isRequired":true,"uniqueKey":"created_at","typeLabel":"integer"},"updated_at":{"type":"integer","description":"Unix timestamp in seconds when the task was last updated.","isRequired":true,"uniqueKey":"updated_at","typeLabel":"integer"},"output_url":{"type":"string","description":"Signed download URL for the output, present when `status` is `succeeded`. Requires no API key, and is valid for 7 days after the task was created.","uniqueKey":"output_url","typeLabel":"string"},"references":{"type":"array","items":{"type":"object","description":"A single piece of reference material.","properties":{"source_id":{"type":"string","description":"Identifier of the reference, such as `source1`.","uniqueKey":"references.items.[INDEX].source_id","typeLabel":"string"},"url":{"type":"string","description":"The media URL.","uniqueKey":"references.items.[INDEX].url","typeLabel":"string"},"title":{"type":"string","description":"The title of the reference.","uniqueKey":"references.items.[INDEX].title","typeLabel":"string"},"cover_url":{"type":"string","description":"Thumbnail URL.","uniqueKey":"references.items.[INDEX].cover_url","typeLabel":"string"}},"uniqueKey":"references.items.[INDEX]","typeLabel":"object"},"description":"The reference material used to generate the output.","uniqueKey":"references","typeLabel":"object[]"},"search_results":{"type":"array","items":{"type":"object","description":"The results for one search query.","properties":{"query":{"type":"string","description":"The query the task searched for.","uniqueKey":"search_results.items.[INDEX].query","typeLabel":"string"},"results":{"type":"array","items":{"type":"object","description":"A single search result.","properties":{"type":{"type":"string","enum":["image","video"],"description":"Media type of the result.","uniqueKey":"search_results.items.[INDEX].results.items.[INDEX].type","typeLabel":"enum\u003cstring>"},"title":{"type":"string","description":"The title of the result.","uniqueKey":"search_results.items.[INDEX].results.items.[INDEX].title","typeLabel":"string"},"url":{"type":"string","description":"The media URL.","uniqueKey":"search_results.items.[INDEX].results.items.[INDEX].url","typeLabel":"string"},"source_page":{"type":"string","description":"URL of the original page hosting the media.","uniqueKey":"search_results.items.[INDEX].results.items.[INDEX].source_page","typeLabel":"string"},"description":{"type":"string","description":"Description of the result.","uniqueKey":"search_results.items.[INDEX].results.items.[INDEX].description","typeLabel":"string"},"cover_url":{"type":"string","description":"Thumbnail URL.","uniqueKey":"search_results.items.[INDEX].results.items.[INDEX].cover_url","typeLabel":"string"}},"uniqueKey":"search_results.items.[INDEX].results.items.[INDEX]","typeLabel":"object"},"description":"Results for this query.","uniqueKey":"search_results.items.[INDEX].results","typeLabel":"object[]"}},"uniqueKey":"search_results.items.[INDEX]","typeLabel":"object"},"description":"The search results the references were selected from, grouped by query.","uniqueKey":"search_results","typeLabel":"object[]"},"error":{"type":"object","description":"Failure reason, present when `status` is `failed`. Failed tasks are not billed.","properties":{"code":{"type":"string","enum":["MM_GENERATION_CONTENT_POLICY","MM_GENERATION_INPUT_IMAGE_PRIVACY_BLOCKED","MM_GENERATION_CONTENT_NOT_SUPPORTED","MM_GENERATION_NO_REFERENCE_MATERIAL","MM_GENERATION_REJECTED","MM_GENERATION_TIMEOUT","MM_GENERATION_FAILED"],"description":"`MM_GENERATION_CONTENT_POLICY`: the prompt triggered a content policy; `MM_GENERATION_INPUT_IMAGE_PRIVACY_BLOCKED`: the reference material was blocked for privacy; `MM_GENERATION_CONTENT_NOT_SUPPORTED`: the content is not supported; `MM_GENERATION_NO_REFERENCE_MATERIAL`: no usable reference material was found; `MM_GENERATION_REJECTED`: the model rejected the request; `MM_GENERATION_TIMEOUT`: generation timed out, retry; `MM_GENERATION_FAILED`: generation failed for another reason, retry.","uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"A message describing the failure.","uniqueKey":"error.message","typeLabel":"string"}},"uniqueKey":"error","typeLabel":"object"},"usage":{"type":"object","description":"Metering for the task. Present only when `status` is `succeeded`.","properties":{"image_count":{"type":"integer","description":"Number of images generated. Returned when `modality` is `image`.","uniqueKey":"usage.image_count","typeLabel":"integer"},"video_count":{"type":"integer","description":"Number of videos generated. Returned when `modality` is `video`.","uniqueKey":"usage.video_count","typeLabel":"integer"},"video_seconds":{"type":"integer","description":"Length of the generated video in seconds. Returned when `modality` is `video`.","uniqueKey":"usage.video_seconds","typeLabel":"integer"}},"uniqueKey":"usage","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"request_id":"20260924021635985E9WHYPV4FI","generation_id":"mm-3ca3c4ff37c546b6b59f2e9cde09f2f6","modality":"image","status":"succeeded","output_url":"https://apt-multimodal-output.octen.ai/apt-multimodal-output/images%2F2026_09_24%2Fmm-3ca3c4ff37c546b6b59f2e9cde09f2f6.jpg?se=...\u0026sig=...","references":[{"source_id":"source1","url":"https://upload.wikimedia.org/wikipedia/commons/2/26/Cristiano_Ronaldo_2026.jpg","title":"Cristiano Ronaldo - Wikipedia","cover_url":"https://encrypted-tbn0.gstatic.com/images?q=tbn:..."}],"search_results":[{"query":"Cristiano Ronaldo","results":[{"type":"image","title":"Cristiano Ronaldo - Wikipedia","url":"https://upload.wikimedia.org/wikipedia/commons/2/26/Cristiano_Ronaldo_2026.jpg","source_page":"https://en.wikipedia.org/wiki/Cristiano_Ronaldo","description":"en.wikipedia.org","cover_url":"https://encrypted-tbn0.gstatic.com/images?q=tbn:..."}]}],"created_at":1790215572,"updated_at":1790215601,"usage":{"image_count":1}},"examples":{"Example":{"title":"Example","value":{"request_id":"20260924021635985E9WHYPV4FI","generation_id":"mm-3ca3c4ff37c546b6b59f2e9cde09f2f6","modality":"image","status":"succeeded","output_url":"https://apt-multimodal-output.octen.ai/apt-multimodal-output/images%2F2026_09_24%2Fmm-3ca3c4ff37c546b6b59f2e9cde09f2f6.jpg?se=...\u0026sig=...","references":[{"source_id":"source1","url":"https://upload.wikimedia.org/wikipedia/commons/2/26/Cristiano_Ronaldo_2026.jpg","title":"Cristiano Ronaldo - Wikipedia","cover_url":"https://encrypted-tbn0.gstatic.com/images?q=tbn:..."}],"search_results":[{"query":"Cristiano Ronaldo","results":[{"type":"image","title":"Cristiano Ronaldo - Wikipedia","url":"https://upload.wikimedia.org/wikipedia/commons/2/26/Cristiano_Ronaldo_2026.jpg","source_page":"https://en.wikipedia.org/wiki/Cristiano_Ronaldo","description":"en.wikipedia.org","cover_url":"https://encrypted-tbn0.gstatic.com/images?q=tbn:..."}]}],"created_at":1790215572,"updated_at":1790215601,"usage":{"image_count":1}}}},"exampleType":"examples"}},"exampleType":"examples"},"869d0054-4dcd-4ad2-b3bb-c17f106eb453":{"description":"Invalid API Key — Returned when the API key is missing or invalid.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Business status code. Non-zero values indicate an error.","isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"msg":{"type":"string","description":"A message describing the error.","isRequired":true,"uniqueKey":"msg","typeLabel":"string"},"request_id":{"type":"string","description":"Unique identifier for the request.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"}},"required":["code","msg","request_id"],"uniqueKey":"","typeLabel":"object"},"example":{"code":401,"msg":"Invalid API Key","request_id":"req_abc123def456"},"examples":{"Example":{"title":"Example","value":{"code":401,"msg":"Invalid API Key","request_id":"req_abc123def456"}}},"exampleType":"examples"}},"exampleType":"examples"},"4a5b4f94-19dd-4b60-a1b8-48734adf90eb":{"description":"Task not found or expired — Returned when the generation id does not exist or is older than 7 days.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Business status code. Non-zero values indicate an error.","isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"msg":{"type":"string","description":"A message describing the error.","isRequired":true,"uniqueKey":"msg","typeLabel":"string"},"request_id":{"type":"string","description":"Unique identifier for the request.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"}},"required":["code","msg","request_id"],"uniqueKey":"","typeLabel":"object"},"example":{"code":404,"msg":"Task not found or expired.","request_id":"req_abc123def456"},"examples":{"Example":{"title":"Example","value":{"code":404,"msg":"Task not found or expired.","request_id":"req_abc123def456"}}},"exampleType":"examples"}},"exampleType":"examples"},"d7df64db-b97c-4a89-89aa-ceeacdfc4ae7":{"description":"Exceeding the rate limit — Returned when the request exceeds the configured rate limit.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Business status code. Non-zero values indicate an error.","isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"msg":{"type":"string","description":"A message describing the error.","isRequired":true,"uniqueKey":"msg","typeLabel":"string"},"request_id":{"type":"string","description":"Unique identifier for the request.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"}},"required":["code","msg","request_id"],"uniqueKey":"","typeLabel":"object"},"example":{"code":429,"msg":"Exceeding the rate limit","request_id":"req_abc123def456"},"examples":{"Example":{"title":"Example","value":{"code":429,"msg":"Exceeding the rate limit","request_id":"req_abc123def456"}}},"exampleType":"examples"}},"exampleType":"examples"},"8ac12ed2-cd74-4313-a028-74debef514a2":{"description":"Internal error — Returned when an unexpected server-side error occurs.","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","description":"Business status code. Non-zero values indicate an error.","isRequired":true,"uniqueKey":"code","typeLabel":"integer"},"msg":{"type":"string","description":"A message describing the error.","isRequired":true,"uniqueKey":"msg","typeLabel":"string"},"request_id":{"type":"string","description":"Unique identifier for the request.","isRequired":true,"uniqueKey":"request_id","typeLabel":"string"}},"required":["code","msg","request_id"],"uniqueKey":"","typeLabel":"object"},"example":{"code":500,"msg":"Internal error","request_id":"req_abc123def456"},"examples":{"Example":{"title":"Example","value":{"code":500,"msg":"Internal error","request_id":"req_abc123def456"}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"3641a170-0933-482a-8caf-16197fc63f1c":{"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"}},"7fec3a23-89db-45ea-998a-1e809310f48b":{"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":{"5fd65740-f929-41da-9bbb-1cbf6f244b41":{"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":"Generation Result API Reference - Octen Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-06T11:48:57.963Z","originalFileLocation":"api-reference/get-grounded-generation.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=\"Returns a grounded generation task by id.\">\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=\"Generation Result 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/get-grounded-generation\">\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=\"Generation Result 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/get-grounded-generation\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/get-grounded-generation.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/get-grounded-generation#webpage\",\"url\":\"https://docs.octen.ai/api-reference/get-grounded-generation\",\"name\":\"Generation Result API Reference\",\"description\":\"Returns a grounded generation task by id.\",\"dateModified\":\"2026-11-06T11:48:57.963Z\",\"isPartOf\":{\"@id\":\"https://docs.octen.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.octen.ai/api-reference/get-grounded-generation#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.octen.ai/api-reference/get-grounded-generation#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Applications\",\"item\":\"https://docs.octen.ai/api-reference/answer\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Generation Result API Reference\",\"item\":\"https://docs.octen.ai/api-reference/get-grounded-generation\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.octen.ai/api-reference/get-grounded-generation#apireference\",\"headline\":\"Generation Result API Reference\",\"name\":\"Generation Result API Reference\",\"description\":\"Returns a grounded generation task by id.\",\"url\":\"https://docs.octen.ai/api-reference/get-grounded-generation\",\"mainEntityOfPage\":{\"@id\":\"https://docs.octen.ai/api-reference/get-grounded-generation#webpage\"},\"image\":\"https://octen.ai/_next/static/media/octen-cover.dc74905e.png\",\"dateModified\":\"2026-11-06T11:48:57.963Z\",\"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\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","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"},{"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","description":"Generates an image or a video from a text prompt, grounded in reference material found by search.","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","description":"Compatible with the OpenAI Chat Completions protocol, with optional built-in `octen_broad_search`, `octen_search`, and `octen_multimodal_search` tools.","deprecated":null,"version":null,"sidebarTitle":"LLM Chat (OpenAI-Compatible)","openapi":"/api-reference/openapi.json post /v1/chat/completions","href":"/api-reference/chat-completions"},"pages":[{"title":"LLM Chat (OpenAI-Compatible) API Reference","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","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":"Generation Result API Reference - Octen Docs","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}