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.
Machine-readable failure code, present when status is failed.
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":""},"chroma":{"latestBuiltDeploymentHistoryId":"6ae2095e5ca9b4a2f463df1a","collectionId":"cde2c232-40e8-4ec3-ace9-253104418a48","liveDeploymentHistoryId":"6ae2095e5ca9b4a2f463df1a","schemaVersion":"v3"},"feedback":{"thumbs":true},"entitlements":{"AI_CHAT":{"status":"DISABLED"},"WEB_MCP":{"status":"DISABLED"},"NARRATION":{"status":"DISABLED"}},"buildId":"6ae2095e5ca9b4a2f463df1a","clientVersion":"0.0.4043","searchFilterCounts":[{"language":"default","tag":"Documentation","count":37},{"language":"default","tag":"API Reference","count":20},{"language":"default","tag":"Capabilities","count":16},{"language":"default","tag":"Applications","count":14},{"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":"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":"byok-sep-25","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":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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}],"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-video","slug":"/api-reference/get-video","pageMetadata":{"title":"Video Download API Reference","description":"Returns a video generation task by id.","deprecated":null,"version":null,"sidebarTitle":"Video Download","openapi":"/api-reference/openapi.json get /v1/videos/{id}","href":"/api-reference/get-video","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 video 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":"Video Download API Reference","description":"Returns a video generation task by id.","deprecated":null,"version":null,"sidebarTitle":"Video Download","openapi":"/api-reference/openapi.json get /v1/videos/{id}","href":"/api-reference/get-video","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/octen-ai/1394afa843283735/tryit-button.js"],"openApiReferenceData":{"operation":{"summary":"Download a video","description":"Returns a video generation task by id.","operationId":"get-video","x-mint":{"href":"/api-reference/get-video","metadata":{"title":"Video Download API Reference","sidebarTitle":"Video Download"}},"parameters":["f9c6eab2-8547-442d-a9c1-7b9870c3f85c"],"responses":{"200":"e1e70eec-6331-4b84-856f-964b65072209","401":"bc9a19b5-8abb-4006-83fb-2c5e71c7f44b","404":"fa04c824-8e65-4c7f-a747-a46a64c941f5","429":"57d3f8c3-e0e0-456e-b56b-e1c002225714","500":"8f471c12-98db-4a3c-a5e4-35694a4fc0e3"},"method":"get","type":"path","servers":["32b16a1c-cf4e-4b68-aff3-bedcf295ebee"],"security":["5362b26e-229d-4ca2-9102-1d00c63cffb4","40d8048b-3b20-4ae1-95d6-d0e2619bcdd9"],"path":"/v1/videos/{id}","baseUrlOptions":["https://api.octen.ai"],"title":"Download a video","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated","prefillPlaygroundWithExample":true,"prefillPlaygroundExamples":[]},"dependencies":{"parameters":{"f9c6eab2-8547-442d-a9c1-7b9870c3f85c":{"name":"id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"description":"The task id returned by the Video Generation API.","uniqueKey":"","typeLabel":"string"},"example":"video-1756789012-abc123","description":"The task id returned by the Video Generation API."}},"responses":{"e1e70eec-6331-4b84-856f-964b65072209":{"description":"Successful video task response","content":{"application/json":{"schema":{"type":"object","required":["id","model","status","created"],"properties":{"id":{"type":"string","description":"Unique task id, used to download the video.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"model":{"type":"string","description":"The model used for this task.","isRequired":true,"uniqueKey":"model","typeLabel":"string"},"status":{"type":"string","enum":["queued","in_progress","completed","failed"],"description":"Task state.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"created":{"type":"integer","description":"Unix timestamp in seconds when the task was created.","isRequired":true,"uniqueKey":"created","typeLabel":"integer"},"video_url":{"type":"string","description":"Signed download URL for the video file, present when `status` is `completed`. Valid for 7 days after generation.","uniqueKey":"video_url","typeLabel":"string"},"expires_at":{"type":"integer","description":"Unix timestamp in seconds when `video_url` expires. Present when `status` is `completed`.","uniqueKey":"expires_at","typeLabel":"integer"},"duration":{"type":"integer","description":"Length of the generated video in seconds. Present when `status` is `completed`.","uniqueKey":"duration","typeLabel":"integer"},"resolution":{"type":"string","description":"Resolution of the generated video. Present when `status` is `completed`.","uniqueKey":"resolution","typeLabel":"string"},"usage":{"type":"object","description":"Metering for the task. Present only when `status` is `completed`.","properties":{"video_seconds":{"type":"integer","description":"Video length in seconds.","uniqueKey":"usage.video_seconds","typeLabel":"integer"},"video_tokens":{"type":"integer","description":"Billed token count.","uniqueKey":"usage.video_tokens","typeLabel":"integer"},"input_image_count":{"type":"integer","description":"Number of input images, returned when images were supplied.","uniqueKey":"usage.input_image_count","typeLabel":"integer"}},"uniqueKey":"usage","typeLabel":"object"},"error":{"type":"string","description":"Failure reason, present when `status` is `failed`.","uniqueKey":"error","typeLabel":"string"},"code":{"type":"string","description":"Machine-readable failure code, present when `status` is `failed`.","uniqueKey":"code","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","model":"\u003cstring>","status":"queued","created":123,"video_url":"\u003cstring>","expires_at":123,"duration":123,"resolution":"\u003cstring>","usage":{"video_seconds":123,"video_tokens":123,"input_image_count":123},"error":"\u003cstring>","code":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"bc9a19b5-8abb-4006-83fb-2c5e71c7f44b":{"description":"Invalid API Key","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"},"examples":{"Example":{"title":"Example","value":{"code":123,"msg":"\u003cstring>","request_id":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"fa04c824-8e65-4c7f-a747-a46a64c941f5":{"description":"Video task not found","content":{"application/json":{"schema":{"type":"object","description":"Error body in the OpenAI protocol format.","required":["error"],"properties":{"error":{"type":"object","properties":{"message":{"type":"string","description":"A human-readable description of the error.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"The error category, e.g. `invalid_request_error`.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"param":{"oneOf":[{"type":"string","description":"The parameter related to the error, if any.","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"The parameter related to the error, if any.","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","description":"A machine-readable error code, if any.","uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","description":"A machine-readable error code, if any.","uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.code","typeLabel":"string | null"}},"required":["message","type"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","type":"\u003cstring>","param":"\u003cstring>","code":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"57d3f8c3-e0e0-456e-b56b-e1c002225714":{"description":"Exceeding the rate limit","content":{"application/json":{"schema":{"type":"object","description":"Error body in the OpenAI protocol format.","required":["error"],"properties":{"error":{"type":"object","properties":{"message":{"type":"string","description":"A human-readable description of the error.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"The error category, e.g. `invalid_request_error`.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"param":{"oneOf":[{"type":"string","description":"The parameter related to the error, if any.","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"The parameter related to the error, if any.","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","description":"A machine-readable error code, if any.","uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","description":"A machine-readable error code, if any.","uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.code","typeLabel":"string | null"}},"required":["message","type"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","type":"\u003cstring>","param":"\u003cstring>","code":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"8f471c12-98db-4a3c-a5e4-35694a4fc0e3":{"description":"Internal error","content":{"application/json":{"schema":{"type":"object","description":"Error body in the OpenAI protocol format.","required":["error"],"properties":{"error":{"type":"object","properties":{"message":{"type":"string","description":"A human-readable description of the error.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"type":{"type":"string","description":"The error category, e.g. `invalid_request_error`.","isRequired":true,"uniqueKey":"error.type","typeLabel":"string"},"param":{"oneOf":[{"type":"string","description":"The parameter related to the error, if any.","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"The parameter related to the error, if any.","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"code":{"oneOf":[{"type":"string","description":"A machine-readable error code, if any.","uniqueKey":"error.code.oneOf.0","typeLabel":"string"},{"type":"null","description":"A machine-readable error code, if any.","uniqueKey":"error.code.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.code","typeLabel":"string | null"}},"required":["message","type"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","type":"\u003cstring>","param":"\u003cstring>","code":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"5362b26e-229d-4ca2-9102-1d00c63cffb4":{"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"}},"40d8048b-3b20-4ae1-95d6-d0e2619bcdd9":{"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":{"32b16a1c-cf4e-4b68-aff3-bedcf295ebee":{"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":"Video Download API Reference - Octen Docs","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-28T14:40:38.378Z","originalFileLocation":"api-reference/get-video.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 video 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=\"Video Download 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-video\">\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=\"Video Download 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-video\">\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-video.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-video#webpage\",\"url\":\"https://docs.octen.ai/api-reference/get-video\",\"name\":\"Video Download API Reference\",\"description\":\"Returns a video generation task by id.\",\"dateModified\":\"2026-10-28T14:40:38.378Z\",\"isPartOf\":{\"@id\":\"https://docs.octen.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.octen.ai/api-reference/get-video#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.octen.ai/api-reference/get-video#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\":\"Video Download API Reference\",\"item\":\"https://docs.octen.ai/api-reference/get-video\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.octen.ai/api-reference/get-video#apireference\",\"headline\":\"Video Download API Reference\",\"name\":\"Video Download API Reference\",\"description\":\"Returns a video generation task by id.\",\"url\":\"https://docs.octen.ai/api-reference/get-video\",\"mainEntityOfPage\":{\"@id\":\"https://docs.octen.ai/api-reference/get-video#webpage\"},\"image\":\"https://octen.ai/_next/static/media/octen-cover.dc74905e.png\",\"dateModified\":\"2026-10-28T14:40:38.378Z\",\"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":"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","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","description":"Generates a video from a text prompt, optionally guided by reference images.","deprecated":null,"version":null,"sidebarTitle":"Video Generation","openapi":"/api-reference/openapi.json post /v1/videos","href":"/api-reference/post-video"},{"title":"Video Download API Reference","deprecated":null,"version":null,"sidebarTitle":"Video Download","openapi":"/api-reference/openapi.json get /v1/videos/{id}","href":"/api-reference/get-video"}]}]}]}]},"basePath":"","title":"Video Download API Reference - Octen Docs","buildId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","deploymentId":"dpl_G9nrg4qeJSZtah1Ziwbc2n6WkLch","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B7XKH4J3.js","utils-lOYzL7z-.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DF6jUUIM.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Dpsj5f7C.js","snippetPresets-CYeiDe8v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CUFz1YZ_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-D8H_iLS4.js","shallow-DdluZBHX.js","getApiPlaygroundDisplay-B9922vev.js","CodeSnippet-CMoRNGYs.js","CodeSnippets-DwyrPHuw.js","Page-DSVu9Ucl.js","getPastedJson-G-zIvlHh.js","icon-B03fnEy0.js","MethodPill-CW7teklc.js","DuplicateIcon-CtO8eekd.js","createIcon-DZTKdM_A.js","DynamicMarkdown-D5M2At0B.js","SectionHeading-C_2NaA2U.js","axios-vUo_bRtp.js","Markdown-D7QRHV3m.js","clsx-D1Z-ELXV.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-lvhuD9Du.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CKfC4ywL.js"]}