Type of resource the environment belongs to. Only prompt (a canvas) is supported.
Resource type an environment is attached to. Only canvases (prompt) are supported today.
Environment name. Lowercase letters, digits and single hyphens between segments (no leading, trailing
or consecutive hyphens), at most 64 characters. Leading/trailing whitespace is trimmed before validation.
production is the system environment every canvas has; it is the only reserved name you can publish to.
The names production, promoted, latest and draft are reserved and cannot be used for custom
environments, and a custom name cannot be a UUID.
The same rules apply to the environment_name field of POST /v2/chat/completions, which runs the
version currently published to that environment of the given canvas_id (environment_name cannot be
combined with version_id or application_id, and returns 404 when the environment does not exist or
has no published version).
The publication record that is currently active for the environment.
Show child attributes
{"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":""},"chroma":{"liveDeploymentHistoryId":"6ae399c78fc5c9e41494669d","collectionId":"dc3ad1bf-097f-46e6-8ca4-0afa1e3e89ee","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae399c78fc5c9e41494669d"},"entitlements":{},"buildId":"6ae399c78fc5c9e41494669d","clientVersion":"0.0.4071","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":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","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":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"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/environment/get-environment","slug":"/api-reference/environment/get-environment","pageMetadata":{"title":"List environments","description":"Returns every environment of a canvas (prompt), ordered with `production` first and the remaining environments alphabetically.","openapi":"GET /environment","href":"/api-reference/environment/get-environment"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Returns every environment of a canvas (prompt), ordered with \", _jsx(_components.code, {\n children: \"production\"\n }), \" first and the remaining environments alphabetically.\"]\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":"List environments","description":"Returns every environment of a canvas (prompt), ordered with `production` first and the remaining environments alphabetically.","openapi":"GET /environment","href":"/api-reference/environment/get-environment"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/meistrari/7fb0cf41bd7567c7/scripts/code-samples/chat/completions/v2/example.js"],"openApiReferenceData":{"operation":{"operationId":"listEnvironments","summary":"List environments","description":"Returns every environment of a canvas (prompt), ordered with `production` first and the remaining environments alphabetically.","tags":["Environment"],"security":["1d2333f8-85d0-44d3-ac96-e31a09f4e6a3"],"parameters":["5b63aaa3-9f5d-48f8-9692-36e5ef6a8f9b","a8969e3f-b0b8-4752-bc10-fc536c86bffb"],"responses":{"200":"46f4f04c-5f8e-4587-94f2-8261b1dfcb23","400":"1c787c1a-20ae-4902-834c-de679349831d","401":"de3f0e40-1230-4061-bfab-831c1250559c","403":"211643c0-5b5b-4d5a-b5c6-bae25b0b0e9a","404":"16d04126-818e-46ef-8750-aeb63b170187","422":"33aa2bf0-2c15-47bc-b1e1-d96d6cd52fd6"},"method":"get","type":"path","servers":["f8c8ecf7-c25f-4e5a-8e20-c44514cb2cac"],"path":"/environment","baseUrlOptions":["https://api.tela.com"],"title":"List environments","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"5b63aaa3-9f5d-48f8-9692-36e5ef6a8f9b":{"name":"resourceType","in":"query","required":true,"description":"Type of resource the environment belongs to. Only `prompt` (a canvas) is supported.","schema":{"type":"string","enum":["prompt"],"description":"Type of resource the environment belongs to. Only `prompt` (a canvas) is supported.\nResource type an environment is attached to. Only canvases (`prompt`) are supported today.","isRequired":true,"uniqueKey":"","typeLabel":"enum\u003cstring>"}},"a8969e3f-b0b8-4752-bc10-fc536c86bffb":{"name":"resourceId","in":"query","required":true,"description":"Canvas (prompt) ID.","schema":{"type":"string","format":"uuid","isRequired":true,"description":"Canvas (prompt) ID.","uniqueKey":"","typeLabel":"string\u003cuuid>"}}},"responses":{"46f4f04c-5f8e-4587-94f2-8261b1dfcb23":{"description":"Environments of the canvas","content":{"application/json":{"schema":{"type":"array","items":{"type":"object","description":"An environment of a canvas. Timestamps are ISO 8601 strings.","required":["currentVersion","activePublication","id","resourceType","resourceId","name","isSystem","currentVersionId","workspaceId","createdBy","deletedBy","createdAt","updatedAt","deletedAt"],"example":{"id":"0a3f6c2e-9d1b-4c7a-b5e8-2f4d6a8c0e1b","resourceType":"prompt","resourceId":"95cec438-6080-44fe-8275-28b16bd40178","name":"production","isSystem":true,"currentVersionId":"76065caa-c519-441a-8fe2-cc43e29664ab","workspaceId":"3f55cfd9-4427-4887-a181-d9ad39967802","createdBy":"jane@example.com","deletedBy":null,"createdAt":"2025-05-20T09:30:00.000Z","updatedAt":"2025-06-02T15:45:10.000Z","deletedAt":null,"currentVersion":{"id":"76065caa-c519-441a-8fe2-cc43e29664ab","title":"Contract analysis v3","promptId":"95cec438-6080-44fe-8275-28b16bd40178","draft":false,"promoted":true,"createdAt":"2025-06-02T15:40:00.000Z","updatedAt":"2025-06-02T15:45:10.000Z","createdBy":"jane@example.com","updatedBy":"jane@example.com","versionIndex":3},"activePublication":{"publishedAt":"2025-06-02T15:45:10.000Z","publishedBy":"jane@example.com"}},"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"items.[INDEX].id","typeLabel":"string\u003cuuid>"},"resourceType":{"type":"string","enum":["prompt"],"description":"Resource type an environment is attached to. Only canvases (`prompt`) are supported today.","isRequired":true,"uniqueKey":"items.[INDEX].resourceType","typeLabel":"enum\u003cstring>"},"resourceId":{"type":"string","format":"uuid","description":"Canvas (prompt) ID","isRequired":true,"uniqueKey":"items.[INDEX].resourceId","typeLabel":"string\u003cuuid>"},"name":{"type":"string","pattern":"^[a-z0-9]+(?:-[a-z0-9]+)*$","maxLength":64,"description":"Environment name. Lowercase letters, digits and single hyphens between segments (no leading, trailing\nor consecutive hyphens), at most 64 characters. Leading/trailing whitespace is trimmed before validation.\n\n`production` is the system environment every canvas has; it is the only reserved name you can publish to.\nThe names `production`, `promoted`, `latest` and `draft` are reserved and cannot be used for custom\nenvironments, and a custom name cannot be a UUID.\n\nThe same rules apply to the `environment_name` field of `POST /v2/chat/completions`, which runs the\nversion currently published to that environment of the given `canvas_id` (`environment_name` cannot be\ncombined with `version_id` or `application_id`, and returns `404` when the environment does not exist or\nhas no published version).\n","example":"staging","isRequired":true,"uniqueKey":"items.[INDEX].name","typeLabel":"string"},"isSystem":{"type":"boolean","description":"`true` for the built-in `production` environment, which cannot be deleted.","isRequired":true,"uniqueKey":"items.[INDEX].isSystem","typeLabel":"boolean"},"currentVersionId":{"oneOf":[{"type":"string","format":"uuid","description":"Version currently published to the environment, or `null` when nothing was published.","isRequired":true,"uniqueKey":"items.[INDEX].currentVersionId.oneOf.0","typeLabel":"string\u003cuuid>"},{"type":"null","format":"uuid","description":"Version currently published to the environment, or `null` when nothing was published.","isRequired":true,"uniqueKey":"items.[INDEX].currentVersionId.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].currentVersionId","typeLabel":"string\u003cuuid> | null"},"workspaceId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"items.[INDEX].workspaceId","typeLabel":"string\u003cuuid>"},"createdBy":{"type":"string","description":"Email of the user or key that created the environment.","isRequired":true,"uniqueKey":"items.[INDEX].createdBy","typeLabel":"string"},"deletedBy":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].deletedBy.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"items.[INDEX].deletedBy.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].deletedBy","typeLabel":"string | null"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"items.[INDEX].createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"items.[INDEX].updatedAt","typeLabel":"string\u003cdate-time>"},"deletedAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"items.[INDEX].deletedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"items.[INDEX].deletedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].deletedAt","typeLabel":"string\u003cdate-time> | null"},"currentVersion":{"oneOf":[{"type":"object","description":"Summary of the version currently published to an environment.","required":["id","title","promptId","draft","promoted","createdAt","updatedAt","createdBy","updatedBy"],"properties":{"id":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"items.[INDEX].currentVersion.oneOf.0.id","typeLabel":"string\u003cuuid>"},"title":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].currentVersion.oneOf.0.title","typeLabel":"string"},"promptId":{"type":"string","format":"uuid","isRequired":true,"uniqueKey":"items.[INDEX].currentVersion.oneOf.0.promptId","typeLabel":"string\u003cuuid>"},"draft":{"oneOf":[{"type":"boolean","isRequired":true,"uniqueKey":"items.[INDEX].currentVersion.oneOf.0.draft.oneOf.0","typeLabel":"boolean"},{"type":"null","isRequired":true,"uniqueKey":"items.[INDEX].currentVersion.oneOf.0.draft.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].currentVersion.oneOf.0.draft","typeLabel":"boolean | null"},"promoted":{"oneOf":[{"type":"boolean","isRequired":true,"uniqueKey":"items.[INDEX].currentVersion.oneOf.0.promoted.oneOf.0","typeLabel":"boolean"},{"type":"null","isRequired":true,"uniqueKey":"items.[INDEX].currentVersion.oneOf.0.promoted.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].currentVersion.oneOf.0.promoted","typeLabel":"boolean | null"},"createdAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"items.[INDEX].currentVersion.oneOf.0.createdAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"items.[INDEX].currentVersion.oneOf.0.createdAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].currentVersion.oneOf.0.createdAt","typeLabel":"string\u003cdate-time> | null"},"updatedAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"items.[INDEX].currentVersion.oneOf.0.updatedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","format":"date-time","isRequired":true,"uniqueKey":"items.[INDEX].currentVersion.oneOf.0.updatedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].currentVersion.oneOf.0.updatedAt","typeLabel":"string\u003cdate-time> | null"},"createdBy":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].currentVersion.oneOf.0.createdBy","typeLabel":"string"},"updatedBy":{"type":"string","isRequired":true,"uniqueKey":"items.[INDEX].currentVersion.oneOf.0.updatedBy","typeLabel":"string"},"versionIndex":{"type":"integer","description":"1-based position of the version in the canvas history (1 is the oldest). Omitted when it cannot be computed.","uniqueKey":"items.[INDEX].currentVersion.oneOf.0.versionIndex","typeLabel":"integer"}},"isRequired":true,"uniqueKey":"items.[INDEX].currentVersion.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"items.[INDEX].currentVersion.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].currentVersion","typeLabel":"object | null"},"activePublication":{"oneOf":[{"type":"object","description":"The publication record that is currently active for the environment.","required":["publishedAt","publishedBy"],"properties":{"publishedAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"items.[INDEX].activePublication.oneOf.0.publishedAt","typeLabel":"string\u003cdate-time>"},"publishedBy":{"type":"string","description":"Email of the user or key that published the version.","isRequired":true,"uniqueKey":"items.[INDEX].activePublication.oneOf.0.publishedBy","typeLabel":"string"}},"isRequired":true,"uniqueKey":"items.[INDEX].activePublication.oneOf.0","typeLabel":"object"},{"type":"null","isRequired":true,"uniqueKey":"items.[INDEX].activePublication.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"items.[INDEX].activePublication","typeLabel":"object | null"}},"uniqueKey":"items.[INDEX]","typeLabel":"object"},"uniqueKey":"","typeLabel":"object[]"},"examples":{"Example":{"title":"Example","value":[{"id":"0a3f6c2e-9d1b-4c7a-b5e8-2f4d6a8c0e1b","resourceType":"prompt","resourceId":"95cec438-6080-44fe-8275-28b16bd40178","name":"production","isSystem":true,"currentVersionId":"76065caa-c519-441a-8fe2-cc43e29664ab","workspaceId":"3f55cfd9-4427-4887-a181-d9ad39967802","createdBy":"jane@example.com","deletedBy":null,"createdAt":"2025-05-20T09:30:00.000Z","updatedAt":"2025-06-02T15:45:10.000Z","deletedAt":null,"currentVersion":{"id":"76065caa-c519-441a-8fe2-cc43e29664ab","title":"Contract analysis v3","promptId":"95cec438-6080-44fe-8275-28b16bd40178","draft":false,"promoted":true,"createdAt":"2025-06-02T15:40:00.000Z","updatedAt":"2025-06-02T15:45:10.000Z","createdBy":"jane@example.com","updatedBy":"jane@example.com","versionIndex":3},"activePublication":{"publishedAt":"2025-06-02T15:45:10.000Z","publishedBy":"jane@example.com"}}]}},"exampleType":"generated"}},"exampleType":"generated"},"1c787c1a-20ae-4902-834c-de679349831d":{"description":"Invalid request","content":{"application/json":{"schema":{}}},"exampleType":"generated"},"de3f0e40-1230-4061-bfab-831c1250559c":{"description":"Missing or invalid API key","content":{"application/json":{"schema":{}}},"exampleType":"generated"},"211643c0-5b5b-4d5a-b5c6-bae25b0b0e9a":{"description":"The key does not have the required role or access to the canvas' project","content":{"application/json":{"schema":{}}},"exampleType":"generated"},"16d04126-818e-46ef-8750-aeb63b170187":{"description":"Canvas or environment not found","content":{"application/json":{"schema":{}}},"exampleType":"generated"},"33aa2bf0-2c15-47bc-b1e1-d96d6cd52fd6":{"description":"Request body or query failed schema validation (`code` is `VALIDATION`)","content":{"application/json":{"schema":{}}},"exampleType":"generated"}},"security":{"1d2333f8-85d0-44d3-ac96-e31a09f4e6a3":{"bearerAuth":{"type":"http","scheme":"bearer","bearerFormat":"JWT or UUID","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"f8c8ecf7-c25f-4e5a-8e20-c44514cb2cac":{"url":"https://api.tela.com"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT or UUID","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":"api-reference/openapi.yml"},"subdomain":"meistrari","siteName":"Tela","title":"List environments - Tela","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{"en":{"href":"/api-reference/environment/get-environment","matchLevel":0},"pt-BR":{"href":"/api-reference/environment/get-environment","matchLevel":0}}},"lastModified":"2026-10-16T18:49:21.172Z","originalFileLocation":"api-reference/environment/get-environment.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=\"Returns every environment of a canvas (prompt), ordered with production first and the remaining environments alphabetically.\">\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=\"List environments - Tela\">\u003cmeta data-mint-head property=\"og:description\" content=\"Returns every environment of a canvas (prompt), ordered with production first and the remaining environments alphabetically.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Tela\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.tela.com/api-reference/environment/get-environment\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://meistrari.mintlify.app/_mintlify/api/og/v2?division=Environments\u0026amp;title=List+environments\u0026amp;description=Returns+every+environment+of+a+canvas+%28prompt%29%2C+ordered+with+%60production%60+first+and+the+remaining+environments+alphabetically.\u0026amp;theme=bc02c453c572dc454ca5d848\u0026amp;signature=7581a0e56e002b3c1ee53126e64528153b0583dcf54d39a9b7ede92cdf1f989b\">\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=\"List environments - Tela\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Returns every environment of a canvas (prompt), ordered with production first and the remaining environments alphabetically.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://meistrari.mintlify.app/_mintlify/api/og/v2?division=Environments\u0026amp;title=List+environments\u0026amp;description=Returns+every+environment+of+a+canvas+%28prompt%29%2C+ordered+with+%60production%60+first+and+the+remaining+environments+alphabetically.\u0026amp;theme=bc02c453c572dc454ca5d848\u0026amp;signature=7581a0e56e002b3c1ee53126e64528153b0583dcf54d39a9b7ede92cdf1f989b\">\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/environment/get-environment\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/environment/get-environment.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/environment/get-environment#webpage\",\"url\":\"https://docs.tela.com/api-reference/environment/get-environment\",\"name\":\"List environments\",\"description\":\"Returns every environment of a canvas (prompt), ordered with production first and the remaining environments alphabetically.\",\"dateModified\":\"2026-10-16T18:49:21.172Z\",\"isPartOf\":{\"@id\":\"https://docs.tela.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.tela.com/api-reference/environment/get-environment#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.tela.com/api-reference/environment/get-environment#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Tela\",\"item\":\"https://docs.tela.com\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"List environments\",\"item\":\"https://docs.tela.com/api-reference/environment/get-environment\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.tela.com/api-reference/environment/get-environment#apireference\",\"headline\":\"List environments\",\"name\":\"List environments\",\"description\":\"Returns every environment of a canvas (prompt), ordered with production first and the remaining environments alphabetically.\",\"url\":\"https://docs.tela.com/api-reference/environment/get-environment\",\"mainEntityOfPage\":{\"@id\":\"https://docs.tela.com/api-reference/environment/get-environment#webpage\"},\"dateModified\":\"2026-10-16T18:49:21.172Z\",\"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\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","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","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","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","description":"Permanently deletes a message. Fails when the parent version is promoted or published to an environment (currently surfaced as `500`).","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","description":"Creates a custom environment for a canvas. The name is trimmed and must satisfy the environment name rules: lowercase letters, digits and single hyphens, at most 64 characters, not a reserved name (`production`, `promoted`, `latest`, `draft`) and not a UUID.","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","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","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","description":"Permanently deletes a message. Fails when the parent version is promoted or published to an environment (currently surfaced as `500`).","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","description":"Creates a custom environment for a canvas. The name is trimmed and must satisfy the environment name rules: lowercase letters, digits and single hyphens, at most 64 characters, not a reserved name (`production`, `promoted`, `latest`, `draft`) and not a UUID.","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":"List environments - Tela","buildId":"dpl_GZsjphRpnhWkstV12jxWNcMHFyox","deploymentId":"dpl_GZsjphRpnhWkstV12jxWNcMHFyox","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-B5zPa4Vr.js","utils-CVjrr8Yd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DTgURWzl.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-DxTHtkdZ.js","snippetPresets-Cx47o5Vx.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-4Fr6y9N_.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-Dq2ElbEk.js","shallow-BfYl9r69.js","getApiPlaygroundDisplay-Ch3xc7i1.js","CodeSnippet-BsBxuJ1v.js","CodeSnippets-CetzeDL8.js","Page-CYZot51e.js","getPastedJson-BxPKFSJx.js","icon-o0J1Ochb.js","MethodPill-Du3usO5m.js","DuplicateIcon-DJypyMzl.js","createIcon-YMA6N8KJ.js","DynamicMarkdown-CWvhfcZc.js","SectionHeading-BdLVaXCd.js","axios-vUo_bRtp.js","Markdown-C4Ez6OeV.js","clsx-DptzKFCt.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Dt1IougW.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-CZ6Wt2Vb.js"]}