Submit up to 100 video creation payloads in one request and return a batch id immediately. Videos are created asynchronously; poll GET /v3/videos/batches/ for per-item video ids and statuses.
{
"error": {
"code": "invalid_parameter",
"message": "Invalid payload(s) at index 3.",
"param": "videos",
"doc_url": null
}
}
{
"error": {
"code": "unauthorized",
"message": "Invalid or expired API key. Verify your x-api-key header.",
"param": null,
"doc_url": null
}
}
{
"error": {
"code": "request_in_progress",
"message": "A request with this Idempotency-Key is already in progress. Retry shortly.",
"param": null,
"doc_url": null
}
}
{
"error": {
"code": "rate_limit_exceeded",
"message": "Too many requests. Retry after the duration specified in the Retry-After header.",
"param": null,
"doc_url": null
}
}
Authorizations
ApiKeyAuthBearerAuth
x-api-key
string
header
required
HeyGen API key. Obtain from your HeyGen dashboard.
Headers
Idempotency-Key
string
Optional client-supplied key for safely retrying mutations. Subsequent calls within 24 hours that share this key replay the original response — even if the request body differs slightly (a warning is logged). A retry that arrives while the original is still in flight gets a 409 request_in_progress. Keys must be 1–255 characters from [A-Za-z0-9_:.-]; a UUID is a safe default. Scope is per-endpoint and per-resource: the same key on a different route or path parameter is independent.
Video creation requests (avatar / image / cinematic_avatar). Set folder_id once on the batch request, not on individual videos. Max 100 per batch.
Required array length: 1 - 100 elements
Create a video from a HeyGen avatar (video or photo avatar).
Provide an avatar_id to use a previously created avatar. Supports all
avatar types: studio_avatar, digital_twin, and photo_avatar. Optionally
set engine to select Avatar V for eligible avatars; when omitted, the
server defaults to Avatar IV.
CreateBatchVideoFromAvatar
CreateBatchVideoFromImage
CreateBatchVideoFromCinematicAvatar
CreateBatchVideoFromStudio
Show child attributes
title
string | null
Display name for the batch, shown in the HeyGen app.
folder_id
string | null
Destination folder ID for the batch container. The videos remain grouped inside the newly created batch; the batch itself is placed in this folder. Omit, pass null, or pass an empty string to place the batch at the workspace root.
callback_url
string | null
Webhook URL invoked once when every item in the batch reaches a terminal state.
Response
Accepted — submission acknowledged; poll for completion.
{
"error": {
"code": "invalid_parameter",
"message": "Invalid payload(s) at index 3.",
"param": "videos",
"doc_url": null
}
}
{
"error": {
"code": "unauthorized",
"message": "Invalid or expired API key. Verify your x-api-key header.",
"param": null,
"doc_url": null
}
}
{
"error": {
"code": "request_in_progress",
"message": "A request with this Idempotency-Key is already in progress. Retry shortly.",
"param": null,
"doc_url": null
}
}
{
"error": {
"code": "rate_limit_exceeded",
"message": "Too many requests. Retry after the duration specified in the Retry-After header.",
"param": null,
"doc_url": null
}
}
{"docsConfig":{"theme":"maple","$schema":"https://mintlify.com/docs.json","name":"HeyGen Documentation","colors":{"primary":"#03C3FF","light":"#03C3FF","dark":"#03C3FF"},"logo":{"light":"https://mintcdn.com/heygen-1fa696a7/dQ_uLJDftFYFhC7B/logo/light.png?fit=max\u0026auto=format\u0026n=dQ_uLJDftFYFhC7B\u0026q=85\u0026s=b03d2e41dde1cc0b50cd50e574f66f1c","dark":"https://mintcdn.com/heygen-1fa696a7/dQ_uLJDftFYFhC7B/logo/dark.png?fit=max\u0026auto=format\u0026n=dQ_uLJDftFYFhC7B\u0026q=85\u0026s=1bce9897c94baace249bfc9bd5ebb894"},"favicon":{"light":"https://mintcdn.com/heygen-1fa696a7/eIkZ-KhF8P1D-58U/images/fav.png?fit=max\u0026auto=format\u0026n=eIkZ-KhF8P1D-58U\u0026q=85\u0026s=974346d2956697dca817da145b0107e8","dark":"https://mintcdn.com/heygen-1fa696a7/eIkZ-KhF8P1D-58U/images/fav.png?fit=max\u0026auto=format\u0026n=eIkZ-KhF8P1D-58U\u0026q=85\u0026s=974346d2956697dca817da145b0107e8"},"navbar":{"primary":{"type":"button","label":"Get Started","href":"https://platform.heygen.com"}},"seo":{"metatags":{"robots":"index, follow"},"indexing":"navigable"},"fonts":{"heading":{"family":"ABC Solar Display","source":"https://www-static-assets.heygen.com/fonts/solar-display/ABCSolarDisplay-Bold.woff2","format":"woff2"},"body":{"family":"TT Norms Pro","source":"https://www-static-assets.heygen.com/fonts/tt-norms/TT_Norms_Pro_Normal.woff2","format":"woff2"}},"integrations":{"posthog":{"apiKey":"phc_bcoaBa4uZdMp0CzXr7QhZRRpnNGgBRRZ1GStvuJVAgJ","apiHost":"https://us.i.posthog.com"}},"contextual":{"options":["copy","view","chatgpt","claude","grok","cursor"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"heygen-1fa696a7","hasAudioNarration":false,"actualSubdomain":"heygen-1fa696a7","customDomains":[],"gitSource":{"type":"github","owner":"heygen-com","repo":"api-docs","deployBranch":"master","contentDirectory":"heygen-api","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6b023b5c34aba046b8adc5d2","clientVersion":"0.0.4270","searchFilterCounts":[{"language":"default","tag":"API Reference","count":118},{"language":"default","tag":"Developer Guide","count":89},{"language":"default","tag":"Avatar","count":32},{"language":"default","tag":"Video editing","count":30},{"language":"default","tag":"Video","count":23},{"language":"default","tag":"Brand","count":19},{"language":"default","tag":"Voice","count":18},{"language":"default","tag":"Platform","count":17},{"language":"default","tag":"Batches","count":17},{"language":"default","tag":"Video Agent","count":13}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":"li[id=\"https://platform.heygen.com\"]>a,.lg\\:hidden>a[href=\"https://platform.heygen.com\"]{color:#03C3FF!important;font-weight:600}li[id=\"https://platform.heygen.com\"]>a svg,.lg\\:hidden>a[href=\"https://platform.heygen.com\"] svg{color:#03C3FF!important}#hg-platform-links{position:absolute;top:0;right:calc(var(--sidebar-width, 19rem) + 24px);height:48px;display:flex;align-items:center;gap:6px;z-index:30}@media (max-width: 1023px){#hg-platform-links{display:none}}#hg-platform-links .hg-pill{display:inline-flex;align-items:center;gap:5px;height:24px;padding:0 10px;border-radius:999px;font-size:11.5px;font-weight:500;line-height:1;white-space:nowrap;text-decoration:none;color:rgb(55 65 81);border:1px solid rgb(3 7 18 / 0.1);background:rgb(3 7 18 / 0.02);transition:color 0.15s, border-color 0.15s, background 0.15s, box-shadow 0.15s}#hg-platform-links .hg-pill svg{width:12px;height:12px;fill:none;stroke:currentColor;stroke-width:2;stroke-linecap:round;stroke-linejoin:round}#hg-platform-links .hg-pill:hover{color:#0284c7;border-color:rgb(3 195 255 / 0.5);background:rgb(3 195 255 / 0.06)}#hg-platform-links .hg-pill--primary{color:#03131a;border-color:transparent;background:linear-gradient(90deg, #03C3FF, #7CF5C4);font-weight:600}#hg-platform-links .hg-pill--primary svg{fill:currentColor;stroke:none}#hg-platform-links .hg-pill--primary:hover{color:#03131a;border-color:transparent;background:linear-gradient(90deg, #03C3FF, #7CF5C4);box-shadow:0 0 0 3px rgb(3 195 255 / 0.18), 0 0 18px rgb(3 195 255 / 0.35)}html.dark #hg-platform-links .hg-pill:not(.hg-pill--primary){color:rgb(209 213 219);border-color:rgb(255 255 255 / 0.1);background:rgb(255 255 255 / 0.03)}html.dark #hg-platform-links .hg-pill:not(.hg-pill--primary):hover{color:#03C3FF;border-color:rgb(3 195 255 / 0.45);background:rgb(3 195 255 / 0.08)}@media (max-width: 1439px){#hg-platform-links .hg-pill:not(.hg-pill--primary){width:24px;padding:0;justify-content:center}#hg-platform-links .hg-pill:not(.hg-pill--primary) span{display:none}}@media (max-width: 1179px){#hg-platform-links .hg-pill:not(.hg-pill--primary){display:none}}"}]}
{"page":{"pagePath":"reference/create-video-batch","slug":"/reference/create-video-batch","pageMetadata":{"title":"Create Video Batch","description":"Submit up to 100 video creation payloads in one request and return a batch id immediately. Videos are created asynchronously; poll GET /v3/videos/batches/{batch_id} for per-item video ids and statuses.","deprecated":null,"version":null,"sidebarTitle":"Create video batch","openapi":"/openapi/external-api.json post /v3/videos/batches","href":"/reference/create-video-batch","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Submit up to 100 video creation payloads in one request and return a batch id immediately. Videos are created asynchronously; poll GET /v3/videos/batches/\", \" for per-item video ids and statuses.\"]\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":"Create Video Batch","description":"Submit up to 100 video creation payloads in one request and return a batch id immediately. Videos are created asynchronously; poll GET /v3/videos/batches/{batch_id} for per-item video ids and statuses.","deprecated":null,"version":null,"sidebarTitle":"Create video batch","openapi":"/openapi/external-api.json post /v3/videos/batches","href":"/reference/create-video-batch","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/heygen-1fa696a7/5ff79916e1e2679a/platform-links.js"],"openApiReferenceData":{"operation":{"summary":"Create Video Batch","description":"Submit up to 100 video creation payloads in one request and return a batch id immediately. Videos are created asynchronously; poll GET /v3/videos/batches/{batch_id} for per-item video ids and statuses.","tags":["Batches"],"security":["56b8fe92-2a58-4cdf-bafd-c0fdc1067c89","0610cbc2-0503-4d5e-aa62-04af7767306c"],"responses":{"202":"bb285254-80b4-4063-a2b7-2c3dffe0e84c","400":"735c441d-b201-4871-b060-1e3da857c29c","401":"45b6f8f3-0d48-433a-bb5b-382a53e91489","409":"aecadb5e-3a03-46b7-92f3-a4bf12fc6633","429":"708888b6-3d9d-4400-9625-84738dd0f3d7"},"x-mint":{"href":"/reference/create-video-batch"},"operationId":"createVideoBatchV3","parameters":["8eb121e8-fc80-49f0-86f9-76a9bd459e3e"],"requestBody":"9439cbf7-3a06-468d-bee3-fcd8ddbe8d85","x-heygen-required-scopes":["videos:write"],"method":"post","type":"path","servers":["e6cd17e6-82b7-4d18-b2e2-af0f350698c3"],"path":"/v3/videos/batches","baseUrlOptions":["https://api.heygen.com"],"title":"Create Video Batch","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"8eb121e8-fc80-49f0-86f9-76a9bd459e3e":{"name":"Idempotency-Key","in":"header","required":false,"description":"Optional client-supplied key for safely retrying mutations. Subsequent calls within 24 hours that share this key replay the original response — even if the request body differs slightly (a warning is logged). A retry that arrives while the original is still in flight gets a 409 `request_in_progress`. Keys must be 1–255 characters from `[A-Za-z0-9_:.-]`; a UUID is a safe default. Scope is per-endpoint and per-resource: the same key on a different route or path parameter is independent.","schema":{"type":"string","pattern":"^[A-Za-z0-9_\\-:.]{1,255}$","maxLength":255,"minLength":1,"isRequired":false,"description":"Optional client-supplied key for safely retrying mutations. Subsequent calls within 24 hours that share this key replay the original response — even if the request body differs slightly (a warning is logged). A retry that arrives while the original is still in flight gets a 409 `request_in_progress`. Keys must be 1–255 characters from `[A-Za-z0-9_:.-]`; a UUID is a safe default. Scope is per-endpoint and per-resource: the same key on a different route or path parameter is independent.","uniqueKey":"","typeLabel":"string"},"example":"550e8400-e29b-41d4-a716-446655440000"}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"additionalProperties":false,"properties":{"videos":{"description":"Video creation requests (avatar / image / cinematic_avatar). Set folder_id once on the batch request, not on individual videos. Max 100 per batch.","items":{"oneOf":[{"type":"object","title":"CreateBatchVideoFromAvatar","description":"Create a video from a HeyGen avatar (video or photo avatar).\n\nProvide an avatar_id to use a previously created avatar. Supports all\navatar types: studio_avatar, digital_twin, and photo_avatar. Optionally\nset ``engine`` to select Avatar V for eligible avatars; when omitted, the\nserver defaults to Avatar IV.","required":["type","avatar_id"],"properties":{"type":{"const":"avatar","description":"Must be 'avatar' for avatar-based video creation.","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.0.type","typeLabel":"string"},"avatar_id":{"description":"HeyGen avatar ID (video avatar or photo avatar look ID).","title":"Avatar Id","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.0.avatar_id","typeLabel":"string"},"title":{"oneOf":[{"type":"string","title":"Title","description":"Display title for the video in the HeyGen dashboard.","uniqueKey":"videos.items.[INDEX].oneOf.0.title.oneOf.0","typeLabel":"string"},{"type":"null","title":"Title","description":"Display title for the video in the HeyGen dashboard.","uniqueKey":"videos.items.[INDEX].oneOf.0.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.title","typeLabel":"string | null"},"resolution":{"oneOf":[{"type":"string","title":"VideoResolution","description":"Output video resolution. Defaults to 720p. `4k` is available for Avatar III digital twins and studio avatars. For apps signed in with OAuth, such as MCP clients, the account's plan sets the maximum: 720p on Free, 1080p on Creator.","enum":["4k","1080p","720p"],"uniqueKey":"videos.items.[INDEX].oneOf.0.resolution.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Output video resolution. Defaults to 720p. `4k` is available for Avatar III digital twins and studio avatars. For apps signed in with OAuth, such as MCP clients, the account's plan sets the maximum: 720p on Free, 1080p on Creator.","uniqueKey":"videos.items.[INDEX].oneOf.0.resolution.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.resolution","typeLabel":"enum\u003cstring> | null"},"aspect_ratio":{"oneOf":[{"type":"string","title":"VideoAspectRatio","description":"Output video aspect ratio. Supported values: '16:9', '9:16', '4:5', '5:4', '1:1', 'auto'. Defaults to '16:9'. 'auto' preserves the source's aspect ratio (avatar source frames or uploaded image), short-edge anchored to the requested resolution and capped at the tier's long edge. Falls back to '16:9' when source dimensions can't be read.","default":"16:9","enum":["16:9","9:16","4:5","5:4","1:1","auto"],"x-cli-default":"auto","x-mcp-default":"auto","uniqueKey":"videos.items.[INDEX].oneOf.0.aspect_ratio.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Output video aspect ratio. Supported values: '16:9', '9:16', '4:5', '5:4', '1:1', 'auto'. Defaults to '16:9'. 'auto' preserves the source's aspect ratio (avatar source frames or uploaded image), short-edge anchored to the requested resolution and capped at the tier's long edge. Falls back to '16:9' when source dimensions can't be read.","default":"16:9","x-cli-default":"auto","x-mcp-default":"auto","uniqueKey":"videos.items.[INDEX].oneOf.0.aspect_ratio.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.aspect_ratio","typeLabel":"enum\u003cstring> | null"},"fit":{"oneOf":[{"type":"string","title":"AvatarFit","description":"How the subject is fitted to the output canvas. 'cover' scales to fill the frame (may crop edges). 'contain' scales to fit entirely within the frame (may show background). When omitted, the server picks the best option based on the source and canvas orientations.","enum":["contain","cover"],"uniqueKey":"videos.items.[INDEX].oneOf.0.fit.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"How the subject is fitted to the output canvas. 'cover' scales to fill the frame (may crop edges). 'contain' scales to fit entirely within the frame (may show background). When omitted, the server picks the best option based on the source and canvas orientations.","uniqueKey":"videos.items.[INDEX].oneOf.0.fit.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.fit","typeLabel":"enum\u003cstring> | null"},"background":{"oneOf":[{"type":"object","title":"BackgroundSetting","description":"Background settings for the video.","required":["type"],"properties":{"type":{"description":"Background type. 'color' uses a solid hex color; 'image' uses an image from url or asset_id.","enum":["color","image"],"title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.0.background.oneOf.0.type","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"string","title":"Value","description":"Hex color code (e.g. '#ff0000'). Required when type is 'color'.","uniqueKey":"videos.items.[INDEX].oneOf.0.background.oneOf.0.value.oneOf.0","typeLabel":"string"},{"type":"null","title":"Value","description":"Hex color code (e.g. '#ff0000'). Required when type is 'color'.","uniqueKey":"videos.items.[INDEX].oneOf.0.background.oneOf.0.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.background.oneOf.0.value","typeLabel":"string | null"},"url":{"oneOf":[{"type":"string","title":"Url","description":"URL of the background image. Used when type is 'image'. Mutually exclusive with asset_id.","uniqueKey":"videos.items.[INDEX].oneOf.0.background.oneOf.0.url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Url","description":"URL of the background image. Used when type is 'image'. Mutually exclusive with asset_id.","uniqueKey":"videos.items.[INDEX].oneOf.0.background.oneOf.0.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.background.oneOf.0.url","typeLabel":"string | null"},"asset_id":{"oneOf":[{"type":"string","title":"Asset Id","description":"HeyGen asset ID of the background image. Used when type is 'image'. Mutually exclusive with url.","uniqueKey":"videos.items.[INDEX].oneOf.0.background.oneOf.0.asset_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Asset Id","description":"HeyGen asset ID of the background image. Used when type is 'image'. Mutually exclusive with url.","uniqueKey":"videos.items.[INDEX].oneOf.0.background.oneOf.0.asset_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.background.oneOf.0.asset_id","typeLabel":"string | null"}},"uniqueKey":"videos.items.[INDEX].oneOf.0.background.oneOf.0","typeLabel":"BackgroundSetting · object"},{"type":"null","description":"Background settings for the video.","uniqueKey":"videos.items.[INDEX].oneOf.0.background.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.background","typeLabel":"BackgroundSetting · object | null"},"remove_background":{"oneOf":[{"type":"boolean","title":"Remove Background","description":"Remove the avatar background. Video avatars must be trained with matting enabled.","uniqueKey":"videos.items.[INDEX].oneOf.0.remove_background.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Remove Background","description":"Remove the avatar background. Video avatars must be trained with matting enabled.","uniqueKey":"videos.items.[INDEX].oneOf.0.remove_background.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.remove_background","typeLabel":"boolean | null"},"callback_url":{"oneOf":[{"type":"string","title":"Callback Url","description":"Webhook URL to receive a POST notification when the video is ready.","uniqueKey":"videos.items.[INDEX].oneOf.0.callback_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Callback Url","description":"Webhook URL to receive a POST notification when the video is ready.","uniqueKey":"videos.items.[INDEX].oneOf.0.callback_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.callback_url","typeLabel":"string | null"},"callback_id":{"oneOf":[{"type":"string","title":"Callback Id","description":"Caller-defined identifier echoed back in the webhook payload.","uniqueKey":"videos.items.[INDEX].oneOf.0.callback_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Callback Id","description":"Caller-defined identifier echoed back in the webhook payload.","uniqueKey":"videos.items.[INDEX].oneOf.0.callback_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.callback_id","typeLabel":"string | null"},"watermark":{"oneOf":[{"type":"object","title":"WatermarkInput","description":"Custom watermark image to overlay on the video (PNG or JPEG). Available to workspaces on an Enterprise web or API plan.","required":["image"],"x-cli-visible":false,"x-mcp-visible":false,"properties":{"image":{"oneOf":[{"type":"object","title":"AssetUrl","description":"Asset input via publicly accessible HTTPS URL.","required":["type","url"],"properties":{"type":{"const":"url","description":"Input type discriminator","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.0.watermark.oneOf.0.image.oneOf.0.type","typeLabel":"string"},"url":{"description":"Public http(s) URL HeyGen can download without auth or redirects. Not a local or sandbox path (/mnt/data/..., file://, sandbox:); upload such files and pass asset_id.","title":"Url","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.0.watermark.oneOf.0.image.oneOf.0.url","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.0.watermark.oneOf.0.image.oneOf.0","typeLabel":"AssetUrl · object"},{"type":"object","title":"AssetId","description":"Asset input via HeyGen asset ID from the asset upload endpoint.","required":["type","asset_id"],"properties":{"type":{"const":"asset_id","description":"Input type discriminator","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.0.watermark.oneOf.0.image.oneOf.1.type","typeLabel":"string"},"asset_id":{"description":"HeyGen asset ID from an asset upload or import; not a third-party file ID.","title":"Asset Id","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.0.watermark.oneOf.0.image.oneOf.1.asset_id","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.0.watermark.oneOf.0.image.oneOf.1","typeLabel":"AssetId · object"},{"type":"object","title":"AssetBase64","description":"Asset input via base64-encoded content.","required":["type","media_type","data"],"x-mcp-visible":false,"properties":{"type":{"const":"base64","description":"Input type discriminator","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.0.watermark.oneOf.0.image.oneOf.2.type","typeLabel":"string"},"media_type":{"description":"MIME type of the encoded content (e.g. \"image/png\")","title":"Media Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.0.watermark.oneOf.0.image.oneOf.2.media_type","typeLabel":"string"},"data":{"description":"Base64-encoded file content","title":"Data","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.0.watermark.oneOf.0.image.oneOf.2.data","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.0.watermark.oneOf.0.image.oneOf.2","typeLabel":"AssetBase64 · object"}],"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.0.watermark.oneOf.0.image","typeLabel":"AssetUrl · object | AssetId · object | AssetBase64 · object"},"scale":{"default":1,"description":"Scale multiplier for the watermark image. 1.0 renders at native size.","exclusiveMinimum":0,"maximum":2,"title":"Scale","type":"number","uniqueKey":"videos.items.[INDEX].oneOf.0.watermark.oneOf.0.scale","typeLabel":"number"},"opacity":{"default":1,"description":"Watermark opacity. 0.0 is fully transparent, 1.0 is fully opaque.","maximum":1,"minimum":0,"title":"Opacity","type":"number","uniqueKey":"videos.items.[INDEX].oneOf.0.watermark.oneOf.0.opacity","typeLabel":"number"},"placement":{"oneOf":[{"type":"object","title":"WatermarkPlacement","description":"Watermark placement. Defaults to bottom-right with standard margins when omitted.","properties":{"position":{"description":"Anchor corner for the watermark.","enum":["top_left","top_right","bottom_left","bottom_right"],"title":"WatermarkPosition","type":"string","default":"bottom_right","uniqueKey":"videos.items.[INDEX].oneOf.0.watermark.oneOf.0.placement.oneOf.0.position","typeLabel":"enum\u003cstring>"},"offset_x":{"oneOf":[{"type":"number","title":"Offset X","description":"Fine-tune horizontal position. Fraction of frame width; 0.05 shifts 5% rightward, -0.05 shifts 5% leftward.","maximum":1,"minimum":-1,"uniqueKey":"videos.items.[INDEX].oneOf.0.watermark.oneOf.0.placement.oneOf.0.offset_x.oneOf.0","typeLabel":"number"},{"type":"null","title":"Offset X","description":"Fine-tune horizontal position. Fraction of frame width; 0.05 shifts 5% rightward, -0.05 shifts 5% leftward.","uniqueKey":"videos.items.[INDEX].oneOf.0.watermark.oneOf.0.placement.oneOf.0.offset_x.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.watermark.oneOf.0.placement.oneOf.0.offset_x","typeLabel":"number | null"},"offset_y":{"oneOf":[{"type":"number","title":"Offset Y","description":"Fine-tune vertical position. Fraction of frame height; 0.05 shifts 5% downward, -0.05 shifts 5% upward.","maximum":1,"minimum":-1,"uniqueKey":"videos.items.[INDEX].oneOf.0.watermark.oneOf.0.placement.oneOf.0.offset_y.oneOf.0","typeLabel":"number"},{"type":"null","title":"Offset Y","description":"Fine-tune vertical position. Fraction of frame height; 0.05 shifts 5% downward, -0.05 shifts 5% upward.","uniqueKey":"videos.items.[INDEX].oneOf.0.watermark.oneOf.0.placement.oneOf.0.offset_y.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.watermark.oneOf.0.placement.oneOf.0.offset_y","typeLabel":"number | null"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.0.watermark.oneOf.0.placement.oneOf.0","typeLabel":"WatermarkPlacement · object"},{"type":"null","description":"Watermark placement. Defaults to bottom-right with standard margins when omitted.","uniqueKey":"videos.items.[INDEX].oneOf.0.watermark.oneOf.0.placement.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.watermark.oneOf.0.placement","typeLabel":"WatermarkPlacement · object | null"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.0.watermark.oneOf.0","typeLabel":"WatermarkInput · object"},{"type":"null","description":"Custom watermark image to overlay on the video (PNG or JPEG). Available to workspaces on an Enterprise web or API plan.","x-cli-visible":false,"x-mcp-visible":false,"uniqueKey":"videos.items.[INDEX].oneOf.0.watermark.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.watermark","typeLabel":"WatermarkInput · object | null"},"caption":{"oneOf":[{"type":"object","title":"CaptionSetting","description":"Caption generation settings. A sidecar subtitle file is always returned via subtitle_url; set 'style' to additionally burn captions into the rendered video.","properties":{"file_format":{"description":"Output format for the sidecar caption file.","enum":["srt"],"title":"CaptionFileFormat","type":"string","default":"srt","uniqueKey":"videos.items.[INDEX].oneOf.0.caption.oneOf.0.file_format","typeLabel":"enum\u003cstring>"},"style":{"oneOf":[{"type":"string","title":"CaptionStyle","description":"Visual style for burning captions into the rendered video. Omit for sidecar-only captions.","enum":["default"],"uniqueKey":"videos.items.[INDEX].oneOf.0.caption.oneOf.0.style.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Visual style for burning captions into the rendered video. Omit for sidecar-only captions.","uniqueKey":"videos.items.[INDEX].oneOf.0.caption.oneOf.0.style.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.caption.oneOf.0.style","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"videos.items.[INDEX].oneOf.0.caption.oneOf.0","typeLabel":"CaptionSetting · object"},{"type":"null","description":"Caption generation settings. A sidecar subtitle file is always returned via subtitle_url; set 'style' to additionally burn captions into the rendered video.","uniqueKey":"videos.items.[INDEX].oneOf.0.caption.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.caption","typeLabel":"CaptionSetting · object | null"},"output_format":{"description":"Output container. 'webm' returns a video with a transparent background (alpha channel); 'mp4' (default) returns a standard video. 'webm' requires an avatar that supports matting. When 'webm' is selected, any 'background' value is rejected and background removal is applied automatically — the caller does not need to set 'remove_background'.","enum":["mp4","webm"],"title":"VideoOutputFormat","type":"string","default":"mp4","uniqueKey":"videos.items.[INDEX].oneOf.0.output_format","typeLabel":"enum\u003cstring>"},"script":{"oneOf":[{"type":"string","title":"Script","description":"Text script for the avatar to speak. Pair with voice_id, or omit voice_id when using avatar_id to use the avatar's default voice. Mutually exclusive with audio_url/audio_asset_id.","minLength":1,"uniqueKey":"videos.items.[INDEX].oneOf.0.script.oneOf.0","typeLabel":"string"},{"type":"null","title":"Script","description":"Text script for the avatar to speak. Pair with voice_id, or omit voice_id when using avatar_id to use the avatar's default voice. Mutually exclusive with audio_url/audio_asset_id.","uniqueKey":"videos.items.[INDEX].oneOf.0.script.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.script","typeLabel":"string | null"},"voice_id":{"oneOf":[{"type":"string","title":"Voice Id","description":"Voice ID for text-to-speech. Required when script is provided, unless avatar_id is set (the avatar's default voice is used as fallback).","uniqueKey":"videos.items.[INDEX].oneOf.0.voice_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Voice Id","description":"Voice ID for text-to-speech. Required when script is provided, unless avatar_id is set (the avatar's default voice is used as fallback).","uniqueKey":"videos.items.[INDEX].oneOf.0.voice_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_id","typeLabel":"string | null"},"audio_url":{"oneOf":[{"type":"string","title":"Audio Url","description":"Public http(s) URL of an audio file to lip-sync. Mutually exclusive with script. Not a local or sandbox path (/mnt/data/..., file://); upload it and pass audio_asset_id.","uniqueKey":"videos.items.[INDEX].oneOf.0.audio_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Audio Url","description":"Public http(s) URL of an audio file to lip-sync. Mutually exclusive with script. Not a local or sandbox path (/mnt/data/..., file://); upload it and pass audio_asset_id.","uniqueKey":"videos.items.[INDEX].oneOf.0.audio_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.audio_url","typeLabel":"string | null"},"audio_asset_id":{"oneOf":[{"type":"string","title":"Audio Asset Id","description":"HeyGen asset ID of an uploaded audio file. Mutually exclusive with script.","uniqueKey":"videos.items.[INDEX].oneOf.0.audio_asset_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Audio Asset Id","description":"HeyGen asset ID of an uploaded audio file. Mutually exclusive with script.","uniqueKey":"videos.items.[INDEX].oneOf.0.audio_asset_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.audio_asset_id","typeLabel":"string | null"},"voice_settings":{"oneOf":[{"type":"object","title":"VoiceSettingsInput","description":"Voice settings. Always include engine_settings: the engine from GET /v3/videos/voice-capabilities, and a model only when that row lists models. locale is optional and is the accent only.","properties":{"speed":{"default":1,"description":"Playback speed multiplier. 0.5 (half speed) to 1.5 (1.5x speed).","maximum":1.5,"minimum":0.5,"title":"Speed","type":"number","uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.speed","typeLabel":"number"},"pitch":{"default":0,"description":"Legacy pitch adjustment, normalized to -1 to 1 before synthesis. Among the six documented engines, only Mockingbird can apply it when its base TTS uses Azure; use engine_settings.pitch for HeyGen Voice.","maximum":50,"minimum":-50,"title":"Pitch","type":"number","uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.pitch","typeLabel":"number"},"volume":{"default":1,"description":"Voice audio volume. 1.0 = full, 0.0 = silent. Useful when mixing spoken voice with background audio.","maximum":1,"minimum":0,"title":"Volume","type":"number","uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.volume","typeLabel":"number"},"locale":{"oneOf":[{"type":"string","title":"Locale","description":"Accent the user asked for (e.g. 'en-US'). It is not the script language; the language is read from the script. Omit for Original Accent, the voice's natural accent. Send only a locale that GET /v3/videos/voice-capabilities lists for the script's language and the engine in engine_settings. Mockingbird requires a regional locale.","uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.locale.oneOf.0","typeLabel":"string"},{"type":"null","title":"Locale","description":"Accent the user asked for (e.g. 'en-US'). It is not the script language; the language is read from the script. Omit for Original Accent, the voice's natural accent. Send only a locale that GET /v3/videos/voice-capabilities lists for the script's language and the engine in engine_settings. Mockingbird requires a regional locale.","uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.locale.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.locale","typeLabel":"string | null"},"engine_settings":{"oneOf":[{"type":"object","title":"ElevenLabsEngineSettings","description":"Engine-specific voice settings for ElevenLabs-backed voices.\n\nSupports model, stability, similarity_boost, style, and use_speaker_boost.\nWhen using eleven_v3 or eleven_v4, stability may be any value in [0.0, 1.0].","required":["engine_type"],"properties":{"engine_type":{"const":"elevenlabs","description":"Engine type discriminator. Must be 'elevenlabs' for ElevenLabs-backed voices.","title":"Engine Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.0.engine_type","typeLabel":"string"},"model":{"oneOf":[{"type":"string","description":"ElevenLabs model. eleven_v3 and eleven_v4 use stability only; similarity_boost, style, and use_speaker_boost have no effect on them.","enum":["eleven_multilingual_v2","eleven_turbo_v2_5","eleven_v3","eleven_v4"],"x-mcp-schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.0.model.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"ElevenLabs model. eleven_v3 and eleven_v4 use stability only; similarity_boost, style, and use_speaker_boost have no effect on them.","x-mcp-schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.0.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.0.model","typeLabel":"enum\u003cstring> | null"},"similarity_boost":{"oneOf":[{"type":"number","title":"Similarity Boost","description":"The similarity boost parameter for ElevenLabs.","maximum":1,"minimum":0,"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.0.similarity_boost.oneOf.0","typeLabel":"number"},{"type":"null","title":"Similarity Boost","description":"The similarity boost parameter for ElevenLabs.","uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.0.similarity_boost.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.0.similarity_boost","typeLabel":"number | null"},"stability":{"oneOf":[{"type":"number","title":"Stability","description":"The stability parameter for ElevenLabs.","maximum":1,"minimum":0,"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.0.stability.oneOf.0","typeLabel":"number"},{"type":"null","title":"Stability","description":"The stability parameter for ElevenLabs.","uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.0.stability.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.0.stability","typeLabel":"number | null"},"style":{"oneOf":[{"type":"number","title":"Style","description":"The style parameter for ElevenLabs.","maximum":1,"minimum":0,"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.0.style.oneOf.0","typeLabel":"number"},{"type":"null","title":"Style","description":"The style parameter for ElevenLabs.","uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.0.style.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.0.style","typeLabel":"number | null"},"use_speaker_boost":{"oneOf":[{"type":"boolean","title":"Use Speaker Boost","description":"Whether to use speaker boost for ElevenLabs.","uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.0.use_speaker_boost.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Use Speaker Boost","description":"Whether to use speaker boost for ElevenLabs.","uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.0.use_speaker_boost.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.0.use_speaker_boost","typeLabel":"boolean | null"}},"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.0","typeLabel":"ElevenLabsEngineSettings · object"},{"type":"object","title":"FishEngineSettings","description":"Engine-specific voice settings for Fish Audio-backed voices.\n\nInherits Fish's tuning fields (model, stability, similarity).","required":["engine_type"],"properties":{"engine_type":{"const":"fish","description":"Engine type discriminator. Must be 'fish' for Fish Audio-backed voices.","title":"Engine Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.1.engine_type","typeLabel":"string"},"model":{"oneOf":[{"type":"string","description":"Fish Audio model version. Defaults to s2.1-pro when omitted.","enum":["s2.1-pro","s2-pro"],"x-mcp-schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.1.model.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Fish Audio model version. Defaults to s2.1-pro when omitted.","x-mcp-schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.1.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.1.model","typeLabel":"enum\u003cstring> | null"},"stability":{"oneOf":[{"type":"number","title":"Stability","description":"Stability parameter; higher is more consistent.","maximum":1,"minimum":0,"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.1.stability.oneOf.0","typeLabel":"number"},{"type":"null","title":"Stability","description":"Stability parameter; higher is more consistent.","uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.1.stability.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.1.stability","typeLabel":"number | null"},"similarity":{"oneOf":[{"type":"number","title":"Similarity","description":"Similarity parameter; how closely to match the source voice.","maximum":1,"minimum":0,"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.1.similarity.oneOf.0","typeLabel":"number"},{"type":"null","title":"Similarity","description":"Similarity parameter; how closely to match the source voice.","uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.1.similarity.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.1.similarity","typeLabel":"number | null"}},"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.1","typeLabel":"FishEngineSettings · object"},{"type":"object","title":"StarfishEngineSettings","description":"Engine selection without tunable settings.\n\nSelects the engine named by ``engine_type`` on voices that support multiple engines.\nSend it in video creation requests to preserve the chosen engine.","required":["engine_type"],"properties":{"engine_type":{"const":"starfish","description":"Engine type discriminator for this settings variant.","title":"Engine Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.2.engine_type","typeLabel":"string"}},"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.2","typeLabel":"StarfishEngineSettings · object"},{"type":"object","title":"HeyGenVoiceEngineSettings","description":"HeyGen Voice controls for instant or professional voice clones.","required":["engine_type"],"properties":{"engine_type":{"description":"Engine type discriminator. 'heygen_voice' selects HeyGen Voice; 'orca' is accepted as its legacy alias.","enum":["heygen_voice","orca"],"title":"Engine Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.3.engine_type","typeLabel":"enum\u003cstring>"},"model":{"oneOf":[{"type":"string","title":"Model","description":"HeyGen Voice model for instant voice clones. Defaults to heygen-voice-1. Ignored for professional voice clones.","const":"heygen-voice-1","uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.3.model.oneOf.0","typeLabel":"string"},{"type":"null","title":"Model","description":"HeyGen Voice model for instant voice clones. Defaults to heygen-voice-1. Ignored for professional voice clones.","uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.3.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.3.model","typeLabel":"string | null"},"similarity":{"oneOf":[{"type":"string","title":"Similarity","description":"Similarity for instant voice clones. Ignored for professional voice clones.","enum":["medium","high","extra_high","max"],"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.3.similarity.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Similarity","description":"Similarity for instant voice clones. Ignored for professional voice clones.","uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.3.similarity.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.3.similarity","typeLabel":"enum\u003cstring> | null"},"expressiveness":{"oneOf":[{"type":"number","title":"Expressiveness","description":"Expressiveness from 0 to 1.","maximum":1,"minimum":0,"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.3.expressiveness.oneOf.0","typeLabel":"number"},{"type":"null","title":"Expressiveness","description":"Expressiveness from 0 to 1.","uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.3.expressiveness.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.3.expressiveness","typeLabel":"number | null"},"pitch":{"oneOf":[{"type":"number","title":"Pitch","description":"Pitch shift in semitones.","multipleOf":0.5,"maximum":4,"minimum":-4,"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.3.pitch.oneOf.0","typeLabel":"number"},{"type":"null","title":"Pitch","description":"Pitch shift in semitones.","uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.3.pitch.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.3.pitch","typeLabel":"number | null"},"inflection":{"oneOf":[{"type":"number","title":"Inflection","description":"Pitch variation multiplier.","maximum":2,"minimum":0.5,"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.3.inflection.oneOf.0","typeLabel":"number"},{"type":"null","title":"Inflection","description":"Pitch variation multiplier.","uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.3.inflection.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.3.inflection","typeLabel":"number | null"}},"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.3","typeLabel":"HeyGenVoiceEngineSettings · object"},{"type":"object","title":"CartesiaEngineSettings","description":"Engine-specific voice tuning, discriminated by 'engine_type'. Always name the engine and, where offered, its model so the request reflects the selected voice and model. The request is rejected if the voice_id is not compatible with the selected engine. Always send it. A request without it gets its engine at render time and can fail after the video is created.","required":["engine_type"],"properties":{"engine_type":{"const":"cartesia","description":"Select Cartesia.","title":"Engine Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.4.engine_type","typeLabel":"string"},"model":{"oneOf":[{"type":"string","title":"Model","description":"Cartesia Sonic model; omit for the engine default.","enum":["sonic-3.6","sonic-3.5"],"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.4.model.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Model","description":"Cartesia Sonic model; omit for the engine default.","uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.4.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.4.model","typeLabel":"enum\u003cstring> | null"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.4","typeLabel":"CartesiaEngineSettings · object"},{"type":"object","title":"MockingbirdEngineSettings","description":"Engine-specific voice tuning, discriminated by 'engine_type'. Always name the engine and, where offered, its model so the request reflects the selected voice and model. The request is rejected if the voice_id is not compatible with the selected engine. Always send it. A request without it gets its engine at render time and can fail after the video is created.","required":["engine_type"],"properties":{"engine_type":{"const":"mockingbird","description":"Select Mockingbird. A regional voice_settings.locale is required.","title":"Engine Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.5.engine_type","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.5","typeLabel":"MockingbirdEngineSettings · object"},{"type":"null","title":"Engine Settings","description":"Engine-specific voice tuning, discriminated by 'engine_type'. Always name the engine and, where offered, its model so the request reflects the selected voice and model. The request is rejected if the voice_id is not compatible with the selected engine. Always send it. A request without it gets its engine at render time and can fail after the video is created.","uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings.oneOf.6","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0.engine_settings","typeLabel":"ElevenLabsEngineSettings · object | FishEngineSettings · object | StarfishEngineSettings · object | HeyGenVoiceEngineSettings · object | CartesiaEngineSettings · object | MockingbirdEngineSettings · object | null"}},"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.0","typeLabel":"VoiceSettingsInput · object"},{"type":"null","description":"Voice settings. Always include engine_settings: the engine from GET /v3/videos/voice-capabilities, and a model only when that row lists models. locale is optional and is the accent only.","uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.voice_settings","typeLabel":"VoiceSettingsInput · object | null"},"brand_glossary_id":{"oneOf":[{"type":"string","title":"Brand Glossary Id","description":"Brand glossary ID controlling how custom terms are pronounced in generated speech (for example, saying 'HeyGen' as 'hey-jen'). Applies when the audio is synthesized from `script`; a caller-supplied `audio_url` or `audio_asset_id` is unaffected. Pronunciation is applied to the synthesized audio only, so caption and subtitle text still show the original script wording. Discover IDs via GET /v3/brand-glossaries.","minLength":1,"uniqueKey":"videos.items.[INDEX].oneOf.0.brand_glossary_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Brand Glossary Id","description":"Brand glossary ID controlling how custom terms are pronounced in generated speech (for example, saying 'HeyGen' as 'hey-jen'). Applies when the audio is synthesized from `script`; a caller-supplied `audio_url` or `audio_asset_id` is unaffected. Pronunciation is applied to the synthesized audio only, so caption and subtitle text still show the original script wording. Discover IDs via GET /v3/brand-glossaries.","uniqueKey":"videos.items.[INDEX].oneOf.0.brand_glossary_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.brand_glossary_id","typeLabel":"string | null"},"motion_prompt":{"oneOf":[{"type":"string","title":"Motion Prompt","description":"Natural-language prompt controlling avatar body motion and hand gestures. Supported for photo avatars on either engine, and for video avatars when engine.type is 'avatar_v'. Rejected for video avatars on the default Avatar IV engine, and for photo avatars on 'avatar_v' when the avatar's group has no animation reference (no digital twin or curated reference look).","uniqueKey":"videos.items.[INDEX].oneOf.0.motion_prompt.oneOf.0","typeLabel":"string"},{"type":"null","title":"Motion Prompt","description":"Natural-language prompt controlling avatar body motion and hand gestures. Supported for photo avatars on either engine, and for video avatars when engine.type is 'avatar_v'. Rejected for video avatars on the default Avatar IV engine, and for photo avatars on 'avatar_v' when the avatar's group has no animation reference (no digital twin or curated reference look).","uniqueKey":"videos.items.[INDEX].oneOf.0.motion_prompt.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.motion_prompt","typeLabel":"string | null"},"expressiveness":{"oneOf":[{"type":"string","title":"Expressiveness","description":"Avatar expressiveness level. Photo avatars only. Defaults to 'low' when omitted. Avatar IV only; rejected when engine.type is 'avatar_v'.","enum":["high","medium","low"],"uniqueKey":"videos.items.[INDEX].oneOf.0.expressiveness.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Avatar expressiveness level. Photo avatars only. Defaults to 'low' when omitted. Avatar IV only; rejected when engine.type is 'avatar_v'.","uniqueKey":"videos.items.[INDEX].oneOf.0.expressiveness.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.expressiveness","typeLabel":"enum\u003cstring> | null"},"engine":{"oneOf":[{"type":"object","title":"AvatarVEngineConfig","description":"Avatar V engine configuration with cross-reference-driven animation.","required":["type"],"properties":{"type":{"const":"avatar_v","description":"Engine type discriminator. Must be 'avatar_v'. Check supported_api_engines on the avatar look to confirm eligibility.","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.0.engine.oneOf.0.type","typeLabel":"string"},"reference_look_id":{"oneOf":[{"type":"string","title":"Reference Look Id","description":"Optional look to use as the animation reference. When provided, it must be a `digital_twin` look accessible to your workspace and in the same avatar group as `avatar_id` (`studio_avatar` and `photo_avatar` looks are rejected). When omitted, video avatars self-reference and photo avatars select from their group's eligible candidates, preferring digital twins (ready first, then processing / upgrading), then curated public studio looks. A photo avatar whose group has no eligible reference renders directly from its image without one; motion_prompt is rejected in that case. A non-public `digital_twin` reference, whether provided or selected automatically, must also satisfy its group's consent requirements.","uniqueKey":"videos.items.[INDEX].oneOf.0.engine.oneOf.0.reference_look_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Reference Look Id","description":"Optional look to use as the animation reference. When provided, it must be a `digital_twin` look accessible to your workspace and in the same avatar group as `avatar_id` (`studio_avatar` and `photo_avatar` looks are rejected). When omitted, video avatars self-reference and photo avatars select from their group's eligible candidates, preferring digital twins (ready first, then processing / upgrading), then curated public studio looks. A photo avatar whose group has no eligible reference renders directly from its image without one; motion_prompt is rejected in that case. A non-public `digital_twin` reference, whether provided or selected automatically, must also satisfy its group's consent requirements.","uniqueKey":"videos.items.[INDEX].oneOf.0.engine.oneOf.0.reference_look_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.engine.oneOf.0.reference_look_id","typeLabel":"string | null"},"more_blinking":{"default":false,"description":"Ask Avatar V for more natural blinking.","title":"More Blinking","type":"boolean","uniqueKey":"videos.items.[INDEX].oneOf.0.engine.oneOf.0.more_blinking","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.0.engine.oneOf.0","typeLabel":"AvatarVEngineConfig · object"},{"type":"object","title":"AvatarIVEngineConfig","description":"Avatar IV engine configuration (default behavior).","required":["type"],"properties":{"type":{"const":"avatar_iv","description":"Engine type discriminator. Must be 'avatar_iv'.","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.0.engine.oneOf.1.type","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.0.engine.oneOf.1","typeLabel":"AvatarIVEngineConfig · object"},{"type":"object","title":"AvatarIIIEngineConfig","description":"Avatar III engine configuration.\n\nA single engine value that resolves to the right product by the avatar's\nlook type (mirrors how ``avatar_iv`` already serves both photo and video\navatars):\n\n- video avatar looks (``digital_twin``, ``studio_avatar``) -> Digital Twin\n (supports 4K)\n- ``photo_avatar`` look -> Photo Avatar (no 4K output)\n\nNot supported for raw image input (``type: \"image\"``).\n``motion_prompt`` and ``expressiveness`` are not supported with this engine.","required":["type"],"properties":{"type":{"const":"avatar_iii","description":"Engine type discriminator. Must be 'avatar_iii'. Resolves to Digital Twin for video avatar looks (digital_twin, studio_avatar) and Photo Avatar for photo_avatar looks; not supported for raw image input. Check supported_api_engines on the avatar look to confirm eligibility.","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.0.engine.oneOf.2.type","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.0.engine.oneOf.2","typeLabel":"AvatarIIIEngineConfig · object"},{"type":"null","title":"Engine","description":"Engine configuration for video generation. Pass {\"type\": \"avatar_v\"} to enable cross-reference-driven animation for higher quality, or {\"type\": \"heygen-avatar-6\"} or {\"type\": \"heygen-avatar-6-turbo\"} for Avatar 6. Check supported_api_engines on the avatar look to confirm eligibility. Defaults to Avatar IV when omitted.","uniqueKey":"videos.items.[INDEX].oneOf.0.engine.oneOf.3","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.0.engine","typeLabel":"AvatarVEngineConfig · object | AvatarIVEngineConfig · object | AvatarIIIEngineConfig · object | null"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.0","typeLabel":"CreateBatchVideoFromAvatar · object"},{"type":"object","title":"CreateBatchVideoFromImage","description":"Create a lip-synced video from an image of a person.\n\nThe image must show a clearly visible, human-like face: a photo, or a realistic\nillustration of a person. Images without a detectable face are rejected with 400.\nFor non-human or stylized characters (mascots, animals, objects), use the\nimage_to_video or reference_to_video mode of POST /v3/models/videos instead.\n\nProvide an image via URL, asset ID, or inline base64. The image will be\nanimated with lip-sync to the provided audio or generated speech.","required":["type","image"],"properties":{"type":{"const":"image","description":"Must be 'image' for image-based video creation.","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.1.type","typeLabel":"string"},"image":{"oneOf":[{"type":"object","title":"AssetUrl","description":"Asset input via publicly accessible HTTPS URL.","required":["type","url"],"properties":{"type":{"const":"url","description":"Input type discriminator","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.1.image.oneOf.0.type","typeLabel":"string"},"url":{"description":"Public http(s) URL HeyGen can download without auth or redirects. Not a local or sandbox path (/mnt/data/..., file://, sandbox:); upload such files and pass asset_id.","title":"Url","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.1.image.oneOf.0.url","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.1.image.oneOf.0","typeLabel":"AssetUrl · object"},{"type":"object","title":"AssetId","description":"Asset input via HeyGen asset ID from the asset upload endpoint.","required":["type","asset_id"],"properties":{"type":{"const":"asset_id","description":"Input type discriminator","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.1.image.oneOf.1.type","typeLabel":"string"},"asset_id":{"description":"HeyGen asset ID from an asset upload or import; not a third-party file ID.","title":"Asset Id","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.1.image.oneOf.1.asset_id","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.1.image.oneOf.1","typeLabel":"AssetId · object"},{"type":"object","title":"AssetBase64","description":"Asset input via base64-encoded content.","required":["type","media_type","data"],"x-mcp-visible":false,"properties":{"type":{"const":"base64","description":"Input type discriminator","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.1.image.oneOf.2.type","typeLabel":"string"},"media_type":{"description":"MIME type of the encoded content (e.g. \"image/png\")","title":"Media Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.1.image.oneOf.2.media_type","typeLabel":"string"},"data":{"description":"Base64-encoded file content","title":"Data","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.1.image.oneOf.2.data","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.1.image.oneOf.2","typeLabel":"AssetBase64 · object"}],"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.1.image","typeLabel":"AssetUrl · object | AssetId · object | AssetBase64 · object"},"title":{"oneOf":[{"type":"string","title":"Title","description":"Display title for the video in the HeyGen dashboard.","uniqueKey":"videos.items.[INDEX].oneOf.1.title.oneOf.0","typeLabel":"string"},{"type":"null","title":"Title","description":"Display title for the video in the HeyGen dashboard.","uniqueKey":"videos.items.[INDEX].oneOf.1.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.title","typeLabel":"string | null"},"resolution":{"oneOf":[{"type":"string","title":"VideoResolution","description":"Output video resolution. Defaults to 720p. `4k` is available for Avatar III digital twins and studio avatars. For apps signed in with OAuth, such as MCP clients, the account's plan sets the maximum: 720p on Free, 1080p on Creator.","enum":["4k","1080p","720p"],"uniqueKey":"videos.items.[INDEX].oneOf.1.resolution.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Output video resolution. Defaults to 720p. `4k` is available for Avatar III digital twins and studio avatars. For apps signed in with OAuth, such as MCP clients, the account's plan sets the maximum: 720p on Free, 1080p on Creator.","uniqueKey":"videos.items.[INDEX].oneOf.1.resolution.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.resolution","typeLabel":"enum\u003cstring> | null"},"aspect_ratio":{"oneOf":[{"type":"string","title":"VideoAspectRatio","description":"Output video aspect ratio. Supported values: '16:9', '9:16', '4:5', '5:4', '1:1', 'auto'. Defaults to '16:9'. 'auto' preserves the source's aspect ratio (avatar source frames or uploaded image), short-edge anchored to the requested resolution and capped at the tier's long edge. Falls back to '16:9' when source dimensions can't be read.","default":"16:9","enum":["16:9","9:16","4:5","5:4","1:1","auto"],"x-cli-default":"auto","x-mcp-default":"auto","uniqueKey":"videos.items.[INDEX].oneOf.1.aspect_ratio.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Output video aspect ratio. Supported values: '16:9', '9:16', '4:5', '5:4', '1:1', 'auto'. Defaults to '16:9'. 'auto' preserves the source's aspect ratio (avatar source frames or uploaded image), short-edge anchored to the requested resolution and capped at the tier's long edge. Falls back to '16:9' when source dimensions can't be read.","default":"16:9","x-cli-default":"auto","x-mcp-default":"auto","uniqueKey":"videos.items.[INDEX].oneOf.1.aspect_ratio.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.aspect_ratio","typeLabel":"enum\u003cstring> | null"},"fit":{"oneOf":[{"type":"string","title":"AvatarFit","description":"How the subject is fitted to the output canvas. 'cover' scales to fill the frame (may crop edges). 'contain' scales to fit entirely within the frame (may show background). When omitted, the server picks the best option based on the source and canvas orientations.","enum":["contain","cover"],"uniqueKey":"videos.items.[INDEX].oneOf.1.fit.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"How the subject is fitted to the output canvas. 'cover' scales to fill the frame (may crop edges). 'contain' scales to fit entirely within the frame (may show background). When omitted, the server picks the best option based on the source and canvas orientations.","uniqueKey":"videos.items.[INDEX].oneOf.1.fit.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.fit","typeLabel":"enum\u003cstring> | null"},"background":{"oneOf":[{"type":"object","title":"BackgroundSetting","description":"Background settings for the video.","required":["type"],"properties":{"type":{"description":"Background type. 'color' uses a solid hex color; 'image' uses an image from url or asset_id.","enum":["color","image"],"title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.1.background.oneOf.0.type","typeLabel":"enum\u003cstring>"},"value":{"oneOf":[{"type":"string","title":"Value","description":"Hex color code (e.g. '#ff0000'). Required when type is 'color'.","uniqueKey":"videos.items.[INDEX].oneOf.1.background.oneOf.0.value.oneOf.0","typeLabel":"string"},{"type":"null","title":"Value","description":"Hex color code (e.g. '#ff0000'). Required when type is 'color'.","uniqueKey":"videos.items.[INDEX].oneOf.1.background.oneOf.0.value.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.background.oneOf.0.value","typeLabel":"string | null"},"url":{"oneOf":[{"type":"string","title":"Url","description":"URL of the background image. Used when type is 'image'. Mutually exclusive with asset_id.","uniqueKey":"videos.items.[INDEX].oneOf.1.background.oneOf.0.url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Url","description":"URL of the background image. Used when type is 'image'. Mutually exclusive with asset_id.","uniqueKey":"videos.items.[INDEX].oneOf.1.background.oneOf.0.url.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.background.oneOf.0.url","typeLabel":"string | null"},"asset_id":{"oneOf":[{"type":"string","title":"Asset Id","description":"HeyGen asset ID of the background image. Used when type is 'image'. Mutually exclusive with url.","uniqueKey":"videos.items.[INDEX].oneOf.1.background.oneOf.0.asset_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Asset Id","description":"HeyGen asset ID of the background image. Used when type is 'image'. Mutually exclusive with url.","uniqueKey":"videos.items.[INDEX].oneOf.1.background.oneOf.0.asset_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.background.oneOf.0.asset_id","typeLabel":"string | null"}},"uniqueKey":"videos.items.[INDEX].oneOf.1.background.oneOf.0","typeLabel":"BackgroundSetting · object"},{"type":"null","description":"Background settings for the video.","uniqueKey":"videos.items.[INDEX].oneOf.1.background.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.background","typeLabel":"BackgroundSetting · object | null"},"remove_background":{"oneOf":[{"type":"boolean","title":"Remove Background","description":"Remove the avatar background. Video avatars must be trained with matting enabled.","uniqueKey":"videos.items.[INDEX].oneOf.1.remove_background.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Remove Background","description":"Remove the avatar background. Video avatars must be trained with matting enabled.","uniqueKey":"videos.items.[INDEX].oneOf.1.remove_background.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.remove_background","typeLabel":"boolean | null"},"callback_url":{"oneOf":[{"type":"string","title":"Callback Url","description":"Webhook URL to receive a POST notification when the video is ready.","uniqueKey":"videos.items.[INDEX].oneOf.1.callback_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Callback Url","description":"Webhook URL to receive a POST notification when the video is ready.","uniqueKey":"videos.items.[INDEX].oneOf.1.callback_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.callback_url","typeLabel":"string | null"},"callback_id":{"oneOf":[{"type":"string","title":"Callback Id","description":"Caller-defined identifier echoed back in the webhook payload.","uniqueKey":"videos.items.[INDEX].oneOf.1.callback_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Callback Id","description":"Caller-defined identifier echoed back in the webhook payload.","uniqueKey":"videos.items.[INDEX].oneOf.1.callback_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.callback_id","typeLabel":"string | null"},"watermark":{"oneOf":[{"type":"object","title":"WatermarkInput","description":"Custom watermark image to overlay on the video (PNG or JPEG). Available to workspaces on an Enterprise web or API plan.","required":["image"],"x-cli-visible":false,"x-mcp-visible":false,"properties":{"image":{"oneOf":[{"type":"object","title":"AssetUrl","description":"Asset input via publicly accessible HTTPS URL.","required":["type","url"],"properties":{"type":{"const":"url","description":"Input type discriminator","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.1.watermark.oneOf.0.image.oneOf.0.type","typeLabel":"string"},"url":{"description":"Public http(s) URL HeyGen can download without auth or redirects. Not a local or sandbox path (/mnt/data/..., file://, sandbox:); upload such files and pass asset_id.","title":"Url","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.1.watermark.oneOf.0.image.oneOf.0.url","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.1.watermark.oneOf.0.image.oneOf.0","typeLabel":"AssetUrl · object"},{"type":"object","title":"AssetId","description":"Asset input via HeyGen asset ID from the asset upload endpoint.","required":["type","asset_id"],"properties":{"type":{"const":"asset_id","description":"Input type discriminator","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.1.watermark.oneOf.0.image.oneOf.1.type","typeLabel":"string"},"asset_id":{"description":"HeyGen asset ID from an asset upload or import; not a third-party file ID.","title":"Asset Id","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.1.watermark.oneOf.0.image.oneOf.1.asset_id","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.1.watermark.oneOf.0.image.oneOf.1","typeLabel":"AssetId · object"},{"type":"object","title":"AssetBase64","description":"Asset input via base64-encoded content.","required":["type","media_type","data"],"x-mcp-visible":false,"properties":{"type":{"const":"base64","description":"Input type discriminator","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.1.watermark.oneOf.0.image.oneOf.2.type","typeLabel":"string"},"media_type":{"description":"MIME type of the encoded content (e.g. \"image/png\")","title":"Media Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.1.watermark.oneOf.0.image.oneOf.2.media_type","typeLabel":"string"},"data":{"description":"Base64-encoded file content","title":"Data","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.1.watermark.oneOf.0.image.oneOf.2.data","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.1.watermark.oneOf.0.image.oneOf.2","typeLabel":"AssetBase64 · object"}],"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.1.watermark.oneOf.0.image","typeLabel":"AssetUrl · object | AssetId · object | AssetBase64 · object"},"scale":{"default":1,"description":"Scale multiplier for the watermark image. 1.0 renders at native size.","exclusiveMinimum":0,"maximum":2,"title":"Scale","type":"number","uniqueKey":"videos.items.[INDEX].oneOf.1.watermark.oneOf.0.scale","typeLabel":"number"},"opacity":{"default":1,"description":"Watermark opacity. 0.0 is fully transparent, 1.0 is fully opaque.","maximum":1,"minimum":0,"title":"Opacity","type":"number","uniqueKey":"videos.items.[INDEX].oneOf.1.watermark.oneOf.0.opacity","typeLabel":"number"},"placement":{"oneOf":[{"type":"object","title":"WatermarkPlacement","description":"Watermark placement. Defaults to bottom-right with standard margins when omitted.","properties":{"position":{"description":"Anchor corner for the watermark.","enum":["top_left","top_right","bottom_left","bottom_right"],"title":"WatermarkPosition","type":"string","default":"bottom_right","uniqueKey":"videos.items.[INDEX].oneOf.1.watermark.oneOf.0.placement.oneOf.0.position","typeLabel":"enum\u003cstring>"},"offset_x":{"oneOf":[{"type":"number","title":"Offset X","description":"Fine-tune horizontal position. Fraction of frame width; 0.05 shifts 5% rightward, -0.05 shifts 5% leftward.","maximum":1,"minimum":-1,"uniqueKey":"videos.items.[INDEX].oneOf.1.watermark.oneOf.0.placement.oneOf.0.offset_x.oneOf.0","typeLabel":"number"},{"type":"null","title":"Offset X","description":"Fine-tune horizontal position. Fraction of frame width; 0.05 shifts 5% rightward, -0.05 shifts 5% leftward.","uniqueKey":"videos.items.[INDEX].oneOf.1.watermark.oneOf.0.placement.oneOf.0.offset_x.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.watermark.oneOf.0.placement.oneOf.0.offset_x","typeLabel":"number | null"},"offset_y":{"oneOf":[{"type":"number","title":"Offset Y","description":"Fine-tune vertical position. Fraction of frame height; 0.05 shifts 5% downward, -0.05 shifts 5% upward.","maximum":1,"minimum":-1,"uniqueKey":"videos.items.[INDEX].oneOf.1.watermark.oneOf.0.placement.oneOf.0.offset_y.oneOf.0","typeLabel":"number"},{"type":"null","title":"Offset Y","description":"Fine-tune vertical position. Fraction of frame height; 0.05 shifts 5% downward, -0.05 shifts 5% upward.","uniqueKey":"videos.items.[INDEX].oneOf.1.watermark.oneOf.0.placement.oneOf.0.offset_y.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.watermark.oneOf.0.placement.oneOf.0.offset_y","typeLabel":"number | null"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.1.watermark.oneOf.0.placement.oneOf.0","typeLabel":"WatermarkPlacement · object"},{"type":"null","description":"Watermark placement. Defaults to bottom-right with standard margins when omitted.","uniqueKey":"videos.items.[INDEX].oneOf.1.watermark.oneOf.0.placement.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.watermark.oneOf.0.placement","typeLabel":"WatermarkPlacement · object | null"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.1.watermark.oneOf.0","typeLabel":"WatermarkInput · object"},{"type":"null","description":"Custom watermark image to overlay on the video (PNG or JPEG). Available to workspaces on an Enterprise web or API plan.","x-cli-visible":false,"x-mcp-visible":false,"uniqueKey":"videos.items.[INDEX].oneOf.1.watermark.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.watermark","typeLabel":"WatermarkInput · object | null"},"caption":{"oneOf":[{"type":"object","title":"CaptionSetting","description":"Caption generation settings. A sidecar subtitle file is always returned via subtitle_url; set 'style' to additionally burn captions into the rendered video.","properties":{"file_format":{"description":"Output format for the sidecar caption file.","enum":["srt"],"title":"CaptionFileFormat","type":"string","default":"srt","uniqueKey":"videos.items.[INDEX].oneOf.1.caption.oneOf.0.file_format","typeLabel":"enum\u003cstring>"},"style":{"oneOf":[{"type":"string","title":"CaptionStyle","description":"Visual style for burning captions into the rendered video. Omit for sidecar-only captions.","enum":["default"],"uniqueKey":"videos.items.[INDEX].oneOf.1.caption.oneOf.0.style.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Visual style for burning captions into the rendered video. Omit for sidecar-only captions.","uniqueKey":"videos.items.[INDEX].oneOf.1.caption.oneOf.0.style.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.caption.oneOf.0.style","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"videos.items.[INDEX].oneOf.1.caption.oneOf.0","typeLabel":"CaptionSetting · object"},{"type":"null","description":"Caption generation settings. A sidecar subtitle file is always returned via subtitle_url; set 'style' to additionally burn captions into the rendered video.","uniqueKey":"videos.items.[INDEX].oneOf.1.caption.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.caption","typeLabel":"CaptionSetting · object | null"},"output_format":{"description":"Output container. 'webm' returns a video with a transparent background (alpha channel); 'mp4' (default) returns a standard video. 'webm' requires an avatar that supports matting. When 'webm' is selected, any 'background' value is rejected and background removal is applied automatically — the caller does not need to set 'remove_background'.","enum":["mp4","webm"],"title":"VideoOutputFormat","type":"string","default":"mp4","uniqueKey":"videos.items.[INDEX].oneOf.1.output_format","typeLabel":"enum\u003cstring>"},"script":{"oneOf":[{"type":"string","title":"Script","description":"Text script for the avatar to speak. Pair with voice_id, or omit voice_id when using avatar_id to use the avatar's default voice. Mutually exclusive with audio_url/audio_asset_id.","minLength":1,"uniqueKey":"videos.items.[INDEX].oneOf.1.script.oneOf.0","typeLabel":"string"},{"type":"null","title":"Script","description":"Text script for the avatar to speak. Pair with voice_id, or omit voice_id when using avatar_id to use the avatar's default voice. Mutually exclusive with audio_url/audio_asset_id.","uniqueKey":"videos.items.[INDEX].oneOf.1.script.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.script","typeLabel":"string | null"},"voice_id":{"oneOf":[{"type":"string","title":"Voice Id","description":"Voice ID for text-to-speech. Required when script is provided, unless avatar_id is set (the avatar's default voice is used as fallback).","uniqueKey":"videos.items.[INDEX].oneOf.1.voice_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Voice Id","description":"Voice ID for text-to-speech. Required when script is provided, unless avatar_id is set (the avatar's default voice is used as fallback).","uniqueKey":"videos.items.[INDEX].oneOf.1.voice_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_id","typeLabel":"string | null"},"audio_url":{"oneOf":[{"type":"string","title":"Audio Url","description":"Public http(s) URL of an audio file to lip-sync. Mutually exclusive with script. Not a local or sandbox path (/mnt/data/..., file://); upload it and pass audio_asset_id.","uniqueKey":"videos.items.[INDEX].oneOf.1.audio_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Audio Url","description":"Public http(s) URL of an audio file to lip-sync. Mutually exclusive with script. Not a local or sandbox path (/mnt/data/..., file://); upload it and pass audio_asset_id.","uniqueKey":"videos.items.[INDEX].oneOf.1.audio_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.audio_url","typeLabel":"string | null"},"audio_asset_id":{"oneOf":[{"type":"string","title":"Audio Asset Id","description":"HeyGen asset ID of an uploaded audio file. Mutually exclusive with script.","uniqueKey":"videos.items.[INDEX].oneOf.1.audio_asset_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Audio Asset Id","description":"HeyGen asset ID of an uploaded audio file. Mutually exclusive with script.","uniqueKey":"videos.items.[INDEX].oneOf.1.audio_asset_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.audio_asset_id","typeLabel":"string | null"},"voice_settings":{"oneOf":[{"type":"object","title":"VoiceSettingsInput","description":"Voice settings. Always include engine_settings: the engine from GET /v3/videos/voice-capabilities, and a model only when that row lists models. locale is optional and is the accent only.","properties":{"speed":{"default":1,"description":"Playback speed multiplier. 0.5 (half speed) to 1.5 (1.5x speed).","maximum":1.5,"minimum":0.5,"title":"Speed","type":"number","uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.speed","typeLabel":"number"},"pitch":{"default":0,"description":"Legacy pitch adjustment, normalized to -1 to 1 before synthesis. Among the six documented engines, only Mockingbird can apply it when its base TTS uses Azure; use engine_settings.pitch for HeyGen Voice.","maximum":50,"minimum":-50,"title":"Pitch","type":"number","uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.pitch","typeLabel":"number"},"volume":{"default":1,"description":"Voice audio volume. 1.0 = full, 0.0 = silent. Useful when mixing spoken voice with background audio.","maximum":1,"minimum":0,"title":"Volume","type":"number","uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.volume","typeLabel":"number"},"locale":{"oneOf":[{"type":"string","title":"Locale","description":"Accent the user asked for (e.g. 'en-US'). It is not the script language; the language is read from the script. Omit for Original Accent, the voice's natural accent. Send only a locale that GET /v3/videos/voice-capabilities lists for the script's language and the engine in engine_settings. Mockingbird requires a regional locale.","uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.locale.oneOf.0","typeLabel":"string"},{"type":"null","title":"Locale","description":"Accent the user asked for (e.g. 'en-US'). It is not the script language; the language is read from the script. Omit for Original Accent, the voice's natural accent. Send only a locale that GET /v3/videos/voice-capabilities lists for the script's language and the engine in engine_settings. Mockingbird requires a regional locale.","uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.locale.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.locale","typeLabel":"string | null"},"engine_settings":{"oneOf":[{"type":"object","title":"ElevenLabsEngineSettings","description":"Engine-specific voice settings for ElevenLabs-backed voices.\n\nSupports model, stability, similarity_boost, style, and use_speaker_boost.\nWhen using eleven_v3 or eleven_v4, stability may be any value in [0.0, 1.0].","required":["engine_type"],"properties":{"engine_type":{"const":"elevenlabs","description":"Engine type discriminator. Must be 'elevenlabs' for ElevenLabs-backed voices.","title":"Engine Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.engine_type","typeLabel":"string"},"model":{"oneOf":[{"type":"string","description":"ElevenLabs model. eleven_v3 and eleven_v4 use stability only; similarity_boost, style, and use_speaker_boost have no effect on them.","enum":["eleven_multilingual_v2","eleven_turbo_v2_5","eleven_v3","eleven_v4"],"x-mcp-schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.model.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"ElevenLabs model. eleven_v3 and eleven_v4 use stability only; similarity_boost, style, and use_speaker_boost have no effect on them.","x-mcp-schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.model","typeLabel":"enum\u003cstring> | null"},"similarity_boost":{"oneOf":[{"type":"number","title":"Similarity Boost","description":"The similarity boost parameter for ElevenLabs.","maximum":1,"minimum":0,"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.similarity_boost.oneOf.0","typeLabel":"number"},{"type":"null","title":"Similarity Boost","description":"The similarity boost parameter for ElevenLabs.","uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.similarity_boost.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.similarity_boost","typeLabel":"number | null"},"stability":{"oneOf":[{"type":"number","title":"Stability","description":"The stability parameter for ElevenLabs.","maximum":1,"minimum":0,"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.stability.oneOf.0","typeLabel":"number"},{"type":"null","title":"Stability","description":"The stability parameter for ElevenLabs.","uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.stability.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.stability","typeLabel":"number | null"},"style":{"oneOf":[{"type":"number","title":"Style","description":"The style parameter for ElevenLabs.","maximum":1,"minimum":0,"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.style.oneOf.0","typeLabel":"number"},{"type":"null","title":"Style","description":"The style parameter for ElevenLabs.","uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.style.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.style","typeLabel":"number | null"},"use_speaker_boost":{"oneOf":[{"type":"boolean","title":"Use Speaker Boost","description":"Whether to use speaker boost for ElevenLabs.","uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.use_speaker_boost.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Use Speaker Boost","description":"Whether to use speaker boost for ElevenLabs.","uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.use_speaker_boost.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.use_speaker_boost","typeLabel":"boolean | null"}},"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0","typeLabel":"ElevenLabsEngineSettings · object"},{"type":"object","title":"FishEngineSettings","description":"Engine-specific voice settings for Fish Audio-backed voices.\n\nInherits Fish's tuning fields (model, stability, similarity).","required":["engine_type"],"properties":{"engine_type":{"const":"fish","description":"Engine type discriminator. Must be 'fish' for Fish Audio-backed voices.","title":"Engine Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.1.engine_type","typeLabel":"string"},"model":{"oneOf":[{"type":"string","description":"Fish Audio model version. Defaults to s2.1-pro when omitted.","enum":["s2.1-pro","s2-pro"],"x-mcp-schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.1.model.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Fish Audio model version. Defaults to s2.1-pro when omitted.","x-mcp-schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.1.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.1.model","typeLabel":"enum\u003cstring> | null"},"stability":{"oneOf":[{"type":"number","title":"Stability","description":"Stability parameter; higher is more consistent.","maximum":1,"minimum":0,"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.1.stability.oneOf.0","typeLabel":"number"},{"type":"null","title":"Stability","description":"Stability parameter; higher is more consistent.","uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.1.stability.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.1.stability","typeLabel":"number | null"},"similarity":{"oneOf":[{"type":"number","title":"Similarity","description":"Similarity parameter; how closely to match the source voice.","maximum":1,"minimum":0,"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.1.similarity.oneOf.0","typeLabel":"number"},{"type":"null","title":"Similarity","description":"Similarity parameter; how closely to match the source voice.","uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.1.similarity.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.1.similarity","typeLabel":"number | null"}},"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.1","typeLabel":"FishEngineSettings · object"},{"type":"object","title":"StarfishEngineSettings","description":"Engine selection without tunable settings.\n\nSelects the engine named by ``engine_type`` on voices that support multiple engines.\nSend it in video creation requests to preserve the chosen engine.","required":["engine_type"],"properties":{"engine_type":{"const":"starfish","description":"Engine type discriminator for this settings variant.","title":"Engine Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.2.engine_type","typeLabel":"string"}},"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.2","typeLabel":"StarfishEngineSettings · object"},{"type":"object","title":"HeyGenVoiceEngineSettings","description":"HeyGen Voice controls for instant or professional voice clones.","required":["engine_type"],"properties":{"engine_type":{"description":"Engine type discriminator. 'heygen_voice' selects HeyGen Voice; 'orca' is accepted as its legacy alias.","enum":["heygen_voice","orca"],"title":"Engine Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.engine_type","typeLabel":"enum\u003cstring>"},"model":{"oneOf":[{"type":"string","title":"Model","description":"HeyGen Voice model for instant voice clones. Defaults to heygen-voice-1. Ignored for professional voice clones.","const":"heygen-voice-1","uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.model.oneOf.0","typeLabel":"string"},{"type":"null","title":"Model","description":"HeyGen Voice model for instant voice clones. Defaults to heygen-voice-1. Ignored for professional voice clones.","uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.model","typeLabel":"string | null"},"similarity":{"oneOf":[{"type":"string","title":"Similarity","description":"Similarity for instant voice clones. Ignored for professional voice clones.","enum":["medium","high","extra_high","max"],"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.similarity.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Similarity","description":"Similarity for instant voice clones. Ignored for professional voice clones.","uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.similarity.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.similarity","typeLabel":"enum\u003cstring> | null"},"expressiveness":{"oneOf":[{"type":"number","title":"Expressiveness","description":"Expressiveness from 0 to 1.","maximum":1,"minimum":0,"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.expressiveness.oneOf.0","typeLabel":"number"},{"type":"null","title":"Expressiveness","description":"Expressiveness from 0 to 1.","uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.expressiveness.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.expressiveness","typeLabel":"number | null"},"pitch":{"oneOf":[{"type":"number","title":"Pitch","description":"Pitch shift in semitones.","multipleOf":0.5,"maximum":4,"minimum":-4,"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.pitch.oneOf.0","typeLabel":"number"},{"type":"null","title":"Pitch","description":"Pitch shift in semitones.","uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.pitch.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.pitch","typeLabel":"number | null"},"inflection":{"oneOf":[{"type":"number","title":"Inflection","description":"Pitch variation multiplier.","maximum":2,"minimum":0.5,"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.inflection.oneOf.0","typeLabel":"number"},{"type":"null","title":"Inflection","description":"Pitch variation multiplier.","uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.inflection.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.inflection","typeLabel":"number | null"}},"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3","typeLabel":"HeyGenVoiceEngineSettings · object"},{"type":"object","title":"CartesiaEngineSettings","description":"Engine-specific voice tuning, discriminated by 'engine_type'. Always name the engine and, where offered, its model so the request reflects the selected voice and model. The request is rejected if the voice_id is not compatible with the selected engine. Always send it. A request without it gets its engine at render time and can fail after the video is created.","required":["engine_type"],"properties":{"engine_type":{"const":"cartesia","description":"Select Cartesia.","title":"Engine Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.4.engine_type","typeLabel":"string"},"model":{"oneOf":[{"type":"string","title":"Model","description":"Cartesia Sonic model; omit for the engine default.","enum":["sonic-3.6","sonic-3.5"],"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.4.model.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Model","description":"Cartesia Sonic model; omit for the engine default.","uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.4.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.4.model","typeLabel":"enum\u003cstring> | null"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.4","typeLabel":"CartesiaEngineSettings · object"},{"type":"object","title":"MockingbirdEngineSettings","description":"Engine-specific voice tuning, discriminated by 'engine_type'. Always name the engine and, where offered, its model so the request reflects the selected voice and model. The request is rejected if the voice_id is not compatible with the selected engine. Always send it. A request without it gets its engine at render time and can fail after the video is created.","required":["engine_type"],"properties":{"engine_type":{"const":"mockingbird","description":"Select Mockingbird. A regional voice_settings.locale is required.","title":"Engine Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.5.engine_type","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.5","typeLabel":"MockingbirdEngineSettings · object"},{"type":"null","title":"Engine Settings","description":"Engine-specific voice tuning, discriminated by 'engine_type'. Always name the engine and, where offered, its model so the request reflects the selected voice and model. The request is rejected if the voice_id is not compatible with the selected engine. Always send it. A request without it gets its engine at render time and can fail after the video is created.","uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.6","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings","typeLabel":"ElevenLabsEngineSettings · object | FishEngineSettings · object | StarfishEngineSettings · object | HeyGenVoiceEngineSettings · object | CartesiaEngineSettings · object | MockingbirdEngineSettings · object | null"}},"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.0","typeLabel":"VoiceSettingsInput · object"},{"type":"null","description":"Voice settings. Always include engine_settings: the engine from GET /v3/videos/voice-capabilities, and a model only when that row lists models. locale is optional and is the accent only.","uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.voice_settings","typeLabel":"VoiceSettingsInput · object | null"},"brand_glossary_id":{"oneOf":[{"type":"string","title":"Brand Glossary Id","description":"Brand glossary ID controlling how custom terms are pronounced in generated speech (for example, saying 'HeyGen' as 'hey-jen'). Applies when the audio is synthesized from `script`; a caller-supplied `audio_url` or `audio_asset_id` is unaffected. Pronunciation is applied to the synthesized audio only, so caption and subtitle text still show the original script wording. Discover IDs via GET /v3/brand-glossaries.","minLength":1,"uniqueKey":"videos.items.[INDEX].oneOf.1.brand_glossary_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Brand Glossary Id","description":"Brand glossary ID controlling how custom terms are pronounced in generated speech (for example, saying 'HeyGen' as 'hey-jen'). Applies when the audio is synthesized from `script`; a caller-supplied `audio_url` or `audio_asset_id` is unaffected. Pronunciation is applied to the synthesized audio only, so caption and subtitle text still show the original script wording. Discover IDs via GET /v3/brand-glossaries.","uniqueKey":"videos.items.[INDEX].oneOf.1.brand_glossary_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.brand_glossary_id","typeLabel":"string | null"},"motion_prompt":{"oneOf":[{"type":"string","title":"Motion Prompt","description":"Natural-language prompt controlling avatar body motion. Photo avatars only.","uniqueKey":"videos.items.[INDEX].oneOf.1.motion_prompt.oneOf.0","typeLabel":"string"},{"type":"null","title":"Motion Prompt","description":"Natural-language prompt controlling avatar body motion. Photo avatars only.","uniqueKey":"videos.items.[INDEX].oneOf.1.motion_prompt.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.motion_prompt","typeLabel":"string | null"},"expressiveness":{"oneOf":[{"type":"string","title":"Expressiveness","description":"Avatar expressiveness level. Photo avatars only. Defaults to 'low' when omitted.","enum":["high","medium","low"],"uniqueKey":"videos.items.[INDEX].oneOf.1.expressiveness.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Avatar expressiveness level. Photo avatars only. Defaults to 'low' when omitted.","uniqueKey":"videos.items.[INDEX].oneOf.1.expressiveness.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.1.expressiveness","typeLabel":"enum\u003cstring> | null"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.1","typeLabel":"CreateBatchVideoFromImage · object"},{"type":"object","title":"CreateBatchVideoFromCinematicAvatar","description":"Create a video from a text prompt plus avatar and asset references (Cinematic Avatar).\n\nCinematic Avatar generates a video from a natural-language ``prompt`` guided by\nreference content: one to three avatar looks and optional reference assets\n(images / videos / audio). Unlike the ``avatar`` and ``image`` modes there is\nno script or voice — motion and speech are driven entirely by the prompt and\nthe supplied references. The video model is chosen with ``model``.","required":["type","prompt","avatar_id"],"properties":{"type":{"const":"cinematic_avatar","description":"Must be 'cinematic_avatar' for prompt-and-reference video creation.","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.2.type","typeLabel":"string"},"prompt":{"description":"Natural-language prompt describing the video to generate.","maxLength":10000,"minLength":1,"title":"Prompt","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.2.prompt","typeLabel":"string"},"avatar_id":{"description":"Avatar look ID(s) used as visual references. Provide 1 to 3 look IDs.","items":{"type":"string","uniqueKey":"videos.items.[INDEX].oneOf.2.avatar_id.items.[INDEX]","typeLabel":"string"},"title":"Avatar Id","type":"array","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.2.avatar_id","typeLabel":"string[]"},"model":{"oneOf":[{"type":"string","title":"CinematicAvatarModel","description":"Video model that renders the shot. Omitted means 'seedance_2'. 'seedance_2' supports every aspect_ratio and resolution below. 'heygen_video_1' renders 16:9 or 9:16 at 720p, 5–15 seconds long; it accepts each reference asset_id once.","enum":["seedance_2","heygen_video_1"],"uniqueKey":"videos.items.[INDEX].oneOf.2.model.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Video model that renders the shot. Omitted means 'seedance_2'. 'seedance_2' supports every aspect_ratio and resolution below. 'heygen_video_1' renders 16:9 or 9:16 at 720p, 5–15 seconds long; it accepts each reference asset_id once.","uniqueKey":"videos.items.[INDEX].oneOf.2.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.2.model","typeLabel":"enum\u003cstring> | null"},"references":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"object","title":"AssetUrl","description":"Asset input via publicly accessible HTTPS URL.","required":["type","url"],"properties":{"type":{"const":"url","description":"Input type discriminator","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.2.references.oneOf.0.items.[INDEX].oneOf.0.type","typeLabel":"string"},"url":{"description":"Public http(s) URL HeyGen can download without auth or redirects. Not a local or sandbox path (/mnt/data/..., file://, sandbox:); upload such files and pass asset_id.","title":"Url","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.2.references.oneOf.0.items.[INDEX].oneOf.0.url","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.2.references.oneOf.0.items.[INDEX].oneOf.0","typeLabel":"AssetUrl · object"},{"type":"object","title":"AssetId","description":"Asset input via HeyGen asset ID from the asset upload endpoint.","required":["type","asset_id"],"properties":{"type":{"const":"asset_id","description":"Input type discriminator","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.2.references.oneOf.0.items.[INDEX].oneOf.1.type","typeLabel":"string"},"asset_id":{"description":"HeyGen asset ID from an asset upload or import; not a third-party file ID.","title":"Asset Id","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.2.references.oneOf.0.items.[INDEX].oneOf.1.asset_id","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.2.references.oneOf.0.items.[INDEX].oneOf.1","typeLabel":"AssetId · object"},{"type":"object","title":"AssetBase64","description":"Asset input via base64-encoded content.","required":["type","media_type","data"],"x-mcp-visible":false,"properties":{"type":{"const":"base64","description":"Input type discriminator","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.2.references.oneOf.0.items.[INDEX].oneOf.2.type","typeLabel":"string"},"media_type":{"description":"MIME type of the encoded content (e.g. \"image/png\")","title":"Media Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.2.references.oneOf.0.items.[INDEX].oneOf.2.media_type","typeLabel":"string"},"data":{"description":"Base64-encoded file content","title":"Data","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.2.references.oneOf.0.items.[INDEX].oneOf.2.data","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.2.references.oneOf.0.items.[INDEX].oneOf.2","typeLabel":"AssetBase64 · object"}],"uniqueKey":"videos.items.[INDEX].oneOf.2.references.oneOf.0.items.[INDEX]","typeLabel":"AssetUrl · object | AssetId · object | AssetBase64 · object"},"title":"References","description":"Reference assets (images, videos, or audio) guiding the generation. Each accepts a URL, an asset_id, or inline base64. Combined limits: at most 3 videos and 9 images across avatars and references. 'heygen_video_1' also accepts at most 3 audio clips (avatar voices included), 12 references in total, and 15 seconds of reference video, each avatar counting 3 seconds.","uniqueKey":"videos.items.[INDEX].oneOf.2.references.oneOf.0","typeLabel":"(AssetUrl · object | AssetId · object | AssetBase64 · object)[]"},{"type":"null","title":"References","description":"Reference assets (images, videos, or audio) guiding the generation. Each accepts a URL, an asset_id, or inline base64. Combined limits: at most 3 videos and 9 images across avatars and references. 'heygen_video_1' also accepts at most 3 audio clips (avatar voices included), 12 references in total, and 15 seconds of reference video, each avatar counting 3 seconds.","uniqueKey":"videos.items.[INDEX].oneOf.2.references.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.2.references","typeLabel":"(AssetUrl · object | AssetId · object | AssetBase64 · object)[] | null"},"aspect_ratio":{"default":"16:9","description":"Output aspect ratio. Supported for cinematic_avatar: '16:9', '9:16', '1:1' ('heygen_video_1': '16:9', '9:16'). Defaults to '16:9'.","enum":["16:9","9:16","1:1"],"title":"Aspect Ratio","type":"string","uniqueKey":"videos.items.[INDEX].oneOf.2.aspect_ratio","typeLabel":"enum\u003cstring>"},"resolution":{"default":"720p","description":"Output resolution. Supported for cinematic_avatar: '720p', '1080p' ('heygen_video_1': '720p'). Defaults to '720p'.","enum":["720p","1080p"],"title":"Resolution","type":"string","uniqueKey":"videos.items.[INDEX].oneOf.2.resolution","typeLabel":"enum\u003cstring>"},"auto_duration":{"default":false,"description":"Renders the 10-second default with either model, the same as omitting duration. When true, omit duration.","title":"Auto Duration","type":"boolean","uniqueKey":"videos.items.[INDEX].oneOf.2.auto_duration","typeLabel":"boolean"},"duration":{"oneOf":[{"type":"integer","title":"Duration","description":"Video length in seconds (4–15; 5–15 for 'heygen_video_1'). Defaults to 10. Omit when auto_duration is true.","maximum":15,"minimum":4,"uniqueKey":"videos.items.[INDEX].oneOf.2.duration.oneOf.0","typeLabel":"integer"},{"type":"null","title":"Duration","description":"Video length in seconds (4–15; 5–15 for 'heygen_video_1'). Defaults to 10. Omit when auto_duration is true.","uniqueKey":"videos.items.[INDEX].oneOf.2.duration.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.2.duration","typeLabel":"integer | null"},"enhance_prompt":{"default":false,"description":"Enable server-side prompt enhancement.","title":"Enhance Prompt","type":"boolean","uniqueKey":"videos.items.[INDEX].oneOf.2.enhance_prompt","typeLabel":"boolean"},"title":{"oneOf":[{"type":"string","title":"Title","description":"Display title for the video in the HeyGen dashboard.","uniqueKey":"videos.items.[INDEX].oneOf.2.title.oneOf.0","typeLabel":"string"},{"type":"null","title":"Title","description":"Display title for the video in the HeyGen dashboard.","uniqueKey":"videos.items.[INDEX].oneOf.2.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.2.title","typeLabel":"string | null"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.2","typeLabel":"CreateBatchVideoFromCinematicAvatar · object"},{"type":"object","title":"CreateBatchVideoFromStudio","description":"Create a single video by composing an ordered list of whole-frame scenes.\n\nThe server owns layout and center-crops each scene to the global output\ncanvas. Output settings are global (one per request); a single video_id is\nreturned and rendering is all-or-nothing. MP4 only in v1 — the output\ncontainer is fixed and ``output_format`` is not exposed.","required":["type","scenes"],"properties":{"type":{"const":"studio","description":"Must be 'studio' for scene-composition video creation.","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.type","typeLabel":"string"},"scenes":{"description":"Ordered list of whole-frame scenes to concatenate. Each scene is one of 'avatar_video', 'image', or 'video'. Must contain 1 to 50 scenes.","items":{"oneOf":[{"type":"object","title":"AvatarVideoScene","description":"A whole-frame speaking scene backed by an avatar.","required":["type","input"],"properties":{"type":{"const":"avatar_video","description":"Must be 'avatar_video' for an avatar speaking scene.","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.type","typeLabel":"string"},"input":{"additionalProperties":false,"description":"Scene source ('type': 'avatar'): an avatar_id plus one audio source. The avatar_id accepts any avatar look — video avatars and photo avatars alike (pass a photo avatar's look id to get a talking photo). The scene duration is derived server-side from the audio.","properties":{"type":{"const":"avatar","description":"Must be 'avatar' for an avatar-driven scene source.","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.type","typeLabel":"string"},"avatar_id":{"description":"HeyGen avatar ID (video avatar or photo avatar look ID).","title":"Avatar Id","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.avatar_id","typeLabel":"string"},"script":{"oneOf":[{"type":"string","title":"Script","description":"Text script for the avatar to speak. Pair with voice_id, or omit voice_id when using avatar_id to use the avatar's default voice. Mutually exclusive with audio_url/audio_asset_id.","minLength":1,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.script.oneOf.0","typeLabel":"string"},{"type":"null","title":"Script","description":"Text script for the avatar to speak. Pair with voice_id, or omit voice_id when using avatar_id to use the avatar's default voice. Mutually exclusive with audio_url/audio_asset_id.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.script.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.script","typeLabel":"string | null"},"voice_id":{"oneOf":[{"type":"string","title":"Voice Id","description":"Voice ID for text-to-speech. Required when script is provided, unless avatar_id is set (the avatar's default voice is used as fallback).","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Voice Id","description":"Voice ID for text-to-speech. Required when script is provided, unless avatar_id is set (the avatar's default voice is used as fallback).","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_id","typeLabel":"string | null"},"audio_url":{"oneOf":[{"type":"string","title":"Audio Url","description":"Public http(s) URL of an audio file to lip-sync. Mutually exclusive with script. Not a local or sandbox path (/mnt/data/..., file://); upload it and pass audio_asset_id.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.audio_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Audio Url","description":"Public http(s) URL of an audio file to lip-sync. Mutually exclusive with script. Not a local or sandbox path (/mnt/data/..., file://); upload it and pass audio_asset_id.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.audio_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.audio_url","typeLabel":"string | null"},"audio_asset_id":{"oneOf":[{"type":"string","title":"Audio Asset Id","description":"HeyGen asset ID of an uploaded audio file. Mutually exclusive with script.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.audio_asset_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Audio Asset Id","description":"HeyGen asset ID of an uploaded audio file. Mutually exclusive with script.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.audio_asset_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.audio_asset_id","typeLabel":"string | null"},"voice_settings":{"oneOf":[{"type":"object","title":"VoiceSettingsInput","description":"Voice settings. Always include engine_settings: the engine from GET /v3/videos/voice-capabilities, and a model only when that row lists models. locale is optional and is the accent only.","properties":{"speed":{"default":1,"description":"Playback speed multiplier. 0.5 (half speed) to 1.5 (1.5x speed).","maximum":1.5,"minimum":0.5,"title":"Speed","type":"number","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.speed","typeLabel":"number"},"pitch":{"default":0,"description":"Legacy pitch adjustment, normalized to -1 to 1 before synthesis. Among the six documented engines, only Mockingbird can apply it when its base TTS uses Azure; use engine_settings.pitch for HeyGen Voice.","maximum":50,"minimum":-50,"title":"Pitch","type":"number","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.pitch","typeLabel":"number"},"volume":{"default":1,"description":"Voice audio volume. 1.0 = full, 0.0 = silent. Useful when mixing spoken voice with background audio.","maximum":1,"minimum":0,"title":"Volume","type":"number","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.volume","typeLabel":"number"},"locale":{"oneOf":[{"type":"string","title":"Locale","description":"Accent the user asked for (e.g. 'en-US'). It is not the script language; the language is read from the script. Omit for Original Accent, the voice's natural accent. Send only a locale that GET /v3/videos/voice-capabilities lists for the script's language and the engine in engine_settings. Mockingbird requires a regional locale.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.locale.oneOf.0","typeLabel":"string"},{"type":"null","title":"Locale","description":"Accent the user asked for (e.g. 'en-US'). It is not the script language; the language is read from the script. Omit for Original Accent, the voice's natural accent. Send only a locale that GET /v3/videos/voice-capabilities lists for the script's language and the engine in engine_settings. Mockingbird requires a regional locale.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.locale.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.locale","typeLabel":"string | null"},"engine_settings":{"oneOf":[{"type":"object","title":"ElevenLabsEngineSettings","description":"Engine-specific voice settings for ElevenLabs-backed voices.\n\nSupports model, stability, similarity_boost, style, and use_speaker_boost.\nWhen using eleven_v3 or eleven_v4, stability may be any value in [0.0, 1.0].","required":["engine_type"],"properties":{"engine_type":{"const":"elevenlabs","description":"Engine type discriminator. Must be 'elevenlabs' for ElevenLabs-backed voices.","title":"Engine Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.0.engine_type","typeLabel":"string"},"model":{"oneOf":[{"type":"string","description":"ElevenLabs model. eleven_v3 and eleven_v4 use stability only; similarity_boost, style, and use_speaker_boost have no effect on them.","enum":["eleven_multilingual_v2","eleven_turbo_v2_5","eleven_v3","eleven_v4"],"x-mcp-schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.0.model.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"ElevenLabs model. eleven_v3 and eleven_v4 use stability only; similarity_boost, style, and use_speaker_boost have no effect on them.","x-mcp-schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.0.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.0.model","typeLabel":"enum\u003cstring> | null"},"similarity_boost":{"oneOf":[{"type":"number","title":"Similarity Boost","description":"The similarity boost parameter for ElevenLabs.","maximum":1,"minimum":0,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.0.similarity_boost.oneOf.0","typeLabel":"number"},{"type":"null","title":"Similarity Boost","description":"The similarity boost parameter for ElevenLabs.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.0.similarity_boost.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.0.similarity_boost","typeLabel":"number | null"},"stability":{"oneOf":[{"type":"number","title":"Stability","description":"The stability parameter for ElevenLabs.","maximum":1,"minimum":0,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.0.stability.oneOf.0","typeLabel":"number"},{"type":"null","title":"Stability","description":"The stability parameter for ElevenLabs.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.0.stability.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.0.stability","typeLabel":"number | null"},"style":{"oneOf":[{"type":"number","title":"Style","description":"The style parameter for ElevenLabs.","maximum":1,"minimum":0,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.0.style.oneOf.0","typeLabel":"number"},{"type":"null","title":"Style","description":"The style parameter for ElevenLabs.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.0.style.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.0.style","typeLabel":"number | null"},"use_speaker_boost":{"oneOf":[{"type":"boolean","title":"Use Speaker Boost","description":"Whether to use speaker boost for ElevenLabs.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.0.use_speaker_boost.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Use Speaker Boost","description":"Whether to use speaker boost for ElevenLabs.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.0.use_speaker_boost.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.0.use_speaker_boost","typeLabel":"boolean | null"}},"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.0","typeLabel":"ElevenLabsEngineSettings · object"},{"type":"object","title":"FishEngineSettings","description":"Engine-specific voice settings for Fish Audio-backed voices.\n\nInherits Fish's tuning fields (model, stability, similarity).","required":["engine_type"],"properties":{"engine_type":{"const":"fish","description":"Engine type discriminator. Must be 'fish' for Fish Audio-backed voices.","title":"Engine Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.1.engine_type","typeLabel":"string"},"model":{"oneOf":[{"type":"string","description":"Fish Audio model version. Defaults to s2.1-pro when omitted.","enum":["s2.1-pro","s2-pro"],"x-mcp-schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.1.model.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Fish Audio model version. Defaults to s2.1-pro when omitted.","x-mcp-schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.1.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.1.model","typeLabel":"enum\u003cstring> | null"},"stability":{"oneOf":[{"type":"number","title":"Stability","description":"Stability parameter; higher is more consistent.","maximum":1,"minimum":0,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.1.stability.oneOf.0","typeLabel":"number"},{"type":"null","title":"Stability","description":"Stability parameter; higher is more consistent.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.1.stability.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.1.stability","typeLabel":"number | null"},"similarity":{"oneOf":[{"type":"number","title":"Similarity","description":"Similarity parameter; how closely to match the source voice.","maximum":1,"minimum":0,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.1.similarity.oneOf.0","typeLabel":"number"},{"type":"null","title":"Similarity","description":"Similarity parameter; how closely to match the source voice.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.1.similarity.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.1.similarity","typeLabel":"number | null"}},"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.1","typeLabel":"FishEngineSettings · object"},{"type":"object","title":"StarfishEngineSettings","description":"Engine selection without tunable settings.\n\nSelects the engine named by ``engine_type`` on voices that support multiple engines.\nSend it in video creation requests to preserve the chosen engine.","required":["engine_type"],"properties":{"engine_type":{"const":"starfish","description":"Engine type discriminator for this settings variant.","title":"Engine Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.2.engine_type","typeLabel":"string"}},"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.2","typeLabel":"StarfishEngineSettings · object"},{"type":"object","title":"HeyGenVoiceEngineSettings","description":"HeyGen Voice controls for instant or professional voice clones.","required":["engine_type"],"properties":{"engine_type":{"description":"Engine type discriminator. 'heygen_voice' selects HeyGen Voice; 'orca' is accepted as its legacy alias.","enum":["heygen_voice","orca"],"title":"Engine Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.3.engine_type","typeLabel":"enum\u003cstring>"},"model":{"oneOf":[{"type":"string","title":"Model","description":"HeyGen Voice model for instant voice clones. Defaults to heygen-voice-1. Ignored for professional voice clones.","const":"heygen-voice-1","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.3.model.oneOf.0","typeLabel":"string"},{"type":"null","title":"Model","description":"HeyGen Voice model for instant voice clones. Defaults to heygen-voice-1. Ignored for professional voice clones.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.3.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.3.model","typeLabel":"string | null"},"similarity":{"oneOf":[{"type":"string","title":"Similarity","description":"Similarity for instant voice clones. Ignored for professional voice clones.","enum":["medium","high","extra_high","max"],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.3.similarity.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Similarity","description":"Similarity for instant voice clones. Ignored for professional voice clones.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.3.similarity.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.3.similarity","typeLabel":"enum\u003cstring> | null"},"expressiveness":{"oneOf":[{"type":"number","title":"Expressiveness","description":"Expressiveness from 0 to 1.","maximum":1,"minimum":0,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.3.expressiveness.oneOf.0","typeLabel":"number"},{"type":"null","title":"Expressiveness","description":"Expressiveness from 0 to 1.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.3.expressiveness.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.3.expressiveness","typeLabel":"number | null"},"pitch":{"oneOf":[{"type":"number","title":"Pitch","description":"Pitch shift in semitones.","multipleOf":0.5,"maximum":4,"minimum":-4,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.3.pitch.oneOf.0","typeLabel":"number"},{"type":"null","title":"Pitch","description":"Pitch shift in semitones.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.3.pitch.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.3.pitch","typeLabel":"number | null"},"inflection":{"oneOf":[{"type":"number","title":"Inflection","description":"Pitch variation multiplier.","maximum":2,"minimum":0.5,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.3.inflection.oneOf.0","typeLabel":"number"},{"type":"null","title":"Inflection","description":"Pitch variation multiplier.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.3.inflection.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.3.inflection","typeLabel":"number | null"}},"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.3","typeLabel":"HeyGenVoiceEngineSettings · object"},{"type":"object","title":"CartesiaEngineSettings","description":"Engine-specific voice tuning, discriminated by 'engine_type'. Always name the engine and, where offered, its model so the request reflects the selected voice and model. The request is rejected if the voice_id is not compatible with the selected engine. Always send it. A request without it gets its engine at render time and can fail after the video is created.","required":["engine_type"],"properties":{"engine_type":{"const":"cartesia","description":"Select Cartesia.","title":"Engine Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.4.engine_type","typeLabel":"string"},"model":{"oneOf":[{"type":"string","title":"Model","description":"Cartesia Sonic model; omit for the engine default.","enum":["sonic-3.6","sonic-3.5"],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.4.model.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Model","description":"Cartesia Sonic model; omit for the engine default.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.4.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.4.model","typeLabel":"enum\u003cstring> | null"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.4","typeLabel":"CartesiaEngineSettings · object"},{"type":"object","title":"MockingbirdEngineSettings","description":"Engine-specific voice tuning, discriminated by 'engine_type'. Always name the engine and, where offered, its model so the request reflects the selected voice and model. The request is rejected if the voice_id is not compatible with the selected engine. Always send it. A request without it gets its engine at render time and can fail after the video is created.","required":["engine_type"],"properties":{"engine_type":{"const":"mockingbird","description":"Select Mockingbird. A regional voice_settings.locale is required.","title":"Engine Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.5.engine_type","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.5","typeLabel":"MockingbirdEngineSettings · object"},{"type":"null","title":"Engine Settings","description":"Engine-specific voice tuning, discriminated by 'engine_type'. Always name the engine and, where offered, its model so the request reflects the selected voice and model. The request is rejected if the voice_id is not compatible with the selected engine. Always send it. A request without it gets its engine at render time and can fail after the video is created.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings.oneOf.6","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0.engine_settings","typeLabel":"ElevenLabsEngineSettings · object | FishEngineSettings · object | StarfishEngineSettings · object | HeyGenVoiceEngineSettings · object | CartesiaEngineSettings · object | MockingbirdEngineSettings · object | null"}},"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.0","typeLabel":"VoiceSettingsInput · object"},{"type":"null","description":"Voice settings. Always include engine_settings: the engine from GET /v3/videos/voice-capabilities, and a model only when that row lists models. locale is optional and is the accent only.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.voice_settings","typeLabel":"VoiceSettingsInput · object | null"},"motion_prompt":{"oneOf":[{"type":"string","title":"Motion Prompt","description":"Natural-language prompt controlling avatar body motion and hand gestures. Supported for photo avatars on either engine, and for video avatars when engine.type is 'avatar_v'. Rejected for video avatars on the default Avatar IV engine, and for photo avatars on 'avatar_v' when the avatar's group has no animation reference (no digital twin or curated reference look).","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.motion_prompt.oneOf.0","typeLabel":"string"},{"type":"null","title":"Motion Prompt","description":"Natural-language prompt controlling avatar body motion and hand gestures. Supported for photo avatars on either engine, and for video avatars when engine.type is 'avatar_v'. Rejected for video avatars on the default Avatar IV engine, and for photo avatars on 'avatar_v' when the avatar's group has no animation reference (no digital twin or curated reference look).","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.motion_prompt.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.motion_prompt","typeLabel":"string | null"},"expressiveness":{"oneOf":[{"type":"string","title":"Expressiveness","description":"Avatar expressiveness level. Photo avatars only. Defaults to 'low' when omitted. Avatar IV only; rejected when engine.type is 'avatar_v'.","enum":["high","medium","low"],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.expressiveness.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Avatar expressiveness level. Photo avatars only. Defaults to 'low' when omitted. Avatar IV only; rejected when engine.type is 'avatar_v'.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.expressiveness.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.expressiveness","typeLabel":"enum\u003cstring> | null"},"engine":{"oneOf":[{"type":"object","title":"AvatarVEngineConfig","description":"Avatar V engine configuration with cross-reference-driven animation.","required":["type"],"properties":{"type":{"const":"avatar_v","description":"Engine type discriminator. Must be 'avatar_v'. Check supported_api_engines on the avatar look to confirm eligibility.","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.engine.oneOf.0.type","typeLabel":"string"},"reference_look_id":{"oneOf":[{"type":"string","title":"Reference Look Id","description":"Optional look to use as the animation reference. When provided, it must be a `digital_twin` look accessible to your workspace and in the same avatar group as `avatar_id` (`studio_avatar` and `photo_avatar` looks are rejected). When omitted, video avatars self-reference and photo avatars select from their group's eligible candidates, preferring digital twins (ready first, then processing / upgrading), then curated public studio looks. A photo avatar whose group has no eligible reference renders directly from its image without one; motion_prompt is rejected in that case. A non-public `digital_twin` reference, whether provided or selected automatically, must also satisfy its group's consent requirements.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.engine.oneOf.0.reference_look_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Reference Look Id","description":"Optional look to use as the animation reference. When provided, it must be a `digital_twin` look accessible to your workspace and in the same avatar group as `avatar_id` (`studio_avatar` and `photo_avatar` looks are rejected). When omitted, video avatars self-reference and photo avatars select from their group's eligible candidates, preferring digital twins (ready first, then processing / upgrading), then curated public studio looks. A photo avatar whose group has no eligible reference renders directly from its image without one; motion_prompt is rejected in that case. A non-public `digital_twin` reference, whether provided or selected automatically, must also satisfy its group's consent requirements.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.engine.oneOf.0.reference_look_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.engine.oneOf.0.reference_look_id","typeLabel":"string | null"},"more_blinking":{"default":false,"description":"Ask Avatar V for more natural blinking.","title":"More Blinking","type":"boolean","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.engine.oneOf.0.more_blinking","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.engine.oneOf.0","typeLabel":"AvatarVEngineConfig · object"},{"type":"object","title":"AvatarIVEngineConfig","description":"Avatar IV engine configuration (default behavior).","required":["type"],"properties":{"type":{"const":"avatar_iv","description":"Engine type discriminator. Must be 'avatar_iv'.","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.engine.oneOf.1.type","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.engine.oneOf.1","typeLabel":"AvatarIVEngineConfig · object"},{"type":"object","title":"AvatarIIIEngineConfig","description":"Avatar III engine configuration.\n\nA single engine value that resolves to the right product by the avatar's\nlook type (mirrors how ``avatar_iv`` already serves both photo and video\navatars):\n\n- video avatar looks (``digital_twin``, ``studio_avatar``) -> Digital Twin\n (supports 4K)\n- ``photo_avatar`` look -> Photo Avatar (no 4K output)\n\nNot supported for raw image input (``type: \"image\"``).\n``motion_prompt`` and ``expressiveness`` are not supported with this engine.","required":["type"],"properties":{"type":{"const":"avatar_iii","description":"Engine type discriminator. Must be 'avatar_iii'. Resolves to Digital Twin for video avatar looks (digital_twin, studio_avatar) and Photo Avatar for photo_avatar looks; not supported for raw image input. Check supported_api_engines on the avatar look to confirm eligibility.","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.engine.oneOf.2.type","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.engine.oneOf.2","typeLabel":"AvatarIIIEngineConfig · object"},{"type":"null","title":"Engine","description":"Engine configuration for video generation. Pass {\"type\": \"avatar_v\"} to enable cross-reference-driven animation for higher quality. Check supported_api_engines on the avatar look to confirm eligibility. Defaults to Avatar IV when omitted.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.engine.oneOf.3","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.engine","typeLabel":"AvatarVEngineConfig · object | AvatarIVEngineConfig · object | AvatarIIIEngineConfig · object | null"},"background":{"oneOf":[{"type":"object","title":"StudioColorBackgroundInput","description":"Solid-color background for an ``avatar_video`` studio scene.","required":["type","color"],"properties":{"type":{"const":"color","description":"Background type discriminator. Must be 'color'.","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background.oneOf.0.type","typeLabel":"string"},"color":{"description":"Background color as a 6-digit hex string, e.g. '#1a2b3c'.","pattern":"^#[0-9a-fA-F]{6}$","title":"Color","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background.oneOf.0.color","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background.oneOf.0","typeLabel":"StudioColorBackgroundInput · object"},{"type":"object","title":"StudioImageBackgroundInput","description":"Image background for an ``avatar_video`` studio scene, scaled to cover the frame.\n\n``source`` is the same asset input an ``image`` scene takes, resolved the same way.","required":["type","source"],"properties":{"type":{"const":"image","description":"Background type discriminator. Must be 'image'.","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background.oneOf.1.type","typeLabel":"string"},"source":{"oneOf":[{"type":"object","title":"AssetUrl","description":"Asset input via publicly accessible HTTPS URL.","required":["type","url"],"properties":{"type":{"const":"url","description":"Input type discriminator","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background.oneOf.1.source.oneOf.0.type","typeLabel":"string"},"url":{"description":"Public http(s) URL HeyGen can download without auth or redirects. Not a local or sandbox path (/mnt/data/..., file://, sandbox:); upload such files and pass asset_id.","title":"Url","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background.oneOf.1.source.oneOf.0.url","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background.oneOf.1.source.oneOf.0","typeLabel":"AssetUrl · object"},{"type":"object","title":"AssetId","description":"Asset input via HeyGen asset ID from the asset upload endpoint.","required":["type","asset_id"],"properties":{"type":{"const":"asset_id","description":"Input type discriminator","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background.oneOf.1.source.oneOf.1.type","typeLabel":"string"},"asset_id":{"description":"HeyGen asset ID from an asset upload or import; not a third-party file ID.","title":"Asset Id","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background.oneOf.1.source.oneOf.1.asset_id","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background.oneOf.1.source.oneOf.1","typeLabel":"AssetId · object"},{"type":"object","title":"AssetBase64","description":"Asset input via base64-encoded content.","required":["type","media_type","data"],"x-mcp-visible":false,"properties":{"type":{"const":"base64","description":"Input type discriminator","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background.oneOf.1.source.oneOf.2.type","typeLabel":"string"},"media_type":{"description":"MIME type of the encoded content (e.g. \"image/png\")","title":"Media Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background.oneOf.1.source.oneOf.2.media_type","typeLabel":"string"},"data":{"description":"Base64-encoded file content","title":"Data","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background.oneOf.1.source.oneOf.2.data","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background.oneOf.1.source.oneOf.2","typeLabel":"AssetBase64 · object"}],"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background.oneOf.1.source","typeLabel":"AssetUrl · object | AssetId · object | AssetBase64 · object"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background.oneOf.1","typeLabel":"StudioImageBackgroundInput · object"},{"type":"object","title":"StudioVideoBackgroundInput","description":"Video background for an ``avatar_video`` studio scene, scaled to cover the frame.\n\n``source`` is the same asset input a ``video`` scene takes, resolved the same way. The clip\nis muted so it never competes with the avatar's voice, and loops for the whole scene.","required":["type","source"],"properties":{"type":{"const":"video","description":"Background type discriminator. Must be 'video'.","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background.oneOf.2.type","typeLabel":"string"},"source":{"oneOf":[{"type":"object","title":"AssetUrl","description":"Asset input via publicly accessible HTTPS URL.","required":["type","url"],"properties":{"type":{"const":"url","description":"Input type discriminator","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background.oneOf.2.source.oneOf.0.type","typeLabel":"string"},"url":{"description":"Public http(s) URL HeyGen can download without auth or redirects. Not a local or sandbox path (/mnt/data/..., file://, sandbox:); upload such files and pass asset_id.","title":"Url","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background.oneOf.2.source.oneOf.0.url","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background.oneOf.2.source.oneOf.0","typeLabel":"AssetUrl · object"},{"type":"object","title":"AssetId","description":"Asset input via HeyGen asset ID from the asset upload endpoint.","required":["type","asset_id"],"properties":{"type":{"const":"asset_id","description":"Input type discriminator","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background.oneOf.2.source.oneOf.1.type","typeLabel":"string"},"asset_id":{"description":"HeyGen asset ID from an asset upload or import; not a third-party file ID.","title":"Asset Id","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background.oneOf.2.source.oneOf.1.asset_id","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background.oneOf.2.source.oneOf.1","typeLabel":"AssetId · object"},{"type":"object","title":"AssetBase64","description":"Asset input via base64-encoded content.","required":["type","media_type","data"],"x-mcp-visible":false,"properties":{"type":{"const":"base64","description":"Input type discriminator","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background.oneOf.2.source.oneOf.2.type","typeLabel":"string"},"media_type":{"description":"MIME type of the encoded content (e.g. \"image/png\")","title":"Media Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background.oneOf.2.source.oneOf.2.media_type","typeLabel":"string"},"data":{"description":"Base64-encoded file content","title":"Data","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background.oneOf.2.source.oneOf.2.data","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background.oneOf.2.source.oneOf.2","typeLabel":"AssetBase64 · object"}],"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background.oneOf.2.source","typeLabel":"AssetUrl · object | AssetId · object | AssetBase64 · object"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background.oneOf.2","typeLabel":"StudioVideoBackgroundInput · object"},{"type":"null","title":"Background","description":"Optional scene background composited behind the avatar. Pass {\"type\": \"color\", \"color\": \"#RRGGBB\"} for a solid color, or {\"type\": \"image\", \"source\": {...}} or {\"type\": \"video\", \"source\": {...}} with the same asset input image and video scenes take. Image and video backgrounds cover the frame; a video background is muted and loops for the whole scene.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background.oneOf.3","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.background","typeLabel":"StudioColorBackgroundInput · object | StudioImageBackgroundInput · object | StudioVideoBackgroundInput · object | null"},"remove_background":{"oneOf":[{"type":"boolean","title":"Remove Background","description":"Remove the avatar background. Video avatars must be trained with matting enabled.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.remove_background.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Remove Background","description":"Remove the avatar background. Video avatars must be trained with matting enabled.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.remove_background.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input.remove_background","typeLabel":"boolean | null"}},"required":["type","avatar_id"],"title":"StudioAvatarInput","type":"object","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0.input","typeLabel":"StudioAvatarInput · object"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.0","typeLabel":"AvatarVideoScene · object"},{"type":"object","title":"ImageScene","description":"A whole-frame still-image scene: either silent (held for ``duration``) or narrated.\n\nExactly one mode must be chosen:\n- silent: set ``duration`` (seconds) and no audio source.\n- narrated: set exactly one audio source (script + voice_id, audio_url, or\n audio_asset_id) and omit ``duration`` — the scene length follows the audio.","required":["type","source"],"properties":{"type":{"const":"image","description":"Must be 'image' for a still-image scene.","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.type","typeLabel":"string"},"source":{"oneOf":[{"type":"object","title":"AssetUrl","description":"Asset input via publicly accessible HTTPS URL.","required":["type","url"],"properties":{"type":{"const":"url","description":"Input type discriminator","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.source.oneOf.0.type","typeLabel":"string"},"url":{"description":"Public http(s) URL HeyGen can download without auth or redirects. Not a local or sandbox path (/mnt/data/..., file://, sandbox:); upload such files and pass asset_id.","title":"Url","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.source.oneOf.0.url","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.source.oneOf.0","typeLabel":"AssetUrl · object"},{"type":"object","title":"AssetId","description":"Asset input via HeyGen asset ID from the asset upload endpoint.","required":["type","asset_id"],"properties":{"type":{"const":"asset_id","description":"Input type discriminator","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.source.oneOf.1.type","typeLabel":"string"},"asset_id":{"description":"HeyGen asset ID from an asset upload or import; not a third-party file ID.","title":"Asset Id","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.source.oneOf.1.asset_id","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.source.oneOf.1","typeLabel":"AssetId · object"},{"type":"object","title":"AssetBase64","description":"Asset input via base64-encoded content.","required":["type","media_type","data"],"x-mcp-visible":false,"properties":{"type":{"const":"base64","description":"Input type discriminator","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.source.oneOf.2.type","typeLabel":"string"},"media_type":{"description":"MIME type of the encoded content (e.g. \"image/png\")","title":"Media Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.source.oneOf.2.media_type","typeLabel":"string"},"data":{"description":"Base64-encoded file content","title":"Data","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.source.oneOf.2.data","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.source.oneOf.2","typeLabel":"AssetBase64 · object"}],"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.source","typeLabel":"AssetUrl · object | AssetId · object | AssetBase64 · object"},"duration":{"oneOf":[{"type":"number","title":"Duration","description":"Silent mode: hold the still image for this many seconds. Mutually exclusive with any audio source. Must be > 0 and \u003c= 300.","maximum":300,"minimum":0,"exclusiveMinimum":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.duration.oneOf.0","typeLabel":"number"},{"type":"null","title":"Duration","description":"Silent mode: hold the still image for this many seconds. Mutually exclusive with any audio source. Must be > 0 and \u003c= 300.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.duration.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.duration","typeLabel":"number | null"},"script":{"oneOf":[{"type":"string","title":"Script","description":"Narrated mode: text to speak over the image. Pair with voice_id. Mutually exclusive with duration/audio_url/audio_asset_id.","minLength":1,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.script.oneOf.0","typeLabel":"string"},{"type":"null","title":"Script","description":"Narrated mode: text to speak over the image. Pair with voice_id. Mutually exclusive with duration/audio_url/audio_asset_id.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.script.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.script","typeLabel":"string | null"},"voice_id":{"oneOf":[{"type":"string","title":"Voice Id","description":"Voice ID for text-to-speech. Required when script is provided.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Voice Id","description":"Voice ID for text-to-speech. Required when script is provided.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_id","typeLabel":"string | null"},"audio_url":{"oneOf":[{"type":"string","title":"Audio Url","description":"Narrated mode: public http(s) URL of an audio file to play over the image. Mutually exclusive with duration/script. Not a local or sandbox path (/mnt/data/..., file://); upload it and pass audio_asset_id.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.audio_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Audio Url","description":"Narrated mode: public http(s) URL of an audio file to play over the image. Mutually exclusive with duration/script. Not a local or sandbox path (/mnt/data/..., file://); upload it and pass audio_asset_id.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.audio_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.audio_url","typeLabel":"string | null"},"audio_asset_id":{"oneOf":[{"type":"string","title":"Audio Asset Id","description":"Narrated mode: HeyGen asset ID of an uploaded audio file. Mutually exclusive with duration/script.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.audio_asset_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Audio Asset Id","description":"Narrated mode: HeyGen asset ID of an uploaded audio file. Mutually exclusive with duration/script.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.audio_asset_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.audio_asset_id","typeLabel":"string | null"},"voice_settings":{"oneOf":[{"type":"object","title":"VoiceSettingsInput","description":"Voice settings. Always include engine_settings: the engine from GET /v3/videos/voice-capabilities, and a model only when that row lists models. locale is optional and is the accent only.","properties":{"speed":{"default":1,"description":"Playback speed multiplier. 0.5 (half speed) to 1.5 (1.5x speed).","maximum":1.5,"minimum":0.5,"title":"Speed","type":"number","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.speed","typeLabel":"number"},"pitch":{"default":0,"description":"Legacy pitch adjustment, normalized to -1 to 1 before synthesis. Among the six documented engines, only Mockingbird can apply it when its base TTS uses Azure; use engine_settings.pitch for HeyGen Voice.","maximum":50,"minimum":-50,"title":"Pitch","type":"number","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.pitch","typeLabel":"number"},"volume":{"default":1,"description":"Voice audio volume. 1.0 = full, 0.0 = silent. Useful when mixing spoken voice with background audio.","maximum":1,"minimum":0,"title":"Volume","type":"number","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.volume","typeLabel":"number"},"locale":{"oneOf":[{"type":"string","title":"Locale","description":"Accent the user asked for (e.g. 'en-US'). It is not the script language; the language is read from the script. Omit for Original Accent, the voice's natural accent. Send only a locale that GET /v3/videos/voice-capabilities lists for the script's language and the engine in engine_settings. Mockingbird requires a regional locale.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.locale.oneOf.0","typeLabel":"string"},{"type":"null","title":"Locale","description":"Accent the user asked for (e.g. 'en-US'). It is not the script language; the language is read from the script. Omit for Original Accent, the voice's natural accent. Send only a locale that GET /v3/videos/voice-capabilities lists for the script's language and the engine in engine_settings. Mockingbird requires a regional locale.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.locale.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.locale","typeLabel":"string | null"},"engine_settings":{"oneOf":[{"type":"object","title":"ElevenLabsEngineSettings","description":"Engine-specific voice settings for ElevenLabs-backed voices.\n\nSupports model, stability, similarity_boost, style, and use_speaker_boost.\nWhen using eleven_v3 or eleven_v4, stability may be any value in [0.0, 1.0].","required":["engine_type"],"properties":{"engine_type":{"const":"elevenlabs","description":"Engine type discriminator. Must be 'elevenlabs' for ElevenLabs-backed voices.","title":"Engine Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.engine_type","typeLabel":"string"},"model":{"oneOf":[{"type":"string","description":"ElevenLabs model. eleven_v3 and eleven_v4 use stability only; similarity_boost, style, and use_speaker_boost have no effect on them.","enum":["eleven_multilingual_v2","eleven_turbo_v2_5","eleven_v3","eleven_v4"],"x-mcp-schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.model.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"ElevenLabs model. eleven_v3 and eleven_v4 use stability only; similarity_boost, style, and use_speaker_boost have no effect on them.","x-mcp-schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.model","typeLabel":"enum\u003cstring> | null"},"similarity_boost":{"oneOf":[{"type":"number","title":"Similarity Boost","description":"The similarity boost parameter for ElevenLabs.","maximum":1,"minimum":0,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.similarity_boost.oneOf.0","typeLabel":"number"},{"type":"null","title":"Similarity Boost","description":"The similarity boost parameter for ElevenLabs.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.similarity_boost.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.similarity_boost","typeLabel":"number | null"},"stability":{"oneOf":[{"type":"number","title":"Stability","description":"The stability parameter for ElevenLabs.","maximum":1,"minimum":0,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.stability.oneOf.0","typeLabel":"number"},{"type":"null","title":"Stability","description":"The stability parameter for ElevenLabs.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.stability.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.stability","typeLabel":"number | null"},"style":{"oneOf":[{"type":"number","title":"Style","description":"The style parameter for ElevenLabs.","maximum":1,"minimum":0,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.style.oneOf.0","typeLabel":"number"},{"type":"null","title":"Style","description":"The style parameter for ElevenLabs.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.style.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.style","typeLabel":"number | null"},"use_speaker_boost":{"oneOf":[{"type":"boolean","title":"Use Speaker Boost","description":"Whether to use speaker boost for ElevenLabs.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.use_speaker_boost.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Use Speaker Boost","description":"Whether to use speaker boost for ElevenLabs.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.use_speaker_boost.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0.use_speaker_boost","typeLabel":"boolean | null"}},"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.0","typeLabel":"ElevenLabsEngineSettings · object"},{"type":"object","title":"FishEngineSettings","description":"Engine-specific voice settings for Fish Audio-backed voices.\n\nInherits Fish's tuning fields (model, stability, similarity).","required":["engine_type"],"properties":{"engine_type":{"const":"fish","description":"Engine type discriminator. Must be 'fish' for Fish Audio-backed voices.","title":"Engine Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.1.engine_type","typeLabel":"string"},"model":{"oneOf":[{"type":"string","description":"Fish Audio model version. Defaults to s2.1-pro when omitted.","enum":["s2.1-pro","s2-pro"],"x-mcp-schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.1.model.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Fish Audio model version. Defaults to s2.1-pro when omitted.","x-mcp-schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.1.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.1.model","typeLabel":"enum\u003cstring> | null"},"stability":{"oneOf":[{"type":"number","title":"Stability","description":"Stability parameter; higher is more consistent.","maximum":1,"minimum":0,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.1.stability.oneOf.0","typeLabel":"number"},{"type":"null","title":"Stability","description":"Stability parameter; higher is more consistent.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.1.stability.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.1.stability","typeLabel":"number | null"},"similarity":{"oneOf":[{"type":"number","title":"Similarity","description":"Similarity parameter; how closely to match the source voice.","maximum":1,"minimum":0,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.1.similarity.oneOf.0","typeLabel":"number"},{"type":"null","title":"Similarity","description":"Similarity parameter; how closely to match the source voice.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.1.similarity.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.1.similarity","typeLabel":"number | null"}},"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.1","typeLabel":"FishEngineSettings · object"},{"type":"object","title":"StarfishEngineSettings","description":"Engine selection without tunable settings.\n\nSelects the engine named by ``engine_type`` on voices that support multiple engines.\nSend it in video creation requests to preserve the chosen engine.","required":["engine_type"],"properties":{"engine_type":{"const":"starfish","description":"Engine type discriminator for this settings variant.","title":"Engine Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.2.engine_type","typeLabel":"string"}},"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.2","typeLabel":"StarfishEngineSettings · object"},{"type":"object","title":"HeyGenVoiceEngineSettings","description":"HeyGen Voice controls for instant or professional voice clones.","required":["engine_type"],"properties":{"engine_type":{"description":"Engine type discriminator. 'heygen_voice' selects HeyGen Voice; 'orca' is accepted as its legacy alias.","enum":["heygen_voice","orca"],"title":"Engine Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.engine_type","typeLabel":"enum\u003cstring>"},"model":{"oneOf":[{"type":"string","title":"Model","description":"HeyGen Voice model for instant voice clones. Defaults to heygen-voice-1. Ignored for professional voice clones.","const":"heygen-voice-1","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.model.oneOf.0","typeLabel":"string"},{"type":"null","title":"Model","description":"HeyGen Voice model for instant voice clones. Defaults to heygen-voice-1. Ignored for professional voice clones.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.model","typeLabel":"string | null"},"similarity":{"oneOf":[{"type":"string","title":"Similarity","description":"Similarity for instant voice clones. Ignored for professional voice clones.","enum":["medium","high","extra_high","max"],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.similarity.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Similarity","description":"Similarity for instant voice clones. Ignored for professional voice clones.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.similarity.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.similarity","typeLabel":"enum\u003cstring> | null"},"expressiveness":{"oneOf":[{"type":"number","title":"Expressiveness","description":"Expressiveness from 0 to 1.","maximum":1,"minimum":0,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.expressiveness.oneOf.0","typeLabel":"number"},{"type":"null","title":"Expressiveness","description":"Expressiveness from 0 to 1.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.expressiveness.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.expressiveness","typeLabel":"number | null"},"pitch":{"oneOf":[{"type":"number","title":"Pitch","description":"Pitch shift in semitones.","multipleOf":0.5,"maximum":4,"minimum":-4,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.pitch.oneOf.0","typeLabel":"number"},{"type":"null","title":"Pitch","description":"Pitch shift in semitones.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.pitch.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.pitch","typeLabel":"number | null"},"inflection":{"oneOf":[{"type":"number","title":"Inflection","description":"Pitch variation multiplier.","maximum":2,"minimum":0.5,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.inflection.oneOf.0","typeLabel":"number"},{"type":"null","title":"Inflection","description":"Pitch variation multiplier.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.inflection.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3.inflection","typeLabel":"number | null"}},"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.3","typeLabel":"HeyGenVoiceEngineSettings · object"},{"type":"object","title":"CartesiaEngineSettings","description":"Engine-specific voice tuning, discriminated by 'engine_type'. Always name the engine and, where offered, its model so the request reflects the selected voice and model. The request is rejected if the voice_id is not compatible with the selected engine. Always send it. A request without it gets its engine at render time and can fail after the video is created.","required":["engine_type"],"properties":{"engine_type":{"const":"cartesia","description":"Select Cartesia.","title":"Engine Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.4.engine_type","typeLabel":"string"},"model":{"oneOf":[{"type":"string","title":"Model","description":"Cartesia Sonic model; omit for the engine default.","enum":["sonic-3.6","sonic-3.5"],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.4.model.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Model","description":"Cartesia Sonic model; omit for the engine default.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.4.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.4.model","typeLabel":"enum\u003cstring> | null"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.4","typeLabel":"CartesiaEngineSettings · object"},{"type":"object","title":"MockingbirdEngineSettings","description":"Engine-specific voice tuning, discriminated by 'engine_type'. Always name the engine and, where offered, its model so the request reflects the selected voice and model. The request is rejected if the voice_id is not compatible with the selected engine. Always send it. A request without it gets its engine at render time and can fail after the video is created.","required":["engine_type"],"properties":{"engine_type":{"const":"mockingbird","description":"Select Mockingbird. A regional voice_settings.locale is required.","title":"Engine Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.5.engine_type","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.5","typeLabel":"MockingbirdEngineSettings · object"},{"type":"null","title":"Engine Settings","description":"Engine-specific voice tuning, discriminated by 'engine_type'. Always name the engine and, where offered, its model so the request reflects the selected voice and model. The request is rejected if the voice_id is not compatible with the selected engine. Always send it. A request without it gets its engine at render time and can fail after the video is created.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings.oneOf.6","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0.engine_settings","typeLabel":"ElevenLabsEngineSettings · object | FishEngineSettings · object | StarfishEngineSettings · object | HeyGenVoiceEngineSettings · object | CartesiaEngineSettings · object | MockingbirdEngineSettings · object | null"}},"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.0","typeLabel":"VoiceSettingsInput · object"},{"type":"null","description":"Voice settings. Always include engine_settings: the engine from GET /v3/videos/voice-capabilities, and a model only when that row lists models. locale is optional and is the accent only.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1.voice_settings","typeLabel":"VoiceSettingsInput · object | null"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.1","typeLabel":"ImageScene · object"},{"type":"object","title":"VideoScene","description":"A whole-frame scene backed by an existing video clip.\n\nOptional ``playback`` exposes the audio volume / mute capability; when\nomitted the clip plays at its source volume.\n\nFor optional voiceover / narration, supply at most one audio source\n(``script`` + ``voice_id``, ``audio_url``, or ``audio_asset_id``) — the *same*\naudio inputs a narrated ``image`` scene accepts. When present, the narration\ndrives the scene length and ``playback.mode`` controls whether the clip\nfreezes, loops, or changes speed to fit that duration. When omitted the clip\nplays full-length as before. The clip's own audio level is still governed by\n``playback`` (the two compose).","required":["type","source"],"properties":{"type":{"const":"video","description":"Must be 'video' for a video-clip scene.","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.type","typeLabel":"string"},"source":{"oneOf":[{"type":"object","title":"AssetUrl","description":"Asset input via publicly accessible HTTPS URL.","required":["type","url"],"properties":{"type":{"const":"url","description":"Input type discriminator","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.source.oneOf.0.type","typeLabel":"string"},"url":{"description":"Public http(s) URL HeyGen can download without auth or redirects. Not a local or sandbox path (/mnt/data/..., file://, sandbox:); upload such files and pass asset_id.","title":"Url","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.source.oneOf.0.url","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.source.oneOf.0","typeLabel":"AssetUrl · object"},{"type":"object","title":"AssetId","description":"Asset input via HeyGen asset ID from the asset upload endpoint.","required":["type","asset_id"],"properties":{"type":{"const":"asset_id","description":"Input type discriminator","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.source.oneOf.1.type","typeLabel":"string"},"asset_id":{"description":"HeyGen asset ID from an asset upload or import; not a third-party file ID.","title":"Asset Id","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.source.oneOf.1.asset_id","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.source.oneOf.1","typeLabel":"AssetId · object"},{"type":"object","title":"AssetBase64","description":"Asset input via base64-encoded content.","required":["type","media_type","data"],"x-mcp-visible":false,"properties":{"type":{"const":"base64","description":"Input type discriminator","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.source.oneOf.2.type","typeLabel":"string"},"media_type":{"description":"MIME type of the encoded content (e.g. \"image/png\")","title":"Media Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.source.oneOf.2.media_type","typeLabel":"string"},"data":{"description":"Base64-encoded file content","title":"Data","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.source.oneOf.2.data","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.source.oneOf.2","typeLabel":"AssetBase64 · object"}],"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.source","typeLabel":"AssetUrl · object | AssetId · object | AssetBase64 · object"},"playback":{"oneOf":[{"type":"object","title":"PlaybackInput","description":"Optional playback capability: narrated-clip alignment 'mode', audio 'volume' (0.0–1.0), and 'mute'. Omit to use freeze alignment and keep the clip's source volume.","properties":{"mode":{"oneOf":[{"type":"string","title":"Mode","description":"How a narrated clip aligns to the voiceover-driven scene duration. 'freeze' plays once and holds the last frame; 'loop' repeats the clip; 'fit_to_scene' adjusts playback speed to exactly match the scene. Defaults to 'freeze' when omitted. Requires a video-scene voiceover.","enum":["freeze","loop","fit_to_scene"],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.playback.oneOf.0.mode.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Mode","description":"How a narrated clip aligns to the voiceover-driven scene duration. 'freeze' plays once and holds the last frame; 'loop' repeats the clip; 'fit_to_scene' adjusts playback speed to exactly match the scene. Defaults to 'freeze' when omitted. Requires a video-scene voiceover.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.playback.oneOf.0.mode.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.playback.oneOf.0.mode","typeLabel":"enum\u003cstring> | null"},"volume":{"default":1,"description":"Clip audio volume. 1.0 = source level (default), 0.0 = silent.","maximum":1,"minimum":0,"title":"Volume","type":"number","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.playback.oneOf.0.volume","typeLabel":"number"},"mute":{"default":false,"description":"If True, force the clip silent regardless of 'volume'.","title":"Mute","type":"boolean","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.playback.oneOf.0.mute","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.playback.oneOf.0","typeLabel":"PlaybackInput · object"},{"type":"null","description":"Optional playback capability: narrated-clip alignment 'mode', audio 'volume' (0.0–1.0), and 'mute'. Omit to use freeze alignment and keep the clip's source volume.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.playback.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.playback","typeLabel":"PlaybackInput · object | null"},"script":{"oneOf":[{"type":"string","title":"Script","description":"Optional voiceover: text to speak over the clip. Pair with voice_id. Mutually exclusive with audio_url/audio_asset_id.","minLength":1,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.script.oneOf.0","typeLabel":"string"},{"type":"null","title":"Script","description":"Optional voiceover: text to speak over the clip. Pair with voice_id. Mutually exclusive with audio_url/audio_asset_id.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.script.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.script","typeLabel":"string | null"},"voice_id":{"oneOf":[{"type":"string","title":"Voice Id","description":"Voice ID for text-to-speech. Required when script is provided.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Voice Id","description":"Voice ID for text-to-speech. Required when script is provided.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_id","typeLabel":"string | null"},"audio_url":{"oneOf":[{"type":"string","title":"Audio Url","description":"Optional voiceover: public http(s) URL of an audio file to play over the clip. Mutually exclusive with script/audio_asset_id. Not a local or sandbox path (/mnt/data/..., file://); upload it and pass audio_asset_id.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.audio_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Audio Url","description":"Optional voiceover: public http(s) URL of an audio file to play over the clip. Mutually exclusive with script/audio_asset_id. Not a local or sandbox path (/mnt/data/..., file://); upload it and pass audio_asset_id.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.audio_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.audio_url","typeLabel":"string | null"},"audio_asset_id":{"oneOf":[{"type":"string","title":"Audio Asset Id","description":"Optional voiceover: HeyGen asset ID of an uploaded audio file. Mutually exclusive with script/audio_url.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.audio_asset_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Audio Asset Id","description":"Optional voiceover: HeyGen asset ID of an uploaded audio file. Mutually exclusive with script/audio_url.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.audio_asset_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.audio_asset_id","typeLabel":"string | null"},"voice_settings":{"oneOf":[{"type":"object","title":"VoiceSettingsInput","description":"Voice settings for a script voiceover. Always include engine_settings: the engine from GET /v3/videos/voice-capabilities, and a model only when that row lists models. locale is optional and is the accent only.","properties":{"speed":{"default":1,"description":"Playback speed multiplier. 0.5 (half speed) to 1.5 (1.5x speed).","maximum":1.5,"minimum":0.5,"title":"Speed","type":"number","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.speed","typeLabel":"number"},"pitch":{"default":0,"description":"Legacy pitch adjustment, normalized to -1 to 1 before synthesis. Among the six documented engines, only Mockingbird can apply it when its base TTS uses Azure; use engine_settings.pitch for HeyGen Voice.","maximum":50,"minimum":-50,"title":"Pitch","type":"number","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.pitch","typeLabel":"number"},"volume":{"default":1,"description":"Voice audio volume. 1.0 = full, 0.0 = silent. Useful when mixing spoken voice with background audio.","maximum":1,"minimum":0,"title":"Volume","type":"number","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.volume","typeLabel":"number"},"locale":{"oneOf":[{"type":"string","title":"Locale","description":"Accent the user asked for (e.g. 'en-US'). It is not the script language; the language is read from the script. Omit for Original Accent, the voice's natural accent. Send only a locale that GET /v3/videos/voice-capabilities lists for the script's language and the engine in engine_settings. Mockingbird requires a regional locale.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.locale.oneOf.0","typeLabel":"string"},{"type":"null","title":"Locale","description":"Accent the user asked for (e.g. 'en-US'). It is not the script language; the language is read from the script. Omit for Original Accent, the voice's natural accent. Send only a locale that GET /v3/videos/voice-capabilities lists for the script's language and the engine in engine_settings. Mockingbird requires a regional locale.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.locale.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.locale","typeLabel":"string | null"},"engine_settings":{"oneOf":[{"type":"object","title":"ElevenLabsEngineSettings","description":"Engine-specific voice settings for ElevenLabs-backed voices.\n\nSupports model, stability, similarity_boost, style, and use_speaker_boost.\nWhen using eleven_v3 or eleven_v4, stability may be any value in [0.0, 1.0].","required":["engine_type"],"properties":{"engine_type":{"const":"elevenlabs","description":"Engine type discriminator. Must be 'elevenlabs' for ElevenLabs-backed voices.","title":"Engine Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.0.engine_type","typeLabel":"string"},"model":{"oneOf":[{"type":"string","description":"ElevenLabs model. eleven_v3 and eleven_v4 use stability only; similarity_boost, style, and use_speaker_boost have no effect on them.","enum":["eleven_multilingual_v2","eleven_turbo_v2_5","eleven_v3","eleven_v4"],"x-mcp-schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.0.model.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"ElevenLabs model. eleven_v3 and eleven_v4 use stability only; similarity_boost, style, and use_speaker_boost have no effect on them.","x-mcp-schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.0.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.0.model","typeLabel":"enum\u003cstring> | null"},"similarity_boost":{"oneOf":[{"type":"number","title":"Similarity Boost","description":"The similarity boost parameter for ElevenLabs.","maximum":1,"minimum":0,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.0.similarity_boost.oneOf.0","typeLabel":"number"},{"type":"null","title":"Similarity Boost","description":"The similarity boost parameter for ElevenLabs.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.0.similarity_boost.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.0.similarity_boost","typeLabel":"number | null"},"stability":{"oneOf":[{"type":"number","title":"Stability","description":"The stability parameter for ElevenLabs.","maximum":1,"minimum":0,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.0.stability.oneOf.0","typeLabel":"number"},{"type":"null","title":"Stability","description":"The stability parameter for ElevenLabs.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.0.stability.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.0.stability","typeLabel":"number | null"},"style":{"oneOf":[{"type":"number","title":"Style","description":"The style parameter for ElevenLabs.","maximum":1,"minimum":0,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.0.style.oneOf.0","typeLabel":"number"},{"type":"null","title":"Style","description":"The style parameter for ElevenLabs.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.0.style.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.0.style","typeLabel":"number | null"},"use_speaker_boost":{"oneOf":[{"type":"boolean","title":"Use Speaker Boost","description":"Whether to use speaker boost for ElevenLabs.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.0.use_speaker_boost.oneOf.0","typeLabel":"boolean"},{"type":"null","title":"Use Speaker Boost","description":"Whether to use speaker boost for ElevenLabs.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.0.use_speaker_boost.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.0.use_speaker_boost","typeLabel":"boolean | null"}},"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.0","typeLabel":"ElevenLabsEngineSettings · object"},{"type":"object","title":"FishEngineSettings","description":"Engine-specific voice settings for Fish Audio-backed voices.\n\nInherits Fish's tuning fields (model, stability, similarity).","required":["engine_type"],"properties":{"engine_type":{"const":"fish","description":"Engine type discriminator. Must be 'fish' for Fish Audio-backed voices.","title":"Engine Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.1.engine_type","typeLabel":"string"},"model":{"oneOf":[{"type":"string","description":"Fish Audio model version. Defaults to s2.1-pro when omitted.","enum":["s2.1-pro","s2-pro"],"x-mcp-schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.1.model.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Fish Audio model version. Defaults to s2.1-pro when omitted.","x-mcp-schema":{"anyOf":[{"type":"string"},{"type":"null"}]},"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.1.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.1.model","typeLabel":"enum\u003cstring> | null"},"stability":{"oneOf":[{"type":"number","title":"Stability","description":"Stability parameter; higher is more consistent.","maximum":1,"minimum":0,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.1.stability.oneOf.0","typeLabel":"number"},{"type":"null","title":"Stability","description":"Stability parameter; higher is more consistent.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.1.stability.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.1.stability","typeLabel":"number | null"},"similarity":{"oneOf":[{"type":"number","title":"Similarity","description":"Similarity parameter; how closely to match the source voice.","maximum":1,"minimum":0,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.1.similarity.oneOf.0","typeLabel":"number"},{"type":"null","title":"Similarity","description":"Similarity parameter; how closely to match the source voice.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.1.similarity.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.1.similarity","typeLabel":"number | null"}},"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.1","typeLabel":"FishEngineSettings · object"},{"type":"object","title":"StarfishEngineSettings","description":"Engine selection without tunable settings.\n\nSelects the engine named by ``engine_type`` on voices that support multiple engines.\nSend it in video creation requests to preserve the chosen engine.","required":["engine_type"],"properties":{"engine_type":{"const":"starfish","description":"Engine type discriminator for this settings variant.","title":"Engine Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.2.engine_type","typeLabel":"string"}},"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.2","typeLabel":"StarfishEngineSettings · object"},{"type":"object","title":"HeyGenVoiceEngineSettings","description":"HeyGen Voice controls for instant or professional voice clones.","required":["engine_type"],"properties":{"engine_type":{"description":"Engine type discriminator. 'heygen_voice' selects HeyGen Voice; 'orca' is accepted as its legacy alias.","enum":["heygen_voice","orca"],"title":"Engine Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.3.engine_type","typeLabel":"enum\u003cstring>"},"model":{"oneOf":[{"type":"string","title":"Model","description":"HeyGen Voice model for instant voice clones. Defaults to heygen-voice-1. Ignored for professional voice clones.","const":"heygen-voice-1","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.3.model.oneOf.0","typeLabel":"string"},{"type":"null","title":"Model","description":"HeyGen Voice model for instant voice clones. Defaults to heygen-voice-1. Ignored for professional voice clones.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.3.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.3.model","typeLabel":"string | null"},"similarity":{"oneOf":[{"type":"string","title":"Similarity","description":"Similarity for instant voice clones. Ignored for professional voice clones.","enum":["medium","high","extra_high","max"],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.3.similarity.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Similarity","description":"Similarity for instant voice clones. Ignored for professional voice clones.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.3.similarity.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.3.similarity","typeLabel":"enum\u003cstring> | null"},"expressiveness":{"oneOf":[{"type":"number","title":"Expressiveness","description":"Expressiveness from 0 to 1.","maximum":1,"minimum":0,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.3.expressiveness.oneOf.0","typeLabel":"number"},{"type":"null","title":"Expressiveness","description":"Expressiveness from 0 to 1.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.3.expressiveness.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.3.expressiveness","typeLabel":"number | null"},"pitch":{"oneOf":[{"type":"number","title":"Pitch","description":"Pitch shift in semitones.","multipleOf":0.5,"maximum":4,"minimum":-4,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.3.pitch.oneOf.0","typeLabel":"number"},{"type":"null","title":"Pitch","description":"Pitch shift in semitones.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.3.pitch.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.3.pitch","typeLabel":"number | null"},"inflection":{"oneOf":[{"type":"number","title":"Inflection","description":"Pitch variation multiplier.","maximum":2,"minimum":0.5,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.3.inflection.oneOf.0","typeLabel":"number"},{"type":"null","title":"Inflection","description":"Pitch variation multiplier.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.3.inflection.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.3.inflection","typeLabel":"number | null"}},"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.3","typeLabel":"HeyGenVoiceEngineSettings · object"},{"type":"object","title":"CartesiaEngineSettings","description":"Engine-specific voice tuning, discriminated by 'engine_type'. Always name the engine and, where offered, its model so the request reflects the selected voice and model. The request is rejected if the voice_id is not compatible with the selected engine. Always send it. A request without it gets its engine at render time and can fail after the video is created.","required":["engine_type"],"properties":{"engine_type":{"const":"cartesia","description":"Select Cartesia.","title":"Engine Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.4.engine_type","typeLabel":"string"},"model":{"oneOf":[{"type":"string","title":"Model","description":"Cartesia Sonic model; omit for the engine default.","enum":["sonic-3.6","sonic-3.5"],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.4.model.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","title":"Model","description":"Cartesia Sonic model; omit for the engine default.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.4.model.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.4.model","typeLabel":"enum\u003cstring> | null"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.4","typeLabel":"CartesiaEngineSettings · object"},{"type":"object","title":"MockingbirdEngineSettings","description":"Engine-specific voice tuning, discriminated by 'engine_type'. Always name the engine and, where offered, its model so the request reflects the selected voice and model. The request is rejected if the voice_id is not compatible with the selected engine. Always send it. A request without it gets its engine at render time and can fail after the video is created.","required":["engine_type"],"properties":{"engine_type":{"const":"mockingbird","description":"Select Mockingbird. A regional voice_settings.locale is required.","title":"Engine Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.5.engine_type","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.5","typeLabel":"MockingbirdEngineSettings · object"},{"type":"null","title":"Engine Settings","description":"Engine-specific voice tuning, discriminated by 'engine_type'. Always name the engine and, where offered, its model so the request reflects the selected voice and model. The request is rejected if the voice_id is not compatible with the selected engine. Always send it. A request without it gets its engine at render time and can fail after the video is created.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings.oneOf.6","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0.engine_settings","typeLabel":"ElevenLabsEngineSettings · object | FishEngineSettings · object | StarfishEngineSettings · object | HeyGenVoiceEngineSettings · object | CartesiaEngineSettings · object | MockingbirdEngineSettings · object | null"}},"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.0","typeLabel":"VoiceSettingsInput · object"},{"type":"null","description":"Voice settings for a script voiceover. Always include engine_settings: the engine from GET /v3/videos/voice-capabilities, and a model only when that row lists models. locale is optional and is the accent only.","uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2.voice_settings","typeLabel":"VoiceSettingsInput · object | null"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX].oneOf.2","typeLabel":"VideoScene · object"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes.items.[INDEX]","typeLabel":"AvatarVideoScene · object | ImageScene · object | VideoScene · object"},"title":"Scenes","type":"array","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.scenes","typeLabel":"(AvatarVideoScene · object | ImageScene · object | VideoScene · object)[]"},"title":{"oneOf":[{"type":"string","title":"Title","description":"Display title for the video in the HeyGen dashboard.","uniqueKey":"videos.items.[INDEX].oneOf.3.title.oneOf.0","typeLabel":"string"},{"type":"null","title":"Title","description":"Display title for the video in the HeyGen dashboard.","uniqueKey":"videos.items.[INDEX].oneOf.3.title.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.title","typeLabel":"string | null"},"aspect_ratio":{"oneOf":[{"type":"string","title":"VideoAspectRatio","description":"Global output aspect ratio. Supported values: '16:9', '9:16', '4:5', '5:4', '1:1', 'auto'. Defaults to '16:9'. Each scene is center-cropped to this canvas.","default":"16:9","enum":["16:9","9:16","4:5","5:4","1:1","auto"],"x-cli-default":"auto","x-mcp-default":"auto","uniqueKey":"videos.items.[INDEX].oneOf.3.aspect_ratio.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Global output aspect ratio. Supported values: '16:9', '9:16', '4:5', '5:4', '1:1', 'auto'. Defaults to '16:9'. Each scene is center-cropped to this canvas.","default":"16:9","x-cli-default":"auto","x-mcp-default":"auto","uniqueKey":"videos.items.[INDEX].oneOf.3.aspect_ratio.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.aspect_ratio","typeLabel":"enum\u003cstring> | null"},"resolution":{"oneOf":[{"type":"string","title":"VideoResolution","description":"Global output video resolution. Defaults to 1080p. `4k` is available for Avatar III digital twins and studio avatars. For apps signed in with OAuth, such as MCP clients, the account's plan sets the maximum: 720p on Free, 1080p on Creator.","enum":["4k","1080p","720p"],"uniqueKey":"videos.items.[INDEX].oneOf.3.resolution.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Global output video resolution. Defaults to 1080p. `4k` is available for Avatar III digital twins and studio avatars. For apps signed in with OAuth, such as MCP clients, the account's plan sets the maximum: 720p on Free, 1080p on Creator.","uniqueKey":"videos.items.[INDEX].oneOf.3.resolution.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.resolution","typeLabel":"enum\u003cstring> | null"},"brand_glossary_id":{"oneOf":[{"type":"string","title":"Brand Glossary Id","description":"Brand glossary ID controlling how custom terms are pronounced in generated speech (for example, saying 'HeyGen' as 'hey-jen'). Applies to every scene whose audio is synthesized from a script; scenes that supply their own audio URL or audio asset are unaffected. Pronunciation is applied to the synthesized audio only, so caption and subtitle text still show the original script wording. Discover IDs via GET /v3/brand-glossaries.","minLength":1,"uniqueKey":"videos.items.[INDEX].oneOf.3.brand_glossary_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Brand Glossary Id","description":"Brand glossary ID controlling how custom terms are pronounced in generated speech (for example, saying 'HeyGen' as 'hey-jen'). Applies to every scene whose audio is synthesized from a script; scenes that supply their own audio URL or audio asset are unaffected. Pronunciation is applied to the synthesized audio only, so caption and subtitle text still show the original script wording. Discover IDs via GET /v3/brand-glossaries.","uniqueKey":"videos.items.[INDEX].oneOf.3.brand_glossary_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.brand_glossary_id","typeLabel":"string | null"},"callback_url":{"oneOf":[{"type":"string","title":"Callback Url","description":"Webhook URL to receive a POST notification when the video is ready.","uniqueKey":"videos.items.[INDEX].oneOf.3.callback_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Callback Url","description":"Webhook URL to receive a POST notification when the video is ready.","uniqueKey":"videos.items.[INDEX].oneOf.3.callback_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.callback_url","typeLabel":"string | null"},"callback_id":{"oneOf":[{"type":"string","title":"Callback Id","description":"Caller-defined identifier echoed back in the webhook payload.","uniqueKey":"videos.items.[INDEX].oneOf.3.callback_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Callback Id","description":"Caller-defined identifier echoed back in the webhook payload.","uniqueKey":"videos.items.[INDEX].oneOf.3.callback_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.callback_id","typeLabel":"string | null"},"caption":{"oneOf":[{"type":"object","title":"CaptionSetting","description":"Caption generation settings. A sidecar subtitle file is always returned via subtitle_url; set 'style' to additionally burn captions into the rendered video.","properties":{"file_format":{"description":"Output format for the sidecar caption file.","enum":["srt"],"title":"CaptionFileFormat","type":"string","default":"srt","uniqueKey":"videos.items.[INDEX].oneOf.3.caption.oneOf.0.file_format","typeLabel":"enum\u003cstring>"},"style":{"oneOf":[{"type":"string","title":"CaptionStyle","description":"Visual style for burning captions into the rendered video. Omit for sidecar-only captions.","enum":["default"],"uniqueKey":"videos.items.[INDEX].oneOf.3.caption.oneOf.0.style.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","description":"Visual style for burning captions into the rendered video. Omit for sidecar-only captions.","uniqueKey":"videos.items.[INDEX].oneOf.3.caption.oneOf.0.style.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.caption.oneOf.0.style","typeLabel":"enum\u003cstring> | null"}},"uniqueKey":"videos.items.[INDEX].oneOf.3.caption.oneOf.0","typeLabel":"CaptionSetting · object"},{"type":"null","description":"Caption generation settings. A sidecar subtitle file is always returned via subtitle_url; set 'style' to additionally burn captions into the rendered video.","uniqueKey":"videos.items.[INDEX].oneOf.3.caption.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.caption","typeLabel":"CaptionSetting · object | null"},"watermark":{"oneOf":[{"type":"object","title":"WatermarkInput","description":"Custom watermark image to overlay on the video (PNG or JPEG). Available to workspaces on an Enterprise web or API plan.","required":["image"],"x-cli-visible":false,"x-mcp-visible":false,"properties":{"image":{"oneOf":[{"type":"object","title":"AssetUrl","description":"Asset input via publicly accessible HTTPS URL.","required":["type","url"],"properties":{"type":{"const":"url","description":"Input type discriminator","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.watermark.oneOf.0.image.oneOf.0.type","typeLabel":"string"},"url":{"description":"Public http(s) URL HeyGen can download without auth or redirects. Not a local or sandbox path (/mnt/data/..., file://, sandbox:); upload such files and pass asset_id.","title":"Url","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.watermark.oneOf.0.image.oneOf.0.url","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.watermark.oneOf.0.image.oneOf.0","typeLabel":"AssetUrl · object"},{"type":"object","title":"AssetId","description":"Asset input via HeyGen asset ID from the asset upload endpoint.","required":["type","asset_id"],"properties":{"type":{"const":"asset_id","description":"Input type discriminator","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.watermark.oneOf.0.image.oneOf.1.type","typeLabel":"string"},"asset_id":{"description":"HeyGen asset ID from an asset upload or import; not a third-party file ID.","title":"Asset Id","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.watermark.oneOf.0.image.oneOf.1.asset_id","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.watermark.oneOf.0.image.oneOf.1","typeLabel":"AssetId · object"},{"type":"object","title":"AssetBase64","description":"Asset input via base64-encoded content.","required":["type","media_type","data"],"x-mcp-visible":false,"properties":{"type":{"const":"base64","description":"Input type discriminator","title":"Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.watermark.oneOf.0.image.oneOf.2.type","typeLabel":"string"},"media_type":{"description":"MIME type of the encoded content (e.g. \"image/png\")","title":"Media Type","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.watermark.oneOf.0.image.oneOf.2.media_type","typeLabel":"string"},"data":{"description":"Base64-encoded file content","title":"Data","type":"string","isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.watermark.oneOf.0.image.oneOf.2.data","typeLabel":"string"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.watermark.oneOf.0.image.oneOf.2","typeLabel":"AssetBase64 · object"}],"isRequired":true,"uniqueKey":"videos.items.[INDEX].oneOf.3.watermark.oneOf.0.image","typeLabel":"AssetUrl · object | AssetId · object | AssetBase64 · object"},"scale":{"default":1,"description":"Scale multiplier for the watermark image. 1.0 renders at native size.","exclusiveMinimum":0,"maximum":2,"title":"Scale","type":"number","uniqueKey":"videos.items.[INDEX].oneOf.3.watermark.oneOf.0.scale","typeLabel":"number"},"opacity":{"default":1,"description":"Watermark opacity. 0.0 is fully transparent, 1.0 is fully opaque.","maximum":1,"minimum":0,"title":"Opacity","type":"number","uniqueKey":"videos.items.[INDEX].oneOf.3.watermark.oneOf.0.opacity","typeLabel":"number"},"placement":{"oneOf":[{"type":"object","title":"WatermarkPlacement","description":"Watermark placement. Defaults to bottom-right with standard margins when omitted.","properties":{"position":{"description":"Anchor corner for the watermark.","enum":["top_left","top_right","bottom_left","bottom_right"],"title":"WatermarkPosition","type":"string","default":"bottom_right","uniqueKey":"videos.items.[INDEX].oneOf.3.watermark.oneOf.0.placement.oneOf.0.position","typeLabel":"enum\u003cstring>"},"offset_x":{"oneOf":[{"type":"number","title":"Offset X","description":"Fine-tune horizontal position. Fraction of frame width; 0.05 shifts 5% rightward, -0.05 shifts 5% leftward.","maximum":1,"minimum":-1,"uniqueKey":"videos.items.[INDEX].oneOf.3.watermark.oneOf.0.placement.oneOf.0.offset_x.oneOf.0","typeLabel":"number"},{"type":"null","title":"Offset X","description":"Fine-tune horizontal position. Fraction of frame width; 0.05 shifts 5% rightward, -0.05 shifts 5% leftward.","uniqueKey":"videos.items.[INDEX].oneOf.3.watermark.oneOf.0.placement.oneOf.0.offset_x.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.watermark.oneOf.0.placement.oneOf.0.offset_x","typeLabel":"number | null"},"offset_y":{"oneOf":[{"type":"number","title":"Offset Y","description":"Fine-tune vertical position. Fraction of frame height; 0.05 shifts 5% downward, -0.05 shifts 5% upward.","maximum":1,"minimum":-1,"uniqueKey":"videos.items.[INDEX].oneOf.3.watermark.oneOf.0.placement.oneOf.0.offset_y.oneOf.0","typeLabel":"number"},{"type":"null","title":"Offset Y","description":"Fine-tune vertical position. Fraction of frame height; 0.05 shifts 5% downward, -0.05 shifts 5% upward.","uniqueKey":"videos.items.[INDEX].oneOf.3.watermark.oneOf.0.placement.oneOf.0.offset_y.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.watermark.oneOf.0.placement.oneOf.0.offset_y","typeLabel":"number | null"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.3.watermark.oneOf.0.placement.oneOf.0","typeLabel":"WatermarkPlacement · object"},{"type":"null","description":"Watermark placement. Defaults to bottom-right with standard margins when omitted.","uniqueKey":"videos.items.[INDEX].oneOf.3.watermark.oneOf.0.placement.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.watermark.oneOf.0.placement","typeLabel":"WatermarkPlacement · object | null"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.3.watermark.oneOf.0","typeLabel":"WatermarkInput · object"},{"type":"null","description":"Custom watermark image to overlay on the video (PNG or JPEG). Available to workspaces on an Enterprise web or API plan.","x-cli-visible":false,"x-mcp-visible":false,"uniqueKey":"videos.items.[INDEX].oneOf.3.watermark.oneOf.1","typeLabel":"null"}],"uniqueKey":"videos.items.[INDEX].oneOf.3.watermark","typeLabel":"WatermarkInput · object | null"}},"additionalProperties":false,"uniqueKey":"videos.items.[INDEX].oneOf.3","typeLabel":"CreateBatchVideoFromStudio · object"}],"uniqueKey":"videos.items.[INDEX]","typeLabel":"CreateBatchVideoFromAvatar · object | CreateBatchVideoFromImage · object | CreateBatchVideoFromCinematicAvatar · object | CreateBatchVideoFromStudio · object"},"maxItems":100,"minItems":1,"title":"Videos","type":"array","isRequired":true,"uniqueKey":"videos","typeLabel":"(CreateBatchVideoFromAvatar · object | CreateBatchVideoFromImage · object | CreateBatchVideoFromCinematicAvatar · object | CreateBatchVideoFromStudio · object)[]"},"title":{"oneOf":[{"type":"string","title":"Title","description":"Display name for the batch, shown in the HeyGen app.","uniqueKey":"title.oneOf.0","typeLabel":"string"},{"type":"null","title":"Title","description":"Display name for the batch, shown in the HeyGen app.","uniqueKey":"title.oneOf.1","typeLabel":"null"}],"uniqueKey":"title","typeLabel":"string | null"},"folder_id":{"oneOf":[{"type":"string","title":"Folder Id","description":"Destination folder ID for the batch container. The videos remain grouped inside the newly created batch; the batch itself is placed in this folder. Omit, pass null, or pass an empty string to place the batch at the workspace root.","uniqueKey":"folder_id.oneOf.0","typeLabel":"string"},{"type":"null","title":"Folder Id","description":"Destination folder ID for the batch container. The videos remain grouped inside the newly created batch; the batch itself is placed in this folder. Omit, pass null, or pass an empty string to place the batch at the workspace root.","uniqueKey":"folder_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"folder_id","typeLabel":"string | null"},"callback_url":{"oneOf":[{"type":"string","title":"Callback Url","description":"Webhook URL invoked once when every item in the batch reaches a terminal state.","uniqueKey":"callback_url.oneOf.0","typeLabel":"string"},{"type":"null","title":"Callback Url","description":"Webhook URL invoked once when every item in the batch reaches a terminal state.","uniqueKey":"callback_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"callback_url","typeLabel":"string | null"}},"required":["videos"],"title":"CreateVideoBatchRequest","type":"object","uniqueKey":"","typeLabel":"CreateVideoBatchRequest · object"},"examples":{"Example":{"title":"Example","value":{"videos":[{"type":"avatar","avatar_id":"\u003cstring>","title":"\u003cstring>","aspect_ratio":"16:9","background":{"value":"\u003cstring>","url":"\u003cstring>","asset_id":"\u003cstring>"},"remove_background":true,"callback_url":"\u003cstring>","callback_id":"\u003cstring>","watermark":{"image":{"type":"url","url":"\u003cstring>"},"scale":1,"opacity":1,"placement":{"position":"bottom_right","offset_x":0,"offset_y":0}},"caption":{"file_format":"srt","style":"default"},"output_format":"mp4","script":"\u003cstring>","voice_id":"\u003cstring>","audio_url":"\u003cstring>","audio_asset_id":"\u003cstring>","voice_settings":{"speed":1,"pitch":0,"volume":1,"locale":"\u003cstring>","engine_settings":{"engine_type":"elevenlabs","similarity_boost":0.5,"stability":0.5,"style":0.5,"use_speaker_boost":true}},"brand_glossary_id":"\u003cstring>","motion_prompt":"\u003cstring>","engine":{"type":"avatar_v","reference_look_id":"\u003cstring>","more_blinking":false}}],"title":"\u003cstring>","folder_id":"\u003cstring>","callback_url":"\u003cstring>"}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"bb285254-80b4-4063-a2b7-2c3dffe0e84c":{"description":"Accepted — submission acknowledged; poll for completion.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"properties":{"batch_id":{"description":"Identifier of the created batch. Poll GET /v3/videos/batches/{batch_id} for progress.","title":"Batch Id","type":"string","isRequired":true,"uniqueKey":"data.batch_id","typeLabel":"string"}},"required":["batch_id"],"title":"CreateVideoBatchResponse","type":"object","uniqueKey":"data","typeLabel":"CreateVideoBatchResponse · object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"batch_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"735c441d-b201-4871-b060-1e3da857c29c":{"description":"Invalid request parameters","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"invalid_parameter","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"Video not found","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","description":"Which request field caused the error","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"Which request field caused the error","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"doc_url":{"oneOf":[{"type":"string","description":"Link to error documentation","uniqueKey":"error.doc_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Link to error documentation","uniqueKey":"error.doc_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.doc_url","typeLabel":"string | null"},"errors":{"type":"array","description":"Per-item error details for batch/multi-node failures (e.g. graph compilation errors by node).","items":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"unknown_node_type","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"Unknown node type","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].message","typeLabel":"string"},"node_id":{"type":"string","description":"Graph node id this error pertains to, if applicable","uniqueKey":"error.errors.items.[INDEX].node_id","typeLabel":"string"},"port":{"type":"string","description":"Port name on the node this error pertains to, if applicable","uniqueKey":"error.errors.items.[INDEX].port","typeLabel":"string"},"path":{"type":"string","description":"Field path within the item this error pertains to, if applicable","uniqueKey":"error.errors.items.[INDEX].path","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.errors","typeLabel":"object[]"},"request_id":{"type":"string","description":"Request identifier, also returned in the X-HeyGen-Request-Id response header. Include it when contacting support.","example":"8c4f0b9e1d2a4f6b9e3c7a1d5f2b8e40","uniqueKey":"error.request_id","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"invalid_parameter","message":"Invalid payload(s) at index 3.","param":"videos","doc_url":null}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"invalid_parameter","message":"Invalid payload(s) at index 3.","param":"videos","doc_url":null}}}},"exampleType":"examples"}},"exampleType":"examples"},"45b6f8f3-0d48-433a-bb5b-382a53e91489":{"description":"Authentication failed","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"invalid_parameter","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"Video not found","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","description":"Which request field caused the error","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"Which request field caused the error","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"doc_url":{"oneOf":[{"type":"string","description":"Link to error documentation","uniqueKey":"error.doc_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Link to error documentation","uniqueKey":"error.doc_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.doc_url","typeLabel":"string | null"},"errors":{"type":"array","description":"Per-item error details for batch/multi-node failures (e.g. graph compilation errors by node).","items":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"unknown_node_type","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"Unknown node type","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].message","typeLabel":"string"},"node_id":{"type":"string","description":"Graph node id this error pertains to, if applicable","uniqueKey":"error.errors.items.[INDEX].node_id","typeLabel":"string"},"port":{"type":"string","description":"Port name on the node this error pertains to, if applicable","uniqueKey":"error.errors.items.[INDEX].port","typeLabel":"string"},"path":{"type":"string","description":"Field path within the item this error pertains to, if applicable","uniqueKey":"error.errors.items.[INDEX].path","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.errors","typeLabel":"object[]"},"request_id":{"type":"string","description":"Request identifier, also returned in the X-HeyGen-Request-Id response header. Include it when contacting support.","example":"8c4f0b9e1d2a4f6b9e3c7a1d5f2b8e40","uniqueKey":"error.request_id","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"unauthorized","message":"Invalid or expired API key. Verify your x-api-key header.","param":null,"doc_url":null}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"unauthorized","message":"Invalid or expired API key. Verify your x-api-key header.","param":null,"doc_url":null}}}},"exampleType":"examples"}},"exampleType":"examples"},"aecadb5e-3a03-46b7-92f3-a4bf12fc6633":{"description":"A prior request with this Idempotency-Key is still in progress. Wait for the original request to complete, then retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"invalid_parameter","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"Video not found","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","description":"Which request field caused the error","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"Which request field caused the error","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"doc_url":{"oneOf":[{"type":"string","description":"Link to error documentation","uniqueKey":"error.doc_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Link to error documentation","uniqueKey":"error.doc_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.doc_url","typeLabel":"string | null"},"errors":{"type":"array","description":"Per-item error details for batch/multi-node failures (e.g. graph compilation errors by node).","items":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"unknown_node_type","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"Unknown node type","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].message","typeLabel":"string"},"node_id":{"type":"string","description":"Graph node id this error pertains to, if applicable","uniqueKey":"error.errors.items.[INDEX].node_id","typeLabel":"string"},"port":{"type":"string","description":"Port name on the node this error pertains to, if applicable","uniqueKey":"error.errors.items.[INDEX].port","typeLabel":"string"},"path":{"type":"string","description":"Field path within the item this error pertains to, if applicable","uniqueKey":"error.errors.items.[INDEX].path","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.errors","typeLabel":"object[]"},"request_id":{"type":"string","description":"Request identifier, also returned in the X-HeyGen-Request-Id response header. Include it when contacting support.","example":"8c4f0b9e1d2a4f6b9e3c7a1d5f2b8e40","uniqueKey":"error.request_id","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"request_in_progress","message":"A request with this Idempotency-Key is already in progress. Retry shortly.","param":null,"doc_url":null}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"request_in_progress","message":"A request with this Idempotency-Key is already in progress. Retry shortly.","param":null,"doc_url":null}}}},"exampleType":"examples"}},"exampleType":"examples"},"708888b6-3d9d-4400-9625-84738dd0f3d7":{"description":"Rate limit exceeded","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"invalid_parameter","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"Video not found","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"param":{"oneOf":[{"type":"string","description":"Which request field caused the error","uniqueKey":"error.param.oneOf.0","typeLabel":"string"},{"type":"null","description":"Which request field caused the error","uniqueKey":"error.param.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.param","typeLabel":"string | null"},"doc_url":{"oneOf":[{"type":"string","description":"Link to error documentation","uniqueKey":"error.doc_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Link to error documentation","uniqueKey":"error.doc_url.oneOf.1","typeLabel":"null"}],"uniqueKey":"error.doc_url","typeLabel":"string | null"},"errors":{"type":"array","description":"Per-item error details for batch/multi-node failures (e.g. graph compilation errors by node).","items":{"type":"object","properties":{"code":{"type":"string","description":"Machine-readable error code","example":"unknown_node_type","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].code","typeLabel":"string"},"message":{"type":"string","description":"Human-readable error message","example":"Unknown node type","isRequired":true,"uniqueKey":"error.errors.items.[INDEX].message","typeLabel":"string"},"node_id":{"type":"string","description":"Graph node id this error pertains to, if applicable","uniqueKey":"error.errors.items.[INDEX].node_id","typeLabel":"string"},"port":{"type":"string","description":"Port name on the node this error pertains to, if applicable","uniqueKey":"error.errors.items.[INDEX].port","typeLabel":"string"},"path":{"type":"string","description":"Field path within the item this error pertains to, if applicable","uniqueKey":"error.errors.items.[INDEX].path","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"error.errors.items.[INDEX]","typeLabel":"object"},"uniqueKey":"error.errors","typeLabel":"object[]"},"request_id":{"type":"string","description":"Request identifier, also returned in the X-HeyGen-Request-Id response header. Include it when contacting support.","example":"8c4f0b9e1d2a4f6b9e3c7a1d5f2b8e40","uniqueKey":"error.request_id","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"rate_limit_exceeded","message":"Too many requests. Retry after the duration specified in the Retry-After header.","param":null,"doc_url":null}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"rate_limit_exceeded","message":"Too many requests. Retry after the duration specified in the Retry-After header.","param":null,"doc_url":null}}}},"exampleType":"examples"}},"headers":{"Retry-After":{"description":"Seconds to wait before retrying","schema":{"type":"integer"}}},"exampleType":"examples"}},"security":{"56b8fe92-2a58-4cdf-bafd-c0fdc1067c89":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"HeyGen API key. Obtain from your HeyGen dashboard.","scopes":[],"schemeName":"ApiKeyAuth"}},"0610cbc2-0503-4d5e-aa62-04af7767306c":{"BearerAuth":{"type":"http","scheme":"bearer","description":"OAuth2 bearer token.","scopes":[],"schemeName":"BearerAuth"}}},"servers":{"e6cd17e6-82b7-4d18-b2e2-af0f350698c3":{"url":"https://api.heygen.com","description":"Production"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"HeyGen API key. Obtain from your HeyGen dashboard.","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-api-key","type":"string","description":"HeyGen API key. Obtain from your HeyGen dashboard.","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"}],"title":"ApiKeyAuth"},{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"OAuth2 bearer token.","scopes":[],"schemeName":"BearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"OAuth2 bearer token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"BearerAuth","name":"Authorization"}],"title":"BearerAuth"}]},"originalFileLocation":"openapi/external-api.json"},"subdomain":"heygen-1fa696a7","siteName":"HeyGen Documentation","title":"Create Video Batch - HeyGen Documentation","relatedPagesConfig":{"enabled":true,"limit":8,"mode":"manual"},"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-22T00:46:31.733Z","originalFileLocation":"reference/create-video-batch.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=\"Submit up to 100 video creation payloads in one request and return a batch id immediately. Videos are created asynchronously; poll GET /v3/videos/batches/{batch_id} for per-item video ids and statuses.\">\u003cmeta data-mint-head name=\"application-name\" content=\"HeyGen Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/heygen-1fa696a7/V7Z_LW-WQjtKUYWA/_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/heygen-1fa696a7/V7Z_LW-WQjtKUYWA/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/heygen-1fa696a7/V7Z_LW-WQjtKUYWA/_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/heygen-1fa696a7/V7Z_LW-WQjtKUYWA/_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/heygen-1fa696a7/V7Z_LW-WQjtKUYWA/_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/heygen-1fa696a7/V7Z_LW-WQjtKUYWA/_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/heygen-1fa696a7/V7Z_LW-WQjtKUYWA/_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/heygen-1fa696a7/V7Z_LW-WQjtKUYWA/_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/heygen-1fa696a7/V7Z_LW-WQjtKUYWA/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Create Video Batch - HeyGen Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Submit up to 100 video creation payloads in one request and return a batch id immediately. Videos are created asynchronously; poll GET /v3/videos/batches/{batch_id} for per-item video ids and statuses.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"HeyGen Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://heygen-1fa696a7.mintlify.app/reference/create-video-batch\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://heygen-1fa696a7.mintlify.site/_mintlify/api/og/v2?division=Batches\u0026amp;title=Create+Video+Batch\u0026amp;description=Submit+up+to+100+video+creation+payloads+in+one+request+and+return+a+batch+id+immediately.+Videos+are+created+asynchronously%3B+poll+GET+%2Fv3%2Fvideos%2Fbatches%2F%7Bbatch\u0026amp;theme=806bfcae4fd50c26d3779ac8\u0026amp;signature=69dd74f1f96cbe5d82bca297ab73bf2ab4f7e131046019ed386d660e92284794\">\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=\"Create Video Batch - HeyGen Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Submit up to 100 video creation payloads in one request and return a batch id immediately. Videos are created asynchronously; poll GET /v3/videos/batches/{batch_id} for per-item video ids and statuses.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://heygen-1fa696a7.mintlify.site/_mintlify/api/og/v2?division=Batches\u0026amp;title=Create+Video+Batch\u0026amp;description=Submit+up+to+100+video+creation+payloads+in+one+request+and+return+a+batch+id+immediately.+Videos+are+created+asynchronously%3B+poll+GET+%2Fv3%2Fvideos%2Fbatches%2F%7Bbatch\u0026amp;theme=806bfcae4fd50c26d3779ac8\u0026amp;signature=69dd74f1f96cbe5d82bca297ab73bf2ab4f7e131046019ed386d660e92284794\">\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/heygen-1fa696a7/V7Z_LW-WQjtKUYWA/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"HeyGen Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#03C3FF\">\u003clink data-mint-head rel=\"canonical\" href=\"https://heygen-1fa696a7.mintlify.app/reference/create-video-batch\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/create-video-batch.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://heygen-1fa696a7.mintlify.app/#organization\",\"name\":\"HeyGen Documentation\",\"url\":\"https://heygen-1fa696a7.mintlify.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/heygen-1fa696a7/dQ_uLJDftFYFhC7B/logo/light.png?fit=max\u0026auto=format\u0026n=dQ_uLJDftFYFhC7B\u0026q=85\u0026s=b03d2e41dde1cc0b50cd50e574f66f1c\"}},{\"@type\":\"WebSite\",\"@id\":\"https://heygen-1fa696a7.mintlify.app#website\",\"name\":\"HeyGen Documentation\",\"url\":\"https://heygen-1fa696a7.mintlify.app\",\"publisher\":{\"@id\":\"https://heygen-1fa696a7.mintlify.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://heygen-1fa696a7.mintlify.app/reference/create-video-batch#webpage\",\"url\":\"https://heygen-1fa696a7.mintlify.app/reference/create-video-batch\",\"name\":\"Create Video Batch\",\"description\":\"Submit up to 100 video creation payloads in one request and return a batch id immediately. Videos are created asynchronously; poll GET /v3/videos/batches/{batch_id} for per-item video ids and statuses.\",\"dateModified\":\"2026-11-22T00:46:31.733Z\",\"isPartOf\":{\"@id\":\"https://heygen-1fa696a7.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://heygen-1fa696a7.mintlify.app/reference/create-video-batch#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://heygen-1fa696a7.mintlify.app/reference/create-video-batch#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"HeyGen Documentation\",\"item\":\"https://heygen-1fa696a7.mintlify.app\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Create Video Batch\",\"item\":\"https://heygen-1fa696a7.mintlify.app/reference/create-video-batch\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://heygen-1fa696a7.mintlify.app/reference/create-video-batch#apireference\",\"headline\":\"Create Video Batch\",\"name\":\"Create Video Batch\",\"description\":\"Submit up to 100 video creation payloads in one request and return a batch id immediately. Videos are created asynchronously; poll GET /v3/videos/batches/{batch_id} for per-item video ids and statuses.\",\"url\":\"https://heygen-1fa696a7.mintlify.app/reference/create-video-batch\",\"mainEntityOfPage\":{\"@id\":\"https://heygen-1fa696a7.mintlify.app/reference/create-video-batch#webpage\"},\"dateModified\":\"2026-11-22T00:46:31.733Z\",\"publisher\":{\"@id\":\"https://heygen-1fa696a7.mintlify.app/#organization\"},\"isPartOf\":{\"@id\":\"https://heygen-1fa696a7.mintlify.app#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"HeyGen Documentation\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"HeyGen Documentation\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/reference/create-video-batch.md","siteName":"HeyGen Documentation","nav":{"global":null,"tabs":[{"tab":"Developer Guide","pages":[{"title":"Developer Guide","href":"/docs/quick-start"}]},{"tab":"API Reference","groups":[{"group":"Video","pages":[{"title":"List Videos","deprecated":null,"version":null,"sidebarTitle":"List videos","openapi":"/openapi/external-api.json get /v3/videos","href":"/reference/list-videos"},{"title":"Create Video","deprecated":null,"version":null,"sidebarTitle":"Create video","openapi":"/openapi/external-api.json post /v3/videos","href":"/reference/create-video"},{"title":"Get Video Voice Capabilities","deprecated":null,"version":null,"sidebarTitle":"Get video voice capabilities","openapi":"/openapi/external-api.json get /v3/videos/voice-capabilities","href":"/reference/get-video-voice-capabilities"},{"title":"Get Video","deprecated":null,"version":null,"sidebarTitle":"Get video","openapi":"/openapi/external-api.json get /v3/videos/{video_id}","href":"/reference/get-video"},{"title":"Delete Video","deprecated":null,"version":null,"sidebarTitle":"Delete video","openapi":"/openapi/external-api.json delete /v3/videos/{video_id}","href":"/reference/delete-video"},{"title":"Get Video Scenes","deprecated":null,"version":null,"sidebarTitle":"Get video scenes","openapi":"/openapi/external-api.json get /v3/videos/{video_id}/scenes","href":"/reference/get-video-scenes"},{"title":"Create HeyGen Video","deprecated":null,"version":null,"sidebarTitle":"Create heygen video","openapi":"/openapi/external-api.json post /v3/models/videos","href":"/reference/create-heygen-video"},{"title":"Get HeyGen Video","deprecated":null,"version":null,"sidebarTitle":"Get heygen video","openapi":"/openapi/external-api.json get /v3/models/videos/{video_id}","href":"/reference/get-heygen-video"}]},{"group":"Avatar","pages":[{"title":"List Avatar Groups","deprecated":null,"version":null,"sidebarTitle":"List avatar groups","openapi":"/openapi/external-api.json get /v3/avatars","href":"/reference/list-avatar-groups"},{"title":"Create Avatar","deprecated":null,"version":null,"sidebarTitle":"Create avatar","openapi":"/openapi/external-api.json post /v3/avatars","href":"/reference/create-avatar"},{"title":"Get Avatar Group","deprecated":null,"version":null,"sidebarTitle":"Get avatar group","openapi":"/openapi/external-api.json get /v3/avatars/{group_id}","href":"/reference/get-avatar-group"},{"title":"Delete Avatar Group","deprecated":null,"version":null,"sidebarTitle":"Delete avatar group","openapi":"/openapi/external-api.json delete /v3/avatars/{group_id}","href":"/reference/delete-avatar-group"},{"title":"Update Avatar Group","deprecated":null,"version":null,"sidebarTitle":"Update avatar group","openapi":"/openapi/external-api.json patch /v3/avatars/{group_id}","href":"/reference/update-avatar-group"},{"title":"Create Avatar Consent","deprecated":null,"version":null,"sidebarTitle":"Create avatar consent","openapi":"/openapi/external-api.json post /v3/avatars/{group_id}/consent","href":"/reference/create-avatar-consent"},{"title":"List Avatar Looks","deprecated":null,"version":null,"sidebarTitle":"List avatar looks","openapi":"/openapi/external-api.json get /v3/avatars/looks","href":"/reference/list-avatar-looks"},{"title":"Create Avatar Looks","deprecated":null,"version":null,"sidebarTitle":"Create avatar looks","openapi":"/openapi/external-api.json post /v3/avatars/looks","href":"/reference/create-avatar-looks"},{"title":"List Look Templates","deprecated":null,"version":null,"sidebarTitle":"List look templates","openapi":"/openapi/external-api.json get /v3/avatars/look-templates","href":"/reference/list-look-templates"},{"title":"Get Avatar Look","deprecated":null,"version":null,"sidebarTitle":"Get avatar look","openapi":"/openapi/external-api.json get /v3/avatars/looks/{look_id}","href":"/reference/get-avatar-look"},{"title":"Delete Avatar Look","deprecated":null,"version":null,"sidebarTitle":"Delete avatar look","openapi":"/openapi/external-api.json delete /v3/avatars/looks/{look_id}","href":"/reference/delete-avatar-look"},{"title":"Update Avatar Look","deprecated":null,"version":null,"sidebarTitle":"Update avatar look","openapi":"/openapi/external-api.json patch /v3/avatars/looks/{look_id}","href":"/reference/update-avatar-look"},{"title":"Create Avatar 6 Video","deprecated":null,"version":null,"sidebarTitle":"Create avatar 6 video","openapi":"/openapi/external-api.json post /v3/models/avatars","href":"/reference/create-avatar-6-video"}]},{"group":"Voice","pages":[{"title":"List Audio Voices","deprecated":null,"version":null,"sidebarTitle":"List audio voices","openapi":"/openapi/external-api.json get /v3/models/audio/voices","href":"/reference/list-audio-voices"},{"title":"Create or Retrain an Audio Voice","deprecated":null,"version":null,"sidebarTitle":"Create or retrain an audio voice","openapi":"/openapi/external-api.json post /v3/models/audio/voices","href":"/reference/create-or-retrain-an-audio-voice"},{"title":"Convert Speech","deprecated":null,"version":null,"sidebarTitle":"Convert model speech","openapi":"/openapi/external-api.json post /v3/models/audio/sts","href":"/reference/convert-model-speech"},{"title":"Generate Speech","deprecated":null,"version":null,"sidebarTitle":"Generate model speech","openapi":"/openapi/external-api.json post /v3/models/audio/tts","href":"/reference/generate-model-speech"},{"title":"Stream Speech","deprecated":null,"version":null,"sidebarTitle":"Stream speech","openapi":"/openapi/external-api.json post /v3/models/audio/tts/stream","href":"/reference/stream-speech"},{"title":"Create Speech Input Token","deprecated":null,"version":null,"sidebarTitle":"Create speech input token","openapi":"/openapi/external-api.json post /v3/models/audio/tts/stream-input/tokens","href":"/reference/create-speech-input-token"},{"title":"Get an Audio Voice","deprecated":null,"version":null,"sidebarTitle":"Get an audio voice","openapi":"/openapi/external-api.json get /v3/models/audio/voices/{voice_id}","href":"/reference/get-an-audio-voice"},{"title":"Delete an Audio Voice","deprecated":null,"version":null,"sidebarTitle":"Delete an audio voice","openapi":"/openapi/external-api.json delete /v3/models/audio/voices/{voice_id}","href":"/reference/delete-an-audio-voice"}]},{"group":"Audio","pages":[{"title":"Search audio (music or sound effects)","deprecated":null,"version":null,"sidebarTitle":"Search audio music or sound effects","openapi":"/openapi/external-api.json get /v3/audio/sounds","href":"/reference/search-audio-music-or-sound-effects"}]},{"group":"Image","pages":[{"title":"Create HeyGen Image","deprecated":null,"version":null,"sidebarTitle":"Create heygen image","openapi":"/openapi/external-api.json post /v3/models/images","href":"/reference/create-heygen-image"},{"title":"Get HeyGen Image","deprecated":null,"version":null,"sidebarTitle":"Get heygen image","openapi":"/openapi/external-api.json get /v3/models/images/{generation_id}","href":"/reference/get-heygen-image"}]},{"group":"Video editing","pages":[{"title":"List Video Translations","deprecated":null,"version":null,"sidebarTitle":"List video translations","openapi":"/openapi/external-api.json get /v3/video-translations","href":"/reference/list-video-translations"},{"title":"Create Video Translation","deprecated":null,"version":null,"sidebarTitle":"Create video translation","openapi":"/openapi/external-api.json post /v3/video-translations","href":"/reference/create-video-translation"},{"title":"Get Video Translation","deprecated":null,"version":null,"sidebarTitle":"Get video translation","openapi":"/openapi/external-api.json get /v3/video-translations/{video_translation_id}","href":"/reference/get-video-translation"},{"title":"Delete Video Translation","deprecated":null,"version":null,"sidebarTitle":"Delete video translation","openapi":"/openapi/external-api.json delete /v3/video-translations/{video_translation_id}","href":"/reference/delete-video-translation"},{"title":"Update Video Translation","deprecated":null,"version":null,"sidebarTitle":"Update video translation","openapi":"/openapi/external-api.json patch /v3/video-translations/{video_translation_id}","href":"/reference/update-video-translation"},{"title":"List Supported Translation Languages","deprecated":null,"version":null,"sidebarTitle":"List supported translation languages","openapi":"/openapi/external-api.json get /v3/video-translations/languages","href":"/reference/list-supported-translation-languages"},{"title":"List Proofread Sessions","deprecated":null,"version":null,"sidebarTitle":"List proofread sessions","openapi":"/openapi/external-api.json get /v3/video-translations/proofreads","href":"/reference/list-proofread-sessions"},{"title":"Create Proofread Session","deprecated":null,"version":null,"sidebarTitle":"Create proofread session","openapi":"/openapi/external-api.json post /v3/video-translations/proofreads","href":"/reference/create-proofread-session"},{"title":"Get Proofread Session","deprecated":null,"version":null,"sidebarTitle":"Get proofread session","openapi":"/openapi/external-api.json get /v3/video-translations/proofreads/{proofread_id}","href":"/reference/get-proofread-session"},{"title":"Delete Proofread Session","deprecated":null,"version":null,"sidebarTitle":"Delete proofread session","openapi":"/openapi/external-api.json delete /v3/video-translations/proofreads/{proofread_id}","href":"/reference/delete-proofread-session"},{"title":"Download Proofread SRT","deprecated":null,"version":null,"sidebarTitle":"Download proofread srt","openapi":"/openapi/external-api.json get /v3/video-translations/proofreads/{proofread_id}/srt","href":"/reference/download-proofread-srt"},{"title":"Upload Proofread SRT","deprecated":null,"version":null,"sidebarTitle":"Upload proofread srt","openapi":"/openapi/external-api.json put /v3/video-translations/proofreads/{proofread_id}/srt","href":"/reference/upload-proofread-srt"},{"title":"Generate Video from Proofread","deprecated":null,"version":null,"sidebarTitle":"Generate video from proofread","openapi":"/openapi/external-api.json post /v3/video-translations/proofreads/{proofread_id}/generate","href":"/reference/generate-video-from-proofread"},{"title":"List Lipsyncs","deprecated":null,"version":null,"sidebarTitle":"List lipsyncs","openapi":"/openapi/external-api.json get /v3/lipsyncs","href":"/reference/list-lipsyncs"},{"title":"Create Lipsync","deprecated":null,"version":null,"sidebarTitle":"Create lipsync","openapi":"/openapi/external-api.json post /v3/lipsyncs","href":"/reference/create-lipsync"},{"title":"Get Lipsync","deprecated":null,"version":null,"sidebarTitle":"Get lipsync","openapi":"/openapi/external-api.json get /v3/lipsyncs/{lipsync_id}","href":"/reference/get-lipsync"},{"title":"Delete Lipsync","deprecated":null,"version":null,"sidebarTitle":"Delete lipsync","openapi":"/openapi/external-api.json delete /v3/lipsyncs/{lipsync_id}","href":"/reference/delete-lipsync"},{"title":"Update Lipsync","deprecated":null,"version":null,"sidebarTitle":"Update lipsync","openapi":"/openapi/external-api.json patch /v3/lipsyncs/{lipsync_id}","href":"/reference/update-lipsync"},{"title":"Get AI Clipping","deprecated":null,"version":null,"sidebarTitle":"Get ai clipping","openapi":"/openapi/external-api.json get /v3/ai-clipping/{job_id}","href":"/reference/get-ai-clipping"},{"title":"Delete AI Clipping","deprecated":null,"version":null,"sidebarTitle":"Delete ai clipping","openapi":"/openapi/external-api.json delete /v3/ai-clipping/{job_id}","href":"/reference/delete-ai-clipping"},{"title":"List AI Clipping","deprecated":null,"version":null,"sidebarTitle":"List ai clipping","openapi":"/openapi/external-api.json get /v3/ai-clipping","href":"/reference/list-ai-clipping"},{"title":"Create AI Clipping","deprecated":null,"version":null,"sidebarTitle":"Create ai clipping","openapi":"/openapi/external-api.json post /v3/ai-clipping","href":"/reference/create-ai-clipping"},{"title":"Create Filler Word Removal","deprecated":null,"version":null,"sidebarTitle":"Create filler word removal","openapi":"/openapi/external-api.json post /v3/filler-word-removals","href":"/reference/create-filler-word-removal"},{"title":"Get Filler Word Removal","deprecated":null,"version":null,"sidebarTitle":"Get filler word removal","openapi":"/openapi/external-api.json get /v3/filler-word-removals/{filler_word_removal_id}","href":"/reference/get-filler-word-removal"}]},{"group":"Video Agent","pages":[{"title":"List Video Agent Sessions","deprecated":null,"version":null,"sidebarTitle":"List video agent sessions","openapi":"/openapi/external-api.json get /v3/video-agents","href":"/reference/list-video-agent-sessions"},{"title":"Create Video Agent Session","deprecated":null,"version":null,"sidebarTitle":"Create video agent session","openapi":"/openapi/external-api.json post /v3/video-agents","href":"/reference/create-video-agent-session"},{"title":"List Video Agent Styles","deprecated":null,"version":null,"sidebarTitle":"List video agent styles","openapi":"/openapi/external-api.json get /v3/video-agents/styles","href":"/reference/list-video-agent-styles"},{"title":"Get Video Agent Session","deprecated":null,"version":null,"sidebarTitle":"Get video agent session","openapi":"/openapi/external-api.json get /v3/video-agents/{session_id}","href":"/reference/get-video-agent-session"},{"title":"Send Video Agent Message","deprecated":null,"version":null,"sidebarTitle":"Send message or request revision","openapi":"/openapi/external-api.json post /v3/video-agents/{session_id}","href":"/reference/send-message-or-request-revision"},{"title":"Get Session Resource","deprecated":null,"version":null,"sidebarTitle":"Get session resource","openapi":"/openapi/external-api.json get /v3/video-agents/{session_id}/resources/{resource_id}","href":"/reference/get-session-resource"},{"title":"List Session Videos","deprecated":null,"version":null,"sidebarTitle":"List session videos","openapi":"/openapi/external-api.json get /v3/video-agents/{session_id}/videos","href":"/reference/list-session-videos"},{"title":"Stop Video Agent Session","deprecated":null,"version":null,"sidebarTitle":"Stop video agent session","openapi":"/openapi/external-api.json post /v3/video-agents/{session_id}/stop","href":"/reference/stop-video-agent-session"}]},{"group":"Templates","pages":[{"title":"List Templates","deprecated":null,"version":null,"sidebarTitle":"List templates","openapi":"/openapi/external-api.json get /v3/templates","href":"/reference/list-templates"},{"title":"Create Template from Video","deprecated":null,"version":null,"sidebarTitle":"Create template from video","openapi":"/openapi/external-api.json post /v3/templates","href":"/reference/create-template-from-video"},{"title":"Get Template","deprecated":null,"version":null,"sidebarTitle":"Get template","openapi":"/openapi/external-api.json get /v3/templates/{template_id}","href":"/reference/get-template"},{"title":"Generate Video from Template","deprecated":null,"version":null,"sidebarTitle":"Generate video from template","openapi":"/openapi/external-api.json post /v3/templates/{template_id}","href":"/reference/generate-video-from-template"},{"title":"Delete Template","deprecated":null,"version":null,"sidebarTitle":"Delete template","openapi":"/openapi/external-api.json delete /v3/templates/{template_id}","href":"/reference/delete-template"},{"title":"Update Template","deprecated":null,"version":null,"sidebarTitle":"Update template","openapi":"/openapi/external-api.json patch /v3/templates/{template_id}","href":"/reference/update-template"},{"title":"Set Template Variables","deprecated":null,"version":null,"sidebarTitle":"Set template variables","openapi":"/openapi/external-api.json put /v3/templates/{template_id}/variables","href":"/reference/set-template-variables"}]},{"group":"HyperFrames","pages":[{"title":"List HyperFrames Renders","deprecated":null,"version":null,"sidebarTitle":"List hyperframes renders","openapi":"/openapi/external-api.json get /v3/hyperframes/renders","href":"/reference/list-hyperframes-renders"},{"title":"Create HyperFrames Render","deprecated":null,"version":null,"sidebarTitle":"Create hyperframes render","openapi":"/openapi/external-api.json post /v3/hyperframes/renders","href":"/reference/create-hyperframes-render"},{"title":"Get HyperFrames Render","deprecated":null,"version":null,"sidebarTitle":"Get hyperframes render","openapi":"/openapi/external-api.json get /v3/hyperframes/renders/{render_id}","href":"/reference/get-hyperframes-render"},{"title":"Delete HyperFrames Render","deprecated":null,"version":null,"sidebarTitle":"Delete hyperframes render","openapi":"/openapi/external-api.json delete /v3/hyperframes/renders/{render_id}","href":"/reference/delete-hyperframes-render"}]},{"group":"Brand","pages":[{"title":"List Brand Glossaries","deprecated":null,"version":null,"sidebarTitle":"List brand glossaries","openapi":"/openapi/external-api.json get /v3/brand-glossaries","href":"/reference/list-brand-glossaries"},{"title":"Create Brand Glossary","deprecated":null,"version":null,"sidebarTitle":"Create brand glossary","openapi":"/openapi/external-api.json post /v3/brand-glossaries","href":"/reference/create-brand-glossary"},{"title":"List Brand Kits","deprecated":null,"version":null,"sidebarTitle":"List brand kits","openapi":"/openapi/external-api.json get /v3/brand-kits","href":"/reference/list-brand-kits"},{"title":"Create Brand Kit","deprecated":null,"version":null,"sidebarTitle":"Create brand kit","openapi":"/openapi/external-api.json post /v3/brand-kits","href":"/reference/create-brand-kit"},{"title":"Get Brand Kit","deprecated":null,"version":null,"sidebarTitle":"Get brand kit","openapi":"/openapi/external-api.json get /v3/brand-kits/{brand_kit_id}","href":"/reference/get-brand-kit"},{"title":"Delete Brand Kit","deprecated":null,"version":null,"sidebarTitle":"Delete brand kit","openapi":"/openapi/external-api.json delete /v3/brand-kits/{brand_kit_id}","href":"/reference/delete-brand-kit"},{"title":"Update Brand Kit","deprecated":null,"version":null,"sidebarTitle":"Update brand kit","openapi":"/openapi/external-api.json patch /v3/brand-kits/{brand_kit_id}","href":"/reference/update-brand-kit"},{"title":"Get Brand Glossary","deprecated":null,"version":null,"sidebarTitle":"Get brand glossary","openapi":"/openapi/external-api.json get /v3/brand-glossaries/{brand_glossary_id}","href":"/reference/get-brand-glossary"},{"title":"Delete Brand Glossary","deprecated":null,"version":null,"sidebarTitle":"Delete brand glossary","openapi":"/openapi/external-api.json delete /v3/brand-glossaries/{brand_glossary_id}","href":"/reference/delete-brand-glossary"},{"title":"Update Brand Glossary","deprecated":null,"version":null,"sidebarTitle":"Update brand glossary","openapi":"/openapi/external-api.json patch /v3/brand-glossaries/{brand_glossary_id}","href":"/reference/update-brand-glossary"}]},{"group":"Assets and folders","pages":[{"title":"Create Folder","deprecated":null,"version":null,"sidebarTitle":"Create folder","openapi":"/openapi/external-api.json post /v3/folders","href":"/reference/create-folder"},{"title":"Get Folder","deprecated":null,"version":null,"sidebarTitle":"Get folder","openapi":"/openapi/external-api.json get /v3/folders/{folder_id}","href":"/reference/get-folder"},{"title":"Upload Asset","deprecated":null,"version":null,"sidebarTitle":"Upload asset","openapi":"/openapi/external-api.json post /v3/assets","href":"/reference/upload-asset"},{"title":"Get Asset","deprecated":null,"version":null,"sidebarTitle":"Get asset","openapi":"/openapi/external-api.json get /v3/assets/{asset_id}","href":"/reference/get-asset"},{"title":"Delete Asset","deprecated":null,"version":null,"sidebarTitle":"Delete asset","openapi":"/openapi/external-api.json delete /v3/assets/{asset_id}","href":"/reference/delete-asset"},{"title":"Create Asset Upload","deprecated":null,"version":null,"sidebarTitle":"Create asset upload","openapi":"/openapi/external-api.json post /v3/assets/direct-uploads","href":"/reference/create-asset-upload"},{"title":"Complete Asset Upload","deprecated":null,"version":null,"sidebarTitle":"Complete asset upload","openapi":"/openapi/external-api.json post /v3/assets/{asset_id}/complete","href":"/reference/complete-asset-upload"},{"title":"List Uploaded Asset Parts","deprecated":null,"version":null,"sidebarTitle":"List uploaded asset parts","openapi":"/openapi/external-api.json get /v3/assets/{asset_id}/parts","href":"/reference/list-uploaded-asset-parts"},{"title":"Get Asset Upload Part URLs","deprecated":null,"version":null,"sidebarTitle":"Get asset upload part urls","openapi":"/openapi/external-api.json post /v3/assets/{asset_id}/parts","href":"/reference/get-asset-upload-part-urls"},{"title":"Abort Asset Upload Parts","description":"Give up an upload created with `multipart`: the parts stored so far are dropped. Pass the multipart_upload_id from the create response as a query parameter.","deprecated":null,"version":null,"sidebarTitle":"Abort asset upload parts","openapi":"/openapi/external-api.json delete /v3/assets/{asset_id}/parts","href":"/reference/abort-asset-upload-parts"}]},{"group":"Batches","pages":[{"title":"Create Video Batch","deprecated":null,"version":null,"sidebarTitle":"Create video batch","openapi":"/openapi/external-api.json post /v3/videos/batches","href":"/reference/create-video-batch"},{"title":"Get Video Batch","description":"Returns batch aggregate status and one page of items with their video ids and statuses. Item statuses are one of queued, processing, completed, or failed.","deprecated":null,"version":null,"sidebarTitle":"Get video batch","openapi":"/openapi/external-api.json get /v3/videos/batches/{batch_id}","href":"/reference/get-video-batch"},{"title":"Bulk Video Statuses","deprecated":null,"version":null,"sidebarTitle":"Bulk video statuses","openapi":"/openapi/external-api.json get /v3/videos/statuses","href":"/reference/bulk-video-statuses"},{"title":"Create Video Translation Batch","deprecated":null,"version":null,"sidebarTitle":"Create video translation batch","openapi":"/openapi/external-api.json post /v3/video-translations/batches","href":"/reference/create-video-translation-batch"},{"title":"Get Video Translation Batch","deprecated":null,"version":null,"sidebarTitle":"Get video translation batch","openapi":"/openapi/external-api.json get /v3/video-translations/batches/{batch_id}","href":"/reference/get-video-translation-batch"},{"title":"Bulk Video Translation Statuses","deprecated":null,"version":null,"sidebarTitle":"Bulk video translation statuses","openapi":"/openapi/external-api.json get /v3/video-translations/statuses","href":"/reference/bulk-video-translation-statuses"},{"title":"Create Lipsync Batch","deprecated":null,"version":null,"sidebarTitle":"Create lipsync batch","openapi":"/openapi/external-api.json post /v3/lipsyncs/batches","href":"/reference/create-lipsync-batch"},{"title":"Get Lipsync Batch","deprecated":null,"version":null,"sidebarTitle":"Get lipsync batch","openapi":"/openapi/external-api.json get /v3/lipsyncs/batches/{batch_id}","href":"/reference/get-lipsync-batch"},{"title":"Bulk Lipsync Statuses","deprecated":null,"version":null,"sidebarTitle":"Bulk lipsync statuses","openapi":"/openapi/external-api.json get /v3/lipsyncs/statuses","href":"/reference/bulk-lipsync-statuses"},{"title":"Create Asset Upload Batch","deprecated":null,"version":null,"sidebarTitle":"Create asset upload batch","openapi":"/openapi/external-api.json post /v3/assets/direct-uploads/batches","href":"/reference/create-asset-upload-batch"},{"title":"Complete Asset Upload Batch","deprecated":null,"version":null,"sidebarTitle":"Complete asset upload batch","openapi":"/openapi/external-api.json post /v3/assets/complete/batches","href":"/reference/complete-asset-upload-batch"},{"title":"Get Asset Batch","deprecated":null,"version":null,"sidebarTitle":"Get asset batch","openapi":"/openapi/external-api.json get /v3/assets/batches/{batch_id}","href":"/reference/get-asset-batch"},{"title":"Bulk Asset Statuses","deprecated":null,"version":null,"sidebarTitle":"Bulk asset statuses","openapi":"/openapi/external-api.json get /v3/assets/statuses","href":"/reference/bulk-asset-statuses"}]},{"group":"Webhooks","pages":[{"title":"List Webhook Event Types","deprecated":null,"version":null,"sidebarTitle":"List webhook event types","openapi":"/openapi/external-api.json get /v3/webhooks/event-types","href":"/reference/list-webhook-event-types"},{"title":"List Webhook Endpoints","deprecated":null,"version":null,"sidebarTitle":"List webhook endpoints","openapi":"/openapi/external-api.json get /v3/webhooks/endpoints","href":"/reference/list-webhook-endpoints"},{"title":"Create Webhook Endpoint","deprecated":null,"version":null,"sidebarTitle":"Create webhook endpoint","openapi":"/openapi/external-api.json post /v3/webhooks/endpoints","href":"/reference/create-webhook-endpoint"},{"title":"Delete Webhook Endpoint","deprecated":null,"version":null,"sidebarTitle":"Delete webhook endpoint","openapi":"/openapi/external-api.json delete /v3/webhooks/endpoints/{endpoint_id}","href":"/reference/delete-webhook-endpoint"},{"title":"Update Webhook Endpoint","deprecated":null,"version":null,"sidebarTitle":"Update webhook endpoint","openapi":"/openapi/external-api.json patch /v3/webhooks/endpoints/{endpoint_id}","href":"/reference/update-webhook-endpoint"},{"title":"Rotate Webhook Signing Secret","deprecated":null,"version":null,"sidebarTitle":"Rotate webhook signing secret","openapi":"/openapi/external-api.json post /v3/webhooks/endpoints/{endpoint_id}/rotate-secret","href":"/reference/rotate-webhook-signing-secret"},{"title":"List Webhook Events","deprecated":null,"version":null,"sidebarTitle":"List webhook events","openapi":"/openapi/external-api.json get /v3/webhooks/events","href":"/reference/list-webhook-events"}]},{"group":"Feedback","pages":[{"title":"Send Feedback","deprecated":null,"version":null,"sidebarTitle":"Send feedback","openapi":"/openapi/external-api.json post /v3/feedback","href":"/reference/send-feedback"}]},{"group":"Account and usage","pages":[{"title":"Get Current User","deprecated":null,"version":null,"sidebarTitle":"Get current user","openapi":"/openapi/external-api.json get /v3/users/me","href":"/reference/get-current-user"},{"title":"Get Current API Key","deprecated":null,"version":null,"sidebarTitle":"Get current api key","openapi":"/openapi/external-api.json get /v3/api_keys/self","href":"/reference/get-current-api-key"}]}]},{"tab":"MCP","pages":[{"title":"MCP","href":"/mcp/overview"}]},{"tab":"Skills","pages":[{"title":"Skills","href":"/skills/overview"}]},{"tab":"CLI","pages":[{"title":"CLI","href":"/cli"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]},{"tab":"Get help","pages":[{"title":"Get help","href":"/docs/discord"}]}]},"basePath":"","title":"Create Video Batch - HeyGen Documentation","deploymentId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","buildId":"dpl_DyXGnKeCjZyA3sUdfMJ7FjkdBefg","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-CiUHMMOm.js","snippetPresets-BgfXU7Bw.js","utils-DWvOwgy_.js","style-to-object-BY3JEAdk.js","utils-BN7RXSMJ.js","v4-DIgz8zy6.js","addUniqueKeysToSchema-CFw8bq89.js","conditional-requirements-CFM0id0Q.js","cloneDeep-CAwdfOU2.js","_Uint8Array-BJr8e-ZL.js","isObject-FP1Yky1u.js","Page-CVJ-f_k1.js","CodeSnippet-D_HwgQO_.js","DynamicMarkdown-CQM9Bhbv.js","SectionHeading-DpbrP8nQ.js","icon-BPCgijHy.js","ApiExamples-XX0UgMZK.js","usePlaygroundInputsStore-DXDFSa1V.js","shallow-CdX5aREi.js","isEqual-CoOaxexF.js","CodeSnippets-Cg2wpzWm.js","getApiPlaygroundDisplay-CmCoerhe.js","MethodPill-GQ8DuY0c.js","getPastedJson-Cb5mT31m.js","Check2Icon-a7bUI6e8.js","axios-CsQoIw0U.js","Markdown-CX2QY19L.js","AssistantPageLink-CY3bFglh.js","dist-Dl6_zDnT.js","lib-DMeTj1gb.js","lib-B8HbPgcC.js","katex-Dbtb6Wk7.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js"]}