The current status of the chat completion. 'created' means the request has been received but processing hasn't started. 'running' means the chat completion is currently being processed. 'succeeded' means the chat completion has finished successfully. 'failed' means the chat completion encountered an error and couldn't complete.
The timestamp when this chat completion was last updated
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Tela","colors":{"primary":"#171717","light":"#EBECED","dark":"#171717"},"logo":{"light":"https://mintcdn.com/meistrari/pblu7JGV78zF0-_0/logo/tela-docs-logo-light.svg?fit=max\u0026auto=format\u0026n=pblu7JGV78zF0-_0\u0026q=85\u0026s=2203db70c6af3499a392576fba857701","dark":"https://mintcdn.com/meistrari/pblu7JGV78zF0-_0/logo/tela-docs-logo-dark.svg?fit=max\u0026auto=format\u0026n=pblu7JGV78zF0-_0\u0026q=85\u0026s=a654991459d67d985930d693c2c84d53"},"favicon":"https://mintcdn.com/meistrari/pblu7JGV78zF0-_0/favicon.svg?fit=max\u0026auto=format\u0026n=pblu7JGV78zF0-_0\u0026q=85\u0026s=d467e03abcb66668deda7bd0eb39b121","background":{"color":{"dark":"#020913"}},"navbar":{"primary":{"type":"button","label":"Open Dashboard","href":"https://tela.com/app/dashboard"}},"search":{"prompt":"Search in TelaDocs"},"fonts":{"family":"Inter"},"styling":{"latex":false},"navigation":{"languages":[{"language":"en","default":true,"href":"en/welcome"},{"language":"pt-BR","href":"pt/welcome"}]}},"deployment":{"deploymentMetadataValue":{"subdomain":"meistrari","hasAudioNarration":false,"actualSubdomain":"meistrari","customDomains":["docs.tela.com"],"gitSource":{"type":"github","owner":"meistrari","repo":"tela-docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae399c78fc5c9e41494669d","clientVersion":"0.0.4124","searchFilterCounts":[{"language":"default","tag":"API Reference","count":67},{"language":"en","tag":"Documentation","count":54},{"language":"pt-BR","tag":"Documentação","count":54},{"language":"en","tag":"Build","count":26},{"language":"pt-BR","tag":"Construir","count":26},{"language":"en","tag":"Integrate","count":12},{"language":"pt-BR","tag":"Integrar","count":12},{"language":"default","tag":"Workstation Events","count":10},{"language":"en","tag":"Workflow","count":10},{"language":"pt-BR","tag":"Workflow","count":10},{"language":"default","tag":"Versions","count":9},{"language":"default","tag":"Tasks","count":9},{"language":"default","tag":"Test case tags","count":9},{"language":"default","tag":"Test cases","count":8},{"language":"en","tag":"Agent","count":8},{"language":"pt-BR","tag":"Agente","count":8},{"language":"en","tag":"Completion API","count":7},{"language":"pt-BR","tag":"Completion API","count":7},{"language":"default","tag":"Environments","count":6},{"language":"en","tag":"Canvas","count":6},{"language":"en","tag":"Operate","count":6},{"language":"pt-BR","tag":"Canvas","count":6},{"language":"pt-BR","tag":"Operar","count":6},{"language":"default","tag":"Version messages","count":5},{"language":"en","tag":"Workstation","count":5},{"language":"en","tag":"Get started","count":5},{"language":"pt-BR","tag":"Workstation","count":5},{"language":"pt-BR","tag":"Primeiros passos","count":5},{"language":"default","tag":"Completions","count":3},{"language":"default","tag":"Workflow runs","count":3}]},"assistantConfig":{},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"style.css","content":":root{--tela-text-primary: #262626;--tela-text-secondary: #737373;--tela-text-contrast: #171717;--tela-border: #e8e8e8;--tela-bg-hover: #f5f5f5;--tela-bg-active: #e8e8e8;--tela-weight-medium: 460;--tela-weight-semibold: 540;--tela-weight-heading: 520}html.dark{--tela-text-primary: #e8e8e8;--tela-text-secondary: #a3a3a3;--tela-text-contrast: #ffffff;--tela-border: rgba(255, 255, 255, 0.08);--tela-bg-hover: rgba(255, 255, 255, 0.04);--tela-bg-active: rgba(255, 255, 255, 0.08)}body{-webkit-font-smoothing:antialiased;-moz-osx-font-smoothing:grayscale}#navbar-transition{border-bottom:0.5px solid var(--tela-border)}#sidebar{border-right:0.5px solid var(--tela-border)}#sidebar .sidebar-group-header{font-size:12px;line-height:16px;font-weight:var(--tela-weight-semibold);letter-spacing:0.05em;text-transform:uppercase;color:var(--tela-text-secondary)}#sidebar li>a,#sidebar li>button{border-radius:10px;font-size:14px;line-height:18px;letter-spacing:-0.15px;font-weight:var(--tela-weight-medium);color:var(--tela-text-secondary)}#sidebar li>a:hover,#sidebar li>button:hover{background-color:var(--tela-bg-hover);color:var(--tela-text-primary)}#sidebar li[data-active-nav-item=\"true\"]>a{background-color:var(--tela-bg-active);color:var(--tela-text-primary);font-weight:var(--tela-weight-semibold);text-shadow:none}#sidebar li[data-active-nav-item=\"true\"]>a svg{background-color:var(--tela-text-primary)}[data-layout-item=\"toc-item-link\"]{font-size:12px;line-height:16px;color:var(--tela-text-secondary)}[data-layout-item=\"toc-item-link\"][data-active=\"true\"],[data-layout-item=\"toc-item-link\"]:hover{color:var(--tela-text-contrast)}#header .eyebrow{font-size:12px;line-height:16px;font-weight:var(--tela-weight-semibold);letter-spacing:0.05em;text-transform:uppercase;color:var(--tela-text-secondary)}#page-title{font-size:32px;line-height:36px;letter-spacing:-1px;font-weight:var(--tela-weight-heading);color:var(--tela-text-contrast)}#content-area .mdx-content{color:var(--tela-text-primary);font-size:16px;line-height:28px;letter-spacing:-0.18px}#content-area .mdx-content h2{font-size:24px;line-height:28px;letter-spacing:-0.8px;font-weight:var(--tela-weight-heading);color:var(--tela-text-contrast)}#content-area .mdx-content h3{font-size:20px;line-height:24px;letter-spacing:-0.5px;font-weight:var(--tela-weight-heading);color:var(--tela-text-contrast)}#content-area .mdx-content h4{font-size:16px;line-height:20px;letter-spacing:-0.2px;font-weight:var(--tela-weight-heading);color:var(--tela-text-contrast)}#content-area .mdx-content h5{font-size:14px;line-height:16px;letter-spacing:-0.15px;font-weight:var(--tela-weight-heading);color:var(--tela-text-contrast)}#content-area .mdx-content h6{font-size:12px;line-height:14px;letter-spacing:-0.1px;font-weight:var(--tela-weight-heading);color:var(--tela-text-contrast)}#content-area .mdx-content strong{font-weight:var(--tela-weight-semibold)}#content-area .mdx-content .card,#content-area .mdx-content .callout{border-radius:12px}#content-area .mdx-content .card{border:0.5px solid var(--tela-border)}#content-area .mdx-content .frame{width:fit-content;max-width:100%;margin-inline:auto}#content-area .mdx-content .frame img{width:auto;max-width:100%;max-height:560px}"}],"page":{"pagePath":"api-reference/completion/get","slug":"/api-reference/completion/get","pageMetadata":{"title":"Retrieve Canvas Run","description":"Retrieve the status and details of an asynchronous chat completion using its unique identifier, enabling efficient polling and status monitoring.","openapi":"GET /v2/chat/completions/{id}","href":"/api-reference/completion/get"},"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: \"Retrieve the status and details of an asynchronous chat completion using its unique identifier, enabling efficient polling and status monitoring.\"\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":"Retrieve Canvas Run","description":"Retrieve the status and details of an asynchronous chat completion using its unique identifier, enabling efficient polling and status monitoring.","openapi":"GET /v2/chat/completions/{id}","href":"/api-reference/completion/get"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/meistrari/7fb0cf41bd7567c7/scripts/code-samples/chat/completions/v2/example.js"],"openApiReferenceData":{"operation":{"parameters":["a4b742d9-98d9-47c3-a965-1fdb589752da"],"responses":{"200":"05e0f692-8e98-4479-9423-f5138a134bba"},"method":"get","type":"path","servers":["f8c8ecf7-c25f-4e5a-8e20-c44514cb2cac"],"security":[],"path":"/v2/chat/completions/{id}","baseUrlOptions":["https://api.tela.com"],"title":"","description":"Retrieve the status and details of an asynchronous chat completion using its unique identifier, enabling efficient polling and status monitoring.","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"a4b742d9-98d9-47c3-a965-1fdb589752da":{"name":"id","in":"path","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"responses":{"05e0f692-8e98-4479-9423-f5138a134bba":{"description":"Successful retrieval of chat completion","content":{"application/json":{"schema":{"type":"object","title":"Chat completion webhook response","description":"Response structure for a chat completion webhook. This represents the data sent to the webhook URL when a chat completion is finished.","properties":{"id":{"type":"string","description":"Unique identifier for this chat completion response","uniqueKey":"id","typeLabel":"string"},"status":{"type":"string","enum":["created","failed","running","succeeded"],"description":"The current status of the chat completion. 'created' means the request has been received but processing hasn't started. 'running' means the chat completion is currently being processed. 'succeeded' means the chat completion has finished successfully. 'failed' means the chat completion encountered an error and couldn't complete.","uniqueKey":"status","typeLabel":"enum\u003cstring>"},"input_content":{"type":"object","description":"Contains information about the input provided for this chat completion","properties":{"variables":{"type":"object","description":"Variables passed to the chat completion, including any file URLs","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"input_content.variables.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"object","required":["file_url"],"properties":{"file_url":{"type":"string","isRequired":true,"uniqueKey":"input_content.variables.additionalProperties.oneOf.1.file_url","typeLabel":"string"},"options":{"type":"object","uniqueKey":"input_content.variables.additionalProperties.oneOf.1.options","typeLabel":"object"}},"uniqueKey":"input_content.variables.additionalProperties.oneOf.1","typeLabel":"object"}],"uniqueKey":"input_content.variables.additionalProperties","typeLabel":"string | object"},"uniqueKey":"input_content.variables","typeLabel":"object"},"messages":{"type":"array","description":"Array of messages that were part of the input","items":{"type":"object","properties":{"role":{"type":"string","description":"The role of the message sender (e.g., 'user', 'assistant', 'system')","uniqueKey":"input_content.messages.items.[INDEX].role","typeLabel":"string"},"content":{"oneOf":[{"type":"string","description":"The content of the message. Can be a string for text messages, or an object for more complex content types like images.","uniqueKey":"input_content.messages.items.[INDEX].content.oneOf.0","typeLabel":"string"},{"type":"object","description":"The content of the message. Can be a string for text messages, or an object for more complex content types like images.","properties":{"type":{"type":"string","enum":["text","image_url"],"uniqueKey":"input_content.messages.items.[INDEX].content.oneOf.1.type","typeLabel":"enum\u003cstring>"},"text":{"type":"string","uniqueKey":"input_content.messages.items.[INDEX].content.oneOf.1.text","typeLabel":"string"},"image_url":{"type":"object","properties":{"url":{"type":"string","uniqueKey":"input_content.messages.items.[INDEX].content.oneOf.1.image_url.url","typeLabel":"string"},"detail":{"type":"string","enum":["auto","high","low"],"uniqueKey":"input_content.messages.items.[INDEX].content.oneOf.1.image_url.detail","typeLabel":"enum\u003cstring>"}},"uniqueKey":"input_content.messages.items.[INDEX].content.oneOf.1.image_url","typeLabel":"object"}},"uniqueKey":"input_content.messages.items.[INDEX].content.oneOf.1","typeLabel":"object"}],"uniqueKey":"input_content.messages.items.[INDEX].content","typeLabel":"string | object"},"function_call":{"type":"object","description":"Optional. Information about a function call, if applicable.","properties":{"name":{"type":"string","uniqueKey":"input_content.messages.items.[INDEX].function_call.name","typeLabel":"string"},"arguments":{"type":"string","uniqueKey":"input_content.messages.items.[INDEX].function_call.arguments","typeLabel":"string"}},"uniqueKey":"input_content.messages.items.[INDEX].function_call","typeLabel":"object"}},"uniqueKey":"input_content.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"input_content.messages","typeLabel":"object[]"},"files":{"type":"array","description":"Information about files used in the chat completion","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"input_content.files.items.[INDEX].name","typeLabel":"string"},"used_at":{"type":"string","enum":["variables","messages"],"uniqueKey":"input_content.files.items.[INDEX].used_at","typeLabel":"enum\u003cstring>"},"parsed_content":{"type":"string","uniqueKey":"input_content.files.items.[INDEX].parsed_content","typeLabel":"string"},"url":{"type":"string","uniqueKey":"input_content.files.items.[INDEX].url","typeLabel":"string"},"type":{"type":"string","enum":["image","file"],"uniqueKey":"input_content.files.items.[INDEX].type","typeLabel":"enum\u003cstring>"}},"uniqueKey":"input_content.files.items.[INDEX]","typeLabel":"object"},"uniqueKey":"input_content.files","typeLabel":"object[]"}},"uniqueKey":"input_content","typeLabel":"object"},"output_content":{"type":"object","description":"Contains the output generated by the chat completion","properties":{"role":{"type":"string","enum":["system","user","assistant","function"],"description":"The role of the entity providing the output","uniqueKey":"output_content.role","typeLabel":"enum\u003cstring>"},"tool_calls":{"type":"array","description":"Optional. Information about tool calls made during the completion.","items":{"type":"object","properties":{"name":{"type":"string","uniqueKey":"output_content.tool_calls.items.[INDEX].name","typeLabel":"string"},"arguments":{"type":"string","uniqueKey":"output_content.tool_calls.items.[INDEX].arguments","typeLabel":"string"}},"uniqueKey":"output_content.tool_calls.items.[INDEX]","typeLabel":"object"},"uniqueKey":"output_content.tool_calls","typeLabel":"object[]"},"information":{"type":"object","description":"Optional. Additional information about the completion process.","properties":{"duration":{"type":"number","uniqueKey":"output_content.information.duration","typeLabel":"number"},"cost":{"type":"number","uniqueKey":"output_content.information.cost","typeLabel":"number"},"input_tokens":{"type":"integer","uniqueKey":"output_content.information.input_tokens","typeLabel":"integer"},"output_tokens":{"type":"integer","uniqueKey":"output_content.information.output_tokens","typeLabel":"integer"}},"uniqueKey":"output_content.information","typeLabel":"object"},"has_structured_output":{"type":"boolean","description":"Indicates whether the output has a structured format","uniqueKey":"output_content.has_structured_output","typeLabel":"boolean"},"content":{"type":"object","description":"The main content of the chat completion output","uniqueKey":"output_content.content","typeLabel":"object"},"input_messages":{"type":"string","description":"Optional. The input messages in a string format.","uniqueKey":"output_content.input_messages","typeLabel":"string"}},"uniqueKey":"output_content","typeLabel":"object"},"raw_input":{"oneOf":[{"type":"object","description":"The original input parameters provided for this chat completion","properties":{"version_id":{"type":"string","description":"The ID of the version used for this chat completion","uniqueKey":"raw_input.oneOf.0.version_id","typeLabel":"string"},"canvas_id":{"type":"string","description":"The ID of the canvas used for this chat completion","uniqueKey":"raw_input.oneOf.0.canvas_id","typeLabel":"string"},"application_id":{"type":"string","description":"The ID of the application associated with this chat completion","uniqueKey":"raw_input.oneOf.0.application_id","typeLabel":"string"},"webhook_url":{"type":"string","description":"The URL where webhook notifications are sent","uniqueKey":"raw_input.oneOf.0.webhook_url","typeLabel":"string"},"variables":{"type":"object","description":"The variables to pass to the canvas","additionalProperties":{"oneOf":[{"type":"string","uniqueKey":"raw_input.oneOf.0.variables.additionalProperties.oneOf.0","typeLabel":"string"},{"type":"object","required":["file_url"],"properties":{"file_url":{"type":"string","isRequired":true,"uniqueKey":"raw_input.oneOf.0.variables.additionalProperties.oneOf.1.file_url","typeLabel":"string"},"options":{"type":"object","uniqueKey":"raw_input.oneOf.0.variables.additionalProperties.oneOf.1.options","typeLabel":"object"}},"uniqueKey":"raw_input.oneOf.0.variables.additionalProperties.oneOf.1","typeLabel":"object"}],"uniqueKey":"raw_input.oneOf.0.variables.additionalProperties","typeLabel":"string | object"},"uniqueKey":"raw_input.oneOf.0.variables","typeLabel":"object"},"messages":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["user","assistant"],"isRequired":true,"uniqueKey":"raw_input.oneOf.0.messages.items.[INDEX].role","typeLabel":"enum\u003cstring>"},"content":{"oneOf":[{"type":"string","description":"The content of the message, either as a string or a file","isRequired":true,"uniqueKey":"raw_input.oneOf.0.messages.items.[INDEX].content.oneOf.0","typeLabel":"string"},{"type":"object","description":"The content of the message, either as a string or a file","properties":{"file_url":{"type":"string","description":"The URL of the file","uniqueKey":"raw_input.oneOf.0.messages.items.[INDEX].content.oneOf.1.file_url","typeLabel":"string"}},"isRequired":true,"uniqueKey":"raw_input.oneOf.0.messages.items.[INDEX].content.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"raw_input.oneOf.0.messages.items.[INDEX].content","typeLabel":"string | object"}},"required":["role","content"],"uniqueKey":"raw_input.oneOf.0.messages.items.[INDEX]","typeLabel":"object"},"uniqueKey":"raw_input.oneOf.0.messages","typeLabel":"object[]"},"override":{"type":"object","description":"Override default settings specified in the canvas. This allows for fine-tuning the completion behavior for this specific request.","properties":{"type":{"type":"string","enum":["chat","completion"],"description":"Specifies whether to use a chat or completion model.","isRequired":true,"uniqueKey":"raw_input.oneOf.0.override.type","typeLabel":"enum\u003cstring>"},"model":{"type":"string","description":"The specific model to use for this completion. If not specified, the default model set in the canvas will be used.","uniqueKey":"raw_input.oneOf.0.override.model","typeLabel":"string"},"temperature":{"type":"number","description":"Controls randomness in the output. Values between 0 and 1. Lower values make the output more focused and deterministic.","uniqueKey":"raw_input.oneOf.0.override.temperature","typeLabel":"number"},"functions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"raw_input.oneOf.0.override.functions.items.[INDEX].id","typeLabel":"string"},"name":{"type":"string","uniqueKey":"raw_input.oneOf.0.override.functions.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","uniqueKey":"raw_input.oneOf.0.override.functions.items.[INDEX].description","typeLabel":"string"},"parameters":{"type":"object","properties":{"type":{"type":"string","enum":["object"],"uniqueKey":"raw_input.oneOf.0.override.functions.items.[INDEX].parameters.type","typeLabel":"enum\u003cstring>"},"properties":{"type":"object","additionalProperties":true,"uniqueKey":"raw_input.oneOf.0.override.functions.items.[INDEX].parameters.properties","typeLabel":"object"},"required":{"type":"array","items":{"type":"string","uniqueKey":"raw_input.oneOf.0.override.functions.items.[INDEX].parameters.required.items.[INDEX]","typeLabel":"string"},"uniqueKey":"raw_input.oneOf.0.override.functions.items.[INDEX].parameters.required","typeLabel":"string[]"}},"uniqueKey":"raw_input.oneOf.0.override.functions.items.[INDEX].parameters","typeLabel":"object"}},"uniqueKey":"raw_input.oneOf.0.override.functions.items.[INDEX]","typeLabel":"object"},"description":"An array of functions that the model can call. This allows for more structured and interactive completions.","uniqueKey":"raw_input.oneOf.0.override.functions","typeLabel":"object[]"},"structured_output":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether to enable structured output for this completion.","uniqueKey":"raw_input.oneOf.0.override.structured_output.enabled","typeLabel":"boolean"},"schema":{"type":"object","properties":{"properties":{"type":"object","additionalProperties":true,"description":"Defines the properties of the structured output","uniqueKey":"raw_input.oneOf.0.override.structured_output.schema.properties","typeLabel":"object"},"type":{"type":"string","enum":["object"],"description":"The type of the schema, always \"object\" for structured output","uniqueKey":"raw_input.oneOf.0.override.structured_output.schema.type","typeLabel":"enum\u003cstring>"},"title":{"type":"string","description":"The title of the schema","uniqueKey":"raw_input.oneOf.0.override.structured_output.schema.title","typeLabel":"string"},"description":{"type":"string","description":"A description of the schema","uniqueKey":"raw_input.oneOf.0.override.structured_output.schema.description","typeLabel":"string"},"required":{"type":"array","items":{"type":"string","uniqueKey":"raw_input.oneOf.0.override.structured_output.schema.required.items.[INDEX]","typeLabel":"string"},"description":"An array of required property names","uniqueKey":"raw_input.oneOf.0.override.structured_output.schema.required","typeLabel":"string[]"}},"description":"The schema defining the structure of the output. This is used when structured output is enabled.","uniqueKey":"raw_input.oneOf.0.override.structured_output.schema","typeLabel":"object"}},"description":"Configuration for generating structured output.","uniqueKey":"raw_input.oneOf.0.override.structured_output","typeLabel":"object"}},"required":["type"],"uniqueKey":"raw_input.oneOf.0.override","typeLabel":"object"}},"uniqueKey":"raw_input.oneOf.0","typeLabel":"object"},{"type":"null","description":"The original input parameters provided for this chat completion","properties":{"version_id":{"type":"string","description":"The ID of the version used for this chat completion"},"canvas_id":{"type":"string","description":"The ID of the canvas used for this chat completion"},"application_id":{"type":"string","description":"The ID of the application associated with this chat completion"},"webhook_url":{"type":"string","description":"The URL where webhook notifications are sent"},"variables":{"type":"object","description":"The variables to pass to the canvas","additionalProperties":{"oneOf":[{"type":"string"},{"type":"object","required":["file_url"],"properties":{"file_url":{"type":"string"},"options":{"type":"object"}}}]}},"messages":{"type":"array","items":{"type":"object","properties":{"role":{"type":"string","enum":["user","assistant"]},"content":{"oneOf":[{"type":"string","description":"The content of the message, either as a string or a file"},{"type":"object","description":"The content of the message, either as a string or a file","properties":{"file_url":{"type":"string","description":"The URL of the file"}}}]}},"required":["role","content"]}},"override":{"type":"object","description":"Override default settings specified in the canvas. This allows for fine-tuning the completion behavior for this specific request.","properties":{"model":{"type":"string","description":"The specific model to use for this completion. If not specified, the default model set in the canvas will be used."},"temperature":{"type":"number","description":"Controls randomness in the output. Values between 0 and 1. Lower values make the output more focused and deterministic."},"type":{"type":"string","enum":["chat","completion"],"description":"Specifies whether to use a chat or completion model."},"functions":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"parameters":{"type":"object","properties":{"type":{"type":"string","enum":["object"]},"properties":{"type":"object","additionalProperties":true},"required":{"type":"array","items":{"type":"string"}}}}}},"description":"An array of functions that the model can call. This allows for more structured and interactive completions."},"structured_output":{"type":"object","properties":{"enabled":{"type":"boolean","description":"Whether to enable structured output for this completion."},"schema":{"type":"object","properties":{"properties":{"type":"object","additionalProperties":true,"description":"Defines the properties of the structured output"},"type":{"type":"string","enum":["object"],"description":"The type of the schema, always \"object\" for structured output"},"title":{"type":"string","description":"The title of the schema"},"description":{"type":"string","description":"A description of the schema"},"required":{"type":"array","items":{"type":"string"},"description":"An array of required property names"}},"description":"The schema defining the structure of the output. This is used when structured output is enabled."}},"description":"Configuration for generating structured output."}},"required":["type"]}},"uniqueKey":"raw_input.oneOf.1","typeLabel":"null"}],"uniqueKey":"raw_input","typeLabel":"object | null"},"raw_output":{"type":"object","additionalProperties":true,"description":"The raw output from the chat completion process","uniqueKey":"raw_output","typeLabel":"object"},"compatibility_date":{"type":"string","format":"date-time","description":"The date used for compatibility checks","uniqueKey":"compatibility_date","typeLabel":"string\u003cdate-time>"},"prompt_version_id":{"type":"string","description":"The ID of the prompt version used for this chat completion","uniqueKey":"prompt_version_id","typeLabel":"string"},"prompt_application_id":{"oneOf":[{"type":"string","description":"The ID of the prompt application, if applicable","uniqueKey":"prompt_application_id.oneOf.0","typeLabel":"string"},{"type":"null","description":"The ID of the prompt application, if applicable","uniqueKey":"prompt_application_id.oneOf.1","typeLabel":"null"}],"uniqueKey":"prompt_application_id","typeLabel":"string | null"},"workspace_id":{"type":"string","description":"The ID of the workspace where this chat completion was executed","uniqueKey":"workspace_id","typeLabel":"string"},"created_at":{"type":"string","format":"date-time","description":"The timestamp when this chat completion was created","uniqueKey":"created_at","typeLabel":"string\u003cdate-time>"},"updated_at":{"type":"string","format":"date-time","description":"The timestamp when this chat completion was last updated","uniqueKey":"updated_at","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"","typeLabel":"Chat completion webhook response · object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","status":"created","input_content":{"variables":{},"messages":[{"role":"\u003cstring>","content":"\u003cstring>","function_call":{"name":"\u003cstring>","arguments":"\u003cstring>"}}],"files":[{"name":"\u003cstring>","used_at":"variables","parsed_content":"\u003cstring>","url":"\u003cstring>","type":"image"}]},"output_content":{"role":"system","tool_calls":[{"name":"\u003cstring>","arguments":"\u003cstring>"}],"information":{"duration":123,"cost":123,"input_tokens":123,"output_tokens":123},"has_structured_output":true,"content":{},"input_messages":"\u003cstring>"},"raw_input":{"version_id":"\u003cstring>","canvas_id":"\u003cstring>","application_id":"\u003cstring>","webhook_url":"\u003cstring>","variables":{},"messages":[{"role":"user","content":"\u003cstring>"}],"override":{"type":"chat","model":"\u003cstring>","temperature":123,"functions":[{"id":"\u003cstring>","name":"\u003cstring>","description":"\u003cstring>","parameters":{"type":"object","properties":{},"required":["\u003cstring>"]}}],"structured_output":{"enabled":true,"schema":{"properties":{},"type":"object","title":"\u003cstring>","description":"\u003cstring>","required":["\u003cstring>"]}}}},"raw_output":{},"compatibility_date":"2023-11-07T05:31:56Z","prompt_version_id":"\u003cstring>","prompt_application_id":"\u003cstring>","workspace_id":"\u003cstring>","created_at":"2023-11-07T05:31:56Z","updated_at":"2023-11-07T05:31:56Z"}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{},"servers":{"f8c8ecf7-c25f-4e5a-8e20-c44514cb2cac":{"url":"https://api.tela.com"}}},"originalFileLocation":"api-reference/openapi.yml"},"subdomain":"meistrari","siteName":"Tela","title":"Retrieve Canvas Run - Tela","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/completion/get","matchLevel":0},"pt-BR":{"href":"/api-reference/completion/get","matchLevel":0}}},"lastModified":"2025-10-17T15:09:32.609Z","originalFileLocation":"api-reference/completion/get.mdx","locale":"en"},"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=\"Retrieve the status and details of an asynchronous chat completion using its unique identifier, enabling efficient polling and status monitoring.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Tela\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/meistrari/iDbVYACJhr5G8i3-/_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/meistrari/iDbVYACJhr5G8i3-/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/meistrari/iDbVYACJhr5G8i3-/_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/meistrari/iDbVYACJhr5G8i3-/_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/meistrari/iDbVYACJhr5G8i3-/_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/meistrari/iDbVYACJhr5G8i3-/_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/meistrari/iDbVYACJhr5G8i3-/_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/meistrari/iDbVYACJhr5G8i3-/_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/meistrari/iDbVYACJhr5G8i3-/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Retrieve Canvas Run - Tela\">\u003cmeta data-mint-head property=\"og:description\" content=\"Retrieve the status and details of an asynchronous chat completion using its unique identifier, enabling efficient polling and status monitoring.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Tela\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.tela.com/api-reference/completion/get\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://meistrari.mintlify.site/_mintlify/api/og/v2?division=Completions\u0026amp;title=Retrieve+Canvas+Run\u0026amp;description=Retrieve+the+status+and+details+of+an+asynchronous+chat+completion+using+its+unique+identifier%2C+enabling+efficient+polling+and+status+monitoring.\u0026amp;theme=9e774641ea1764eceaf3a9a9\u0026amp;signature=61c875fd5e4af9cbae7fff36c0c2fd8af624f9a60dbfaeee38346c8101a07648\">\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=\"Retrieve Canvas Run - Tela\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Retrieve the status and details of an asynchronous chat completion using its unique identifier, enabling efficient polling and status monitoring.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://meistrari.mintlify.site/_mintlify/api/og/v2?division=Completions\u0026amp;title=Retrieve+Canvas+Run\u0026amp;description=Retrieve+the+status+and+details+of+an+asynchronous+chat+completion+using+its+unique+identifier%2C+enabling+efficient+polling+and+status+monitoring.\u0026amp;theme=9e774641ea1764eceaf3a9a9\u0026amp;signature=61c875fd5e4af9cbae7fff36c0c2fd8af624f9a60dbfaeee38346c8101a07648\">\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/meistrari/iDbVYACJhr5G8i3-/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Tela\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#171717\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.tela.com/api-reference/completion/get\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/completion/get.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.tela.com/#organization\",\"name\":\"Tela\",\"url\":\"https://docs.tela.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/meistrari/pblu7JGV78zF0-_0/logo/tela-docs-logo-light.svg?fit=max\u0026auto=format\u0026n=pblu7JGV78zF0-_0\u0026q=85\u0026s=2203db70c6af3499a392576fba857701\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.tela.com#website\",\"name\":\"Tela\",\"url\":\"https://docs.tela.com\",\"publisher\":{\"@id\":\"https://docs.tela.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.tela.com/api-reference/completion/get#webpage\",\"url\":\"https://docs.tela.com/api-reference/completion/get\",\"name\":\"Retrieve Canvas Run\",\"description\":\"Retrieve the status and details of an asynchronous chat completion using its unique identifier, enabling efficient polling and status monitoring.\",\"dateModified\":\"2025-10-17T15:09:32.609Z\",\"isPartOf\":{\"@id\":\"https://docs.tela.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.tela.com/api-reference/completion/get#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.tela.com/api-reference/completion/get#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Completions\",\"item\":\"https://docs.tela.com/api-reference/completion/create\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Retrieve Canvas Run\",\"item\":\"https://docs.tela.com/api-reference/completion/get\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.tela.com/api-reference/completion/get#apireference\",\"headline\":\"Retrieve Canvas Run\",\"name\":\"Retrieve Canvas Run\",\"description\":\"Retrieve the status and details of an asynchronous chat completion using its unique identifier, enabling efficient polling and status monitoring.\",\"url\":\"https://docs.tela.com/api-reference/completion/get\",\"mainEntityOfPage\":{\"@id\":\"https://docs.tela.com/api-reference/completion/get#webpage\"},\"dateModified\":\"2025-10-17T15:09:32.609Z\",\"publisher\":{\"@id\":\"https://docs.tela.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.tela.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Tela\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Tela\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/completion/get.md","siteName":"Tela","nav":{"global":null,"languages":[{"language":"en","default":true,"tabs":[{"tab":"Documentation","pages":[{"title":"Documentation","href":"/en/welcome"}]},{"tab":"API Reference","groups":[{"group":"Introduction","pages":[{"title":"Introduction","icon":"book-open","href":"/api-reference/introduction"}]},{"group":"Completions","pages":[{"title":"Run Canvas","description":"Executes a canvas","openapi":"POST /v2/chat/completions","href":"/api-reference/completion/create"},{"title":"Retrieve Canvas Run","openapi":"GET /v2/chat/completions/{id}","href":"/api-reference/completion/get"},{"title":"List completion runs","description":"Returns a paginated list of completion runs in the authenticated workspace, most recently updated first (`updatedAt` desc, then `id` desc). Rows are returned with camelCase keys (unlike the snake_case webhook payload).","openapi":"GET /v1/completion-run","href":"/api-reference/completion-run/get-v1-completion-run"}]},{"group":"Files","pages":[{"title":"Upload a File","openapi":"POST /v2/file","href":"/api-reference/file/create"},{"title":"Upload a File (v3)","openapi":"POST /v3/files","href":"/api-reference/file/upload"}]},{"group":"Canvases","pages":[{"title":"List canvases","openapi":"GET /prompt","href":"/api-reference/canvas/get-prompt"},{"title":"Get a canvas","openapi":"GET /prompt/{id}","href":"/api-reference/canvas/get-prompt-id"}]},{"group":"Versions","pages":[{"title":"List Prompt Versions","openapi":"GET /prompt-version","href":"/api-reference/prompt-version/get"},{"title":"Create Prompt Version","openapi":"POST /prompt-version","href":"/api-reference/prompt-version/create"},{"title":"Get Prompt Version","openapi":"GET /prompt-version/{id}","href":"/api-reference/prompt-version/get-by-id"},{"title":"Update Prompt Version","openapi":"PATCH /prompt-version/{id}","href":"/api-reference/prompt-version/update"},{"title":"Delete Prompt Version","openapi":"DELETE /prompt-version/{id}","href":"/api-reference/prompt-version/delete"},{"title":"Get the latest version of a canvas","openapi":"GET /prompt/{id}/latest-version","href":"/api-reference/prompt-version/get-prompt-id-latest-version"},{"title":"Get the promoted (production) version of a canvas","openapi":"GET /prompt/{id}/promoted-version","href":"/api-reference/prompt-version/get-prompt-id-promoted-version"},{"title":"List version history of a canvas","openapi":"GET /prompt-version/history","href":"/api-reference/prompt-version/get-prompt-version-history"},{"title":"Get the version index map of a canvas","openapi":"GET /prompt-version/index-map","href":"/api-reference/prompt-version/get-prompt-version-index-map"}]},{"group":"Version messages","pages":[{"title":"List messages of a prompt version","openapi":"GET /prompt-version-message","href":"/api-reference/prompt-version-message/get-prompt-version-message"},{"title":"Create a prompt version message","openapi":"POST /prompt-version-message","href":"/api-reference/prompt-version-message/post-prompt-version-message"},{"title":"Get a prompt version message","openapi":"GET /prompt-version-message/{id}","href":"/api-reference/prompt-version-message/get-prompt-version-message-id"},{"title":"Update a prompt version message","openapi":"PATCH /prompt-version-message/{id}","href":"/api-reference/prompt-version-message/patch-prompt-version-message-id"},{"title":"Delete a prompt version message","openapi":"DELETE /prompt-version-message/{id}","href":"/api-reference/prompt-version-message/delete-prompt-version-message-id"}]},{"group":"Environments","pages":[{"title":"List environments","openapi":"GET /environment","href":"/api-reference/environment/get-environment"},{"title":"Create environment","openapi":"POST /environment","href":"/api-reference/environment/post-environment"},{"title":"List environment publication history","openapi":"GET /environment/versions","href":"/api-reference/environment/get-environment-versions"},{"title":"Get the version published to an environment","openapi":"GET /environment/version","href":"/api-reference/environment/get-environment-version"},{"title":"Publish a version to an environment","openapi":"POST /environment/publish-by-name","href":"/api-reference/environment/post-environment-publish-by-name"},{"title":"Delete environment","openapi":"DELETE /environment/{id}","href":"/api-reference/environment/delete-environment-id"}]},{"group":"Test cases","pages":[{"title":"Retrieve Test Cases","openapi":"GET /test-case","href":"/api-reference/test-case/get"},{"title":"Create Test Cases","openapi":"POST /test-case","href":"/api-reference/test-case/create"},{"title":"Get Test Case by ID","openapi":"GET /test-case/{id}","href":"/api-reference/test-case/get-by-id"},{"title":"Update Test Case","openapi":"PATCH /test-case/{id}","href":"/api-reference/test-case/update"},{"title":"Delete Test Case","openapi":"DELETE /test-case/{id}","href":"/api-reference/test-case/delete"},{"title":"Run a test case","openapi":"POST /test-case/{id}/run","href":"/api-reference/test-case/post-test-case-id-run"},{"title":"Run many test cases","openapi":"POST /test-case/run-all","href":"/api-reference/test-case/post-test-case-run-all"},{"title":"Abort a running test case","openapi":"POST /test-case/{id}/abort","href":"/api-reference/test-case/post-test-case-id-abort"}]},{"group":"Test case tags","pages":[{"title":"Add tags to many test cases","openapi":"POST /test-case/bulk-add-tags","href":"/api-reference/test-case-tag/post-test-case-bulk-add-tags"},{"title":"Remove tags from many test cases","openapi":"POST /test-case/bulk-remove-tags","href":"/api-reference/test-case-tag/post-test-case-bulk-remove-tags"},{"title":"List tags of a test case","openapi":"GET /test-case/{id}/tags","href":"/api-reference/test-case-tag/get-test-case-id-tags"},{"title":"Assign tags to a test case","openapi":"POST /test-case/{id}/tags","href":"/api-reference/test-case-tag/post-test-case-id-tags"},{"title":"Remove a tag from a test case","openapi":"DELETE /test-case/{id}/tags/{tagId}","href":"/api-reference/test-case-tag/delete-test-case-id-tags-tagid"},{"title":"List test case tags of a canvas","openapi":"GET /test-case-tags","href":"/api-reference/test-case-tag/get-test-case-tags"},{"title":"Create a test case tag","openapi":"POST /test-case-tags","href":"/api-reference/test-case-tag/post-test-case-tags"},{"title":"Update a test case tag","openapi":"PATCH /test-case-tags/{id}","href":"/api-reference/test-case-tag/patch-test-case-tags-id"},{"title":"Delete a test case tag","openapi":"DELETE /test-case-tags/{id}","href":"/api-reference/test-case-tag/delete-test-case-tags-id"}]},{"group":"Tasks","pages":[{"title":"Query Tasks","openapi":"POST /task/query","href":"/api-reference/task/query"},{"title":"List tasks","openapi":"GET /task","href":"/api-reference/task/get-task"},{"title":"Create tasks","openapi":"POST /task","href":"/api-reference/task/post-task"},{"title":"Get a task","openapi":"GET /task/{id}","href":"/api-reference/task/get-task-id"},{"title":"Update a task","openapi":"PATCH /task/{id}","href":"/api-reference/task/patch-task-id"},{"title":"Delete a task","openapi":"DELETE /task/{id}","href":"/api-reference/task/delete-task-id"},{"title":"Create a task export job","openapi":"POST /task/export-job","href":"/api-reference/task/post-task-export-job"},{"title":"Get an export job","openapi":"GET /task/export-job/{id}","href":"/api-reference/task/get-task-export-job-id"},{"title":"Get an export download URL","openapi":"GET /task/export-job/{id}/download","href":"/api-reference/task/get-task-export-job-id-download"}]},{"group":"Workstation Events","pages":[{"title":"Create webhook subscription","openapi":"POST /prompt-application/{id}/webhooks","href":"/api-reference/webhook/post-prompt-application-id-webhooks"},{"title":"List webhook subscriptions","openapi":"GET /prompt-application/{id}/webhooks","href":"/api-reference/webhook/get-prompt-application-id-webhooks"},{"title":"List webhook deliveries of an application","openapi":"GET /prompt-application/{id}/webhook-deliveries","href":"/api-reference/webhook/get-prompt-application-id-webhook-deliveries"},{"title":"Get webhook subscription","openapi":"GET /webhook/{webhookId}","href":"/api-reference/webhook/get-webhook-webhookid"},{"title":"Update webhook subscription","openapi":"PATCH /webhook/{webhookId}","href":"/api-reference/webhook/patch-webhook-webhookid"},{"title":"Delete webhook subscription","openapi":"DELETE /webhook/{webhookId}","href":"/api-reference/webhook/delete-webhook-webhookid"},{"title":"Send a test event to a webhook","openapi":"POST /webhook/{webhookId}/test","href":"/api-reference/webhook/post-webhook-webhookid-test"},{"title":"Send a test event to an arbitrary URL","openapi":"POST /webhook/test-url","href":"/api-reference/webhook/post-webhook-test-url"},{"title":"List deliveries of a webhook","openapi":"GET /webhook/{webhookId}/deliveries","href":"/api-reference/webhook/get-webhook-webhookid-deliveries"},{"title":"Resend a webhook delivery","openapi":"POST /webhook-delivery/{deliveryId}/resend","href":"/api-reference/webhook/post-webhook-delivery-deliveryid-resend"}]},{"group":"Workflow runs","pages":[{"title":"List workflow runs","openapi":"GET /workflow/runs","href":"/api-reference/workflow-run/get-workflow-runs"},{"title":"Get a workflow run","openapi":"GET /workflow/runs/{id}","href":"/api-reference/workflow-run/get-workflow-runs-id"},{"title":"Cancel a workflow run","openapi":"POST /workflow/runs/{id}/cancel","href":"/api-reference/workflow-run/post-workflow-runs-id-cancel"}]}]}]},{"language":"pt-BR","tabs":[{"tab":"Documentação","pages":[{"title":"Documentação","href":"/pt/welcome"}]},{"tab":"Referência de API","groups":[{"group":"Introdução","pages":[{"title":"Introduction","icon":"book-open","href":"/api-reference/introduction"}]},{"group":"Completions","pages":[{"title":"Run Canvas","description":"Executes a canvas","openapi":"POST /v2/chat/completions","href":"/api-reference/completion/create"},{"title":"Retrieve Canvas Run","openapi":"GET /v2/chat/completions/{id}","href":"/api-reference/completion/get"},{"title":"List completion runs","description":"Returns a paginated list of completion runs in the authenticated workspace, most recently updated first (`updatedAt` desc, then `id` desc). Rows are returned with camelCase keys (unlike the snake_case webhook payload).","openapi":"GET /v1/completion-run","href":"/api-reference/completion-run/get-v1-completion-run"}]},{"group":"Arquivos","pages":[{"title":"Upload a File","openapi":"POST /v2/file","href":"/api-reference/file/create"},{"title":"Upload a File (v3)","openapi":"POST /v3/files","href":"/api-reference/file/upload"}]},{"group":"Canvases","pages":[{"title":"List canvases","openapi":"GET /prompt","href":"/api-reference/canvas/get-prompt"},{"title":"Get a canvas","openapi":"GET /prompt/{id}","href":"/api-reference/canvas/get-prompt-id"}]},{"group":"Versões","pages":[{"title":"List Prompt Versions","openapi":"GET /prompt-version","href":"/api-reference/prompt-version/get"},{"title":"Create Prompt Version","openapi":"POST /prompt-version","href":"/api-reference/prompt-version/create"},{"title":"Get Prompt Version","openapi":"GET /prompt-version/{id}","href":"/api-reference/prompt-version/get-by-id"},{"title":"Update Prompt Version","openapi":"PATCH /prompt-version/{id}","href":"/api-reference/prompt-version/update"},{"title":"Delete Prompt Version","openapi":"DELETE /prompt-version/{id}","href":"/api-reference/prompt-version/delete"},{"title":"Get the latest version of a canvas","openapi":"GET /prompt/{id}/latest-version","href":"/api-reference/prompt-version/get-prompt-id-latest-version"},{"title":"Get the promoted (production) version of a canvas","openapi":"GET /prompt/{id}/promoted-version","href":"/api-reference/prompt-version/get-prompt-id-promoted-version"},{"title":"List version history of a canvas","openapi":"GET /prompt-version/history","href":"/api-reference/prompt-version/get-prompt-version-history"},{"title":"Get the version index map of a canvas","openapi":"GET /prompt-version/index-map","href":"/api-reference/prompt-version/get-prompt-version-index-map"}]},{"group":"Mensagens de versão","pages":[{"title":"List messages of a prompt version","openapi":"GET /prompt-version-message","href":"/api-reference/prompt-version-message/get-prompt-version-message"},{"title":"Create a prompt version message","openapi":"POST /prompt-version-message","href":"/api-reference/prompt-version-message/post-prompt-version-message"},{"title":"Get a prompt version message","openapi":"GET /prompt-version-message/{id}","href":"/api-reference/prompt-version-message/get-prompt-version-message-id"},{"title":"Update a prompt version message","openapi":"PATCH /prompt-version-message/{id}","href":"/api-reference/prompt-version-message/patch-prompt-version-message-id"},{"title":"Delete a prompt version message","openapi":"DELETE /prompt-version-message/{id}","href":"/api-reference/prompt-version-message/delete-prompt-version-message-id"}]},{"group":"Ambientes","pages":[{"title":"List environments","openapi":"GET /environment","href":"/api-reference/environment/get-environment"},{"title":"Create environment","openapi":"POST /environment","href":"/api-reference/environment/post-environment"},{"title":"List environment publication history","openapi":"GET /environment/versions","href":"/api-reference/environment/get-environment-versions"},{"title":"Get the version published to an environment","openapi":"GET /environment/version","href":"/api-reference/environment/get-environment-version"},{"title":"Publish a version to an environment","openapi":"POST /environment/publish-by-name","href":"/api-reference/environment/post-environment-publish-by-name"},{"title":"Delete environment","openapi":"DELETE /environment/{id}","href":"/api-reference/environment/delete-environment-id"}]},{"group":"Casos de teste","pages":[{"title":"Retrieve Test Cases","openapi":"GET /test-case","href":"/api-reference/test-case/get"},{"title":"Create Test Cases","openapi":"POST /test-case","href":"/api-reference/test-case/create"},{"title":"Get Test Case by ID","openapi":"GET /test-case/{id}","href":"/api-reference/test-case/get-by-id"},{"title":"Update Test Case","openapi":"PATCH /test-case/{id}","href":"/api-reference/test-case/update"},{"title":"Delete Test Case","openapi":"DELETE /test-case/{id}","href":"/api-reference/test-case/delete"},{"title":"Run a test case","openapi":"POST /test-case/{id}/run","href":"/api-reference/test-case/post-test-case-id-run"},{"title":"Run many test cases","openapi":"POST /test-case/run-all","href":"/api-reference/test-case/post-test-case-run-all"},{"title":"Abort a running test case","openapi":"POST /test-case/{id}/abort","href":"/api-reference/test-case/post-test-case-id-abort"}]},{"group":"Tags de casos de teste","pages":[{"title":"Add tags to many test cases","openapi":"POST /test-case/bulk-add-tags","href":"/api-reference/test-case-tag/post-test-case-bulk-add-tags"},{"title":"Remove tags from many test cases","openapi":"POST /test-case/bulk-remove-tags","href":"/api-reference/test-case-tag/post-test-case-bulk-remove-tags"},{"title":"List tags of a test case","openapi":"GET /test-case/{id}/tags","href":"/api-reference/test-case-tag/get-test-case-id-tags"},{"title":"Assign tags to a test case","openapi":"POST /test-case/{id}/tags","href":"/api-reference/test-case-tag/post-test-case-id-tags"},{"title":"Remove a tag from a test case","openapi":"DELETE /test-case/{id}/tags/{tagId}","href":"/api-reference/test-case-tag/delete-test-case-id-tags-tagid"},{"title":"List test case tags of a canvas","openapi":"GET /test-case-tags","href":"/api-reference/test-case-tag/get-test-case-tags"},{"title":"Create a test case tag","openapi":"POST /test-case-tags","href":"/api-reference/test-case-tag/post-test-case-tags"},{"title":"Update a test case tag","openapi":"PATCH /test-case-tags/{id}","href":"/api-reference/test-case-tag/patch-test-case-tags-id"},{"title":"Delete a test case tag","openapi":"DELETE /test-case-tags/{id}","href":"/api-reference/test-case-tag/delete-test-case-tags-id"}]},{"group":"Tarefas","pages":[{"title":"Query Tasks","openapi":"POST /task/query","href":"/api-reference/task/query"},{"title":"List tasks","openapi":"GET /task","href":"/api-reference/task/get-task"},{"title":"Create tasks","openapi":"POST /task","href":"/api-reference/task/post-task"},{"title":"Get a task","openapi":"GET /task/{id}","href":"/api-reference/task/get-task-id"},{"title":"Update a task","openapi":"PATCH /task/{id}","href":"/api-reference/task/patch-task-id"},{"title":"Delete a task","openapi":"DELETE /task/{id}","href":"/api-reference/task/delete-task-id"},{"title":"Create a task export job","openapi":"POST /task/export-job","href":"/api-reference/task/post-task-export-job"},{"title":"Get an export job","openapi":"GET /task/export-job/{id}","href":"/api-reference/task/get-task-export-job-id"},{"title":"Get an export download URL","openapi":"GET /task/export-job/{id}/download","href":"/api-reference/task/get-task-export-job-id-download"}]},{"group":"Eventos da Workstation","pages":[{"title":"Create webhook subscription","openapi":"POST /prompt-application/{id}/webhooks","href":"/api-reference/webhook/post-prompt-application-id-webhooks"},{"title":"List webhook subscriptions","openapi":"GET /prompt-application/{id}/webhooks","href":"/api-reference/webhook/get-prompt-application-id-webhooks"},{"title":"List webhook deliveries of an application","openapi":"GET /prompt-application/{id}/webhook-deliveries","href":"/api-reference/webhook/get-prompt-application-id-webhook-deliveries"},{"title":"Get webhook subscription","openapi":"GET /webhook/{webhookId}","href":"/api-reference/webhook/get-webhook-webhookid"},{"title":"Update webhook subscription","openapi":"PATCH /webhook/{webhookId}","href":"/api-reference/webhook/patch-webhook-webhookid"},{"title":"Delete webhook subscription","openapi":"DELETE /webhook/{webhookId}","href":"/api-reference/webhook/delete-webhook-webhookid"},{"title":"Send a test event to a webhook","openapi":"POST /webhook/{webhookId}/test","href":"/api-reference/webhook/post-webhook-webhookid-test"},{"title":"Send a test event to an arbitrary URL","openapi":"POST /webhook/test-url","href":"/api-reference/webhook/post-webhook-test-url"},{"title":"List deliveries of a webhook","openapi":"GET /webhook/{webhookId}/deliveries","href":"/api-reference/webhook/get-webhook-webhookid-deliveries"},{"title":"Resend a webhook delivery","openapi":"POST /webhook-delivery/{deliveryId}/resend","href":"/api-reference/webhook/post-webhook-delivery-deliveryid-resend"}]},{"group":"Execuções de workflow","pages":[{"title":"List workflow runs","openapi":"GET /workflow/runs","href":"/api-reference/workflow-run/get-workflow-runs"},{"title":"Get a workflow run","openapi":"GET /workflow/runs/{id}","href":"/api-reference/workflow-run/get-workflow-runs-id"},{"title":"Cancel a workflow run","openapi":"POST /workflow/runs/{id}/cancel","href":"/api-reference/workflow-run/post-workflow-runs-id-cancel"}]}]}]}]},"basePath":"","title":"Retrieve Canvas Run - Tela","buildId":"dpl_8hoxaqFTU7hTr6A2fUraxAyjuiZo","deploymentId":"dpl_8hoxaqFTU7hTr6A2fUraxAyjuiZo","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-CDiBsYGW.js","utils-KF9rPlmF.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C26urKTX.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BdjmJAC1.js","snippetPresets-3IpDBjt3.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-D4x_2vvo.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BIWdc5Pa.js","shallow-LQqfiMNd.js","getApiPlaygroundDisplay-DryzlOZG.js","CodeSnippet-tcJujU4r.js","CodeSnippets-BHp0nVLL.js","Page-1CZdsdAn.js","getPastedJson-DU-1ayUv.js","icon-CZK2hPr4.js","MethodPill-DOaqmTFC.js","DuplicateIcon-B5-nUxxl.js","createIcon-CDP_U77G.js","DynamicMarkdown-GHvayGOn.js","SectionHeading-BYvpkmUD.js","axios-vUo_bRtp.js","Markdown-uxhlayGT.js","clsx-B35qUV0p.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-BvrGG8gU.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CAf0yVYe.js"]}