Starts a render and returns the Video plus renderCost, the credits debited for this render (0 when the bundle was free). Quote the same number beforehand with GET /videos//estimate. Creation costs are not included.
The events you will receive on this callback are VIDEO_GENERATION_SUCCESS or VIDEO_GENERATION_FAILED. Both include renderCost and renderCostRefunded.The 200 response is the video plus renderCost, the credits debited for this render. Quote that number first with GET /videos//estimate. When the balance is too low the render does not start, and the 402 body includes renderCost and currentBalance.
Optional HTTPS URL to receive a one-shot webhook notification when this specific render completes (success or fail). The callback is fired once and then discarded. Both this callback and workspace webhooks include renderCost (credits debited for this render) and renderCostRefunded (true when that debit was refunded, which is the usual case when the render fails).
Example:
"https://example.com/hooks/argil-render"
Response
The video plus the credits debited for this render
Url to the embedable preview of the video. Can be watched from web browsers or integrated in other websites before launching the generation. For embedable mode, add ?embed=true to the url.
A dictionary of custom key-value pairs to extend the video metadata. Maximum of 5 key-value pairs of 256 characters allowed.
Show child attributes
Was this page helpful?
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Argil","colors":{"primary":"#741FFF","light":"#741FFF","dark":"#741FFF"},"logo":{"light":"https://mintcdn.com/argil/BBUki6oAamfarwsT/logo/argil.png?fit=max\u0026auto=format\u0026n=BBUki6oAamfarwsT\u0026q=85\u0026s=dfbe09e5c3594d42ae24e6dc64435e34","dark":"https://mintcdn.com/argil/BBUki6oAamfarwsT/logo/argil.png?fit=max\u0026auto=format\u0026n=BBUki6oAamfarwsT\u0026q=85\u0026s=dfbe09e5c3594d42ae24e6dc64435e34"},"favicon":"https://mintcdn.com/argil/YLD0AiDvdvngf94r/favicon.svg?fit=max\u0026auto=format\u0026n=YLD0AiDvdvngf94r\u0026q=85\u0026s=8632e101b747618f73ca5e2209b1796e","api":{"openapi":["openapi.yml"]},"appearance":{"default":"light","strict":true},"navbar":{"links":[{"href":"mailto:support@argil.ai","label":"Support"}],"primary":{"type":"button","label":"Go to the app","href":"https://app.argil.ai"}},"footer":{"socials":{"twitter":"https://twitter.com/argildotai","github":"https://github.com/argildotai","linkedin":"https://www.linkedin.com/company/argilai"}},"styling":{"latex":true},"navigation":{"global":{"anchors":[{"anchor":"Go to the app","icon":"A","href":"https://app.argil.ai"},{"anchor":"Community","icon":"discord","href":"https://discord.gg/CnqyRA3bHg"}]},"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"argil","hasAudioNarration":false,"actualSubdomain":"argil","customDomains":["docs.argil.ai"],"gitSource":{"type":"github","owner":"argildotai","repo":"app-core","deployBranch":"docs-live","contentDirectory":"apps/docs","isPrivate":true,"mountPath":"","label":"","_id":"6ae0947b821834ad75f5d832"},"feedback":{"thumbs":true,"edits":false,"issues":false},"buildId":"6af31d905b327c2363d28d90","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"Developers","count":72},{"language":"default","tag":"Help center","count":36},{"language":"default","tag":"Models","count":35},{"language":"default","tag":"API reference","count":24},{"language":"default","tag":"Video","count":11},{"language":"default","tag":"Audio","count":11},{"language":"default","tag":"Image","count":11},{"language":"default","tag":"Guides","count":9},{"language":"default","tag":"Get Started","count":9},{"language":"default","tag":"Templates","count":8}]},"assistantConfig":{},"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":"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}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"api-reference/endpoint/videos.render","slug":"/api-reference/endpoint/videos.render","pageMetadata":{"openapi":"post /videos/{id}/render","sidebarTitle":"/videos/{id}/render","title":"Render a Video by id","description":"Starts a render and returns the Video plus `renderCost`, the credits debited for this render (0 when the bundle was free). Quote the same number beforehand with GET /videos/{id}/estimate. Creation costs are not included.\n","href":"/api-reference/endpoint/videos.render"},"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: [\"Starts a render and returns the Video plus \", _jsx(_components.code, {\n children: \"renderCost\"\n }), \", the credits debited for this render (0 when the bundle was free). Quote the same number beforehand with GET /videos/\", \"/estimate. Creation costs are not included.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Heading,Note}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);if(!Note)_missingMdxReference(`Note`,true);return _jsxs(_Fragment,{children:[_jsx(Heading,{level:`2`,id:`per-render-callback-url`,children:`Per-Render Callback URL`}),`\n`,_jsxs(_components.p,{children:[`You can optionally pass a `,_jsx(_components.code,{children:`callbackUrl`}),` in the request body to receive a one-shot notification when this specific render completes.`]}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`3`,language:`json`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`json`,children:_jsxs(_components.code,{language:`json`,numberOfLines:`3`,children:[_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`{`})}),`\n`,_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#116329`,\"--shiki-dark\":`#9CDCFE`},children:` \"callbackUrl\"`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#0A3069`,\"--shiki-dark\":`#CE9178`},children:`\"https://example.com/hooks/argil-render\"`})]}),`\n`,_jsx(_components.span,{className:`line`,children:_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`}`})}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`The events you will receive on this callback are `,_jsx(_components.a,{href:`/pages/webhook-events/video-generation-success`,children:`VIDEO_GENERATION_SUCCESS`}),` or `,_jsx(_components.a,{href:`/pages/webhook-events/video-generation-failed`,children:`VIDEO_GENERATION_FAILED`}),`. Both include `,_jsx(_components.code,{children:`renderCost`}),` and `,_jsx(_components.code,{children:`renderCostRefunded`}),`.`]}),`\n`,_jsxs(_components.p,{children:[`The 200 response is the video plus `,_jsx(_components.code,{children:`renderCost`}),`, the credits debited for this render. Quote that number first with `,_jsxs(_components.a,{href:`/api-reference/endpoint/videos.estimate`,children:[`GET /videos/`,`/estimate`]}),`. When the balance is too low the render does not start, and the 402 body includes `,_jsx(_components.code,{children:`renderCost`}),` and `,_jsx(_components.code,{children:`currentBalance`}),`.`]}),`\n`,_jsx(Note,{children:_jsxs(_components.p,{children:[`The `,_jsx(_components.code,{children:`callbackUrl`}),` must use HTTPS.`]})})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"openapi":"post /videos/{id}/render","sidebarTitle":"/videos/{id}/render","title":"Render a Video by id","description":"Starts a render and returns the Video plus `renderCost`, the credits debited for this render (0 when the bundle was free). Quote the same number beforehand with GET /videos/{id}/estimate. Creation costs are not included.\n","href":"/api-reference/endpoint/videos.render"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"Per-Render Callback URL","slug":"per-render-callback-url","depth":2,"children":[]}],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"summary":"Render a Video by id","description":"Starts a render and returns the Video plus `renderCost`, the credits debited for this render (0 when the bundle was free). Quote the same number beforehand with GET /videos/{id}/estimate. Creation costs are not included.\n","parameters":["9bc254f7-3e27-4b1d-905b-99a31f6698af"],"requestBody":"b54fb63c-efd1-4139-a102-6206cd709b40","responses":{"200":"126739e9-2159-418a-a021-28ee65a14417","400":"6e72adf9-e880-4821-a49f-a2d669a5c12f","402":"52ae74ee-c4e9-4e8f-b5f7-0dcc6ade553c","404":"abb81eaf-e7e9-4406-972b-9c2273b09ac5"},"method":"post","type":"path","servers":["45e3b608-3740-4743-908b-e7b95f279378"],"security":["27a93a08-18bb-4828-b3ce-2f5f2052c5a4"],"path":"/videos/{id}/render","baseUrlOptions":["https://api.argil.ai/v1"],"title":"Render a Video by id","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"9bc254f7-3e27-4b1d-905b-99a31f6698af":{"name":"id","in":"path","required":true,"schema":{"type":"string","description":"The id of the Video to render","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":false,"content":{"application/json":{"schema":{"type":"object","properties":{"callbackUrl":{"type":"string","format":"uri","description":"Optional HTTPS URL to receive a one-shot webhook notification when this specific render completes (success or fail). The callback is fired once and then discarded. Both this callback and workspace webhooks include `renderCost` (credits debited for this render) and `renderCostRefunded` (true when that debit was refunded, which is the usual case when the render fails).\n","example":"https://example.com/hooks/argil-render","uniqueKey":"callbackUrl","typeLabel":"string\u003curi>"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"callbackUrl":"https://example.com/hooks/argil-render"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"126739e9-2159-418a-a021-28ee65a14417":{"description":"The video plus the credits debited for this render","content":{"application/json":{"schema":{"type":"object","required":["renderCost"],"properties":{"renderCost":{"type":"integer","minimum":0,"description":"Credits debited for this render. 0 when the bundle was free. Absent from GET /videos and GET /videos/{id}.\n","isRequired":true,"uniqueKey":"renderCost","typeLabel":"integer"},"id":{"type":"string","format":"uuid","uniqueKey":"id","typeLabel":"string\u003cuuid>"},"name":{"type":"string","uniqueKey":"name","typeLabel":"string"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","uniqueKey":"updatedAt","typeLabel":"string\u003cdate-time>"},"status":{"type":"string","description":"Can be either `IDLE`, `GENERATING_AUDIO`, `GENERATING_VIDEO`, `DONE` or `FAILED`.","uniqueKey":"status","typeLabel":"string"},"duration":{"oneOf":[{"type":"number","description":"Total video duration in seconds. `null` when audio hasn't been generated yet.","uniqueKey":"duration.oneOf.0","typeLabel":"number"},{"type":"null","description":"Total video duration in seconds. `null` when audio hasn't been generated yet.","uniqueKey":"duration.oneOf.1","typeLabel":"null"}],"uniqueKey":"duration","typeLabel":"number | null"},"moments":{"type":"array","description":"An array of Moment items, each representing a portion of the complete video.","items":{"type":"object","properties":{"transcript":{"type":"string","description":"A portion of the complete transcript. Current limit: 500 characters.","uniqueKey":"moments.items.[INDEX].transcript","typeLabel":"string"},"avatarId":{"type":"string","description":"The id of the avatar to be used for this moment.","uniqueKey":"moments.items.[INDEX].avatarId","typeLabel":"string"},"voiceId":{"type":"string","description":"The id of the voice to be used for this moment.","uniqueKey":"moments.items.[INDEX].voiceId","typeLabel":"string"},"audioUrl":{"type":"string","description":"The audio that will be used for the video rendering. Automatically generated from the transcript when not provided. Current limit: 40 seconds.","uniqueKey":"moments.items.[INDEX].audioUrl","typeLabel":"string"},"videoUrl":{"type":"string","description":"The url of the avatar rendering video for this moment.","uniqueKey":"moments.items.[INDEX].videoUrl","typeLabel":"string"},"gestureSlug":{"type":"string","description":"The slug identifier of the gesture to be used for this moment.","uniqueKey":"moments.items.[INDEX].gestureSlug","typeLabel":"string"},"zoom":{"description":"Current zoom effect applied to the avatar. Present only when a non-default zoom is set.","type":"object","uniqueKey":"moments.items.[INDEX].zoom","typeLabel":"object"},"broll":{"type":"object","description":"B-roll information for this moment.","properties":{"zoom":{"description":"Current zoom effect applied to the B-roll. Present only when a non-default zoom is set.","type":"object","uniqueKey":"moments.items.[INDEX].broll.zoom","typeLabel":"object"}},"uniqueKey":"moments.items.[INDEX].broll","typeLabel":"object"}},"uniqueKey":"moments.items.[INDEX]","typeLabel":"object"},"uniqueKey":"moments","typeLabel":"object[]"},"videoUrl":{"type":"string","description":"The url of the final avatar rendering video, containing all the moments merged.","uniqueKey":"videoUrl","typeLabel":"string"},"videoUrlSubtitled":{"type":"string","description":"The url of the final avatar rendering video with subtitles. Only available if subtitles are enabled.","uniqueKey":"videoUrlSubtitled","typeLabel":"string"},"previewUrl":{"type":"string","description":"Url to the embedable preview of the video. Can be watched from web browsers or integrated in other websites before launching the generation. For embedable mode, add ?embed=true to the url.","uniqueKey":"previewUrl","typeLabel":"string"},"aspectRatio":{"type":"string","enum":["16:9","9:16"],"description":"The aspect ratio of the video output: 16:9 or 9:16.","uniqueKey":"aspectRatio","typeLabel":"enum\u003cstring>"},"subtitles":{"type":"object","properties":{"enable":{"type":"boolean","uniqueKey":"subtitles.enable","typeLabel":"boolean"}},"description":"Subtitles settings for the video","uniqueKey":"subtitles","typeLabel":"object"},"extras":{"type":"object","description":"A dictionary of custom key-value pairs to extend the video metadata. Maximum of 5 key-value pairs of 256 characters allowed.","additionalProperties":{"type":"string","uniqueKey":"extras.additionalProperties","typeLabel":"string"},"maxProperties":10,"uniqueKey":"extras","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"renderCost":1,"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","name":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z","status":"\u003cstring>","duration":123,"moments":[{"transcript":"\u003cstring>","avatarId":"\u003cstring>","voiceId":"\u003cstring>","audioUrl":"\u003cstring>","videoUrl":"\u003cstring>","gestureSlug":"\u003cstring>","zoom":{},"broll":{"zoom":{}}}],"videoUrl":"\u003cstring>","videoUrlSubtitled":"\u003cstring>","previewUrl":"\u003cstring>","aspectRatio":"16:9","subtitles":{"enable":true},"extras":{}}}},"exampleType":"generated"}},"exampleType":"generated"},"6e72adf9-e880-4821-a49f-a2d669a5c12f":{"description":"Unexpected error","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","format":"int32","uniqueKey":"code","typeLabel":"integer\u003cint32>"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":123,"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"52ae74ee-c4e9-4e8f-b5f7-0dcc6ade553c":{"description":"Not enough credits to render this project. Nothing was debited.","content":{"application/json":{"schema":{"type":"object","required":["success","error"],"properties":{"success":{"type":"boolean","enum":[false],"isRequired":true,"uniqueKey":"success","typeLabel":"enum\u003cboolean>"},"error":{"type":"object","required":["code","message","details"],"properties":{"code":{"type":"string","enum":["INSUFFICIENT_CREDITS"],"isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"type":"object","required":["renderCost","currentBalance"],"properties":{"renderCost":{"type":"integer","description":"Credits this render would have debited","isRequired":true,"uniqueKey":"error.details.renderCost","typeLabel":"integer"},"currentBalance":{"type":"integer","description":"Workspace balance before the refused debit","isRequired":true,"uniqueKey":"error.details.currentBalance","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"success":false,"error":{"code":"INSUFFICIENT_CREDITS","message":"\u003cstring>","details":{"renderCost":123,"currentBalance":123}}}}},"exampleType":"generated"}},"exampleType":"generated"},"abb81eaf-e7e9-4406-972b-9c2273b09ac5":{"description":"Video not found","content":{"application/json":{"schema":{"type":"object","properties":{"code":{"type":"integer","format":"int32","uniqueKey":"code","typeLabel":"integer\u003cint32>"},"message":{"type":"string","uniqueKey":"message","typeLabel":"string"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"code":123,"message":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"27a93a08-18bb-4828-b3ce-2f5f2052c5a4":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key to be included in the x-api-key header","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"45e3b608-3740-4743-908b-e7b95f279378":{"url":"https://api.argil.ai/v1"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"API key to be included in the x-api-key header","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-api-key","type":"string","description":"API key to be included in the x-api-key header","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"openapi.yml"},"subdomain":"argil","siteName":"Argil","title":"Render a Video by id - Argil","navMaps":{"firstHrefInVersion":{"v2":{"href":"/v2/mcp/overview","matchLevel":4},"v1":{"href":"/api-reference/endpoint/videos.render","matchLevel":0}},"firstHrefInLanguage":{}},"lastModified":"2026-10-09T12:56:24.366Z","originalFileLocation":"api-reference/endpoint/videos.render.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=\"light\";if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"light\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Starts a render and returns the Video plus renderCost, the credits debited for this render (0 when the bundle was free). Quote the same number beforehand with GET /videos/{id}/estimate. Creation costs are not included.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Argil\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/argil/SzJFasrSejT7EHv_/_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/argil/SzJFasrSejT7EHv_/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/argil/SzJFasrSejT7EHv_/_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/argil/SzJFasrSejT7EHv_/_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/argil/SzJFasrSejT7EHv_/_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/argil/SzJFasrSejT7EHv_/_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/argil/SzJFasrSejT7EHv_/_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/argil/SzJFasrSejT7EHv_/_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/argil/SzJFasrSejT7EHv_/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Render a Video by id - Argil\">\u003cmeta data-mint-head property=\"og:description\" content=\"Starts a render and returns the Video plus renderCost, the credits debited for this render (0 when the bundle was free). Quote the same number beforehand with GET /videos/{id}/estimate. Creation costs are not included.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Argil\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.argil.ai/api-reference/endpoint/videos.render\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://argil.mintlify.site/_mintlify/api/og/v2?division=Videos\u0026amp;title=Render+a+Video+by+id\u0026amp;description=Starts+a+render+and+returns+the+Video+plus+%60renderCost%60%2C+the+credits+debited+for+this+render+%280+when+the+bundle+was+free%29.+Quote+the+same+number+beforehand+with\u0026amp;theme=012447cc6203ad9b33a32ac7\u0026amp;signature=8c0830c08c0c5e600a67f37e93ceb8223bd2472da09bd3d5b9683faeaed9dafd\">\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=\"Render a Video by id - Argil\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Starts a render and returns the Video plus renderCost, the credits debited for this render (0 when the bundle was free). Quote the same number beforehand with GET /videos/{id}/estimate. Creation costs are not included.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://argil.mintlify.site/_mintlify/api/og/v2?division=Videos\u0026amp;title=Render+a+Video+by+id\u0026amp;description=Starts+a+render+and+returns+the+Video+plus+%60renderCost%60%2C+the+credits+debited+for+this+render+%280+when+the+bundle+was+free%29.+Quote+the+same+number+beforehand+with\u0026amp;theme=012447cc6203ad9b33a32ac7\u0026amp;signature=8c0830c08c0c5e600a67f37e93ceb8223bd2472da09bd3d5b9683faeaed9dafd\">\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/argil/SzJFasrSejT7EHv_/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Argil\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#741FFF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.argil.ai/api-reference/endpoint/videos.render\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/endpoint/videos.render.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.argil.ai/#organization\",\"name\":\"Argil\",\"url\":\"https://docs.argil.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/argil/BBUki6oAamfarwsT/logo/argil.png?fit=max\u0026auto=format\u0026n=BBUki6oAamfarwsT\u0026q=85\u0026s=dfbe09e5c3594d42ae24e6dc64435e34\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.argil.ai#website\",\"name\":\"Argil\",\"url\":\"https://docs.argil.ai\",\"publisher\":{\"@id\":\"https://docs.argil.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.argil.ai/api-reference/endpoint/videos.render#webpage\",\"url\":\"https://docs.argil.ai/api-reference/endpoint/videos.render\",\"name\":\"Render a Video by id\",\"description\":\"Starts a render and returns the Video plus renderCost, the credits debited for this render (0 when the bundle was free). Quote the same number beforehand with GET /videos/{id}/estimate. Creation costs are not included.\",\"dateModified\":\"2026-10-09T12:56:24.366Z\",\"isPartOf\":{\"@id\":\"https://docs.argil.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.argil.ai/api-reference/endpoint/videos.render#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.argil.ai/api-reference/endpoint/videos.render#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Videos\",\"item\":\"https://docs.argil.ai/api-reference/endpoint/videos.list\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Render a Video by id\",\"item\":\"https://docs.argil.ai/api-reference/endpoint/videos.render\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.argil.ai/api-reference/endpoint/videos.render#apireference\",\"headline\":\"Render a Video by id\",\"name\":\"Render a Video by id\",\"description\":\"Starts a render and returns the Video plus renderCost, the credits debited for this render (0 when the bundle was free). Quote the same number beforehand with GET /videos/{id}/estimate. Creation costs are not included.\",\"url\":\"https://docs.argil.ai/api-reference/endpoint/videos.render\",\"mainEntityOfPage\":{\"@id\":\"https://docs.argil.ai/api-reference/endpoint/videos.render#webpage\"},\"dateModified\":\"2026-10-09T12:56:24.366Z\",\"publisher\":{\"@id\":\"https://docs.argil.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.argil.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Argil\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Argil\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/endpoint/videos.render.md","siteName":"Argil","nav":{"global":{"anchors":[{"anchor":"Go to the app","icon":"A","href":"https://app.argil.ai"},{"anchor":"Community","icon":"discord","href":"https://discord.gg/CnqyRA3bHg"}]},"products":[{"product":"Developers","icon":"code","description":"Build on the Argil API","versions":[{"version":"v2","default":true,"tag":"Preview","pages":[{"title":"v2","href":"/v2/mcp/overview"}]},{"version":"v1","tabs":[{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":"/pages/get-started/introduction"}]},{"tab":"API reference","icon":"square-terminal","groups":[{"group":"Avatars","pages":[{"openapi":"get /avatars/{id}","sidebarTitle":"/avatars/{id}","title":"Get an Avatar by id","href":"/api-reference/endpoint/avatars.get"},{"openapi":"get /avatars","sidebarTitle":"/avatars","title":"List all avatars","href":"/api-reference/endpoint/avatars.list"},{"openapi":"post /avatars","sidebarTitle":"/avatars","title":"Create a new Avatar","href":"/api-reference/endpoint/avatars.create"},{"sidebarTitle":"/avatars (video)","deprecated":true,"title":"Create an avatar from a video","href":"/api-reference/endpoint/avatars.create.video"}]},{"group":"Voices","pages":[{"openapi":"get /voices","sidebarTitle":"/voices","title":"List all voices","href":"/api-reference/endpoint/voices.list"},{"openapi":"get /voices/{id}","sidebarTitle":"/voices/{id}","title":"Get a Voice by id","href":"/api-reference/endpoint/voices.get"},{"openapi":"post /voices","sidebarTitle":"/voices","title":"Create a voice from audio","href":"/api-reference/endpoint/voices.create"},{"openapi":"post /voices/sync","sidebarTitle":"/voices/sync","title":"Sync voices from connected providers","href":"/api-reference/endpoint/voices.sync"}]},{"group":"Videos","pages":[{"openapi":"get /videos","sidebarTitle":"/videos","title":"Paginated list of Videos","href":"/api-reference/endpoint/videos.list"},{"openapi":"post /videos","sidebarTitle":"/videos","title":"Create a new Video","href":"/api-reference/endpoint/videos.create"},{"openapi":"get /videos/{id}","sidebarTitle":"/videos/{id}","title":"Get a Video by id","href":"/api-reference/endpoint/videos.get"},{"openapi":"delete /videos/{id}","sidebarTitle":"/videos/{id}","title":"Delete a Video by id","href":"/api-reference/endpoint/videos.delete"},{"openapi":"get /videos/{id}/estimate","sidebarTitle":"/videos/{id}/estimate","title":"Estimate the credit cost of rendering a Video","description":"Returns the credit cost of a render started right now, without debiting or starting one. The numbers match POST /videos/{id}/render. Creation costs (speech synthesis and other work already done while building the project) are not included. `newBalance` may be negative; this route still returns 200.\n","href":"/api-reference/endpoint/videos.estimate"},{"openapi":"post /videos/{id}/render","sidebarTitle":"/videos/{id}/render","title":"Render a Video by id","href":"/api-reference/endpoint/videos.render"}]},{"group":"Webhooks","pages":[{"openapi":"get /webhooks","sidebarTitle":"/webhooks","title":"Retrieve all webhooks","description":"Retrieves all webhooks for the authenticated user.","href":"/api-reference/endpoint/webhooks.list"},{"openapi":"post /webhooks","sidebarTitle":"/webhooks","title":"Create a new webhook","href":"/api-reference/endpoint/webhooks.create"},{"openapi":"PUT /webhooks/{id}","sidebarTitle":"/webhooks/{id}","title":"Update a webhook","href":"/api-reference/endpoint/webhooks.update"},{"openapi":"delete /webhooks/{id}","sidebarTitle":"/webhooks/{id}","title":"Delete a webhook","href":"/api-reference/endpoint/webhooks.delete"}]},{"group":"Assets","pages":[{"title":"List Assets","openapi":"get /assets","sidebarTitle":"/assets","href":"/api-reference/endpoint/assets.list"},{"title":"Upload Asset","openapi":"post /assets","sidebarTitle":"/assets","href":"/api-reference/endpoint/assets.create"},{"title":"Get Asset","openapi":"get /assets/{id}","sidebarTitle":"/assets/{id}","href":"/api-reference/endpoint/assets.get"},{"title":"Delete Asset","openapi":"delete /assets/{id}","sidebarTitle":"/assets/{id}","href":"/api-reference/endpoint/assets.delete"}]},{"group":"Subtitles","pages":[{"openapi":"get /subtitles","sidebarTitle":"/subtitles","title":"List subtitle styles","href":"/api-reference/endpoint/subtitles.list"},{"openapi":"get /subtitles/videos/{videoProjectId}/export","sidebarTitle":"/subtitles/videos/{videoProjectId}/export","title":"Export subtitles for a video project","href":"/api-reference/endpoint/subtitles.export"}]}]}]}]},{"product":"Help center","icon":"life-ring","description":"Use the Argil app","pages":[{"title":"Help center","href":"/resources/introduction"}]}]},"basePath":"","title":"Render a Video by id - Argil","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}