For images and sprites, credit and quota admission failures appear later in execution state; retryable admission failures remain queued. Video instead accepts a ready quote using only quote_id and max_credits and returns 202 JSON, or synchronous errors such as 402 insufficient_credits and 429 too_many_active_jobs. Use a stable Idempotency-Key and save the acceptance body before submitting. Video does not return an initial SSE stream. See https://docs.dreamlayer.io/agent-api/text-to-video.
Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
DreamLayer-Version
string
required
Allowed value: "1"
Idempotency-Key
string
required
Required string length: 1 - 200
Body
application/json
Option 1
Option 2
Option 3
Option 4
operation
enum<string>
required
Optional. Name the operation to execute it deterministically: DreamLayer skips interpreting the prompt, so the request cannot be reclassified and cannot return a question event. No word in the prompt changes a named operation, and a named operation ignores an image remembered from an earlier turn in the same conversation. Omit it to let DreamLayer decide from the prompt. text_to_image must not carry input_asset_id; image_to_image, background_remove, upscale and sprite_sheet require it. sprite_sheet requires exactly one of options.action or options.animation_prompt. Read the authenticated /v1/sprite-pricing estimate for the requested frame_count and background, then set an explicitly authorized max_credits ceiling. Current amounts can have four decimal places. Estimates are non-binding; admission refuses a price above the ceiling before debiting. Default capabilities pricing is historical compatibility data, not a current account estimate. Put custom animation instructions in options.animation_prompt, not prompt. Sprite requests have no customer cancellation. Other operations require max_credits of 1 and do not accept options.
upscale doubles each side, so the input's longest side must be 2048 or smaller: 4096 is the delivery ceiling and an oversize request is refused at execution admission before paid processing starts. That also means an upscaled image is AT maximum_input_dimension and cannot be upscaled again.
Available options:
text_to_image,
image_to_image,
background_remove,
upscale,
sprite_sheet
Allowed value: "sprite_sheet"
input_asset_id
string<uuid>
required
options
object
required
Supply exactly one non-null action or animation_prompt. Presets default to loop playback; custom instructions default to once. Frame size affects the square export canvas, not price or guaranteed source detail. Insufficient distinct frames fail explicitly; frames are not duplicated or interpolated to meet the count.
Option 1
Option 2
Show child attributes
Example:
{ "action": "walk", "frame_count": 12 }
prompt
string
Required string length: 1 - 4000
respond
string
Required string length: 1 - 4000
conversation_id
string<uuid>
aspect_ratio
string
default:1:1
max_credits
number
default:1
Required range: 0.1 <= x <= 100
Response
Sanitized server-sent events
The response is of type string.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"DreamLayer","description":"Image, sprite-sheet, and video guides for the DreamLayer Agent API","colors":{"primary":"#2563EB","light":"#4F7DE8","dark":"#3B82F6"},"logo":{"light":"https://mintcdn.com/dreamlayer/nTq76C0wt2gtdpTX/dreamlayer-wordmark.svg?fit=max\u0026auto=format\u0026n=nTq76C0wt2gtdpTX\u0026q=85\u0026s=2bada060ddfa8271c6f5af3a9992f609","dark":"https://mintcdn.com/dreamlayer/nTq76C0wt2gtdpTX/dreamlayer-wordmark.svg?fit=max\u0026auto=format\u0026n=nTq76C0wt2gtdpTX\u0026q=85\u0026s=2bada060ddfa8271c6f5af3a9992f609"},"favicon":"https://mintcdn.com/dreamlayer/nTq76C0wt2gtdpTX/dreamlayer-mark.svg?fit=max\u0026auto=format\u0026n=nTq76C0wt2gtdpTX\u0026q=85\u0026s=a30cbb85006f27cc02240d26c1dc07c1","navbar":{"links":[{"href":"https://dreamlayer.io/pricing","label":"Pricing"},{"href":"https://platform.dreamlayer.io","label":"Developer console"}],"primary":{"type":"button","label":"Get started","href":"/quickstart"}},"footer":{"socials":{}},"seo":{"metatags":{"canonical":"https://docs.dreamlayer.io"}},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"dreamlayer","hasAudioNarration":false,"actualSubdomain":"dreamlayer","customDomains":["docs.dreamlayer.io"],"gitSource":{"type":"github","owner":"thedesignfounder","repo":"abloh","deployBranch":"main","contentDirectory":"docs-site","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"DISABLED"}},"buildId":"6ad4457c8c6f8bf3b1024425","clientVersion":"0.0.4205","searchFilterCounts":[{"language":"default","tag":"DreamLayer Agent API","count":14},{"language":"default","tag":"Endpoint reference","count":14},{"language":"default","tag":"API Reference","count":14},{"language":"default","tag":"Command line and agents","count":6},{"language":"default","tag":"Video","count":5},{"language":"default","tag":"Start","count":4},{"language":"default","tag":"Project","count":2}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableContextualStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"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":[],"page":{"pagePath":"api-reference/post-v1execute","slug":"/api-reference/post-v1execute","pageMetadata":{"title":"Start or replay an execution","description":"For images and sprites, credit and quota admission failures appear later in execution state; retryable admission failures remain queued. Video instead accepts a ready quote using only quote_id and max_credits and returns 202 JSON, or synchronous errors such as 402 insufficient_credits and 429 too_many_active_jobs. Use a stable Idempotency-Key and save the acceptance body before submitting. Video does not return an initial SSE stream. See https://docs.dreamlayer.io/agent-api/text-to-video.","deprecated":null,"version":null,"sidebarTitle":"Post v1execute","openapi":"/openapi/managed.yaml post /v1/execute","href":"/api-reference/post-v1execute","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 a: \"a\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"For images and sprites, credit and quota admission failures appear later in execution state; retryable admission failures remain queued. Video instead accepts a ready quote using only quote_id and max_credits and returns 202 JSON, or synchronous errors such as 402 insufficient_credits and 429 too_many_active_jobs. Use a stable Idempotency-Key and save the acceptance body before submitting. Video does not return an initial SSE stream. See \", _jsx(_components.a, {\n href: \"https://docs.dreamlayer.io/agent-api/text-to-video\",\n children: \"https://docs.dreamlayer.io/agent-api/text-to-video\"\n }), \".\"]\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":"Start or replay an execution","description":"For images and sprites, credit and quota admission failures appear later in execution state; retryable admission failures remain queued. Video instead accepts a ready quote using only quote_id and max_credits and returns 202 JSON, or synchronous errors such as 402 insufficient_credits and 429 too_many_active_jobs. Use a stable Idempotency-Key and save the acceptance body before submitting. Video does not return an initial SSE stream. See https://docs.dreamlayer.io/agent-api/text-to-video.","deprecated":null,"version":null,"sidebarTitle":"Post v1execute","openapi":"/openapi/managed.yaml post /v1/execute","href":"/api-reference/post-v1execute","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"execute","x-mint":{"href":"/api-reference/post-v1execute"},"summary":"Start or replay an execution","description":"For images and sprites, credit and quota admission failures appear later in execution state; retryable admission failures remain queued. Video instead accepts a ready quote using only quote_id and max_credits and returns 202 JSON, or synchronous errors such as 402 insufficient_credits and 429 too_many_active_jobs. Use a stable Idempotency-Key and save the acceptance body before submitting. Video does not return an initial SSE stream. See https://docs.dreamlayer.io/agent-api/text-to-video.","parameters":["eeb146a8-1560-46ed-bf95-239d3bcefe45","83387a2e-4c0a-4af2-ac34-7b76bb8eac82"],"requestBody":"cd645e0c-5047-4bb3-84f9-55e5a44982d9","responses":{"200":"87d7f75c-cf23-4842-8ba5-ef6503ac977b","202":"3379ad63-7672-4860-807d-bdcb2e07147b","400":"e8baece6-e142-486a-a381-52a9e026b8fa","401":"a7ebde93-5a07-49e8-ba47-4f284842a07c","402":"03ac3473-d36d-498f-bfb4-02f3e8706c26","403":"b882ba58-cd57-4133-bd29-85aa42cd059f","409":"81608689-eb04-48ad-a25b-fc7db387c347","422":"458495fb-b854-4514-b670-7702fdacbd45","429":"4b6a843b-ebce-4514-8a4f-4cd808f9333e","500":"1ab6fd3c-a08a-4fcd-a22f-d4d7405beab2","503":"c510d246-8c66-467d-9e01-cb247ab40b26"},"method":"post","type":"path","servers":["ce4d3de8-ed35-48c3-94fa-eba6f0a8e8b8"],"security":["3ea0abe2-b535-498d-8518-3829164d3f44"],"path":"/v1/execute","baseUrlOptions":["https://api.dreamlayer.io"],"title":"Start or replay an execution","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"eeb146a8-1560-46ed-bf95-239d3bcefe45":{"name":"DreamLayer-Version","in":"header","required":true,"schema":{"type":"string","const":"1","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"83387a2e-4c0a-4af2-ac34-7b76bb8eac82":{"name":"Idempotency-Key","in":"header","required":true,"schema":{"type":"string","minLength":1,"maxLength":200,"isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"required":true,"content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["operation","input_asset_id","options"],"properties":{"operation":{"type":"string","description":"Optional. Name the operation to execute it deterministically: DreamLayer skips interpreting the prompt, so the request cannot be reclassified and cannot return a question event. No word in the prompt changes a named operation, and a named operation ignores an image remembered from an earlier turn in the same conversation. Omit it to let DreamLayer decide from the prompt. text_to_image must not carry input_asset_id; image_to_image, background_remove, upscale and sprite_sheet require it. sprite_sheet requires exactly one of options.action or options.animation_prompt. Read the authenticated /v1/sprite-pricing estimate for the requested frame_count and background, then set an explicitly authorized max_credits ceiling. Current amounts can have four decimal places. Estimates are non-binding; admission refuses a price above the ceiling before debiting. Default capabilities pricing is historical compatibility data, not a current account estimate. Put custom animation instructions in options.animation_prompt, not prompt. Sprite requests have no customer cancellation. Other operations require max_credits of 1 and do not accept options.\n\nupscale doubles each side, so the input's longest side must be 2048 or smaller: 4096 is the delivery ceiling and an oversize request is refused at execution admission before paid processing starts. That also means an upscaled image is AT maximum_input_dimension and cannot be upscaled again.","enum":["text_to_image","image_to_image","background_remove","upscale","sprite_sheet"],"const":"sprite_sheet","isRequired":true,"uniqueKey":"oneOf.0.operation","typeLabel":"enum\u003cstring>"},"input_asset_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.0.input_asset_id","typeLabel":"string\u003cuuid>"},"options":{"oneOf":[{"type":"object","description":"Supply exactly one non-null action or animation_prompt. Presets default to loop playback; custom instructions default to once. Frame size affects the square export canvas, not price or guaranteed source detail. Insufficient distinct frames fail explicitly; frames are not duplicated or interpolated to meet the count.","required":["action"],"example":{"action":"walk","frame_count":12},"properties":{"action":{"type":"string","description":"Preset alternative to animation_prompt. Walk and run use a right-facing side view; idle keeps the reference viewpoint.","enum":["walk","run","idle"],"isRequired":true,"uniqueKey":"oneOf.0.options.oneOf.0.action","typeLabel":"enum\u003cstring>"},"animation_prompt":{"type":"null","description":"Describe the subject's animation, viewpoint, movement and style. Characters, creatures, objects, effects and turntables can be requested; quality is not guaranteed.","maxLength":4000,"minLength":1,"pattern":"\\S","uniqueKey":"oneOf.0.options.oneOf.0.animation_prompt","typeLabel":"null"},"animation_mode":{"oneOf":[{"type":"string","enum":["loop","once",null],"description":"Defaults to loop for presets and once for custom instructions. Once preserves the beginning and ending; a loop is not guaranteed seamless. Use atlas frame_durations_ms for playback timing.","uniqueKey":"oneOf.0.options.oneOf.0.animation_mode.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["loop","once",null],"description":"Defaults to loop for presets and once for custom instructions. Once preserves the beginning and ending; a loop is not guaranteed seamless. Use atlas frame_durations_ms for playback timing.","uniqueKey":"oneOf.0.options.oneOf.0.animation_mode.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.options.oneOf.0.animation_mode","typeLabel":"enum\u003cstring> | null"},"frame_count":{"type":"integer","minimum":7,"maximum":100,"default":12,"uniqueKey":"oneOf.0.options.oneOf.0.frame_count","typeLabel":"integer"},"frame_size":{"type":"integer","enum":[32,64,128,256,512,720,1080],"default":512,"description":"Square PNG frame and sheet-cell size in pixels, with shared alignment and transparent padding. Does not change pricing.","uniqueKey":"oneOf.0.options.oneOf.0.frame_size","typeLabel":"enum\u003cinteger>"},"background":{"oneOf":[{"type":"string","enum":["remove","keep",null],"description":"Omit or send remove for transparent frames. Send keep to skip background removal and take the frames as generated, priced at $0.32 plus $0.01 per frame converted to credits at the account's undiscounted purchase rate.","uniqueKey":"oneOf.0.options.oneOf.0.background.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["remove","keep",null],"description":"Omit or send remove for transparent frames. Send keep to skip background removal and take the frames as generated, priced at $0.32 plus $0.01 per frame converted to credits at the account's undiscounted purchase rate.","uniqueKey":"oneOf.0.options.oneOf.0.background.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.options.oneOf.0.background","typeLabel":"enum\u003cstring> | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.0.options.oneOf.0","typeLabel":"object"},{"type":"object","description":"Supply exactly one non-null action or animation_prompt. Presets default to loop playback; custom instructions default to once. Frame size affects the square export canvas, not price or guaranteed source detail. Insufficient distinct frames fail explicitly; frames are not duplicated or interpolated to meet the count.","required":["animation_prompt"],"example":{"action":"walk","frame_count":12},"properties":{"animation_prompt":{"type":"string","description":"Describe the subject's animation, viewpoint, movement and style. Characters, creatures, objects, effects and turntables can be requested; quality is not guaranteed.","maxLength":4000,"minLength":1,"pattern":"\\S","isRequired":true,"uniqueKey":"oneOf.0.options.oneOf.1.animation_prompt","typeLabel":"string"},"action":{"type":"null","description":"Preset alternative to animation_prompt. Walk and run use a right-facing side view; idle keeps the reference viewpoint.","enum":["walk","run","idle",null],"uniqueKey":"oneOf.0.options.oneOf.1.action","typeLabel":"null"},"animation_mode":{"oneOf":[{"type":"string","enum":["loop","once",null],"description":"Defaults to loop for presets and once for custom instructions. Once preserves the beginning and ending; a loop is not guaranteed seamless. Use atlas frame_durations_ms for playback timing.","uniqueKey":"oneOf.0.options.oneOf.1.animation_mode.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["loop","once",null],"description":"Defaults to loop for presets and once for custom instructions. Once preserves the beginning and ending; a loop is not guaranteed seamless. Use atlas frame_durations_ms for playback timing.","uniqueKey":"oneOf.0.options.oneOf.1.animation_mode.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.options.oneOf.1.animation_mode","typeLabel":"enum\u003cstring> | null"},"frame_count":{"type":"integer","minimum":7,"maximum":100,"default":12,"uniqueKey":"oneOf.0.options.oneOf.1.frame_count","typeLabel":"integer"},"frame_size":{"type":"integer","enum":[32,64,128,256,512,720,1080],"default":512,"description":"Square PNG frame and sheet-cell size in pixels, with shared alignment and transparent padding. Does not change pricing.","uniqueKey":"oneOf.0.options.oneOf.1.frame_size","typeLabel":"enum\u003cinteger>"},"background":{"oneOf":[{"type":"string","enum":["remove","keep",null],"description":"Omit or send remove for transparent frames. Send keep to skip background removal and take the frames as generated, priced at $0.32 plus $0.01 per frame converted to credits at the account's undiscounted purchase rate.","uniqueKey":"oneOf.0.options.oneOf.1.background.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["remove","keep",null],"description":"Omit or send remove for transparent frames. Send keep to skip background removal and take the frames as generated, priced at $0.32 plus $0.01 per frame converted to credits at the account's undiscounted purchase rate.","uniqueKey":"oneOf.0.options.oneOf.1.background.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.options.oneOf.1.background","typeLabel":"enum\u003cstring> | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.0.options.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"oneOf.0.options","typeLabel":"object"},"prompt":{"type":"string","minLength":1,"maxLength":4000,"uniqueKey":"oneOf.0.prompt","typeLabel":"string"},"respond":{"type":"string","minLength":1,"maxLength":4000,"uniqueKey":"oneOf.0.respond","typeLabel":"string"},"conversation_id":{"type":"string","format":"uuid","uniqueKey":"oneOf.0.conversation_id","typeLabel":"string\u003cuuid>"},"aspect_ratio":{"type":"string","default":"1:1","uniqueKey":"oneOf.0.aspect_ratio","typeLabel":"string"},"max_credits":{"type":"number","minimum":0.1,"maximum":100,"default":1,"uniqueKey":"oneOf.0.max_credits","typeLabel":"number"}},"additionalProperties":false,"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["prompt"],"properties":{"prompt":{"type":"string","minLength":1,"maxLength":4000,"isRequired":true,"uniqueKey":"oneOf.1.prompt","typeLabel":"string"},"respond":{"type":"string","minLength":1,"maxLength":4000,"uniqueKey":"oneOf.1.respond","typeLabel":"string"},"conversation_id":{"type":"string","format":"uuid","uniqueKey":"oneOf.1.conversation_id","typeLabel":"string\u003cuuid>"},"input_asset_id":{"type":"string","format":"uuid","uniqueKey":"oneOf.1.input_asset_id","typeLabel":"string\u003cuuid>"},"aspect_ratio":{"type":"string","default":"1:1","uniqueKey":"oneOf.1.aspect_ratio","typeLabel":"string"},"max_credits":{"type":"number","minimum":0.1,"maximum":100,"default":1,"uniqueKey":"oneOf.1.max_credits","typeLabel":"number"},"options":{"oneOf":[{"type":"object","description":"Supply exactly one non-null action or animation_prompt. Presets default to loop playback; custom instructions default to once. Frame size affects the square export canvas, not price or guaranteed source detail. Insufficient distinct frames fail explicitly; frames are not duplicated or interpolated to meet the count.","required":["action"],"example":{"action":"walk","frame_count":12},"properties":{"action":{"type":"string","description":"Preset alternative to animation_prompt. Walk and run use a right-facing side view; idle keeps the reference viewpoint.","enum":["walk","run","idle"],"isRequired":true,"uniqueKey":"oneOf.1.options.oneOf.0.action","typeLabel":"enum\u003cstring>"},"animation_prompt":{"type":"null","description":"Describe the subject's animation, viewpoint, movement and style. Characters, creatures, objects, effects and turntables can be requested; quality is not guaranteed.","maxLength":4000,"minLength":1,"pattern":"\\S","uniqueKey":"oneOf.1.options.oneOf.0.animation_prompt","typeLabel":"null"},"animation_mode":{"oneOf":[{"type":"string","enum":["loop","once",null],"description":"Defaults to loop for presets and once for custom instructions. Once preserves the beginning and ending; a loop is not guaranteed seamless. Use atlas frame_durations_ms for playback timing.","uniqueKey":"oneOf.1.options.oneOf.0.animation_mode.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["loop","once",null],"description":"Defaults to loop for presets and once for custom instructions. Once preserves the beginning and ending; a loop is not guaranteed seamless. Use atlas frame_durations_ms for playback timing.","uniqueKey":"oneOf.1.options.oneOf.0.animation_mode.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.options.oneOf.0.animation_mode","typeLabel":"enum\u003cstring> | null"},"frame_count":{"type":"integer","minimum":7,"maximum":100,"default":12,"uniqueKey":"oneOf.1.options.oneOf.0.frame_count","typeLabel":"integer"},"frame_size":{"type":"integer","enum":[32,64,128,256,512,720,1080],"default":512,"description":"Square PNG frame and sheet-cell size in pixels, with shared alignment and transparent padding. Does not change pricing.","uniqueKey":"oneOf.1.options.oneOf.0.frame_size","typeLabel":"enum\u003cinteger>"},"background":{"oneOf":[{"type":"string","enum":["remove","keep",null],"description":"Omit or send remove for transparent frames. Send keep to skip background removal and take the frames as generated, priced at $0.32 plus $0.01 per frame converted to credits at the account's undiscounted purchase rate.","uniqueKey":"oneOf.1.options.oneOf.0.background.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["remove","keep",null],"description":"Omit or send remove for transparent frames. Send keep to skip background removal and take the frames as generated, priced at $0.32 plus $0.01 per frame converted to credits at the account's undiscounted purchase rate.","uniqueKey":"oneOf.1.options.oneOf.0.background.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.options.oneOf.0.background","typeLabel":"enum\u003cstring> | null"}},"additionalProperties":false,"uniqueKey":"oneOf.1.options.oneOf.0","typeLabel":"object"},{"type":"object","description":"Supply exactly one non-null action or animation_prompt. Presets default to loop playback; custom instructions default to once. Frame size affects the square export canvas, not price or guaranteed source detail. Insufficient distinct frames fail explicitly; frames are not duplicated or interpolated to meet the count.","required":["animation_prompt"],"example":{"action":"walk","frame_count":12},"properties":{"animation_prompt":{"type":"string","description":"Describe the subject's animation, viewpoint, movement and style. Characters, creatures, objects, effects and turntables can be requested; quality is not guaranteed.","maxLength":4000,"minLength":1,"pattern":"\\S","isRequired":true,"uniqueKey":"oneOf.1.options.oneOf.1.animation_prompt","typeLabel":"string"},"action":{"type":"null","description":"Preset alternative to animation_prompt. Walk and run use a right-facing side view; idle keeps the reference viewpoint.","enum":["walk","run","idle",null],"uniqueKey":"oneOf.1.options.oneOf.1.action","typeLabel":"null"},"animation_mode":{"oneOf":[{"type":"string","enum":["loop","once",null],"description":"Defaults to loop for presets and once for custom instructions. Once preserves the beginning and ending; a loop is not guaranteed seamless. Use atlas frame_durations_ms for playback timing.","uniqueKey":"oneOf.1.options.oneOf.1.animation_mode.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["loop","once",null],"description":"Defaults to loop for presets and once for custom instructions. Once preserves the beginning and ending; a loop is not guaranteed seamless. Use atlas frame_durations_ms for playback timing.","uniqueKey":"oneOf.1.options.oneOf.1.animation_mode.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.options.oneOf.1.animation_mode","typeLabel":"enum\u003cstring> | null"},"frame_count":{"type":"integer","minimum":7,"maximum":100,"default":12,"uniqueKey":"oneOf.1.options.oneOf.1.frame_count","typeLabel":"integer"},"frame_size":{"type":"integer","enum":[32,64,128,256,512,720,1080],"default":512,"description":"Square PNG frame and sheet-cell size in pixels, with shared alignment and transparent padding. Does not change pricing.","uniqueKey":"oneOf.1.options.oneOf.1.frame_size","typeLabel":"enum\u003cinteger>"},"background":{"oneOf":[{"type":"string","enum":["remove","keep",null],"description":"Omit or send remove for transparent frames. Send keep to skip background removal and take the frames as generated, priced at $0.32 plus $0.01 per frame converted to credits at the account's undiscounted purchase rate.","uniqueKey":"oneOf.1.options.oneOf.1.background.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["remove","keep",null],"description":"Omit or send remove for transparent frames. Send keep to skip background removal and take the frames as generated, priced at $0.32 plus $0.01 per frame converted to credits at the account's undiscounted purchase rate.","uniqueKey":"oneOf.1.options.oneOf.1.background.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.options.oneOf.1.background","typeLabel":"enum\u003cstring> | null"}},"additionalProperties":false,"uniqueKey":"oneOf.1.options.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.1.options","typeLabel":"object"},"operation":{"type":"string","enum":["text_to_image","image_to_image","background_remove","upscale","sprite_sheet"],"description":"Optional. Name the operation to execute it deterministically: DreamLayer skips interpreting the prompt, so the request cannot be reclassified and cannot return a question event. No word in the prompt changes a named operation, and a named operation ignores an image remembered from an earlier turn in the same conversation. Omit it to let DreamLayer decide from the prompt. text_to_image must not carry input_asset_id; image_to_image, background_remove, upscale and sprite_sheet require it. sprite_sheet requires exactly one of options.action or options.animation_prompt. Read the authenticated /v1/sprite-pricing estimate for the requested frame_count and background, then set an explicitly authorized max_credits ceiling. Current amounts can have four decimal places. Estimates are non-binding; admission refuses a price above the ceiling before debiting. Default capabilities pricing is historical compatibility data, not a current account estimate. Put custom animation instructions in options.animation_prompt, not prompt. Sprite requests have no customer cancellation. Other operations require max_credits of 1 and do not accept options.\n\nupscale doubles each side, so the input's longest side must be 2048 or smaller: 4096 is the delivery ceiling and an oversize request is refused at execution admission before paid processing starts. That also means an upscaled image is AT maximum_input_dimension and cannot be upscaled again.","uniqueKey":"oneOf.1.operation","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"oneOf.1","typeLabel":"object"},{"type":"object","required":["respond","conversation_id"],"properties":{"respond":{"type":"string","minLength":1,"maxLength":4000,"isRequired":true,"uniqueKey":"oneOf.2.respond","typeLabel":"string"},"conversation_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.2.conversation_id","typeLabel":"string\u003cuuid>"},"prompt":{"type":"string","minLength":1,"maxLength":4000,"uniqueKey":"oneOf.2.prompt","typeLabel":"string"},"input_asset_id":{"type":"string","format":"uuid","uniqueKey":"oneOf.2.input_asset_id","typeLabel":"string\u003cuuid>"},"aspect_ratio":{"type":"string","default":"1:1","uniqueKey":"oneOf.2.aspect_ratio","typeLabel":"string"},"max_credits":{"type":"number","minimum":0.1,"maximum":100,"default":1,"uniqueKey":"oneOf.2.max_credits","typeLabel":"number"},"options":{"oneOf":[{"type":"object","description":"Supply exactly one non-null action or animation_prompt. Presets default to loop playback; custom instructions default to once. Frame size affects the square export canvas, not price or guaranteed source detail. Insufficient distinct frames fail explicitly; frames are not duplicated or interpolated to meet the count.","required":["action"],"example":{"action":"walk","frame_count":12},"properties":{"action":{"type":"string","description":"Preset alternative to animation_prompt. Walk and run use a right-facing side view; idle keeps the reference viewpoint.","enum":["walk","run","idle"],"isRequired":true,"uniqueKey":"oneOf.2.options.oneOf.0.action","typeLabel":"enum\u003cstring>"},"animation_prompt":{"type":"null","description":"Describe the subject's animation, viewpoint, movement and style. Characters, creatures, objects, effects and turntables can be requested; quality is not guaranteed.","maxLength":4000,"minLength":1,"pattern":"\\S","uniqueKey":"oneOf.2.options.oneOf.0.animation_prompt","typeLabel":"null"},"animation_mode":{"oneOf":[{"type":"string","enum":["loop","once",null],"description":"Defaults to loop for presets and once for custom instructions. Once preserves the beginning and ending; a loop is not guaranteed seamless. Use atlas frame_durations_ms for playback timing.","uniqueKey":"oneOf.2.options.oneOf.0.animation_mode.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["loop","once",null],"description":"Defaults to loop for presets and once for custom instructions. Once preserves the beginning and ending; a loop is not guaranteed seamless. Use atlas frame_durations_ms for playback timing.","uniqueKey":"oneOf.2.options.oneOf.0.animation_mode.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.options.oneOf.0.animation_mode","typeLabel":"enum\u003cstring> | null"},"frame_count":{"type":"integer","minimum":7,"maximum":100,"default":12,"uniqueKey":"oneOf.2.options.oneOf.0.frame_count","typeLabel":"integer"},"frame_size":{"type":"integer","enum":[32,64,128,256,512,720,1080],"default":512,"description":"Square PNG frame and sheet-cell size in pixels, with shared alignment and transparent padding. Does not change pricing.","uniqueKey":"oneOf.2.options.oneOf.0.frame_size","typeLabel":"enum\u003cinteger>"},"background":{"oneOf":[{"type":"string","enum":["remove","keep",null],"description":"Omit or send remove for transparent frames. Send keep to skip background removal and take the frames as generated, priced at $0.32 plus $0.01 per frame converted to credits at the account's undiscounted purchase rate.","uniqueKey":"oneOf.2.options.oneOf.0.background.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["remove","keep",null],"description":"Omit or send remove for transparent frames. Send keep to skip background removal and take the frames as generated, priced at $0.32 plus $0.01 per frame converted to credits at the account's undiscounted purchase rate.","uniqueKey":"oneOf.2.options.oneOf.0.background.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.options.oneOf.0.background","typeLabel":"enum\u003cstring> | null"}},"additionalProperties":false,"uniqueKey":"oneOf.2.options.oneOf.0","typeLabel":"object"},{"type":"object","description":"Supply exactly one non-null action or animation_prompt. Presets default to loop playback; custom instructions default to once. Frame size affects the square export canvas, not price or guaranteed source detail. Insufficient distinct frames fail explicitly; frames are not duplicated or interpolated to meet the count.","required":["animation_prompt"],"example":{"action":"walk","frame_count":12},"properties":{"animation_prompt":{"type":"string","description":"Describe the subject's animation, viewpoint, movement and style. Characters, creatures, objects, effects and turntables can be requested; quality is not guaranteed.","maxLength":4000,"minLength":1,"pattern":"\\S","isRequired":true,"uniqueKey":"oneOf.2.options.oneOf.1.animation_prompt","typeLabel":"string"},"action":{"type":"null","description":"Preset alternative to animation_prompt. Walk and run use a right-facing side view; idle keeps the reference viewpoint.","enum":["walk","run","idle",null],"uniqueKey":"oneOf.2.options.oneOf.1.action","typeLabel":"null"},"animation_mode":{"oneOf":[{"type":"string","enum":["loop","once",null],"description":"Defaults to loop for presets and once for custom instructions. Once preserves the beginning and ending; a loop is not guaranteed seamless. Use atlas frame_durations_ms for playback timing.","uniqueKey":"oneOf.2.options.oneOf.1.animation_mode.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["loop","once",null],"description":"Defaults to loop for presets and once for custom instructions. Once preserves the beginning and ending; a loop is not guaranteed seamless. Use atlas frame_durations_ms for playback timing.","uniqueKey":"oneOf.2.options.oneOf.1.animation_mode.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.options.oneOf.1.animation_mode","typeLabel":"enum\u003cstring> | null"},"frame_count":{"type":"integer","minimum":7,"maximum":100,"default":12,"uniqueKey":"oneOf.2.options.oneOf.1.frame_count","typeLabel":"integer"},"frame_size":{"type":"integer","enum":[32,64,128,256,512,720,1080],"default":512,"description":"Square PNG frame and sheet-cell size in pixels, with shared alignment and transparent padding. Does not change pricing.","uniqueKey":"oneOf.2.options.oneOf.1.frame_size","typeLabel":"enum\u003cinteger>"},"background":{"oneOf":[{"type":"string","enum":["remove","keep",null],"description":"Omit or send remove for transparent frames. Send keep to skip background removal and take the frames as generated, priced at $0.32 plus $0.01 per frame converted to credits at the account's undiscounted purchase rate.","uniqueKey":"oneOf.2.options.oneOf.1.background.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"null","enum":["remove","keep",null],"description":"Omit or send remove for transparent frames. Send keep to skip background removal and take the frames as generated, priced at $0.32 plus $0.01 per frame converted to credits at the account's undiscounted purchase rate.","uniqueKey":"oneOf.2.options.oneOf.1.background.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.2.options.oneOf.1.background","typeLabel":"enum\u003cstring> | null"}},"additionalProperties":false,"uniqueKey":"oneOf.2.options.oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.2.options","typeLabel":"object"},"operation":{"type":"string","enum":["text_to_image","image_to_image","background_remove","upscale","sprite_sheet"],"description":"Optional. Name the operation to execute it deterministically: DreamLayer skips interpreting the prompt, so the request cannot be reclassified and cannot return a question event. No word in the prompt changes a named operation, and a named operation ignores an image remembered from an earlier turn in the same conversation. Omit it to let DreamLayer decide from the prompt. text_to_image must not carry input_asset_id; image_to_image, background_remove, upscale and sprite_sheet require it. sprite_sheet requires exactly one of options.action or options.animation_prompt. Read the authenticated /v1/sprite-pricing estimate for the requested frame_count and background, then set an explicitly authorized max_credits ceiling. Current amounts can have four decimal places. Estimates are non-binding; admission refuses a price above the ceiling before debiting. Default capabilities pricing is historical compatibility data, not a current account estimate. Put custom animation instructions in options.animation_prompt, not prompt. Sprite requests have no customer cancellation. Other operations require max_credits of 1 and do not accept options.\n\nupscale doubles each side, so the input's longest side must be 2048 or smaller: 4096 is the delivery ceiling and an oversize request is refused at execution admission before paid processing starts. That also means an upscaled image is AT maximum_input_dimension and cannot be upscaled again.","uniqueKey":"oneOf.2.operation","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"oneOf.2","typeLabel":"object"},{"type":"object","required":["quote_id","max_credits"],"example":{"quote_id":"d34db33f-0000-4000-8000-000000000002","max_credits":"33"},"properties":{"quote_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.3.quote_id","typeLabel":"string\u003cuuid>"},"max_credits":{"oneOf":[{"type":"number","description":"Positive API credit ceiling, at most 100, covering the quoted amount. Decimal strings preserve exact amounts. Never increase without approval.","maximum":100,"minimum":0,"exclusiveMinimum":true,"isRequired":true,"uniqueKey":"oneOf.3.max_credits.oneOf.0","typeLabel":"number"},{"type":"string","description":"Positive API credit ceiling, at most 100, covering the quoted amount. Decimal strings preserve exact amounts. Never increase without approval.","pattern":"^(?:0\\.(?=[0-9]*[1-9])[0-9]+|[1-9][0-9]?(?:\\.[0-9]+)?|100(?:\\.0+)?)$","isRequired":true,"uniqueKey":"oneOf.3.max_credits.oneOf.1","typeLabel":"string"}],"isRequired":true,"uniqueKey":"oneOf.3.max_credits","typeLabel":"number | string"}},"additionalProperties":false,"uniqueKey":"oneOf.3","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"operation":"sprite_sheet","input_asset_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","options":{"action":"walk","frame_count":12},"prompt":"\u003cstring>","respond":"\u003cstring>","conversation_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","aspect_ratio":"1:1","max_credits":1}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"87d7f75c-cf23-4842-8ba5-ef6503ac977b":{"description":"Sanitized server-sent events","content":{"text/event-stream":{"schema":{"type":"string","uniqueKey":"","typeLabel":"string"},"examples":{"Example":{"title":"Example","value":"\u003cstring>"}},"exampleType":"generated"}},"exampleType":"generated"},"3379ad63-7672-4860-807d-bdcb2e07147b":{"description":"Durable execution accepted","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["execution_id","conversation_id","status"],"properties":{"execution_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.0.execution_id","typeLabel":"string\u003cuuid>"},"conversation_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.0.conversation_id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["needs_input","queued","running","completed","failed","cancelled"],"isRequired":true,"uniqueKey":"oneOf.0.status","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["execution_id","conversation_id","status","image_job","video_job"],"properties":{"execution_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.1.execution_id","typeLabel":"string\u003cuuid>"},"conversation_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.1.conversation_id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["queued","submitting","uncertain","generating","delivering","completed","failed","cancelled","expired"],"isRequired":true,"uniqueKey":"oneOf.1.status","typeLabel":"enum\u003cstring>"},"image_job":{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.image_job","typeLabel":"null"},"video_job":{"type":"object","additionalProperties":true,"description":"Documented integration fields. Additional response fields can include original request data; do not log full responses.","required":["stage","requested_settings","metadata","credits","credits_restored","settled_credits","reserved_credits","billing_note","error_code","retention_expires_at","download_url"],"properties":{"stage":{"type":"string","enum":["queued","submitting","uncertain","generating","delivering","completed","failed","cancelled","expired"],"isRequired":true,"uniqueKey":"oneOf.1.video_job.stage","typeLabel":"enum\u003cstring>"},"requested_settings":{"type":"object","additionalProperties":false,"required":["duration_seconds","resolution","aspect_ratio","generate_audio"],"properties":{"duration_seconds":{"type":"integer","isRequired":true,"uniqueKey":"oneOf.1.video_job.requested_settings.duration_seconds","typeLabel":"integer"},"resolution":{"type":"string","const":"720p","isRequired":true,"uniqueKey":"oneOf.1.video_job.requested_settings.resolution","typeLabel":"string"},"aspect_ratio":{"type":"string","description":"Resolved text aspect or the source-driven profile marker for image video. Read delivered metadata for actual width and height.","isRequired":true,"uniqueKey":"oneOf.1.video_job.requested_settings.aspect_ratio","typeLabel":"string"},"generate_audio":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.1.video_job.requested_settings.generate_audio","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"oneOf.1.video_job.requested_settings","typeLabel":"object"},"metadata":{"oneOf":[{"type":"object","description":"Actual delivered metadata, available after validation. Dimensions and duration can differ slightly from nominal settings.","properties":{"width":{"type":"integer","uniqueKey":"oneOf.1.video_job.metadata.oneOf.0.width","typeLabel":"integer"},"height":{"type":"integer","uniqueKey":"oneOf.1.video_job.metadata.oneOf.0.height","typeLabel":"integer"},"duration_seconds":{"type":"number","uniqueKey":"oneOf.1.video_job.metadata.oneOf.0.duration_seconds","typeLabel":"number"},"fps":{"type":"number","uniqueKey":"oneOf.1.video_job.metadata.oneOf.0.fps","typeLabel":"number"},"audio_streams":{"type":"integer","uniqueKey":"oneOf.1.video_job.metadata.oneOf.0.audio_streams","typeLabel":"integer"},"codec":{"type":"string","uniqueKey":"oneOf.1.video_job.metadata.oneOf.0.codec","typeLabel":"string"},"content_type":{"type":"string","const":"video/mp4","uniqueKey":"oneOf.1.video_job.metadata.oneOf.0.content_type","typeLabel":"string"},"bytes":{"type":"integer","maximum":268435456,"uniqueKey":"oneOf.1.video_job.metadata.oneOf.0.bytes","typeLabel":"integer"},"sha256":{"type":"string","uniqueKey":"oneOf.1.video_job.metadata.oneOf.0.sha256","typeLabel":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.video_job.metadata.oneOf.0","typeLabel":"object"},{"type":"null","description":"Actual delivered metadata, available after validation. Dimensions and duration can differ slightly from nominal settings.","properties":{"width":{"type":"integer"},"height":{"type":"integer"},"duration_seconds":{"type":"number"},"fps":{"type":"number"},"audio_streams":{"type":"integer"},"codec":{"type":"string"},"content_type":{"type":"string","const":"video/mp4"},"bytes":{"type":"integer","maximum":268435456},"sha256":{"type":"string"}},"isRequired":true,"uniqueKey":"oneOf.1.video_job.metadata.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.video_job.metadata","typeLabel":"object | null"},"credits":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.video_job.credits","typeLabel":"string"},"credits_restored":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.1.video_job.credits_restored","typeLabel":"boolean"},"settled_credits":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.video_job.settled_credits","typeLabel":"string"},"reserved_credits":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.video_job.reserved_credits","typeLabel":"string"},"billing_note":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.video_job.billing_note","typeLabel":"string"},"error_code":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.video_job.error_code.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.1.video_job.error_code.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.video_job.error_code","typeLabel":"string | null"},"retention_expires_at":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"oneOf.1.video_job.retention_expires_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"oneOf.1.video_job.retention_expires_at.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.video_job.retention_expires_at","typeLabel":"string\u003cdate-time> | null"},"download_url":{"oneOf":[{"type":"string","description":"Owned relative asset path on completion; authenticate only at the API origin.","isRequired":true,"uniqueKey":"oneOf.1.video_job.download_url.oneOf.0","typeLabel":"string"},{"type":"null","description":"Owned relative asset path on completion; authenticate only at the API origin.","isRequired":true,"uniqueKey":"oneOf.1.video_job.download_url.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.1.video_job.download_url","typeLabel":"string | null"},"created_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"oneOf.1.video_job.created_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"oneOf.1.video_job.created_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.video_job.created_at","typeLabel":"string\u003cdate-time> | null"},"completed_at":{"oneOf":[{"type":"string","format":"date-time","uniqueKey":"oneOf.1.video_job.completed_at.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","uniqueKey":"oneOf.1.video_job.completed_at.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.1.video_job.completed_at","typeLabel":"string\u003cdate-time> | null"}},"isRequired":true,"uniqueKey":"oneOf.1.video_job","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"execution_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","conversation_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":"needs_input"}}},"exampleType":"generated"}},"exampleType":"generated"},"e8baece6-e142-486a-a381-52a9e026b8fa":{"description":"Invalid request, including a missing required Authorization header","headers":{"Cache-Control":{"schema":{"type":"string","const":"no-store"}},"Pragma":{"schema":{"type":"string","const":"no-cache"}},"X-Request-ID":{"schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","reason","message","category","retryable","request_id"],"properties":{"code":{"type":"string","description":"Legacy uppercase code retained for existing clients.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"reason":{"type":"string","enum":["invalid_request","authentication_failed","access_denied","resource_not_found","insufficient_credits","conflict","too_many_active_jobs","rate_limited","quota_exceeded","content_refused","temporarily_unavailable","generation_failed","insufficient_frames","prompt_policy_blocked","feature_unavailable"],"isRequired":true,"uniqueKey":"error.reason","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"category":{"type":"string","isRequired":true,"uniqueKey":"error.category","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"request_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string\u003cuuid>"},"details":{"type":"object","description":"Optional sanitized validation detail. Submitted values are never echoed.","additionalProperties":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","reason":"invalid_request","message":"\u003cstring>","category":"\u003cstring>","retryable":true,"request_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"a7ebde93-5a07-49e8-ba47-4f284842a07c":{"description":"Invalid or revoked API key. A missing Authorization header returns 422 invalid_request.","headers":{"Cache-Control":{"schema":{"type":"string","const":"no-store"}},"Pragma":{"schema":{"type":"string","const":"no-cache"}},"X-Request-ID":{"schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","reason","message","category","retryable","request_id"],"properties":{"code":{"type":"string","description":"Legacy uppercase code retained for existing clients.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"reason":{"type":"string","enum":["invalid_request","authentication_failed","access_denied","resource_not_found","insufficient_credits","conflict","too_many_active_jobs","rate_limited","quota_exceeded","content_refused","temporarily_unavailable","generation_failed","insufficient_frames","prompt_policy_blocked","feature_unavailable"],"isRequired":true,"uniqueKey":"error.reason","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"category":{"type":"string","isRequired":true,"uniqueKey":"error.category","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"request_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string\u003cuuid>"},"details":{"type":"object","description":"Optional sanitized validation detail. Submitted values are never echoed.","additionalProperties":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","reason":"invalid_request","message":"\u003cstring>","category":"\u003cstring>","retryable":true,"request_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"03ac3473-d36d-498f-bfb4-02f3e8706c26":{"description":"Video request rejected. Inspect error.reason and retryable. Credit or capacity rejection on acceptance does not create an execution.","content":{"application/json":{"schema":{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","reason","message","retryable"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"reason":{"type":"string","isRequired":true,"uniqueKey":"error.reason","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","reason":"\u003cstring>","message":"\u003cstring>","retryable":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"b882ba58-cd57-4133-bd29-85aa42cd059f":{"description":"Video business error or shared validation, authentication, or request-limit error. See the operation-specific recovery guide.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","reason","message","retryable"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.error.code","typeLabel":"string"},"reason":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.error.reason","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.error.message","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.0.error.retryable","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","reason","message","category","retryable","request_id"],"properties":{"code":{"type":"string","description":"Legacy uppercase code retained for existing clients.","isRequired":true,"uniqueKey":"oneOf.1.error.code","typeLabel":"string"},"reason":{"type":"string","enum":["invalid_request","authentication_failed","access_denied","resource_not_found","insufficient_credits","conflict","too_many_active_jobs","rate_limited","quota_exceeded","content_refused","temporarily_unavailable","generation_failed","insufficient_frames","prompt_policy_blocked","feature_unavailable"],"isRequired":true,"uniqueKey":"oneOf.1.error.reason","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.error.message","typeLabel":"string"},"category":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.error.category","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.1.error.retryable","typeLabel":"boolean"},"request_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.1.error.request_id","typeLabel":"string\u003cuuid>"},"details":{"type":"object","description":"Optional sanitized validation detail. Submitted values are never echoed.","additionalProperties":true,"uniqueKey":"oneOf.1.error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"oneOf.1.error","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","reason":"\u003cstring>","message":"\u003cstring>","retryable":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"81608689-eb04-48ad-a25b-fc7db387c347":{"description":"Video business error or shared validation, authentication, or request-limit error. See the operation-specific recovery guide.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","reason","message","retryable"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.error.code","typeLabel":"string"},"reason":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.error.reason","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.error.message","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.0.error.retryable","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","reason","message","category","retryable","request_id"],"properties":{"code":{"type":"string","description":"Legacy uppercase code retained for existing clients.","isRequired":true,"uniqueKey":"oneOf.1.error.code","typeLabel":"string"},"reason":{"type":"string","enum":["invalid_request","authentication_failed","access_denied","resource_not_found","insufficient_credits","conflict","too_many_active_jobs","rate_limited","quota_exceeded","content_refused","temporarily_unavailable","generation_failed","insufficient_frames","prompt_policy_blocked","feature_unavailable"],"isRequired":true,"uniqueKey":"oneOf.1.error.reason","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.error.message","typeLabel":"string"},"category":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.error.category","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.1.error.retryable","typeLabel":"boolean"},"request_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.1.error.request_id","typeLabel":"string\u003cuuid>"},"details":{"type":"object","description":"Optional sanitized validation detail. Submitted values are never echoed.","additionalProperties":true,"uniqueKey":"oneOf.1.error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"oneOf.1.error","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","reason":"\u003cstring>","message":"\u003cstring>","retryable":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"458495fb-b854-4514-b670-7702fdacbd45":{"description":"Invalid request, including a missing required Authorization header","headers":{"Cache-Control":{"schema":{"type":"string","const":"no-store"}},"Pragma":{"schema":{"type":"string","const":"no-cache"}},"X-Request-ID":{"schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","reason","message","category","retryable","request_id"],"properties":{"code":{"type":"string","description":"Legacy uppercase code retained for existing clients.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"reason":{"type":"string","enum":["invalid_request","authentication_failed","access_denied","resource_not_found","insufficient_credits","conflict","too_many_active_jobs","rate_limited","quota_exceeded","content_refused","temporarily_unavailable","generation_failed","insufficient_frames","prompt_policy_blocked","feature_unavailable"],"isRequired":true,"uniqueKey":"error.reason","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"category":{"type":"string","isRequired":true,"uniqueKey":"error.category","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"request_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string\u003cuuid>"},"details":{"type":"object","description":"Optional sanitized validation detail. Submitted values are never echoed.","additionalProperties":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","reason":"invalid_request","message":"\u003cstring>","category":"\u003cstring>","retryable":true,"request_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"4b6a843b-ebce-4514-8a4f-4cd808f9333e":{"description":"Video business error or shared validation, authentication, or request-limit error. See the operation-specific recovery guide.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","reason","message","retryable"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.error.code","typeLabel":"string"},"reason":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.error.reason","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.error.message","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.0.error.retryable","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","reason","message","category","retryable","request_id"],"properties":{"code":{"type":"string","description":"Legacy uppercase code retained for existing clients.","isRequired":true,"uniqueKey":"oneOf.1.error.code","typeLabel":"string"},"reason":{"type":"string","enum":["invalid_request","authentication_failed","access_denied","resource_not_found","insufficient_credits","conflict","too_many_active_jobs","rate_limited","quota_exceeded","content_refused","temporarily_unavailable","generation_failed","insufficient_frames","prompt_policy_blocked","feature_unavailable"],"isRequired":true,"uniqueKey":"oneOf.1.error.reason","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.error.message","typeLabel":"string"},"category":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.error.category","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.1.error.retryable","typeLabel":"boolean"},"request_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.1.error.request_id","typeLabel":"string\u003cuuid>"},"details":{"type":"object","description":"Optional sanitized validation detail. Submitted values are never echoed.","additionalProperties":true,"uniqueKey":"oneOf.1.error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"oneOf.1.error","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","reason":"\u003cstring>","message":"\u003cstring>","retryable":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"1ab6fd3c-a08a-4fcd-a22f-d4d7405beab2":{"description":"Retryable service failure","headers":{"Cache-Control":{"schema":{"type":"string","const":"no-store"}},"Pragma":{"schema":{"type":"string","const":"no-cache"}},"X-Request-ID":{"schema":{"type":"string","format":"uuid"}}},"content":{"application/json":{"schema":{"type":"object","additionalProperties":false,"required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","reason","message","category","retryable","request_id"],"properties":{"code":{"type":"string","description":"Legacy uppercase code retained for existing clients.","isRequired":true,"uniqueKey":"error.code","typeLabel":"string"},"reason":{"type":"string","enum":["invalid_request","authentication_failed","access_denied","resource_not_found","insufficient_credits","conflict","too_many_active_jobs","rate_limited","quota_exceeded","content_refused","temporarily_unavailable","generation_failed","insufficient_frames","prompt_policy_blocked","feature_unavailable"],"isRequired":true,"uniqueKey":"error.reason","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"category":{"type":"string","isRequired":true,"uniqueKey":"error.category","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"error.retryable","typeLabel":"boolean"},"request_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"error.request_id","typeLabel":"string\u003cuuid>"},"details":{"type":"object","description":"Optional sanitized validation detail. Submitted values are never echoed.","additionalProperties":true,"uniqueKey":"error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","reason":"invalid_request","message":"\u003cstring>","category":"\u003cstring>","retryable":true,"request_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","details":{}}}}},"exampleType":"generated"}},"exampleType":"generated"},"c510d246-8c66-467d-9e01-cb247ab40b26":{"description":"Video business error or shared validation, authentication, or request-limit error. See the operation-specific recovery guide.","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["error"],"properties":{"error":{"type":"object","required":["code","reason","message","retryable"],"properties":{"code":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.error.code","typeLabel":"string"},"reason":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.error.reason","typeLabel":"string"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.error.message","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.0.error.retryable","typeLabel":"boolean"}},"isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"object"}},"uniqueKey":"oneOf.0","typeLabel":"object"},{"type":"object","required":["error"],"properties":{"error":{"type":"object","additionalProperties":false,"required":["code","reason","message","category","retryable","request_id"],"properties":{"code":{"type":"string","description":"Legacy uppercase code retained for existing clients.","isRequired":true,"uniqueKey":"oneOf.1.error.code","typeLabel":"string"},"reason":{"type":"string","enum":["invalid_request","authentication_failed","access_denied","resource_not_found","insufficient_credits","conflict","too_many_active_jobs","rate_limited","quota_exceeded","content_refused","temporarily_unavailable","generation_failed","insufficient_frames","prompt_policy_blocked","feature_unavailable"],"isRequired":true,"uniqueKey":"oneOf.1.error.reason","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.error.message","typeLabel":"string"},"category":{"type":"string","isRequired":true,"uniqueKey":"oneOf.1.error.category","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.1.error.retryable","typeLabel":"boolean"},"request_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.1.error.request_id","typeLabel":"string\u003cuuid>"},"details":{"type":"object","description":"Optional sanitized validation detail. Submitted values are never echoed.","additionalProperties":true,"uniqueKey":"oneOf.1.error.details","typeLabel":"object"}},"isRequired":true,"uniqueKey":"oneOf.1.error","typeLabel":"object"}},"additionalProperties":false,"uniqueKey":"oneOf.1","typeLabel":"object"}],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"code":"\u003cstring>","reason":"\u003cstring>","message":"\u003cstring>","retryable":true}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"3ea0abe2-b535-498d-8518-3829164d3f44":{"bearerAuth":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"ce4d3de8-ed35-48c3-94fa-eba6f0a8e8b8":{"url":"https://api.dreamlayer.io"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"openapi/managed.yaml"},"subdomain":"dreamlayer","siteName":"DreamLayer","title":"Start or replay an execution - DreamLayer","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-18T03:29:52.035Z","originalFileLocation":"api-reference/post-v1execute.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=\"For images and sprites, credit and quota admission failures appear later in execution state; retryable admission failures remain queued. Video instead accepts a ready quote using only quote_id and max_credits and returns 202 JSON, or synchronous errors such as 402 insufficient_credits and 429 too_many_active_jobs. Use a stable Idempotency-Key and save the acceptance body before submitting. Video does not return an initial SSE stream. See https://docs.dreamlayer.io/agent-api/text-to-video.\">\u003cmeta data-mint-head name=\"application-name\" content=\"DreamLayer\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/dreamlayer/FXMe6qM2RdvJl_ft/_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/dreamlayer/FXMe6qM2RdvJl_ft/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/dreamlayer/FXMe6qM2RdvJl_ft/_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/dreamlayer/FXMe6qM2RdvJl_ft/_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/dreamlayer/FXMe6qM2RdvJl_ft/_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/dreamlayer/FXMe6qM2RdvJl_ft/_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/dreamlayer/FXMe6qM2RdvJl_ft/_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/dreamlayer/FXMe6qM2RdvJl_ft/_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/dreamlayer/FXMe6qM2RdvJl_ft/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Start or replay an execution - DreamLayer\">\u003cmeta data-mint-head property=\"og:description\" content=\"For images and sprites, credit and quota admission failures appear later in execution state; retryable admission failures remain queued. Video instead accepts a ready quote using only quote_id and max_credits and returns 202 JSON, or synchronous errors such as 402 insufficient_credits and 429 too_many_active_jobs. Use a stable Idempotency-Key and save the acceptance body before submitting. Video does not return an initial SSE stream. See https://docs.dreamlayer.io/agent-api/text-to-video.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"DreamLayer\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.dreamlayer.io/api-reference/post-v1execute\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://dreamlayer.mintlify.site/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=Start+or+replay+an+execution\u0026amp;description=For+images+and+sprites%2C+credit+and+quota+admission+failures+appear+later+in+execution+state%3B+retryable+admission+failures+remain+queued.+Video+instead+accepts+a\u0026amp;theme=d38de3f5f31c8b42ab253196\u0026amp;signature=f8bab70feef555b63548f72f6c059ca81ca8b5c891a959f32f9c7706e9bd7055\">\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=\"Start or replay an execution - DreamLayer\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"For images and sprites, credit and quota admission failures appear later in execution state; retryable admission failures remain queued. Video instead accepts a ready quote using only quote_id and max_credits and returns 202 JSON, or synchronous errors such as 402 insufficient_credits and 429 too_many_active_jobs. Use a stable Idempotency-Key and save the acceptance body before submitting. Video does not return an initial SSE stream. See https://docs.dreamlayer.io/agent-api/text-to-video.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://dreamlayer.mintlify.site/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=Start+or+replay+an+execution\u0026amp;description=For+images+and+sprites%2C+credit+and+quota+admission+failures+appear+later+in+execution+state%3B+retryable+admission+failures+remain+queued.+Video+instead+accepts+a\u0026amp;theme=d38de3f5f31c8b42ab253196\u0026amp;signature=f8bab70feef555b63548f72f6c059ca81ca8b5c891a959f32f9c7706e9bd7055\">\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/dreamlayer/FXMe6qM2RdvJl_ft/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"DreamLayer\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#2563EB\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.dreamlayer.io/api-reference/post-v1execute\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/post-v1execute.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.dreamlayer.io/#organization\",\"name\":\"DreamLayer\",\"url\":\"https://docs.dreamlayer.io\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/dreamlayer/nTq76C0wt2gtdpTX/dreamlayer-wordmark.svg?fit=max\u0026auto=format\u0026n=nTq76C0wt2gtdpTX\u0026q=85\u0026s=2bada060ddfa8271c6f5af3a9992f609\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.dreamlayer.io#website\",\"name\":\"DreamLayer\",\"url\":\"https://docs.dreamlayer.io\",\"publisher\":{\"@id\":\"https://docs.dreamlayer.io/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.dreamlayer.io/api-reference/post-v1execute#webpage\",\"url\":\"https://docs.dreamlayer.io/api-reference/post-v1execute\",\"name\":\"Start or replay an execution\",\"description\":\"For images and sprites, credit and quota admission failures appear later in execution state; retryable admission failures remain queued. Video instead accepts a ready quote using only quote_id and max_credits and returns 202 JSON, or synchronous errors such as 402 insufficient_credits and 429 too_many_active_jobs. Use a stable Idempotency-Key and save the acceptance body before submitting. Video does not return an initial SSE stream. See https://docs.dreamlayer.io/agent-api/text-to-video.\",\"dateModified\":\"2026-10-18T03:29:52.035Z\",\"isPartOf\":{\"@id\":\"https://docs.dreamlayer.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.dreamlayer.io/api-reference/post-v1execute#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.dreamlayer.io/api-reference/post-v1execute#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoint reference\",\"item\":\"https://docs.dreamlayer.io/api-reference/get-v1capabilities\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"API Reference\",\"item\":\"https://docs.dreamlayer.io/api-reference/get-v1capabilities\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Start or replay an execution\",\"item\":\"https://docs.dreamlayer.io/api-reference/post-v1execute\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.dreamlayer.io/api-reference/post-v1execute#apireference\",\"headline\":\"Start or replay an execution\",\"name\":\"Start or replay an execution\",\"description\":\"For images and sprites, credit and quota admission failures appear later in execution state; retryable admission failures remain queued. Video instead accepts a ready quote using only quote_id and max_credits and returns 202 JSON, or synchronous errors such as 402 insufficient_credits and 429 too_many_active_jobs. Use a stable Idempotency-Key and save the acceptance body before submitting. Video does not return an initial SSE stream. See https://docs.dreamlayer.io/agent-api/text-to-video.\",\"url\":\"https://docs.dreamlayer.io/api-reference/post-v1execute\",\"mainEntityOfPage\":{\"@id\":\"https://docs.dreamlayer.io/api-reference/post-v1execute#webpage\"},\"dateModified\":\"2026-10-18T03:29:52.035Z\",\"publisher\":{\"@id\":\"https://docs.dreamlayer.io/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.dreamlayer.io#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"DreamLayer\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"DreamLayer\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/post-v1execute.md","siteName":"DreamLayer","nav":{"global":null,"groups":[{"group":"Start","pages":[{"title":"DreamLayer documentation","href":"/index"},{"title":"Quickstart","href":"/quickstart"},{"title":"API reference","href":"/api-reference"},{"title":"Troubleshooting","href":"/troubleshooting"}]},{"group":"DreamLayer Agent API","pages":[{"title":"DreamLayer Agent API","href":"/agent-api/index"},{"title":"API keys","href":"/agent-api/api-keys"},{"title":"Limits and retry handling","href":"/agent-api/limits"},{"title":"Check balance","href":"/agent-api/balance"},{"title":"Conversations","href":"/agent-api/conversations"},{"title":"Text-to-image","href":"/agent-api/text-to-image"},{"title":"Image-to-image","href":"/agent-api/image-to-image"},{"title":"Sprite sheets","href":"/agent-api/sprite-sheet"},{"title":"Jobs and event streams","href":"/agent-api/jobs-and-events"},{"title":"Assets","href":"/agent-api/assets"},{"title":"Idempotency and retries","href":"/agent-api/idempotency-and-retries"},{"title":"Error contract","href":"/agent-api/errors"},{"title":"Runnable API examples","href":"/agent-api/examples"},{"title":"Process multiple images","href":"/agent-api/multiple-images"}]},{"group":"Video","pages":[{"title":"Video","href":"/agent-api/video"},{"title":"Text-to-video","href":"/agent-api/text-to-video"},{"title":"Image-to-video","href":"/agent-api/image-to-video"},{"title":"Video settings, sound, and pricing","href":"/agent-api/video-settings"},{"title":"Video jobs and recovery","href":"/agent-api/video-jobs"}]},{"group":"Command line and agents","pages":[{"title":"DreamLayer CLI","href":"/cli"},{"title":"CLI automation","href":"/cli/automation"},{"title":"Image Agent MCP Server","href":"/mcp/index"},{"title":"MCP installation by client","href":"/mcp/clients"},{"title":"MCP tool reference","href":"/mcp/tools"},{"title":"Image workflows for agents","href":"/agent-workflows"}]},{"group":"Project","pages":[{"title":"Pricing","href":"/pricing"},{"title":"Security, privacy, and telemetry","href":"/security-and-privacy"}]},{"group":"Endpoint reference","pages":[{"group":"API Reference","pages":[{"title":"Discover available operations","deprecated":null,"version":null,"sidebarTitle":"Get v1capabilities","openapi":"/openapi/managed.yaml get /v1/capabilities","href":"/api-reference/get-v1capabilities"},{"title":"Read available credits","deprecated":null,"version":null,"sidebarTitle":"Get v1balance","openapi":"/openapi/managed.yaml get /v1/balance","href":"/api-reference/get-v1balance"},{"title":"Estimate sprite usage credits","deprecated":null,"version":null,"openapi":"/openapi/managed.yaml get /v1/sprite-pricing","href":"/api-reference/estimate-sprite-usage-credits"},{"title":"Upload a reference image","description":"Create an owned input asset. Keep its ID and expiry; reuse the same ID when replaying a request.","deprecated":null,"version":null,"sidebarTitle":"Post v1input assets","openapi":"/openapi/managed.yaml post /v1/input-assets","href":"/api-reference/post-v1input-assets"},{"title":"Start or replay an execution","deprecated":null,"version":null,"sidebarTitle":"Post v1execute","openapi":"/openapi/managed.yaml post /v1/execute","href":"/api-reference/post-v1execute"},{"title":"Read execution state","description":"Read canonical status after a timeout or dropped stream. A successful HTTP response does not mean the execution itself succeeded.","deprecated":null,"version":null,"sidebarTitle":"Get v1executions","openapi":"/openapi/managed.yaml get /v1/executions/{execution_id}","href":"/api-reference/get-v1executions"},{"title":"Resume execution events","deprecated":null,"version":null,"sidebarTitle":"Get v1executions events","openapi":"/openapi/managed.yaml get /v1/executions/{execution_id}/events","href":"/api-reference/get-v1executions-events"},{"title":"Cancel an eligible execution","deprecated":null,"version":null,"sidebarTitle":"Post v1executions cancel","openapi":"/openapi/managed.yaml post /v1/executions/{execution_id}/cancel","href":"/api-reference/post-v1executions-cancel"},{"title":"Discover Video availability and defaults","deprecated":null,"version":null,"sidebarTitle":"Get v1video capabilities","openapi":"/openapi/managed.yaml get /v1/video/capabilities","href":"/api-reference/get-v1video-capabilities"},{"title":"Quote a video before generation","deprecated":null,"version":null,"sidebarTitle":"Post v1video quotes","openapi":"/openapi/managed.yaml post /v1/video/quotes","href":"/api-reference/post-v1video-quotes"},{"title":"Download an owned completed video","deprecated":null,"version":null,"sidebarTitle":"Get v1video executions asset","openapi":"/openapi/managed.yaml get /v1/video/executions/{execution_id}/asset","href":"/api-reference/get-v1video-executions-asset"},{"title":"List recent conversations","deprecated":null,"version":null,"sidebarTitle":"Get v1conversations","openapi":"/openapi/managed.yaml get /v1/conversations","href":"/api-reference/get-v1conversations"},{"title":"Delete a conversation","deprecated":null,"version":null,"sidebarTitle":"Delete v1conversations","openapi":"/openapi/managed.yaml delete /v1/conversations/{conversation_id}","href":"/api-reference/delete-v1conversations"},{"title":"Download a completed output","deprecated":null,"version":null,"sidebarTitle":"Get v1image jobsjob idasset","openapi":"/openapi/managed.yaml get /v1/image-jobs/{job_id}/asset","href":"/api-reference/get-v1image-jobsjob_idasset"}]}]}]},"basePath":"","title":"Start or replay an execution - DreamLayer","deploymentId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","buildId":"dpl_FZMKUpaaKiVETbfqhoUe4sPFDTmY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B6WFFOBL.js","utils-BN5um1KA.js","cloneDeep-C3md22mN.js","_Uint8Array-DLlL8L26.js","isObject-FP1Yky1u.js","utils-BSmbkXJR.js","addUniqueKeysToSchema-2tqcVnUE.js","snippetPresets-CtWfvr2J.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-DkKHBy30.js","isEqual-O3q7y6pq.js","usePlaygroundInputsStore-Brc5H9UJ.js","shallow-C4L4xvbs.js","getApiPlaygroundDisplay-2bxyq_aI.js","CodeSnippet-BJu8ddd5.js","CodeSnippets-dazWmoqB.js","Page-CnLhKuUV.js","getPastedJson-Chy3Qa1S.js","icon-CyO7h3jh.js","MethodPill-Dle0_91v.js","DuplicateIcon-CVvWAf4a.js","createIcon-Di07A27B.js","DynamicMarkdown-C4w9kavL.js","SectionHeading-XiBebVYC.js","axios-vUo_bRtp.js","Markdown-DTeL0SpS.js","dist-OCScizqf.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","katex-YMM-FMeD.js","html-void-elements-mCSPHezU.js","marked.esm-CZWythHk.js","AssistantPageLink-KcneGfMY.js"]}