Bearer authentication header of the form Bearer <token>, where <token> is your auth token.
Headers
DreamLayer-Version
string
required
Allowed value: "1"
Path Parameters
execution_id
string<uuid>
required
Response
Canonical execution state
Option 1
Option 2
execution_id
string<uuid>
required
conversation_id
string<uuid>
required
status
enum<string>
required
Available options:
needs_input,
queued,
running,
completed,
failed,
cancelled
image_job
object | null
required
Show child attributes
question
object | null
required
The outstanding clarification, so a client that reconnected or never held the stream can still answer it. Null whenever nothing is outstanding, which includes an execution whose question has already been answered: answering creates a new execution and the one that asked stays at status needs_input with a null question. A non-null question is the only reliable signal that a turn is still waiting. Additive: treat a missing field as null.
Show child attributes
error
object | null
required
Public admission failure when status is failed; otherwise null.
Show child attributes
{"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/get-v1executions","slug":"/api-reference/get-v1executions","pageMetadata":{"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","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsx(_components.p, {\n children: \"Read canonical status after a timeout or dropped stream. A successful HTTP response does not mean the execution itself succeeded.\"\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":"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","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"getExecution","x-mint":{"href":"/api-reference/get-v1executions"},"summary":"Read execution state","description":"Read canonical status after a timeout or dropped stream. A successful HTTP response does not mean the execution itself succeeded.","parameters":["7d8b27b6-7ac6-4e10-8a99-307f995679da","85dd798c-e18c-47ea-8386-76c06cdc6956"],"responses":{"200":"63a41195-50ca-4254-b107-432afd8d447b","400":"ca385474-6dd7-4c8c-8841-737bdab488b0","401":"a0ebd36f-2828-4f1f-ad38-a75fb6bd8e11","404":"95ba713b-626c-4138-af59-7a320faf58c4","422":"3f6b8f02-9c27-460b-8962-2e6e92b7fed9","429":"33d03c1b-c815-4a0a-9bdb-2c43ca778621"},"method":"get","type":"path","servers":["ce4d3de8-ed35-48c3-94fa-eba6f0a8e8b8"],"security":["3ea0abe2-b535-498d-8518-3829164d3f44"],"path":"/v1/executions/{execution_id}","baseUrlOptions":["https://api.dreamlayer.io"],"title":"Read execution state","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"7d8b27b6-7ac6-4e10-8a99-307f995679da":{"name":"DreamLayer-Version","in":"header","required":true,"schema":{"type":"string","const":"1","isRequired":true,"uniqueKey":"","typeLabel":"string"}},"85dd798c-e18c-47ea-8386-76c06cdc6956":{"name":"execution_id","in":"path","required":true,"schema":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"63a41195-50ca-4254-b107-432afd8d447b":{"description":"Canonical execution state","content":{"application/json":{"schema":{"oneOf":[{"type":"object","required":["execution_id","conversation_id","status","image_job","question","error"],"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>"},"image_job":{"oneOf":[{"type":"object","required":["public_job_id","status","finished_assets","sanitized_error"],"properties":{"public_job_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.0.image_job.oneOf.0.public_job_id","typeLabel":"string\u003cuuid>"},"status":{"type":"string","enum":["queued","running","completed","failed"],"isRequired":true,"uniqueKey":"oneOf.0.image_job.oneOf.0.status","typeLabel":"enum\u003cstring>"},"finished_assets":{"type":"array","maxItems":1,"items":{"oneOf":[{"type":"object","required":["asset_id","download_url","content_type","width","height"],"properties":{"asset_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.0.image_job.oneOf.0.finished_assets.items.[INDEX].oneOf.0.asset_id","typeLabel":"string\u003cuuid>"},"download_url":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.image_job.oneOf.0.finished_assets.items.[INDEX].oneOf.0.download_url","typeLabel":"string"},"content_type":{"type":"string","const":"image/png","isRequired":true,"uniqueKey":"oneOf.0.image_job.oneOf.0.finished_assets.items.[INDEX].oneOf.0.content_type","typeLabel":"string"},"width":{"type":"integer","minimum":1,"maximum":4096,"isRequired":true,"uniqueKey":"oneOf.0.image_job.oneOf.0.finished_assets.items.[INDEX].oneOf.0.width","typeLabel":"integer"},"height":{"type":"integer","minimum":1,"maximum":4096,"isRequired":true,"uniqueKey":"oneOf.0.image_job.oneOf.0.finished_assets.items.[INDEX].oneOf.0.height","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"oneOf.0.image_job.oneOf.0.finished_assets.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","description":"Complete sprite sheet dimensions, not individual frame dimensions. The bounds below cover all supported frame counts and sizes. The correction is deployed; frame_size 512 is the default, not a required workaround. Existing completed outputs do not require regeneration or another charge; retry status and download with the original execution ID.","required":["asset_id","download_url","content_type","width","height","size_bytes"],"properties":{"asset_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.0.image_job.oneOf.0.finished_assets.items.[INDEX].oneOf.1.asset_id","typeLabel":"string\u003cuuid>"},"download_url":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.image_job.oneOf.0.finished_assets.items.[INDEX].oneOf.1.download_url","typeLabel":"string"},"content_type":{"type":"string","const":"application/zip","isRequired":true,"uniqueKey":"oneOf.0.image_job.oneOf.0.finished_assets.items.[INDEX].oneOf.1.content_type","typeLabel":"string"},"width":{"type":"integer","minimum":32,"maximum":10800,"isRequired":true,"uniqueKey":"oneOf.0.image_job.oneOf.0.finished_assets.items.[INDEX].oneOf.1.width","typeLabel":"integer"},"height":{"type":"integer","minimum":32,"maximum":10800,"isRequired":true,"uniqueKey":"oneOf.0.image_job.oneOf.0.finished_assets.items.[INDEX].oneOf.1.height","typeLabel":"integer"},"size_bytes":{"type":"integer","minimum":1,"maximum":134217728,"isRequired":true,"uniqueKey":"oneOf.0.image_job.oneOf.0.finished_assets.items.[INDEX].oneOf.1.size_bytes","typeLabel":"integer"}},"additionalProperties":false,"uniqueKey":"oneOf.0.image_job.oneOf.0.finished_assets.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"oneOf.0.image_job.oneOf.0.finished_assets.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"oneOf.0.image_job.oneOf.0.finished_assets","typeLabel":"object[]"},"sanitized_error":{"oneOf":[{"type":"object","required":["code","reason","message","retryable","request_id"],"properties":{"code":{"type":"string","const":"generation_failed","description":"Legacy value retained for existing clients. New clients use reason.","isRequired":true,"uniqueKey":"oneOf.0.image_job.oneOf.0.sanitized_error.oneOf.0.code","typeLabel":"string"},"reason":{"type":"string","enum":["invalid_request","rate_limited","content_refused","temporarily_unavailable","generation_failed","insufficient_frames"],"isRequired":true,"uniqueKey":"oneOf.0.image_job.oneOf.0.sanitized_error.oneOf.0.reason","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.image_job.oneOf.0.sanitized_error.oneOf.0.message","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.0.image_job.oneOf.0.sanitized_error.oneOf.0.retryable","typeLabel":"boolean"},"request_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.0.image_job.oneOf.0.sanitized_error.oneOf.0.request_id","typeLabel":"string\u003cuuid>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.0.image_job.oneOf.0.sanitized_error.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.image_job.oneOf.0.sanitized_error.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.image_job.oneOf.0.sanitized_error","typeLabel":"object | null"},"frame_review":{"oneOf":[{"type":"object","description":"Optional completed-sprite metadata. Null or absent means unknown, not a clean inspection result. Older jobs need not contain this field. Ordinary images and unfinished jobs return null. All frame numbers are one-based output slots, not source-video frame indices.","required":["frame_count","background","kept_background_frames","inspection_frames","source_shifted_frames"],"properties":{"frame_count":{"type":"integer","minimum":7,"maximum":100,"isRequired":true,"uniqueKey":"oneOf.0.image_job.oneOf.0.frame_review.oneOf.0.frame_count","typeLabel":"integer"},"background":{"type":"string","enum":["remove","keep"],"isRequired":true,"uniqueKey":"oneOf.0.image_job.oneOf.0.frame_review.oneOf.0.background","typeLabel":"enum\u003cstring>"},"kept_background_frames":{"type":"array","maxItems":100,"uniqueItems":true,"description":"Output slots delivered with their backgrounds still present.","items":{"type":"integer","minimum":1,"maximum":100,"uniqueKey":"oneOf.0.image_job.oneOf.0.frame_review.oneOf.0.kept_background_frames.items.[INDEX]","typeLabel":"integer"},"isRequired":true,"uniqueKey":"oneOf.0.image_job.oneOf.0.frame_review.oneOf.0.kept_background_frames","typeLabel":"integer[]"},"inspection_frames":{"type":"array","maxItems":100,"uniqueItems":true,"description":"Slots worth inspecting, not a claim that the artwork is defective.","items":{"type":"integer","minimum":1,"maximum":100,"uniqueKey":"oneOf.0.image_job.oneOf.0.frame_review.oneOf.0.inspection_frames.items.[INDEX]","typeLabel":"integer"},"isRequired":true,"uniqueKey":"oneOf.0.image_job.oneOf.0.frame_review.oneOf.0.inspection_frames","typeLabel":"integer[]"},"source_shifted_frames":{"type":"array","maxItems":100,"uniqueItems":true,"description":"Slots successfully rescued using a nearby source-video moment.","items":{"type":"integer","minimum":1,"maximum":100,"uniqueKey":"oneOf.0.image_job.oneOf.0.frame_review.oneOf.0.source_shifted_frames.items.[INDEX]","typeLabel":"integer"},"isRequired":true,"uniqueKey":"oneOf.0.image_job.oneOf.0.frame_review.oneOf.0.source_shifted_frames","typeLabel":"integer[]"}},"additionalProperties":false,"uniqueKey":"oneOf.0.image_job.oneOf.0.frame_review.oneOf.0","typeLabel":"object"},{"type":"null","description":"Optional completed-sprite metadata. Null or absent means unknown, not a clean inspection result. Older jobs need not contain this field. Ordinary images and unfinished jobs return null. All frame numbers are one-based output slots, not source-video frame indices.","uniqueKey":"oneOf.0.image_job.oneOf.0.frame_review.oneOf.1","typeLabel":"null"}],"uniqueKey":"oneOf.0.image_job.oneOf.0.frame_review","typeLabel":"object | null"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.0.image_job.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"oneOf.0.image_job.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.image_job","typeLabel":"object | null"},"question":{"oneOf":[{"type":"object","description":"The outstanding clarification, so a client that reconnected or never held the stream can still answer it. Null whenever nothing is outstanding, which includes an execution whose question has already been answered: answering creates a new execution and the one that asked stays at status needs_input with a null question. A non-null question is the only reliable signal that a turn is still waiting. Additive: treat a missing field as null.","required":["question_id","text","requires_asset"],"properties":{"question_id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"oneOf.0.question.oneOf.0.question_id","typeLabel":"string\u003cuuid>"},"text":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.question.oneOf.0.text","typeLabel":"string"},"requires_asset":{"type":"boolean","description":"When true the answer must carry input_asset_id as well as respond. Answering without one is refused with a 422 whose details name input_asset_id.","isRequired":true,"uniqueKey":"oneOf.0.question.oneOf.0.requires_asset","typeLabel":"boolean"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.0.question.oneOf.0","typeLabel":"object"},{"type":"null","description":"The outstanding clarification, so a client that reconnected or never held the stream can still answer it. Null whenever nothing is outstanding, which includes an execution whose question has already been answered: answering creates a new execution and the one that asked stays at status needs_input with a null question. A non-null question is the only reliable signal that a turn is still waiting. Additive: treat a missing field as null.","isRequired":true,"uniqueKey":"oneOf.0.question.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.question","typeLabel":"object | null"},"error":{"oneOf":[{"type":"object","description":"Public admission failure when status is failed; otherwise null.","required":["reason","message","retryable"],"properties":{"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.0.error.oneOf.0.reason","typeLabel":"enum\u003cstring>"},"message":{"type":"string","isRequired":true,"uniqueKey":"oneOf.0.error.oneOf.0.message","typeLabel":"string"},"retryable":{"type":"boolean","isRequired":true,"uniqueKey":"oneOf.0.error.oneOf.0.retryable","typeLabel":"boolean"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"oneOf.0.error.oneOf.0","typeLabel":"object"},{"type":"null","description":"Public admission failure when status is failed; otherwise null.","isRequired":true,"uniqueKey":"oneOf.0.error.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"oneOf.0.error","typeLabel":"object | null"}},"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","image_job":{"public_job_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","status":"queued","finished_assets":[{"asset_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","download_url":"\u003cstring>","content_type":"image/png","width":2048,"height":2048}],"sanitized_error":{"code":"generation_failed","reason":"invalid_request","message":"\u003cstring>","retryable":true,"request_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a"},"frame_review":{"frame_count":53,"background":"remove","kept_background_frames":[50],"inspection_frames":[50],"source_shifted_frames":[50]}},"question":{"question_id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","text":"\u003cstring>","requires_asset":true},"error":{"reason":"invalid_request","message":"\u003cstring>","retryable":true}}}},"exampleType":"generated"}},"exampleType":"generated"},"ca385474-6dd7-4c8c-8841-737bdab488b0":{"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"},"a0ebd36f-2828-4f1f-ad38-a75fb6bd8e11":{"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"},"95ba713b-626c-4138-af59-7a320faf58c4":{"description":"Owned resource not found","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"},"3f6b8f02-9c27-460b-8962-2e6e92b7fed9":{"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"},"33d03c1b-c815-4a0a-9bdb-2c43ca778621":{"description":"Synchronous request or open-stream limit reached. See https://docs.dreamlayer.io/agent-api/limits for scopes and backoff. Retry-After and remaining-request headers are not guaranteed.","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"},"example":{"error":{"code":"RATE_LIMITED","reason":"rate_limited","message":"Too many requests. Please try again shortly.","category":"RATE_LIMITED","retryable":true,"request_id":"d34db33f-0000-4000-8000-000000000001"}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"RATE_LIMITED","reason":"rate_limited","message":"Too many requests. Please try again shortly.","category":"RATE_LIMITED","retryable":true,"request_id":"d34db33f-0000-4000-8000-000000000001"}}}},"exampleType":"examples"}},"exampleType":"examples"}},"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":"Read execution state - DreamLayer","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-18T03:29:52.047Z","originalFileLocation":"api-reference/get-v1executions.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=\"Read canonical status after a timeout or dropped stream. A successful HTTP response does not mean the execution itself succeeded.\">\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=\"Read execution state - DreamLayer\">\u003cmeta data-mint-head property=\"og:description\" content=\"Read canonical status after a timeout or dropped stream. A successful HTTP response does not mean the execution itself succeeded.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"DreamLayer\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.dreamlayer.io/api-reference/get-v1executions\">\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=Read+execution+state\u0026amp;description=Read+canonical+status+after+a+timeout+or+dropped+stream.+A+successful+HTTP+response+does+not+mean+the+execution+itself+succeeded.\u0026amp;theme=d38de3f5f31c8b42ab253196\u0026amp;signature=1e723690046685b33ca0f0aaa43f780ecf26dfea4a6d1942c42f857def467e92\">\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=\"Read execution state - DreamLayer\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Read canonical status after a timeout or dropped stream. A successful HTTP response does not mean the execution itself succeeded.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://dreamlayer.mintlify.site/_mintlify/api/og/v2?division=API+Reference\u0026amp;title=Read+execution+state\u0026amp;description=Read+canonical+status+after+a+timeout+or+dropped+stream.+A+successful+HTTP+response+does+not+mean+the+execution+itself+succeeded.\u0026amp;theme=d38de3f5f31c8b42ab253196\u0026amp;signature=1e723690046685b33ca0f0aaa43f780ecf26dfea4a6d1942c42f857def467e92\">\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/get-v1executions\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/get-v1executions.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/get-v1executions#webpage\",\"url\":\"https://docs.dreamlayer.io/api-reference/get-v1executions\",\"name\":\"Read execution state\",\"description\":\"Read canonical status after a timeout or dropped stream. A successful HTTP response does not mean the execution itself succeeded.\",\"dateModified\":\"2026-10-18T03:29:52.047Z\",\"isPartOf\":{\"@id\":\"https://docs.dreamlayer.io#website\"},\"breadcrumb\":{\"@id\":\"https://docs.dreamlayer.io/api-reference/get-v1executions#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.dreamlayer.io/api-reference/get-v1executions#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\":\"Read execution state\",\"item\":\"https://docs.dreamlayer.io/api-reference/get-v1executions\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.dreamlayer.io/api-reference/get-v1executions#apireference\",\"headline\":\"Read execution state\",\"name\":\"Read execution state\",\"description\":\"Read canonical status after a timeout or dropped stream. A successful HTTP response does not mean the execution itself succeeded.\",\"url\":\"https://docs.dreamlayer.io/api-reference/get-v1executions\",\"mainEntityOfPage\":{\"@id\":\"https://docs.dreamlayer.io/api-reference/get-v1executions#webpage\"},\"dateModified\":\"2026-10-18T03:29:52.047Z\",\"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/get-v1executions.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","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","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"},{"title":"Read execution state","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","description":"Reconnect using the last processed Last-Event-ID. A stream boundary does not end or cancel the execution. Video streams use progress, asset, and done, without an initial started event; terminal events may repeat without IDs. Video permits three open streams per key. Read canonical state for expiry and billing. See https://docs.dreamlayer.io/agent-api/video-jobs.","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":"Read execution state - 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"]}