{"docsConfig":{"theme":"luma","$schema":"https://mintlify.com/docs.json","name":"RevoEngine","description":"Build, automate, and operate production software with RevoEngine.","colors":{"primary":"#202124","light":"#F5F5F5","dark":"#6B6B6B"},"logo":{"light":"https://mintcdn.com/revoengine/kML8CcZSPEra9eLq/logo/logo-light.png?fit=max\u0026auto=format\u0026n=kML8CcZSPEra9eLq\u0026q=85\u0026s=373c9adb2e49fc5404a3193b2b612b82","dark":"https://mintcdn.com/revoengine/kML8CcZSPEra9eLq/logo/logo-dark.png?fit=max\u0026auto=format\u0026n=kML8CcZSPEra9eLq\u0026q=85\u0026s=005fc62385c782830d7578effd226413"},"favicon":"https://mintcdn.com/revoengine/gP_luhFNh7-RQAtb/favicon.svg?fit=max\u0026auto=format\u0026n=gP_luhFNh7-RQAtb\u0026q=85\u0026s=d768f127bd12556658633c8589c8253d","api":{"openapi":"api-reference/openapi.json","params":{"expanded":"closed"},"playground":{"display":"interactive","proxy":true,"credentials":false},"examples":{"defaults":"required","languages":["curl","javascript","python"],"autogenerate":true}},"navbar":{"links":[{"href":"https://revoengine.statuspage.io/","label":"Status"}],"primary":{"type":"button","label":"Open RevoEngine","href":"https://app.revoengine.com"}},"footer":{"links":[{"header":"Legal and support","items":[{"label":"Policies and terms","href":"/resources/introduction"},{"label":"Privacy and cookies","href":"/resources/privacy-policy-and-cookies"},{"label":"Support policy","href":"/resources/support-policy"}]}]},"search":{"prompt":"Search RevoEngine concepts, guides, SDK examples, and API operations"},"seo":{"metatags":{},"indexing":"navigable"},"contextual":{"options":["copy","view"],"display":"toc"},"metadata":{"timestamp":true},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"revoengine","hasAudioNarration":false,"actualSubdomain":"revoengine","customDomains":["docs.revoengine.com"],"gitSource":{"type":"github","owner":"revoengine","repo":"public-docs","deployBranch":"main","contentDirectory":"","isPrivate":false,"mountPath":"","label":""},"entitlements":{},"buildId":"6af0919e2f2e026614e775ff","clientVersion":"0.0.4087","searchFilterCounts":[{"language":"default","tag":"Reference","count":804},{"language":"default","tag":"Platform API","count":577},{"language":"default","tag":"Low-code method reference","count":223},{"language":"default","tag":"Guides","count":178},{"language":"default","tag":"api","count":76},{"language":"default","tag":"Build and integrate","count":75},{"language":"default","tag":"Automation","count":74},{"language":"default","tag":"Changelog","count":63},{"language":"default","tag":"Operate","count":60},{"language":"default","tag":"Agents","count":58}]},"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":"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":"comment-mode","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[],"page":{"pagePath":"low-code/reference/agent/get","slug":"/low-code/reference/agent/get","pageMetadata":{"title":"agent.get()","sidebarTitle":"get()","description":"Public low-code contract, signatures and examples for agent.get.","icon":"code","href":"/low-code/reference/agent/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: \"Public low-code contract, signatures and examples for agent.get.\"\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,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,code:`code`,p:`p`,pre:`pre`,span:`span`,..._provideComponents(),...props.components},{CodeBlock,Heading}=_components;if(!CodeBlock)_missingMdxReference(`CodeBlock`,true);if(!Heading)_missingMdxReference(`Heading`,true);return _jsxs(_Fragment,{children:[_jsx(`span`,{id:`agent-get`,\"aria-hidden\":`true`}),`\n`,_jsx(Heading,{level:`2`,id:`agent-get`,children:_jsx(_components.code,{children:`agent.get()`})}),`\n`,_jsx(_components.p,{children:`Returns one agent by id.`}),`\n`,_jsx(Heading,{level:`3`,id:`signature`,children:`Signature`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`static`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:` get`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`agentId`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`: `}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`string`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`): `}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4EC9B0`},children:`Promise`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`\u003c`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`Agent`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:`>`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`;`})]}),`\n`]})})}),`\n`,_jsx(Heading,{level:`3`,id:`example`,children:`Example`}),`\n`,_jsx(CodeBlock,{filename:``,numberOfLines:`1`,language:`typescript`,children:_jsx(_components.pre,{className:`shiki shiki-themes github-light-default dark-plus`,style:{backgroundColor:`#ffffff`,\"--shiki-dark-bg\":`#0B0C0E`,color:`#1f2328`,\"--shiki-dark\":`#D4D4D4`},language:`typescript`,children:_jsxs(_components.code,{language:`typescript`,numberOfLines:`1`,children:[_jsxs(_components.span,{className:`line`,children:[_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#569CD6`},children:`const`}),_jsx(_components.span,{style:{color:`#0550AE`,\"--shiki-dark\":`#4FC1FF`},children:` one`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#D4D4D4`},children:` =`}),_jsx(_components.span,{style:{color:`#CF222E`,\"--shiki-dark\":`#C586C0`},children:` await`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:` agent`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`.`}),_jsx(_components.span,{style:{color:`#8250DF`,\"--shiki-dark\":`#DCDCAA`},children:`get`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`(`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#9CDCFE`},children:`agentId`}),_jsx(_components.span,{style:{color:`#1F2328`,\"--shiki-dark\":`#D4D4D4`},children:`);`})]}),`\n`]})})}),`\n`,_jsxs(_components.p,{children:[`See `,_jsx(_components.a,{href:`/low-code/reference/agent`,children:`all agent methods`}),` or `,_jsx(_components.a,{href:`/low-code/overview`,children:`runtime basics`}),`.`]})]})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent};function _missingMdxReference(id,component){throw new Error(`Expected `+(component?`component`:`object`)+\" `\"+id+\"` to be defined: you likely forgot to import, pass, or provide it.\")}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"agent.get()","sidebarTitle":"get()","description":"Public low-code contract, signatures and examples for agent.get.","icon":"code","href":"/low-code/reference/agent/get"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[{"title":"agent.get()","slug":"agent-get","depth":2,"children":[{"title":"Signature","slug":"signature","depth":3,"children":[]},{"title":"Example","slug":"example","depth":3,"children":[]}]}],"codeExamples":{}},"jsLinks":[],"subdomain":"revoengine","siteName":"RevoEngine","title":"agent.get() - RevoEngine","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-08T12:16:33.823Z","gitLastModified":"2026-11-08T12:15:43.000Z","originalFileLocation":"low-code/reference/agent/get.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Public low-code contract, signatures and examples for agent.get.\">\u003cmeta data-mint-head name=\"application-name\" content=\"RevoEngine\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/revoengine/s4Tw1v44Xc7EV0Rr/_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/revoengine/s4Tw1v44Xc7EV0Rr/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/revoengine/s4Tw1v44Xc7EV0Rr/_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/revoengine/s4Tw1v44Xc7EV0Rr/_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/revoengine/s4Tw1v44Xc7EV0Rr/_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/revoengine/s4Tw1v44Xc7EV0Rr/_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/revoengine/s4Tw1v44Xc7EV0Rr/_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/revoengine/s4Tw1v44Xc7EV0Rr/_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/revoengine/s4Tw1v44Xc7EV0Rr/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"agent.get() - RevoEngine\">\u003cmeta data-mint-head property=\"og:description\" content=\"Public low-code contract, signatures and examples for agent.get.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"RevoEngine\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.revoengine.com/low-code/reference/agent/get\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://revoengine.mintlify.site/_mintlify/api/og/v2?division=Agent+definitions\u0026amp;title=agent.get%28%29\u0026amp;description=Public+low-code+contract%2C+signatures+and+examples+for+agent.get.\u0026amp;theme=dc9432172716906c8e3e0c1b\u0026amp;signature=5066a2af8c7d7c8f6c45b37f7b823a16efaff4a3e6255e80e6897bd4074a35ed\">\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=\"agent.get() - RevoEngine\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Public low-code contract, signatures and examples for agent.get.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://revoengine.mintlify.site/_mintlify/api/og/v2?division=Agent+definitions\u0026amp;title=agent.get%28%29\u0026amp;description=Public+low-code+contract%2C+signatures+and+examples+for+agent.get.\u0026amp;theme=dc9432172716906c8e3e0c1b\u0026amp;signature=5066a2af8c7d7c8f6c45b37f7b823a16efaff4a3e6255e80e6897bd4074a35ed\">\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/revoengine/s4Tw1v44Xc7EV0Rr/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"RevoEngine\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#202124\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.revoengine.com/low-code/reference/agent/get\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/low-code/reference/agent/get.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.revoengine.com/#organization\",\"name\":\"RevoEngine\",\"url\":\"https://docs.revoengine.com\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/revoengine/kML8CcZSPEra9eLq/logo/logo-light.png?fit=max\u0026auto=format\u0026n=kML8CcZSPEra9eLq\u0026q=85\u0026s=373c9adb2e49fc5404a3193b2b612b82\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.revoengine.com#website\",\"name\":\"RevoEngine\",\"url\":\"https://docs.revoengine.com\",\"publisher\":{\"@id\":\"https://docs.revoengine.com/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.revoengine.com/low-code/reference/agent/get#webpage\",\"url\":\"https://docs.revoengine.com/low-code/reference/agent/get\",\"name\":\"agent.get()\",\"description\":\"Public low-code contract, signatures and examples for agent.get.\",\"dateModified\":\"2026-11-08T12:15:43.000Z\",\"isPartOf\":{\"@id\":\"https://docs.revoengine.com#website\"},\"breadcrumb\":{\"@id\":\"https://docs.revoengine.com/low-code/reference/agent/get#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.revoengine.com/low-code/reference/agent/get#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Low-code method reference\",\"item\":\"https://docs.revoengine.com/low-code/reference/index\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"agent\",\"item\":\"https://docs.revoengine.com/low-code/reference/agent\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Agent definitions\",\"item\":\"https://docs.revoengine.com/low-code/reference/agent/list\"},{\"@type\":\"ListItem\",\"position\":4,\"name\":\"agent.get()\",\"item\":\"https://docs.revoengine.com/low-code/reference/agent/get\"}]},{\"@type\":[\"Article\",\"TechArticle\"],\"@id\":\"https://docs.revoengine.com/low-code/reference/agent/get#article\",\"headline\":\"agent.get()\",\"name\":\"agent.get()\",\"description\":\"Public low-code contract, signatures and examples for agent.get.\",\"url\":\"https://docs.revoengine.com/low-code/reference/agent/get\",\"mainEntityOfPage\":{\"@id\":\"https://docs.revoengine.com/low-code/reference/agent/get#webpage\"},\"dateModified\":\"2026-11-08T12:15:43.000Z\",\"publisher\":{\"@id\":\"https://docs.revoengine.com/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.revoengine.com#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"RevoEngine\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"RevoEngine","nav":{"global":null,"tabs":[{"tab":"Guides","icon":"book-open","pages":[{"title":"Guides","href":"/introduction"}]},{"tab":"Examples","icon":"flask","pages":[{"title":"Examples","href":"/examples/overview"}]},{"tab":"Reference","icon":"brackets-curly","groups":[{"group":"Low-code method reference","pages":[{"title":"Low-code runtime reference","icon":"book-open","href":"/low-code/reference"},{"group":"vault","pages":[{"title":"Vault reference","icon":"brackets-curly","href":"/low-code/reference/vault"},{"title":"vault.get()","sidebarTitle":"get()","icon":"code","href":"/low-code/reference/vault/get"},{"title":"vault.create()","sidebarTitle":"create()","icon":"code","href":"/low-code/reference/vault/create"},{"title":"vault.update()","sidebarTitle":"update()","icon":"code","href":"/low-code/reference/vault/update"},{"title":"vault.delete()","sidebarTitle":"delete()","icon":"code","href":"/low-code/reference/vault/delete"},{"title":"vault.rotate()","sidebarTitle":"rotate()","icon":"code","href":"/low-code/reference/vault/rotate"},{"title":"vault.listRevisions()","sidebarTitle":"listRevisions()","icon":"code","href":"/low-code/reference/vault/listRevisions"},{"title":"vault.getAccessToken()","sidebarTitle":"getAccessToken()","icon":"code","href":"/low-code/reference/vault/getAccessToken"},{"title":"vault.getIntegrationMetadata()","sidebarTitle":"getIntegrationMetadata()","icon":"code","href":"/low-code/reference/vault/getIntegrationMetadata"},{"title":"vault.discoverIntegration()","sidebarTitle":"discoverIntegration()","icon":"code","href":"/low-code/reference/vault/discoverIntegration"},{"title":"vault.connectIntegration()","sidebarTitle":"connectIntegration()","icon":"code","href":"/low-code/reference/vault/connectIntegration"},{"title":"vault.disconnectIntegration()","sidebarTitle":"disconnectIntegration()","icon":"code","href":"/low-code/reference/vault/disconnectIntegration"}]},{"group":"serviceAccount","pages":[{"title":"Service Account reference","icon":"brackets-curly","href":"/low-code/reference/serviceAccount"},{"title":"serviceAccount.get()","sidebarTitle":"get()","icon":"code","href":"/low-code/reference/serviceAccount/get"},{"title":"serviceAccount.list()","sidebarTitle":"list()","icon":"code","href":"/low-code/reference/serviceAccount/list"},{"title":"serviceAccount.create()","sidebarTitle":"create()","icon":"code","href":"/low-code/reference/serviceAccount/create"},{"title":"serviceAccount.update()","sidebarTitle":"update()","icon":"code","href":"/low-code/reference/serviceAccount/update"},{"title":"serviceAccount.delete()","sidebarTitle":"delete()","icon":"code","href":"/low-code/reference/serviceAccount/delete"},{"title":"serviceAccount.activate()","sidebarTitle":"activate()","icon":"code","href":"/low-code/reference/serviceAccount/activate"},{"title":"serviceAccount.disable()","sidebarTitle":"disable()","icon":"code","href":"/low-code/reference/serviceAccount/disable"},{"title":"serviceAccount.restore()","sidebarTitle":"restore()","icon":"code","href":"/low-code/reference/serviceAccount/restore"},{"title":"serviceAccount.enablePlatformAccess()","sidebarTitle":"enablePlatformAccess()","icon":"code","href":"/low-code/reference/serviceAccount/enablePlatformAccess"},{"title":"serviceAccount.disablePlatformAccess()","sidebarTitle":"disablePlatformAccess()","icon":"code","href":"/low-code/reference/serviceAccount/disablePlatformAccess"},{"title":"serviceAccount.getKeys()","sidebarTitle":"getKeys()","icon":"code","href":"/low-code/reference/serviceAccount/getKeys"},{"title":"serviceAccount.getKey()","sidebarTitle":"getKey()","icon":"code","href":"/low-code/reference/serviceAccount/getKey"},{"title":"serviceAccount.createKey()","sidebarTitle":"createKey()","icon":"code","href":"/low-code/reference/serviceAccount/createKey"},{"title":"serviceAccount.updateKey()","sidebarTitle":"updateKey()","icon":"code","href":"/low-code/reference/serviceAccount/updateKey"},{"title":"serviceAccount.rotateKey()","sidebarTitle":"rotateKey()","icon":"code","href":"/low-code/reference/serviceAccount/rotateKey"},{"title":"serviceAccount.revokeKey()","sidebarTitle":"revokeKey()","icon":"code","href":"/low-code/reference/serviceAccount/revokeKey"}]},{"group":"api","pages":[{"title":"api reference","icon":"brackets-curly","href":"/low-code/reference/api"},{"group":"Database","pages":[{"title":"api.createDatabase()","sidebarTitle":"createDatabase()","icon":"code","href":"/low-code/reference/api/createDatabase"},{"title":"api.cloneDatabase()","sidebarTitle":"cloneDatabase()","icon":"code","href":"/low-code/reference/api/cloneDatabase"},{"title":"api.exportDatabase()","sidebarTitle":"exportDatabase()","icon":"code","href":"/low-code/reference/api/exportDatabase"},{"title":"api.startDatabaseOperation()","sidebarTitle":"startDatabaseOperation()","icon":"code","href":"/low-code/reference/api/startDatabaseOperation"},{"title":"api.importDatabase()","sidebarTitle":"importDatabase()","icon":"code","href":"/low-code/reference/api/importDatabase"},{"title":"api.updateDatabaseImportMapping()","sidebarTitle":"updateDatabaseImportMapping()","icon":"code","href":"/low-code/reference/api/updateDatabaseImportMapping"},{"title":"api.commitDatabaseImport()","sidebarTitle":"commitDatabaseImport()","icon":"code","href":"/low-code/reference/api/commitDatabaseImport"},{"title":"api.updateDatabase()","sidebarTitle":"updateDatabase()","icon":"code","href":"/low-code/reference/api/updateDatabase"},{"title":"api.deleteDatabase()","sidebarTitle":"deleteDatabase()","icon":"code","href":"/low-code/reference/api/deleteDatabase"},{"title":"api.restoreDatabase()","sidebarTitle":"restoreDatabase()","icon":"code","href":"/low-code/reference/api/restoreDatabase"},{"title":"api.truncateDatabase()","sidebarTitle":"truncateDatabase()","icon":"code","href":"/low-code/reference/api/truncateDatabase"},{"title":"api.transactionDatabase()","sidebarTitle":"transactionDatabase()","icon":"code","href":"/low-code/reference/api/transactionDatabase"},{"title":"api.getDatabaseData()","sidebarTitle":"getDatabaseData()","icon":"code","href":"/low-code/reference/api/getDatabaseData"},{"title":"api.getDatabaseDataRow()","sidebarTitle":"getDatabaseDataRow()","icon":"code","href":"/low-code/reference/api/getDatabaseDataRow"},{"title":"api.countDatabase()","sidebarTitle":"countDatabase()","icon":"code","href":"/low-code/reference/api/countDatabase"},{"title":"api.walkDatabaseData()","sidebarTitle":"walkDatabaseData()","icon":"code","href":"/low-code/reference/api/walkDatabaseData"},{"title":"api.getDatabaseAudit()","sidebarTitle":"getDatabaseAudit()","icon":"code","href":"/low-code/reference/api/getDatabaseAudit"},{"title":"api.insertDatabaseData()","sidebarTitle":"insertDatabaseData()","icon":"code","href":"/low-code/reference/api/insertDatabaseData"},{"title":"api.upsertDatabaseData()","sidebarTitle":"upsertDatabaseData()","icon":"code","href":"/low-code/reference/api/upsertDatabaseData"},{"title":"api.updateDatabaseData()","sidebarTitle":"updateDatabaseData()","icon":"code","href":"/low-code/reference/api/updateDatabaseData"},{"title":"api.deleteDatabaseData()","sidebarTitle":"deleteDatabaseData()","icon":"code","href":"/low-code/reference/api/deleteDatabaseData"},{"title":"api.updateDatabaseDataRequest()","sidebarTitle":"updateDatabaseDataRequest()","icon":"code","href":"/low-code/reference/api/updateDatabaseDataRequest"},{"title":"api.deleteDatabaseDataRequest()","sidebarTitle":"deleteDatabaseDataRequest()","icon":"code","href":"/low-code/reference/api/deleteDatabaseDataRequest"},{"title":"api.queryDatabase()","sidebarTitle":"queryDatabase()","icon":"code","href":"/low-code/reference/api/queryDatabase"}]},{"group":"Execution context","pages":[{"title":"api.currentUser()","sidebarTitle":"currentUser()","icon":"code","href":"/low-code/reference/api/currentUser"},{"title":"api.isDebug()","sidebarTitle":"isDebug()","icon":"code","href":"/low-code/reference/api/isDebug"},{"title":"api.getContext()","sidebarTitle":"getContext()","icon":"code","href":"/low-code/reference/api/getContext"},{"title":"api.getErrors()","sidebarTitle":"getErrors()","icon":"code","href":"/low-code/reference/api/getErrors"},{"title":"api.getExecutionId()","sidebarTitle":"getExecutionId()","icon":"code","href":"/low-code/reference/api/getExecutionId"},{"title":"api.getOperationId()","sidebarTitle":"getOperationId()","icon":"code","href":"/low-code/reference/api/getOperationId"},{"title":"api.executeComponent()","sidebarTitle":"executeComponent()","icon":"code","href":"/low-code/reference/api/executeComponent"},{"title":"api.input()","sidebarTitle":"input()","icon":"code","href":"/low-code/reference/api/input"},{"title":"api.log()","sidebarTitle":"log()","icon":"code","href":"/low-code/reference/api/log"},{"title":"api.exit()","sidebarTitle":"exit()","icon":"code","href":"/low-code/reference/api/exit"},{"title":"api.throw()","sidebarTitle":"throw()","icon":"code","href":"/low-code/reference/api/throw"}]},{"group":"Cache","pages":[{"title":"api.getCache()","sidebarTitle":"getCache()","icon":"code","href":"/low-code/reference/api/getCache"},{"title":"api.setCache()","sidebarTitle":"setCache()","icon":"code","href":"/low-code/reference/api/setCache"},{"title":"api.getInstanceCache()","sidebarTitle":"getInstanceCache()","icon":"code","href":"/low-code/reference/api/getInstanceCache"},{"title":"api.setInstanceCache()","sidebarTitle":"setInstanceCache()","icon":"code","href":"/low-code/reference/api/setInstanceCache"},{"title":"api.setInstanceCacheIfNotExists()","sidebarTitle":"setInstanceCacheIfNotExists()","icon":"code","href":"/low-code/reference/api/setInstanceCacheIfNotExists"},{"title":"api.getOrSetInstanceCache()","sidebarTitle":"getOrSetInstanceCache()","icon":"code","href":"/low-code/reference/api/getOrSetInstanceCache"},{"title":"api.removeInstanceCache()","sidebarTitle":"removeInstanceCache()","icon":"code","href":"/low-code/reference/api/removeInstanceCache"},{"title":"api.existsInstanceCache()","sidebarTitle":"existsInstanceCache()","icon":"code","href":"/low-code/reference/api/existsInstanceCache"},{"title":"api.persistInstanceCache()","sidebarTitle":"persistInstanceCache()","icon":"code","href":"/low-code/reference/api/persistInstanceCache"},{"title":"api.expireInstanceCache()","sidebarTitle":"expireInstanceCache()","icon":"code","href":"/low-code/reference/api/expireInstanceCache"},{"title":"api.getExpireInstanceCache()","sidebarTitle":"getExpireInstanceCache()","icon":"code","href":"/low-code/reference/api/getExpireInstanceCache"},{"title":"api.listInstanceCache()","sidebarTitle":"listInstanceCache()","icon":"code","href":"/low-code/reference/api/listInstanceCache"},{"title":"api.incrementInstanceCache()","sidebarTitle":"incrementInstanceCache()","icon":"code","href":"/low-code/reference/api/incrementInstanceCache"},{"title":"api.decrementInstanceCache()","sidebarTitle":"decrementInstanceCache()","icon":"code","href":"/low-code/reference/api/decrementInstanceCache"},{"title":"api.compareAndSetInstanceCache()","sidebarTitle":"compareAndSetInstanceCache()","icon":"code","href":"/low-code/reference/api/compareAndSetInstanceCache"}]},{"group":"Platform","pages":[{"title":"api.getCurrentInstance()","sidebarTitle":"getCurrentInstance()","icon":"code","href":"/low-code/reference/api/getCurrentInstance"},{"title":"api.getInstanceData()","sidebarTitle":"getInstanceData()","icon":"code","href":"/low-code/reference/api/getInstanceData"},{"title":"api.getInstanceDetails()","sidebarTitle":"getInstanceDetails()","icon":"code","href":"/low-code/reference/api/getInstanceDetails"},{"title":"api.publishMessage()","sidebarTitle":"publishMessage()","icon":"code","href":"/low-code/reference/api/publishMessage"}]},{"group":"Coordination","pages":[{"title":"api.acquireIdempotencyKey()","sidebarTitle":"acquireIdempotencyKey()","icon":"code","href":"/low-code/reference/api/acquireIdempotencyKey"},{"title":"api.getIdempotencyKey()","sidebarTitle":"getIdempotencyKey()","icon":"code","href":"/low-code/reference/api/getIdempotencyKey"},{"title":"api.releaseIdempotencyKey()","sidebarTitle":"releaseIdempotencyKey()","icon":"code","href":"/low-code/reference/api/releaseIdempotencyKey"},{"title":"api.concurrencyLimit()","sidebarTitle":"concurrencyLimit()","icon":"code","href":"/low-code/reference/api/concurrencyLimit"},{"title":"api.rateLimit()","sidebarTitle":"rateLimit()","icon":"code","href":"/low-code/reference/api/rateLimit"},{"title":"api.releaseRateLimit()","sidebarTitle":"releaseRateLimit()","icon":"code","href":"/low-code/reference/api/releaseRateLimit"},{"title":"api.releaseConcurrencyLimit()","sidebarTitle":"releaseConcurrencyLimit()","icon":"code","href":"/low-code/reference/api/releaseConcurrencyLimit"}]},{"group":"Automation","pages":[{"title":"api.triggerEvent()","sidebarTitle":"triggerEvent()","icon":"code","href":"/low-code/reference/api/triggerEvent"},{"title":"api.triggerTarget()","sidebarTitle":"triggerTarget()","icon":"code","href":"/low-code/reference/api/triggerTarget"},{"title":"api.triggerJob()","sidebarTitle":"triggerJob()","icon":"code","href":"/low-code/reference/api/triggerJob"},{"title":"api.triggerWebhook()","sidebarTitle":"triggerWebhook()","icon":"code","href":"/low-code/reference/api/triggerWebhook"},{"title":"api.cancelJobs()","sidebarTitle":"cancelJobs()","icon":"code","href":"/low-code/reference/api/cancelJobs"},{"title":"api.retryJobs()","sidebarTitle":"retryJobs()","icon":"code","href":"/low-code/reference/api/retryJobs"},{"title":"api.deleteJobs()","sidebarTitle":"deleteJobs()","icon":"code","href":"/low-code/reference/api/deleteJobs"},{"title":"api.cancelWebhooks()","sidebarTitle":"cancelWebhooks()","icon":"code","href":"/low-code/reference/api/cancelWebhooks"},{"title":"api.retryWebhooks()","sidebarTitle":"retryWebhooks()","icon":"code","href":"/low-code/reference/api/retryWebhooks"},{"title":"api.deleteWebhooks()","sidebarTitle":"deleteWebhooks()","icon":"code","href":"/low-code/reference/api/deleteWebhooks"},{"title":"api.previewAutomationOperation()","sidebarTitle":"previewAutomationOperation()","icon":"code","href":"/low-code/reference/api/previewAutomationOperation"},{"title":"api.getAutomationOperation()","sidebarTitle":"getAutomationOperation()","icon":"code","href":"/low-code/reference/api/getAutomationOperation"},{"title":"api.getAutomationOperationItems()","sidebarTitle":"getAutomationOperationItems()","icon":"code","href":"/low-code/reference/api/getAutomationOperationItems"}]},{"group":"HTTP","pages":[{"title":"api.httpCall()","sidebarTitle":"httpCall()","icon":"code","href":"/low-code/reference/api/httpCall"}]}]},{"group":"storage","pages":[{"title":"storage reference","icon":"brackets-curly","href":"/low-code/reference/storage"},{"group":"Files and folders","pages":[{"title":"storage.explore()","sidebarTitle":"explore()","icon":"code","href":"/low-code/reference/storage/explore"},{"title":"storage.resolveFolderPath()","sidebarTitle":"resolveFolderPath()","icon":"code","href":"/low-code/reference/storage/resolveFolderPath"},{"title":"storage.ensureFolderPath()","sidebarTitle":"ensureFolderPath()","icon":"code","href":"/low-code/reference/storage/ensureFolderPath"},{"title":"storage.getEntry()","sidebarTitle":"getEntry()","icon":"code","href":"/low-code/reference/storage/getEntry"},{"title":"storage.createFolder()","sidebarTitle":"createFolder()","icon":"code","href":"/low-code/reference/storage/createFolder"},{"title":"storage.updateEntry()","sidebarTitle":"updateEntry()","icon":"code","href":"/low-code/reference/storage/updateEntry"},{"title":"storage.moveEntry()","sidebarTitle":"moveEntry()","icon":"code","href":"/low-code/reference/storage/moveEntry"},{"title":"storage.archiveEntry()","sidebarTitle":"archiveEntry()","icon":"code","href":"/low-code/reference/storage/archiveEntry"},{"title":"storage.restoreEntry()","sidebarTitle":"restoreEntry()","icon":"code","href":"/low-code/reference/storage/restoreEntry"},{"title":"storage.deleteEntry()","sidebarTitle":"deleteEntry()","icon":"code","href":"/low-code/reference/storage/deleteEntry"}]},{"group":"Read and write content","pages":[{"title":"storage.getFile()","sidebarTitle":"getFile()","icon":"code","href":"/low-code/reference/storage/getFile"},{"title":"storage.getFileData()","sidebarTitle":"getFileData()","icon":"code","href":"/low-code/reference/storage/getFileData"},{"title":"storage.walkFileData()","sidebarTitle":"walkFileData()","icon":"code","href":"/low-code/reference/storage/walkFileData"},{"title":"storage.getFileStats()","sidebarTitle":"getFileStats()","icon":"code","href":"/low-code/reference/storage/getFileStats"},{"title":"storage.putObject()","sidebarTitle":"putObject()","icon":"code","href":"/low-code/reference/storage/putObject"},{"title":"storage.getDownload()","sidebarTitle":"getDownload()","icon":"code","href":"/low-code/reference/storage/getDownload"},{"title":"storage.getDocument()","sidebarTitle":"getDocument()","icon":"code","href":"/low-code/reference/storage/getDocument"}]},{"group":"Upload sessions","pages":[{"title":"storage.createUploadSession()","sidebarTitle":"createUploadSession()","icon":"code","href":"/low-code/reference/storage/createUploadSession"},{"title":"storage.extendUploadSession()","sidebarTitle":"extendUploadSession()","icon":"code","href":"/low-code/reference/storage/extendUploadSession"},{"title":"storage.getUploadSession()","sidebarTitle":"getUploadSession()","icon":"code","href":"/low-code/reference/storage/getUploadSession"},{"title":"storage.uploadPart()","sidebarTitle":"uploadPart()","icon":"code","href":"/low-code/reference/storage/uploadPart"},{"title":"storage.finalizeUploadSession()","sidebarTitle":"finalizeUploadSession()","icon":"code","href":"/low-code/reference/storage/finalizeUploadSession"},{"title":"storage.abortUploadSession()","sidebarTitle":"abortUploadSession()","icon":"code","href":"/low-code/reference/storage/abortUploadSession"}]}]},{"group":"transport","pages":[{"title":"SFTP transport reference","icon":"brackets-curly","href":"/low-code/reference/transport"},{"title":"transport.sftpImport()","sidebarTitle":"sftpImport()","icon":"code","href":"/low-code/reference/transport/sftpImport"},{"title":"transport.sftpExport()","sidebarTitle":"sftpExport()","icon":"code","href":"/low-code/reference/transport/sftpExport"},{"title":"transport.sftpCommands()","sidebarTitle":"sftpCommands()","icon":"code","href":"/low-code/reference/transport/sftpCommands"}]},{"group":"agent","pages":[{"title":"agent reference","icon":"brackets-curly","href":"/low-code/reference/agent"},{"group":"Agent definitions","pages":[{"title":"agent.list()","sidebarTitle":"list()","description":"Public low-code contract, signatures and examples for agent.list.","icon":"code","href":"/low-code/reference/agent/list"},{"title":"agent.get()","sidebarTitle":"get()","icon":"code","href":"/low-code/reference/agent/get"},{"title":"agent.create()","sidebarTitle":"create()","description":"Public low-code contract, signatures and examples for agent.create.","icon":"code","href":"/low-code/reference/agent/create"},{"title":"agent.update()","sidebarTitle":"update()","icon":"code","href":"/low-code/reference/agent/update"}]},{"group":"Inbox","pages":[{"title":"agent.listInbox()","sidebarTitle":"listInbox()","icon":"code","href":"/low-code/reference/agent/listInbox"},{"title":"agent.getInboxItem()","sidebarTitle":"getInboxItem()","icon":"code","href":"/low-code/reference/agent/getInboxItem"},{"title":"agent.pushInbox()","sidebarTitle":"pushInbox()","icon":"code","href":"/low-code/reference/agent/pushInbox"},{"title":"agent.updateInboxItem()","sidebarTitle":"updateInboxItem()","icon":"code","href":"/low-code/reference/agent/updateInboxItem"},{"title":"agent.removeInboxItem()","sidebarTitle":"removeInboxItem()","icon":"code","href":"/low-code/reference/agent/removeInboxItem"}]},{"group":"Plugins","pages":[{"title":"agent.listPlugins()","sidebarTitle":"listPlugins()","icon":"code","href":"/low-code/reference/agent/listPlugins"},{"title":"agent.getPlugin()","sidebarTitle":"getPlugin()","icon":"code","href":"/low-code/reference/agent/getPlugin"}]},{"group":"Runs","pages":[{"title":"agent.listRuns()","sidebarTitle":"listRuns()","icon":"code","href":"/low-code/reference/agent/listRuns"},{"title":"agent.getRun()","sidebarTitle":"getRun()","icon":"code","href":"/low-code/reference/agent/getRun"},{"title":"agent.listRunEvents()","sidebarTitle":"listRunEvents()","icon":"code","href":"/low-code/reference/agent/listRunEvents"},{"title":"agent.listRunThreads()","sidebarTitle":"listRunThreads()","icon":"code","href":"/low-code/reference/agent/listRunThreads"},{"title":"agent.startRun()","sidebarTitle":"startRun()","icon":"code","href":"/low-code/reference/agent/startRun"},{"title":"agent.resumeRun()","sidebarTitle":"resumeRun()","icon":"code","href":"/low-code/reference/agent/resumeRun"},{"title":"agent.retryRun()","sidebarTitle":"retryRun()","icon":"code","href":"/low-code/reference/agent/retryRun"},{"title":"agent.tickRun()","sidebarTitle":"tickRun()","icon":"code","href":"/low-code/reference/agent/tickRun"},{"title":"agent.cancelRun()","sidebarTitle":"cancelRun()","icon":"code","href":"/low-code/reference/agent/cancelRun"},{"title":"agent.reconcileRuns()","sidebarTitle":"reconcileRuns()","icon":"code","href":"/low-code/reference/agent/reconcileRuns"}]},{"group":"Assistant conversations","pages":[{"title":"agent.listThreads()","sidebarTitle":"listThreads()","icon":"code","href":"/low-code/reference/agent/listThreads"},{"title":"agent.getThread()","sidebarTitle":"getThread()","icon":"code","href":"/low-code/reference/agent/getThread"},{"title":"agent.getThreadState()","sidebarTitle":"getThreadState()","icon":"code","href":"/low-code/reference/agent/getThreadState"},{"title":"agent.getThreadShare()","sidebarTitle":"getThreadShare()","icon":"code","href":"/low-code/reference/agent/getThreadShare"},{"title":"agent.enableThreadShare()","sidebarTitle":"enableThreadShare()","icon":"code","href":"/low-code/reference/agent/enableThreadShare"},{"title":"agent.disableThreadShare()","sidebarTitle":"disableThreadShare()","icon":"code","href":"/low-code/reference/agent/disableThreadShare"},{"title":"agent.getSharedThread()","sidebarTitle":"getSharedThread()","icon":"code","href":"/low-code/reference/agent/getSharedThread"},{"title":"agent.listSharedThreadMessages()","sidebarTitle":"listSharedThreadMessages()","icon":"code","href":"/low-code/reference/agent/listSharedThreadMessages"},{"title":"agent.getSharedThreadMessageExecutionDetails()","sidebarTitle":"getSharedThreadMessageExecutionDetails()","icon":"code","href":"/low-code/reference/agent/getSharedThreadMessageExecutionDetails"},{"title":"agent.getSharedThreadMessageArtifact()","sidebarTitle":"getSharedThreadMessageArtifact()","icon":"code","href":"/low-code/reference/agent/getSharedThreadMessageArtifact"},{"title":"agent.forkSharedThreadMessage()","sidebarTitle":"forkSharedThreadMessage()","icon":"code","href":"/low-code/reference/agent/forkSharedThreadMessage"},{"title":"agent.createThread()","sidebarTitle":"createThread()","icon":"code","href":"/low-code/reference/agent/createThread"},{"title":"agent.createResponse()","sidebarTitle":"createResponse()","icon":"code","href":"/low-code/reference/agent/createResponse"},{"title":"agent.deleteThread()","sidebarTitle":"deleteThread()","icon":"code","href":"/low-code/reference/agent/deleteThread"},{"title":"agent.restoreThread()","sidebarTitle":"restoreThread()","icon":"code","href":"/low-code/reference/agent/restoreThread"},{"title":"agent.listThreadMessages()","sidebarTitle":"listThreadMessages()","icon":"code","href":"/low-code/reference/agent/listThreadMessages"},{"title":"agent.sendMessage()","sidebarTitle":"sendMessage()","icon":"code","href":"/low-code/reference/agent/sendMessage"},{"title":"agent.retryMessage()","sidebarTitle":"retryMessage()","icon":"code","href":"/low-code/reference/agent/retryMessage"},{"title":"agent.cancelThread()","sidebarTitle":"cancelThread()","icon":"code","href":"/low-code/reference/agent/cancelThread"},{"title":"agent.forkMessage()","sidebarTitle":"forkMessage()","icon":"code","href":"/low-code/reference/agent/forkMessage"},{"title":"agent.renameThread()","sidebarTitle":"renameThread()","icon":"code","href":"/low-code/reference/agent/renameThread"},{"title":"agent.resolveAction()","sidebarTitle":"resolveAction()","icon":"code","href":"/low-code/reference/agent/resolveAction"},{"title":"agent.approveAction()","sidebarTitle":"approveAction()","icon":"code","href":"/low-code/reference/agent/approveAction"},{"title":"agent.rejectAction()","sidebarTitle":"rejectAction()","icon":"code","href":"/low-code/reference/agent/rejectAction"},{"title":"agent.submitAction()","sidebarTitle":"submitAction()","icon":"code","href":"/low-code/reference/agent/submitAction"},{"title":"agent.watchMessage()","sidebarTitle":"watchMessage()","icon":"code","href":"/low-code/reference/agent/watchMessage"},{"title":"agent.compactThread()","sidebarTitle":"compactThread()","icon":"code","href":"/low-code/reference/agent/compactThread"}]}]},{"group":"sse","pages":[{"title":"SSE response reference","icon":"brackets-curly","href":"/low-code/reference/sse"},{"title":"sse.onDisconnect()","sidebarTitle":"onDisconnect()","icon":"code","href":"/low-code/reference/sse/onDisconnect"},{"title":"sse.send()","sidebarTitle":"send()","icon":"code","href":"/low-code/reference/sse/send"},{"title":"sse.json()","sidebarTitle":"json()","icon":"code","href":"/low-code/reference/sse/json"},{"title":"sse.comment()","sidebarTitle":"comment()","icon":"code","href":"/low-code/reference/sse/comment"},{"title":"sse.remainingTime()","sidebarTitle":"remainingTime()","icon":"code","href":"/low-code/reference/sse/remainingTime"}]},{"group":"util","pages":[{"title":"util reference","icon":"brackets-curly","href":"/low-code/reference/util"},{"group":"Validation and utilities","pages":[{"title":"util.sleep()","sidebarTitle":"sleep()","icon":"code","href":"/low-code/reference/util/sleep"},{"title":"util.isUUID()","sidebarTitle":"isUUID()","icon":"code","href":"/low-code/reference/util/isUUID"},{"title":"util.randomUUID()","sidebarTitle":"randomUUID()","icon":"code","href":"/low-code/reference/util/randomUUID"},{"title":"util.getUUID()","sidebarTitle":"getUUID()","icon":"code","href":"/low-code/reference/util/getUUID"},{"title":"util.randomBytes()","sidebarTitle":"randomBytes()","icon":"code","href":"/low-code/reference/util/randomBytes"},{"title":"util.randomInt()","sidebarTitle":"randomInt()","icon":"code","href":"/low-code/reference/util/randomInt"},{"title":"util.randomString()","sidebarTitle":"randomString()","icon":"code","href":"/low-code/reference/util/randomString"},{"title":"util.validate()","sidebarTitle":"validate()","icon":"code","href":"/low-code/reference/util/validate"}]},{"group":"Cryptography","pages":[{"title":"util.aesDecrypt()","sidebarTitle":"aesDecrypt()","icon":"code","href":"/low-code/reference/util/aesDecrypt"},{"title":"util.aesEncrypt()","sidebarTitle":"aesEncrypt()","icon":"code","href":"/low-code/reference/util/aesEncrypt"},{"title":"util.timingSafeEqual()","sidebarTitle":"timingSafeEqual()","icon":"code","href":"/low-code/reference/util/timingSafeEqual"},{"title":"util.hmac()","sidebarTitle":"hmac()","icon":"code","href":"/low-code/reference/util/hmac"},{"title":"util.verifyHmacSignature()","sidebarTitle":"verifyHmacSignature()","icon":"code","href":"/low-code/reference/util/verifyHmacSignature"},{"title":"util.otp()","sidebarTitle":"otp()","icon":"code","href":"/low-code/reference/util/otp"},{"title":"util.jwtDecode()","sidebarTitle":"jwtDecode()","icon":"code","href":"/low-code/reference/util/jwtDecode"},{"title":"util.jwtSign()","sidebarTitle":"jwtSign()","icon":"code","href":"/low-code/reference/util/jwtSign"},{"title":"util.jwtVerify()","sidebarTitle":"jwtVerify()","icon":"code","href":"/low-code/reference/util/jwtVerify"},{"title":"util.rsaDecrypt()","sidebarTitle":"rsaDecrypt()","icon":"code","href":"/low-code/reference/util/rsaDecrypt"},{"title":"util.rsaEncrypt()","sidebarTitle":"rsaEncrypt()","icon":"code","href":"/low-code/reference/util/rsaEncrypt"},{"title":"util.rsaGeneratePair()","sidebarTitle":"rsaGeneratePair()","icon":"code","href":"/low-code/reference/util/rsaGeneratePair"},{"title":"util.rsaSign()","sidebarTitle":"rsaSign()","icon":"code","href":"/low-code/reference/util/rsaSign"},{"title":"util.rsaVerify()","sidebarTitle":"rsaVerify()","icon":"code","href":"/low-code/reference/util/rsaVerify"}]},{"group":"Hashing","pages":[{"title":"util.compareHash()","sidebarTitle":"compareHash()","icon":"code","href":"/low-code/reference/util/compareHash"},{"title":"util.generateHash()","sidebarTitle":"generateHash()","icon":"code","href":"/low-code/reference/util/generateHash"},{"title":"util.hashObject()","sidebarTitle":"hashObject()","icon":"code","href":"/low-code/reference/util/hashObject"},{"title":"util.sha1()","sidebarTitle":"sha1()","icon":"code","href":"/low-code/reference/util/sha1"},{"title":"util.sha256()","sidebarTitle":"sha256()","icon":"code","href":"/low-code/reference/util/sha256"},{"title":"util.md5()","sidebarTitle":"md5()","icon":"code","href":"/low-code/reference/util/md5"}]},{"group":"Encoding","pages":[{"title":"util.isBase64()","sidebarTitle":"isBase64()","icon":"code","href":"/low-code/reference/util/isBase64"},{"title":"util.decodeBase64()","sidebarTitle":"decodeBase64()","icon":"code","href":"/low-code/reference/util/decodeBase64"},{"title":"util.encodeBase64()","sidebarTitle":"encodeBase64()","icon":"code","href":"/low-code/reference/util/encodeBase64"},{"title":"util.base64UrlEncode()","sidebarTitle":"base64UrlEncode()","icon":"code","href":"/low-code/reference/util/base64UrlEncode"},{"title":"util.base64UrlDecode()","sidebarTitle":"base64UrlDecode()","icon":"code","href":"/low-code/reference/util/base64UrlDecode"}]}]}]},{"group":"Developer tools","pages":[{"title":"CLI command reference","icon":"list","href":"/developers/cli-command-reference"}]},{"group":"Before you start","pages":[{"title":"Platform API reference","icon":"brackets-curly","href":"/api-reference/introduction"},{"title":"Authentication","icon":"key","href":"/api-reference/authentication"},{"title":"Errors and HTTP status codes","icon":"circle-exclamation","href":"/api-reference/http-codes"}]},{"group":"Platform API","pages":[{"group":"Search","pages":[{"title":"Search","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/search","href":"/api-reference/search/search"}]},{"group":"Activity","pages":[{"title":"List snapshot-backed resource activity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/activity","href":"/api-reference/activity/list-snapshot-backed-resource-activity"},{"title":"Load a full snapshot version by activity reference","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/activity/{refId}/{version}","href":"/api-reference/activity/load-a-full-snapshot-version-by-activity-reference"}]},{"group":"Observability","pages":[{"title":"Get tenant Observability query capabilities and scan budgets.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/observability/capabilities","href":"/api-reference/observability/get-tenant-observability-query-capabilities-and-scan-budgets"},{"title":"Read service metrics for a bounded time window with explicit coverage information.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/observability/overview/query","href":"/api-reference/observability/read-service-metrics-for-a-bounded-time-window-with-explicit-coverage-information"},{"title":"Filter, sort and page complete resource performance results from a reusable bounded snapshot.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/observability/performance/query","href":"/api-reference/observability/filter-sort-and-page-complete-resource-performance-results-from-a-reusable-bounded-snapshot"},{"title":"Search recorded executions in a mandatory bounded time window.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/observability/executions/query","href":"/api-reference/observability/search-recorded-executions-in-a-mandatory-bounded-time-window"},{"title":"Resolve operation, execution, job, event, schedule or storage identifiers to recorded execution roots.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/observability/resolve","href":"/api-reference/observability/resolve-operation-execution-job-event-schedule-or-storage-identifiers-to-recorded-execution-roots"},{"title":"Read or expand typed execution Flow nodes, with result paging and no fixed total navigation depth.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/observability/graph/query","href":"/api-reference/observability/read-or-expand-typed-execution-flow-nodes-with-result-paging-and-no-fixed-total-navigation-depth"},{"title":"Read log metadata using the shared Observability filter, without loading payloads.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/observability/logs/query","href":"/api-reference/observability/read-log-metadata-using-the-shared-observability-filter-without-loading-payloads"},{"title":"Load a retained log payload through a tenant and principal scoped locator.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/observability/logs/{logId}","href":"/api-reference/observability/load-a-retained-log-payload-through-a-tenant-and-principal-scoped-locator"},{"title":"Read the next result page without repeating its source query.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/observability/pages/{cursor}","href":"/api-reference/observability/read-the-next-result-page-without-repeating-its-source-query"}]},{"group":"Me","pages":[{"title":"Retrieve user, accesses, roles and more.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/me","href":"/api-reference/me/retrieve-user-accesses-roles-and-more"},{"title":"Update user profile.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/me","href":"/api-reference/me/update-user-profile"},{"title":"Get the current product release and complete release-note history.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/me/changelog","href":"/api-reference/me/get-the-current-product-release-and-complete-release-note-history"},{"title":"Show server time.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/me/time","href":"/api-reference/me/show-server-time"},{"title":"Upload avatar.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/me/uploadAvatar","href":"/api-reference/me/upload-avatar"},{"title":"Clear avatar.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/me/clearAvatar","href":"/api-reference/me/clear-avatar"},{"title":"Get your API keys.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/me/keys","href":"/api-reference/me/get-your-api-keys"},{"title":"Get an API key.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/me/key/{key}","href":"/api-reference/me/get-an-api-key"},{"title":"Generate an API key.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/me/key","href":"/api-reference/me/generate-an-api-key"},{"title":"Update an API key.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/me/key/{key}/update","href":"/api-reference/me/update-an-api-key"},{"title":"Delete an API key.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/me/key/{key}/delete","href":"/api-reference/me/delete-an-api-key"},{"title":"Rotate a personal API key.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/me/key/{key}/rotate","href":"/api-reference/me/rotate-a-personal-api-key"}]},{"group":"Accounts","pages":[{"title":"Get all users.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/accounts","href":"/api-reference/accounts/get-all-users"},{"title":"Get stats of users.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/accounts/stats","href":"/api-reference/accounts/get-stats-of-users"},{"title":"Get an account.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/accounts/{userId}","href":"/api-reference/accounts/get-an-account"},{"title":"Update an account.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/accounts/{userId}","href":"/api-reference/accounts/update-an-account"},{"title":"Delete an account.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/accounts/{userId}","href":"/api-reference/accounts/delete-an-account"},{"title":"Create an account.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/accounts/createUserAccount","href":"/api-reference/accounts/create-an-account"},{"title":"Create internal account.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/accounts/createInternalAccount","href":"/api-reference/accounts/create-internal-account"},{"title":"Create a service account.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/accounts/createServiceAccount","href":"/api-reference/accounts/create-a-service-account"},{"title":"Update a service account, its explicit access ACL and execution memberships atomically.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/accounts/service-account/{userId}","href":"/api-reference/accounts/update-a-service-account-its-explicit-access-acl-and-execution-memberships-atomically"},{"title":"Activate an account.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/accounts/{userId}/activate","href":"/api-reference/accounts/activate-an-account"},{"title":"Disable an account.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/accounts/{userId}/disable","href":"/api-reference/accounts/disable-an-account"},{"title":"Enable platform access for user.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/accounts/{userId}/enablePlatformAccess","href":"/api-reference/accounts/enable-platform-access-for-user"},{"title":"Disable platform access for user.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/accounts/{userId}/disablePlatformAccess","href":"/api-reference/accounts/disable-platform-access-for-user"},{"title":"Restore an account.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/accounts/{userId}/restore","href":"/api-reference/accounts/restore-an-account"},{"title":"Get a API keys.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/accounts/{userId}/keys","href":"/api-reference/accounts/get-a-api-keys"},{"title":"Create an API key.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/accounts/{userId}/keys","href":"/api-reference/accounts/create-an-api-key"},{"title":"Get an API key.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/accounts/{userId}/keys/{key}","href":"/api-reference/accounts/get-an-api-key"},{"title":"Update an API key.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/accounts/{userId}/keys/{key}/update","href":"/api-reference/accounts/update-an-api-key"},{"title":"Delete an API key.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/accounts/{userId}/keys/{key}/delete","href":"/api-reference/accounts/delete-an-api-key"},{"title":"Rotate an account API key with an optional bounded grace period.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/accounts/{userId}/keys/{key}/rotate","href":"/api-reference/accounts/rotate-an-account-api-key-with-an-optional-bounded-grace-period"}]},{"group":"Endpoints","pages":[{"title":"Get endpoints.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/endpoints","href":"/api-reference/endpoints/get-endpoints"},{"title":"Create API template.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/endpoints","href":"/api-reference/endpoints/create-api-template"},{"title":"Get endpoint stats (cached in 1 min intervals).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/endpoints/stats","href":"/api-reference/endpoints/get-endpoint-stats-cached-in-1-min-intervals"},{"title":"Daily endpoint performance by UTC day, with an overall series and per-endpoint series.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/endpoints/performance","href":"/api-reference/endpoints/daily-endpoint-performance-by-utc-day-with-an-overall-series-and-per-endpoint-series"},{"title":"Generate OpenAPI document for active runtime endpoints.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/endpoints/openapi","href":"/api-reference/endpoints/generate-openapi-document-for-active-runtime-endpoints"},{"title":"Generate OpenAPI document for one runtime endpoint.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/endpoints/{endpointId}/openapi","href":"/api-reference/endpoints/generate-openapi-document-for-one-runtime-endpoint"},{"title":"Get endpoint.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/endpoints/{endpointId}","href":"/api-reference/endpoints/get-endpoint"},{"title":"Update endpoint.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/endpoints/{endpointId}","href":"/api-reference/endpoints/update-endpoint"},{"title":"Delete template.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/endpoints/delete","href":"/api-reference/endpoints/delete-template"},{"title":"Activate endpoint.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/endpoints/{endpointId}/activate","href":"/api-reference/endpoints/activate-endpoint"},{"title":"Disable endpoint.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/endpoints/{endpointId}/disable","href":"/api-reference/endpoints/disable-endpoint"},{"title":"Restore deleted endpoint.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/endpoints/{endpointId}/restore","href":"/api-reference/endpoints/restore-deleted-endpoint"},{"title":"Get stats from API executions.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/endpoints/{endpointId}/stats","href":"/api-reference/endpoints/get-stats-from-api-executions"},{"title":"Validate applicable endpoint for given criteria.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/endpoints/validate","href":"/api-reference/endpoints/validate-applicable-endpoint-for-given-criteria"}]},{"group":"Components","pages":[{"title":"Get components (all active and not).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/component","href":"/api-reference/components/get-components-all-active-and-not"},{"title":"Create component.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/component","href":"/api-reference/components/create-component"},{"title":"List component sync manifests without source.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/component/sync-manifests","href":"/api-reference/components/list-component-sync-manifests-without-source"},{"title":"Search Studio navigation by component name or element key.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/component/navigation/search","href":"/api-reference/components/search-studio-navigation-by-component-name-or-element-key"},{"title":"Resolve component revisions by portable content digest.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/component/digest/{componentDigest}","href":"/api-reference/components/resolve-component-revisions-by-portable-content-digest"},{"title":"Search portable component digests by prefix.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/component/digests/search","href":"/api-reference/components/search-portable-component-digests-by-prefix"},{"title":"List component revisions with portable content digests.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/component/{componentId}/revisions","href":"/api-reference/components/list-component-revisions-with-portable-content-digests"},{"title":"Get component elements only.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/component/{componentId}/elements","href":"/api-reference/components/get-component-elements-only"},{"title":"Get component by id.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/component/{componentId}","href":"/api-reference/components/get-component-by-id"},{"title":"Update component.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/component/{componentId}","href":"/api-reference/components/update-component"},{"title":"Delete component.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/component/{componentId}","href":"/api-reference/components/delete-component"},{"title":"Replace all component elements.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/component/{componentId}/save","href":"/api-reference/components/replace-all-component-elements"},{"title":"Replace one component element.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/component/{componentId}/patch","href":"/api-reference/components/replace-one-component-element"},{"title":"Edit literal text in existing component elements.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/component/{componentId}/edit","href":"/api-reference/components/edit-literal-text-in-existing-component-elements"},{"title":"Edit literal text in one existing component element.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/component/{componentId}/elements/{componentElementId}/edit","href":"/api-reference/components/edit-literal-text-in-one-existing-component-element"},{"title":"Activate component.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/component/{componentId}/activate","href":"/api-reference/components/activate-component"},{"title":"Disable component.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/component/{componentId}/disable","href":"/api-reference/components/disable-component"},{"title":"Restore deleted component.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/component/{componentId}/restore","href":"/api-reference/components/restore-deleted-component"}]},{"group":"Component deployments","pages":[{"title":"Get custom-component runtime and deployment readiness.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/component/{componentId}/runtime","href":"/api-reference/component-deployments/get-custom-component-runtime-and-deployment-readiness"},{"title":"List custom-component deployment attempts.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/component/{componentId}/deployments","href":"/api-reference/component-deployments/list-custom-component-deployment-attempts"},{"title":"Get one custom-component deployment attempt.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/component/{componentId}/deployments/{deploymentId}","href":"/api-reference/component-deployments/get-one-custom-component-deployment-attempt"},{"title":"Queue another attempt for a failed custom-component deployment.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/component/{componentId}/deployments/{deploymentId}/retry","href":"/api-reference/component-deployments/queue-another-attempt-for-a-failed-custom-component-deployment"},{"title":"Change automatic or manual custom-component revision activation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/component/{componentId}/runtime/activation-mode","href":"/api-reference/component-deployments/change-automatic-or-manual-custom-component-revision-activation"},{"title":"Select a verified READY runtime revision while in MANUAL mode.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/component/{componentId}/runtime/active-revision","href":"/api-reference/component-deployments/select-a-verified-ready-runtime-revision-while-in-manual-mode"}]},{"group":"Role Groups","pages":[{"title":"Get a role groups.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/role-groups","href":"/api-reference/role-groups/get-a-role-groups"},{"title":"Create a role group.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/role-groups","href":"/api-reference/role-groups/create-a-role-group"},{"title":"Get a role group.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/role-groups/{roleGroupId}","href":"/api-reference/role-groups/get-a-role-group"},{"title":"Update a role group.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/role-groups/{roleGroupId}","href":"/api-reference/role-groups/update-a-role-group"},{"title":"Delete a role group.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/role-groups/{roleGroupId}","href":"/api-reference/role-groups/delete-a-role-group"},{"title":"List role-group members.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/role-groups/{roleGroupId}/members","href":"/api-reference/role-groups/list-role-group-members"},{"title":"Add user to a group.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/role-groups/{roleGroupId}/userAdd","href":"/api-reference/role-groups/add-user-to-a-group"},{"title":"Remove user from a group.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/role-groups/{roleGroupId}/userDelete","href":"/api-reference/role-groups/remove-user-from-a-group"},{"title":"Add role to a group.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/role-groups/{roleGroupId}/roleAdd","href":"/api-reference/role-groups/add-role-to-a-group"},{"title":"Remove role from a group.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/role-groups/{roleGroupId}/roleDelete","href":"/api-reference/role-groups/remove-role-from-a-group"},{"title":"Restore removed group.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/role-groups/{roleGroupId}/restore","href":"/api-reference/role-groups/restore-removed-group"}]},{"group":"Roles","pages":[{"title":"Get roles.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/roles","href":"/api-reference/roles/get-roles"},{"title":"Get a role.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/roles/{roleKey}","href":"/api-reference/roles/get-a-role"}]},{"group":"Groups","pages":[{"title":"Get a groups.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/groups","href":"/api-reference/groups/get-a-groups"},{"title":"Create a group.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/groups","href":"/api-reference/groups/create-a-group"},{"title":"Get a group.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/groups/{groupId}","href":"/api-reference/groups/get-a-group"},{"title":"Update a group.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/groups/{groupId}","href":"/api-reference/groups/update-a-group"},{"title":"Delete a group.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/groups/{groupId}","href":"/api-reference/groups/delete-a-group"},{"title":"List group members.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/groups/{groupId}/members","href":"/api-reference/groups/list-group-members"},{"title":"Upload group avatar.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/groups/{groupId}/uploadAvatar","href":"/api-reference/groups/upload-group-avatar"},{"title":"Clear group avatar.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/groups/{groupId}/clearAvatar","href":"/api-reference/groups/clear-group-avatar"},{"title":"Add user to a group.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/groups/{groupId}/userAdd","href":"/api-reference/groups/add-user-to-a-group"},{"title":"Remove user from a group.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/groups/{groupId}/userDelete","href":"/api-reference/groups/remove-user-from-a-group"},{"title":"Restore removed group.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/groups/{groupId}/restore","href":"/api-reference/groups/restore-removed-group"}]},{"group":"Database Views","pages":[{"title":"List Database Views","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/databases/views","href":"/api-reference/database-views/list-database-views"},{"title":"Create a Database View","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/views","href":"/api-reference/database-views/create-a-database-view"},{"title":"Preview a Database View definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/views/preview","href":"/api-reference/database-views/preview-a-database-view-definition"},{"title":"Preview a raw Database View query","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/views/raw-preview","href":"/api-reference/database-views/preview-a-raw-database-view-query"},{"title":"Delete Database Views","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/views/delete","href":"/api-reference/database-views/delete-database-views"},{"title":"Get a Database View","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/databases/views/{databaseViewId}","href":"/api-reference/database-views/get-a-database-view"},{"title":"Update a Database View","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/databases/views/{databaseViewId}","href":"/api-reference/database-views/update-a-database-view"},{"title":"Get Database View storage and row statistics.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/databases/views/{databaseViewId}/stats","href":"/api-reference/database-views/get-database-view-storage-and-row-statistics"},{"title":"Query Database View data","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/views/{databaseViewId}/data","href":"/api-reference/database-views/query-database-view-data"},{"title":"Refresh a materialized Database View","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/views/{databaseViewId}/refresh","href":"/api-reference/database-views/refresh-a-materialized-database-view"},{"title":"Restore a Database View","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/views/{databaseViewId}/restore","href":"/api-reference/database-views/restore-a-database-view"},{"title":"Preview a Database View action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/views/{databaseViewId}/actions/preview","href":"/api-reference/database-views/preview-a-database-view-action"},{"title":"Get a Database View action preview","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/databases/views/{databaseViewId}/actions/preview/{operationId}","href":"/api-reference/database-views/get-a-database-view-action-preview"},{"title":"Apply an update through a Database View","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/views/{databaseViewId}/actions/update","href":"/api-reference/database-views/apply-an-update-through-a-database-view"},{"title":"Apply a delete through a Database View","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/views/{databaseViewId}/actions/delete","href":"/api-reference/database-views/apply-a-delete-through-a-database-view"}]},{"group":"Database Cache","pages":[{"title":"List Database cache entries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/databases/cache","href":"/api-reference/database-cache/list-database-cache-entries"},{"title":"Get Database cache statistics","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/cache/stats","href":"/api-reference/database-cache/get-database-cache-statistics"},{"title":"Get a Database cache value","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/cache/get","href":"/api-reference/database-cache/get-a-database-cache-value"},{"title":"Create a Database cache value","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/cache/create","href":"/api-reference/database-cache/create-a-database-cache-value"},{"title":"Expire a Database cache value","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/cache/expire","href":"/api-reference/database-cache/expire-a-database-cache-value"},{"title":"Persist a Database cache value","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/cache/persist","href":"/api-reference/database-cache/persist-a-database-cache-value"},{"title":"Delete a Database cache value","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/cache/delete","href":"/api-reference/database-cache/delete-a-database-cache-value"}]},{"group":"Databases","pages":[{"title":"List Database operations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/databases/operations","href":"/api-reference/databases/list-database-operations"},{"title":"Start a background Database mutation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/operations","href":"/api-reference/databases/start-a-background-database-mutation"},{"title":"Preview a Database import","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/imports/preview","href":"/api-reference/databases/preview-a-database-import"},{"title":"Update a Database import mapping","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/databases/imports/{importId}/mapping","href":"/api-reference/databases/update-a-database-import-mapping"},{"title":"Commit a Database import","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/imports/{importId}/commit","href":"/api-reference/databases/commit-a-database-import"},{"title":"Get a Database operation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/databases/operations/{jobId}","href":"/api-reference/databases/get-a-database-operation"},{"title":"Cancel a Database operation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/operations/{jobId}/cancel","href":"/api-reference/databases/cancel-a-database-operation"},{"title":"Retry a Database operation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/operations/{jobId}/retry","href":"/api-reference/databases/retry-a-database-operation"},{"title":"Get databases.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/databases","href":"/api-reference/databases/get-databases"},{"title":"Create database.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases","href":"/api-reference/databases/create-database"},{"title":"Check a logical table or database-view name.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/databases/relations/name-availability","href":"/api-reference/databases/check-a-logical-table-or-database-view-name"},{"title":"Get databases stats (cached in 10 sec intervals).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/databases/stats","href":"/api-reference/databases/get-databases-stats-cached-in-10-sec-intervals"},{"title":"Query accessible database row audit events.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/databases/audit","href":"/api-reference/databases/query-accessible-database-row-audit-events"},{"title":"Delete accessible database row audit events using audit-grid filters.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/audit/delete","href":"/api-reference/databases/delete-accessible-database-row-audit-events-using-audit-grid-filters"},{"title":"Get an accessible database row audit snapshot.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/databases/audit/{databaseAuditId}","href":"/api-reference/databases/get-an-accessible-database-row-audit-snapshot"},{"title":"Get database.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/databases/{databaseId}","href":"/api-reference/databases/get-database"},{"title":"Update database.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/databases/{databaseId}","href":"/api-reference/databases/update-database"},{"title":"Delete database with items.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/databases/{databaseId}","href":"/api-reference/databases/delete-database-with-items"},{"title":"Get database row audit history.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/databases/{databaseId}/audit","href":"/api-reference/databases/get-database-row-audit-history"},{"title":"Get a database row audit snapshot.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/databases/{databaseId}/audit/{databaseAuditId}","href":"/api-reference/databases/get-a-database-row-audit-snapshot"},{"title":"Delete databases in bulk.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/delete","href":"/api-reference/databases/delete-databases-in-bulk"},{"title":"Get database data.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/databases/{databaseId}/getData","href":"/api-reference/databases/get-database-data"},{"title":"Query Database data with a request body","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/{databaseId}/data/request","href":"/api-reference/databases/query-database-data-with-a-request-body"},{"title":"Export table, view, or materialized-view data to CSV, TSV, NDJSON, or XLSX.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/databases/{databaseId}/exportData","href":"/api-reference/databases/export-table-view-or-materialized-view-data-to-csv-tsv-ndjson-or-xlsx"},{"title":"Run a full readable-relation export from a structured request.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/{databaseId}/exportData","href":"/api-reference/databases/run-a-full-readable-relation-export-from-a-structured-request"},{"title":"Insert database data.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/{databaseId}/insertData","href":"/api-reference/databases/insert-database-data"},{"title":"Update database data single (used for ID migration).","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/{databaseId}/updateData","href":"/api-reference/databases/update-database-data-single-used-for-id-migration"},{"title":"Mass update database data based on filters.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/{databaseId}/updateRequest","href":"/api-reference/databases/mass-update-database-data-based-on-filters"},{"title":"Mass delete database data based on filters.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/{databaseId}/deleteRequest","href":"/api-reference/databases/mass-delete-database-data-based-on-filters"},{"title":"Delete database data based on partial objects.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/{databaseId}/deleteData","href":"/api-reference/databases/delete-database-data-based-on-partial-objects"},{"title":"Truncate database data. Identity counters are preserved unless restartIdentity is explicitly enabled.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/{databaseId}/truncateData","href":"/api-reference/databases/truncate-database-data-identity-counters-are-preserved-unless-restartidentity-is-explicitly-enabled"},{"title":"Clone database.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/{databaseId}/clone","href":"/api-reference/databases/clone-database"},{"title":"Restore database.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/databases/{databaseId}/restore","href":"/api-reference/databases/restore-database"}]},{"group":"Config","pages":[{"title":"Get instance logs.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/config/logs","href":"/api-reference/config/get-instance-logs"},{"title":"Get instance configuration.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/config/instance","href":"/api-reference/config/get-instance-configuration"},{"title":"Update instance configuration.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/config/instance","href":"/api-reference/config/update-instance-configuration"},{"title":"Change the globally unique frontend path slug.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/config/instance/slug","href":"/api-reference/config/change-the-globally-unique-frontend-path-slug"},{"title":"Retrieve instance usage analytics.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/config/instance/usage","href":"/api-reference/config/retrieve-instance-usage-analytics"},{"title":"Retrieve retained usage by resource, account or execution.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/config/instance/usage/executions","href":"/api-reference/config/retrieve-retained-usage-by-resource-account-or-execution"},{"title":"Retrieve on-demand Assistant tool, skill, and plugin activity for the selected UTC period.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/config/instance/usage/activity","href":"/api-reference/config/retrieve-on-demand-assistant-tool-skill-and-plugin-activity-for-the-selected-utc-period"},{"title":"Purge cache.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/config/instance/purgeCache","href":"/api-reference/config/purge-cache"},{"title":"List instance cache keys.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/config/cache","href":"/api-reference/config/list-instance-cache-keys"},{"title":"Get instance cache statistics.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/config/cache/stats","href":"/api-reference/config/get-instance-cache-statistics"},{"title":"Get an instance cache value.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/config/cache/get","href":"/api-reference/config/get-an-instance-cache-value"},{"title":"Set an instance cache value.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/config/cache/create","href":"/api-reference/config/set-an-instance-cache-value"},{"title":"Expire instance cache key.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/config/cache/expire","href":"/api-reference/config/expire-instance-cache-key"},{"title":"Persist instance cache key.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/config/cache/persist","href":"/api-reference/config/persist-instance-cache-key"},{"title":"Remove instance cache key.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/config/cache/delete","href":"/api-reference/config/remove-instance-cache-key"}]},{"group":"Preferences","pages":[{"title":"Get current user API key expiry notifications for this instance.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/preferences/api-key-notifications","href":"/api-reference/preferences/get-current-user-api-key-expiry-notifications-for-this-instance"},{"title":"Set API key notification channels and reminder days. Automation events remain independent of channel opt-out.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/preferences/api-key-notifications","href":"/api-reference/preferences/set-api-key-notification-channels-and-reminder-days-automation-events-remain-independent-of-channel-opt-out"},{"title":"Get current administrator job failure notification opt-in for this instance.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/preferences/job-notifications","href":"/api-reference/preferences/get-current-administrator-job-failure-notification-opt-in-for-this-instance"},{"title":"Set current administrator job failure notification opt-in for this instance.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/preferences/job-notifications","href":"/api-reference/preferences/set-current-administrator-job-failure-notification-opt-in-for-this-instance"},{"title":"Get a preferences.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/preferences","href":"/api-reference/preferences/get-a-preferences"},{"title":"Create a preference.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/preferences","href":"/api-reference/preferences/create-a-preference"},{"title":"Get a single preference with details.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/preferences/{preferenceId}","href":"/api-reference/preferences/get-a-single-preference-with-details"},{"title":"Update a preference.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/preferences/{preferenceId}","href":"/api-reference/preferences/update-a-preference"},{"title":"Delete a preference.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/preferences/delete","href":"/api-reference/preferences/delete-a-preference"}]},{"group":"Secrets","pages":[{"title":"Get secrets.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/secrets","href":"/api-reference/secrets/get-secrets"},{"title":"Create secret.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/secrets","href":"/api-reference/secrets/create-secret"},{"title":"Get secret.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/secrets/{secretId}","href":"/api-reference/secrets/get-secret"},{"title":"Update secret.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/secrets/{secretId}","href":"/api-reference/secrets/update-secret"},{"title":"Delete secret.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/secrets/{secretId}","href":"/api-reference/secrets/delete-secret"},{"title":"Get secret revisions.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/secrets/{secretId}/data","href":"/api-reference/secrets/get-secret-revisions"},{"title":"Create a secret.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/secrets/{secretId}/create","href":"/api-reference/secrets/create-a-secret"},{"title":"Rotate a secret.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/secrets/{secretId}/rotate","href":"/api-reference/secrets/rotate-a-secret"},{"title":"Reveal secret.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/secrets/{secretId}/reveal/{secretDataId}","href":"/api-reference/secrets/reveal-secret"},{"title":"Activate secret.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/secrets/{secretId}/activate/{secretDataId}","href":"/api-reference/secrets/activate-secret"},{"title":"Disable secret.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/secrets/{secretId}/disable/{secretDataId}","href":"/api-reference/secrets/disable-secret"},{"title":"Destroy secret.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/secrets/{secretId}/destroy/{secretDataId}","href":"/api-reference/secrets/destroy-secret"}]},{"group":"Instance Vault","pages":[{"title":"List instance Vault integrations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/vault/integrations","href":"/api-reference/instance-vault/list-instance-vault-integrations"},{"title":"Disconnect an instance Vault integration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/vault/integrations/disable","href":"/api-reference/instance-vault/disconnect-an-instance-vault-integration"},{"title":"Start instance integration authorization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/vault/integrations/oauth/start","href":"/api-reference/instance-vault/start-instance-integration-authorization"},{"title":"Discover an instance OAuth provider","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/vault/integrations/definitions/discover","href":"/api-reference/instance-vault/discover-an-instance-oauth-provider"},{"title":"List instance OAuth definitions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/vault/integrations/definitions","href":"/api-reference/instance-vault/list-instance-oauth-definitions"},{"title":"Save an instance OAuth definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/vault/integrations/definitions","href":"/api-reference/instance-vault/save-an-instance-oauth-definition"},{"title":"Get an instance OAuth definition","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/vault/integrations/definitions/item","href":"/api-reference/instance-vault/get-an-instance-oauth-definition"},{"title":"Complete instance integration authorization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/vault/integrations/oauth/complete","href":"/api-reference/instance-vault/complete-instance-integration-authorization"}]},{"group":"Storage","pages":[{"title":"List Storage workspaces available to the current user.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/storage/workspaces","href":"/api-reference/storage/list-storage-workspaces-available-to-the-current-user"},{"title":"Explore one available Storage workspace.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/storage/workspaces/{workspaceId}","href":"/api-reference/storage/explore-one-available-storage-workspace"},{"title":"Create a folder in a writable Storage workspace.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/storage/workspaces/{workspaceId}/folders","href":"/api-reference/storage/create-a-folder-in-a-writable-storage-workspace"},{"title":"Create an upload session in a writable Storage workspace.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/storage/workspaces/{workspaceId}/uploads","href":"/api-reference/storage/create-an-upload-session-in-a-writable-storage-workspace"},{"title":"Storage explorer.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/storage","href":"/api-reference/storage/storage-explorer"},{"title":"Resolve an exact folder path relative to the Storage root.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/storage/folders/resolve","href":"/api-reference/storage/resolve-an-exact-folder-path-relative-to-the-storage-root"},{"title":"Idempotently create missing folders along a Storage root-relative path.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/storage/folders/ensure","href":"/api-reference/storage/idempotently-create-missing-folders-along-a-storage-root-relative-path"},{"title":"Get upload session state and uploaded parts.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/storage/uploads/{storageUploadSessionId}","href":"/api-reference/storage/get-upload-session-state-and-uploaded-parts"},{"title":"List upload sessions for Storage administrators.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/storage/uploads","href":"/api-reference/storage/list-upload-sessions-for-storage-administrators"},{"title":"Create an upload session for direct, chunked, or incremental uploads.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/storage/uploads","href":"/api-reference/storage/create-an-upload-session-for-direct-chunked-or-incremental-uploads"},{"title":"Get storage entry.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/storage/{storageEntryId}","href":"/api-reference/storage/get-storage-entry"},{"title":"Rename or update storage entry.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/storage/{storageEntryId}","href":"/api-reference/storage/rename-or-update-storage-entry"},{"title":"Permanently delete storage entry.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/storage/{storageEntryId}","href":"/api-reference/storage/permanently-delete-storage-entry"},{"title":"Create folder.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/storage/folders","href":"/api-reference/storage/create-folder"},{"title":"Read a versioned UTF-8 text range or literal search results.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/storage/entries/{storageEntryId}/text","href":"/api-reference/storage/read-a-versioned-utf-8-text-range-or-literal-search-results"},{"title":"Edit literal UTF-8 text with metadata and content version fences.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/storage/entries/{storageEntryId}/edit","href":"/api-reference/storage/edit-literal-utf-8-text-with-metadata-and-content-version-fences"},{"title":"Put an object in one request.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/storage/objects","href":"/api-reference/storage/put-an-object-in-one-request"},{"title":"Upload one part and let the server assign its order for incremental sessions.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/storage/uploads/{storageUploadSessionId}/parts","href":"/api-reference/storage/upload-one-part-and-let-the-server-assign-its-order-for-incremental-sessions"},{"title":"Upload one explicitly numbered part for chunked sessions or multipart repair.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/storage/uploads/{storageUploadSessionId}/parts/{partNumber}","href":"/api-reference/storage/upload-one-explicitly-numbered-part-for-chunked-sessions-or-multipart-repair"},{"title":"Extend upload session.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/storage/uploads/{storageUploadSessionId}/heartbeat","href":"/api-reference/storage/extend-upload-session"},{"title":"Finalize uploaded file.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/storage/uploads/{storageUploadSessionId}/finalize","href":"/api-reference/storage/finalize-uploaded-file"},{"title":"Abort upload session.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/storage/uploads/{storageUploadSessionId}/abort","href":"/api-reference/storage/abort-upload-session"},{"title":"Archive multiple storage entries and complete folder subtrees.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/storage/bulk/archive","href":"/api-reference/storage/archive-multiple-storage-entries-and-complete-folder-subtrees"},{"title":"Permanently delete multiple archived entries and complete folder subtrees.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/storage/bulk","href":"/api-reference/storage/permanently-delete-multiple-archived-entries-and-complete-folder-subtrees"},{"title":"Move storage entry.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/storage/{storageEntryId}/move","href":"/api-reference/storage/move-storage-entry"},{"title":"Archive storage entry.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/storage/{storageEntryId}/archive","href":"/api-reference/storage/archive-storage-entry"},{"title":"Restore storage entry.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/storage/{storageEntryId}/restore","href":"/api-reference/storage/restore-storage-entry"},{"title":"Create signed download URL.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/storage/{storageEntryId}/download","href":"/api-reference/storage/create-signed-download-url"},{"title":"Create signed preview URL.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/storage/{storageEntryId}/preview","href":"/api-reference/storage/create-signed-preview-url"},{"title":"Create signed thumbnail URL for an image file.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/storage/{storageEntryId}/thumbnail","href":"/api-reference/storage/create-signed-thumbnail-url-for-an-image-file"}]},{"group":"Chat","pages":[{"title":"List chat threads.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/chat/threads","href":"/api-reference/chat/list-chat-threads"},{"title":"Create or reopen a chat thread.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/chat/threads","href":"/api-reference/chat/create-or-reopen-a-chat-thread"},{"title":"Get chat thread details.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/chat/threads/{threadId}","href":"/api-reference/chat/get-chat-thread-details"},{"title":"Soft delete a thread.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/chat/threads/{threadId}","href":"/api-reference/chat/soft-delete-a-thread"},{"title":"Restore a thread.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/chat/threads/{threadId}/restore","href":"/api-reference/chat/restore-a-thread"},{"title":"Archive a thread for the current user.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/chat/threads/{threadId}/archive","href":"/api-reference/chat/archive-a-thread-for-the-current-user"},{"title":"Unarchive a thread for the current user.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/chat/threads/{threadId}/unarchive","href":"/api-reference/chat/unarchive-a-thread-for-the-current-user"},{"title":"Mute a thread for the current user.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/chat/threads/{threadId}/mute","href":"/api-reference/chat/mute-a-thread-for-the-current-user"},{"title":"Unmute a thread for the current user.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/chat/threads/{threadId}/unmute","href":"/api-reference/chat/unmute-a-thread-for-the-current-user"},{"title":"Mark a thread as read.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/chat/threads/{threadId}/read","href":"/api-reference/chat/mark-a-thread-as-read"},{"title":"Mark a thread as unread for the current user.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/chat/threads/{threadId}/unread","href":"/api-reference/chat/mark-a-thread-as-unread-for-the-current-user"},{"title":"List thread messages.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/chat/threads/{threadId}/messages","href":"/api-reference/chat/list-thread-messages"},{"title":"Create a message.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/chat/threads/{threadId}/messages","href":"/api-reference/chat/create-a-message"},{"title":"Get a message.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/chat/threads/{threadId}/messages/{messageId}","href":"/api-reference/chat/get-a-message"},{"title":"Update a message.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/chat/threads/{threadId}/messages/{messageId}","href":"/api-reference/chat/update-a-message"},{"title":"Soft delete a message.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/chat/threads/{threadId}/messages/{messageId}","href":"/api-reference/chat/soft-delete-a-message"},{"title":"Add an emoji reaction to a message.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/chat/threads/{threadId}/messages/{messageId}/reactions","href":"/api-reference/chat/add-an-emoji-reaction-to-a-message"},{"title":"Remove the current user emoji reaction from a message.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/chat/threads/{threadId}/messages/{messageId}/reactions","href":"/api-reference/chat/remove-the-current-user-emoji-reaction-from-a-message"},{"title":"Restore a message.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/chat/threads/{threadId}/messages/{messageId}/restore","href":"/api-reference/chat/restore-a-message"},{"title":"Mark messages through the selected message as read.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/chat/threads/{threadId}/messages/{messageId}/read","href":"/api-reference/chat/mark-messages-through-the-selected-message-as-read"},{"title":"Mark messages from the selected message onward as unread.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/chat/threads/{threadId}/messages/{messageId}/unread","href":"/api-reference/chat/mark-messages-from-the-selected-message-onward-as-unread"},{"title":"Create a file upload session for a message attachment.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/chat/threads/{threadId}/messages/{messageId}/uploads","href":"/api-reference/chat/create-a-file-upload-session-for-a-message-attachment"},{"title":"Create a direct upload session for a thread attachment.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/chat/threads/{threadId}/uploads","href":"/api-reference/chat/create-a-direct-upload-session-for-a-thread-attachment"},{"title":"Create an idempotent direct-upload batch for chat attachments.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/chat/threads/{threadId}/upload-batches","href":"/api-reference/chat/create-an-idempotent-direct-upload-batch-for-chat-attachments"},{"title":"Get a chat attachment upload batch.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/chat/threads/{threadId}/upload-batches/{chatUploadBatchId}","href":"/api-reference/chat/get-a-chat-attachment-upload-batch"},{"title":"Discard every unbound upload in a chat attachment batch.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/chat/threads/{threadId}/upload-batches/{chatUploadBatchId}","href":"/api-reference/chat/discard-every-unbound-upload-in-a-chat-attachment-batch"},{"title":"Extend all active sessions in a chat attachment upload batch.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/chat/threads/{threadId}/upload-batches/{chatUploadBatchId}/heartbeat","href":"/api-reference/chat/extend-all-active-sessions-in-a-chat-attachment-upload-batch"},{"title":"Get a thread attachment upload session.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/chat/threads/{threadId}/uploads/{storageUploadSessionId}","href":"/api-reference/chat/get-a-thread-attachment-upload-session"},{"title":"Abort a thread attachment upload session.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/chat/threads/{threadId}/uploads/{storageUploadSessionId}/abort","href":"/api-reference/chat/abort-a-thread-attachment-upload-session"},{"title":"Verify and synchronously finalize a direct chat attachment upload.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/chat/threads/{threadId}/uploads/{storageUploadSessionId}/complete","href":"/api-reference/chat/verify-and-synchronously-finalize-a-direct-chat-attachment-upload"},{"title":"List storage-backed attachments for a thread.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/chat/threads/{threadId}/attachments","href":"/api-reference/chat/list-storage-backed-attachments-for-a-thread"},{"title":"Create a signed download URL for a thread attachment.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/chat/threads/{threadId}/attachments/{storageEntryId}/download","href":"/api-reference/chat/create-a-signed-download-url-for-a-thread-attachment"},{"title":"Create a signed preview URL for a thread attachment.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/chat/threads/{threadId}/attachments/{storageEntryId}/preview","href":"/api-reference/chat/create-a-signed-preview-url-for-a-thread-attachment"},{"title":"Create a signed thumbnail URL for a thread image attachment.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/chat/threads/{threadId}/attachments/{storageEntryId}/thumbnail","href":"/api-reference/chat/create-a-signed-thumbnail-url-for-a-thread-image-attachment"},{"title":"Create a signed download URL for a message attachment.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/chat/threads/{threadId}/messages/{messageId}/attachments/{storageEntryId}/download","href":"/api-reference/chat/create-a-signed-download-url-for-a-message-attachment"},{"title":"Delete one attachment while preserving the chat message.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/chat/threads/{threadId}/messages/{messageId}/attachments/{storageEntryId}","href":"/api-reference/chat/delete-one-attachment-while-preserving-the-chat-message"},{"title":"Search messages across accessible threads.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/chat/search","href":"/api-reference/chat/search-messages-across-accessible-threads"}]},{"group":"Studio","pages":[{"title":"List Studio sessions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/studio/sessions","href":"/api-reference/studio/list-studio-sessions"},{"title":"Create a Studio session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/studio/sessions","href":"/api-reference/studio/create-a-studio-session"},{"title":"Read a shared Studio session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/studio/sessions/shared/{shareId}","href":"/api-reference/studio/read-a-shared-studio-session"},{"title":"Read shared linked conversation messages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/studio/sessions/shared/{shareId}/linked-chats/{linkId}/messages","href":"/api-reference/studio/read-shared-linked-conversation-messages"},{"title":"Read a shared Studio discussion","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/studio/sessions/shared/{shareId}/chat","href":"/api-reference/studio/read-a-shared-studio-discussion"},{"title":"Read a Studio workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/studio/sessions/{sessionId}","href":"/api-reference/studio/read-a-studio-workspace"},{"title":"Delete a Studio workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/studio/sessions/{sessionId}","href":"/api-reference/studio/delete-a-studio-workspace"},{"title":"Update a Studio session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/studio/sessions/{sessionId}","href":"/api-reference/studio/update-a-studio-session"},{"title":"Fork a Studio workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/studio/sessions/{sessionId}/fork","href":"/api-reference/studio/fork-a-studio-workspace"},{"title":"Attach a shareable conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/studio/sessions/{sessionId}/linked-chats","href":"/api-reference/studio/attach-a-shareable-conversation"},{"title":"Detach a linked conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/studio/sessions/{sessionId}/linked-chats/{linkId}/revoke","href":"/api-reference/studio/detach-a-linked-conversation"},{"title":"Read linked conversation messages","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/studio/sessions/{sessionId}/linked-chats/{linkId}/messages","href":"/api-reference/studio/read-linked-conversation-messages"},{"title":"Add a Studio resource","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/studio/sessions/{sessionId}/resources","href":"/api-reference/studio/add-a-studio-resource"},{"title":"Patch Studio working files","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/studio/sessions/{sessionId}/patch","href":"/api-reference/studio/patch-studio-working-files"},{"title":"List Studio files","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/studio/sessions/{sessionId}/files","href":"/api-reference/studio/list-studio-files"},{"title":"Read a Studio file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/studio/sessions/{sessionId}/files/{fileId}","href":"/api-reference/studio/read-a-studio-file"},{"title":"Read the Studio working diff","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/studio/sessions/{sessionId}/diff","href":"/api-reference/studio/read-the-studio-working-diff"},{"title":"Read Studio events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/studio/sessions/{sessionId}/events","href":"/api-reference/studio/read-studio-events"},{"title":"Search Studio files","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/studio/sessions/{sessionId}/search","href":"/api-reference/studio/search-studio-files"},{"title":"Preview a Studio rebase","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/studio/sessions/{sessionId}/rebase","href":"/api-reference/studio/preview-a-studio-rebase"},{"title":"Rebase a Studio workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/studio/sessions/{sessionId}/rebase","href":"/api-reference/studio/rebase-a-studio-workspace"},{"title":"Manage Studio participants","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/studio/sessions/{sessionId}/participants","href":"/api-reference/studio/manage-studio-participants"},{"title":"Create a Studio chat upload batch","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/studio/sessions/{sessionId}/chat/upload-batches","href":"/api-reference/studio/create-a-studio-chat-upload-batch"},{"title":"Read a Studio chat upload batch","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/studio/sessions/{sessionId}/chat/upload-batches/{batchId}","href":"/api-reference/studio/read-a-studio-chat-upload-batch"},{"title":"Extend a Studio chat upload batch","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/studio/sessions/{sessionId}/chat/upload-batches/{batchId}/heartbeat","href":"/api-reference/studio/extend-a-studio-chat-upload-batch"},{"title":"Discard a Studio chat upload batch","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/studio/sessions/{sessionId}/chat/upload-batches/{batchId}/discard","href":"/api-reference/studio/discard-a-studio-chat-upload-batch"},{"title":"Finalize a Studio chat upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/studio/sessions/{sessionId}/chat/upload-sessions/{uploadSessionId}/complete","href":"/api-reference/studio/finalize-a-studio-chat-upload"},{"title":"Read a Studio chat upload reservation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/studio/sessions/{sessionId}/chat/upload-sessions/{uploadSessionId}","href":"/api-reference/studio/read-a-studio-chat-upload-reservation"},{"title":"Read a Studio message attachment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/studio/sessions/{sessionId}/chat/messages/{messageId}/attachments/{entryId}/{representation}","href":"/api-reference/studio/read-a-studio-message-attachment"},{"title":"Read a shared Studio message attachment","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/studio/sessions/shared/{shareId}/chat/messages/{messageId}/attachments/{entryId}/{representation}","href":"/api-reference/studio/read-a-shared-studio-message-attachment"},{"title":"Read a Studio chat message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/studio/sessions/{sessionId}/chat/messages/{messageId}","href":"/api-reference/studio/read-a-studio-chat-message"},{"title":"Edit an authored Studio message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/studio/sessions/{sessionId}/chat/messages/{messageId}","href":"/api-reference/studio/edit-an-authored-studio-message"},{"title":"Read a shared Studio chat message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/studio/sessions/shared/{shareId}/chat/messages/{messageId}","href":"/api-reference/studio/read-a-shared-studio-chat-message"},{"title":"Delete an authored Studio message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/studio/sessions/{sessionId}/chat/messages/{messageId}/delete","href":"/api-reference/studio/delete-an-authored-studio-message"},{"title":"Change a Studio message reaction","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/studio/sessions/{sessionId}/chat/messages/{messageId}/reactions","href":"/api-reference/studio/change-a-studio-message-reaction"},{"title":"Share a Studio session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/studio/sessions/{sessionId}/share","href":"/api-reference/studio/share-a-studio-session"},{"title":"Revoke a Studio share","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/studio/sessions/{sessionId}/share/{shareId}/revoke","href":"/api-reference/studio/revoke-a-studio-share"},{"title":"Update Studio presence","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/studio/sessions/{sessionId}/presence","href":"/api-reference/studio/update-studio-presence"},{"title":"Read the Studio discussion","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/studio/sessions/{sessionId}/chat","href":"/api-reference/studio/read-the-studio-discussion"},{"title":"List advisory Studio work claims","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/studio/sessions/{sessionId}/claims","href":"/api-reference/studio/list-advisory-studio-work-claims"},{"title":"Claim advisory Studio work","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/studio/sessions/{sessionId}/claims","href":"/api-reference/studio/claim-advisory-studio-work"},{"title":"Release an advisory Studio work claim","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/studio/sessions/{sessionId}/claims/{claimId}/release","href":"/api-reference/studio/release-an-advisory-studio-work-claim"},{"title":"Post a Studio message","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/studio/sessions/{sessionId}/chat/message","href":"/api-reference/studio/post-a-studio-message"},{"title":"Freeze a Studio candidate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/studio/sessions/{sessionId}/proposals","href":"/api-reference/studio/freeze-a-studio-candidate"},{"title":"Review a Studio candidate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/studio/sessions/{sessionId}/proposals/{proposalId}/review","href":"/api-reference/studio/review-a-studio-candidate"},{"title":"Commit an approved Studio candidate","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/studio/sessions/{sessionId}/commit","href":"/api-reference/studio/commit-an-approved-studio-candidate"},{"title":"Prepare a Studio runtime release","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/studio/sessions/{sessionId}/prepare","href":"/api-reference/studio/prepare-a-studio-runtime-release"},{"title":"Activate a Studio runtime release","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/studio/sessions/{sessionId}/activate","href":"/api-reference/studio/activate-a-studio-runtime-release"},{"title":"Create the Studio runtime baseline","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/studio/sessions/{sessionId}/runtime/baseline","href":"/api-reference/studio/create-the-studio-runtime-baseline"},{"title":"Roll back the active runtime release","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/studio/sessions/{sessionId}/runtime/rollback","href":"/api-reference/studio/roll-back-the-active-runtime-release"},{"title":"Run native Studio tests","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/studio/sessions/{sessionId}/test-runs","href":"/api-reference/studio/run-native-studio-tests"},{"title":"Read a saved Studio TestRun","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/studio/sessions/{sessionId}/test-runs/{testRunId}","href":"/api-reference/studio/read-a-saved-studio-testrun"},{"title":"Cancel native test result collection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/studio/sessions/{sessionId}/test-runs/{testRunId}/cancel","href":"/api-reference/studio/cancel-native-test-result-collection"}]},{"group":"Native tests","pages":[{"title":"List native test suites","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/native-tests","href":"/api-reference/native-tests/list-native-test-suites"},{"title":"Capture an independent native fixture run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/native-tests/runs","href":"/api-reference/native-tests/capture-an-independent-native-fixture-run"},{"title":"Read an owned native fixture run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/native-tests/runs/{runId}","href":"/api-reference/native-tests/read-an-owned-native-fixture-run"},{"title":"Execute the next queued native fixture suite","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/native-tests/runs/{runId}/execute","href":"/api-reference/native-tests/execute-the-next-queued-native-fixture-suite"},{"title":"Cancel an owned native fixture run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/native-tests/runs/{runId}/cancel","href":"/api-reference/native-tests/cancel-an-owned-native-fixture-run"}]},{"group":"Automation","pages":[{"title":"Look up Event and Schedule definitions.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/automation/trigger","href":"/api-reference/automation/look-up-event-and-schedule-definitions"},{"title":"Get jobs.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/automation/job","href":"/api-reference/automation/get-jobs"},{"title":"Get job.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/automation/job/{jobId}","href":"/api-reference/automation/get-job"},{"title":"Get job logs.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/automation/job/{jobId}/logs","href":"/api-reference/automation/get-job-logs"},{"title":"Retry job.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/job/{jobId}/retry","href":"/api-reference/automation/retry-job"},{"title":"Force run pending job.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/job/{jobId}/run","href":"/api-reference/automation/force-run-pending-job"},{"title":"Cancel jobs.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/job/cancel","href":"/api-reference/automation/cancel-jobs"},{"title":"Delete job.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/job/delete","href":"/api-reference/automation/delete-job"},{"title":"Restore job.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/job/{jobId}/restore","href":"/api-reference/automation/restore-job"},{"title":"Get templates.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/automation/template","href":"/api-reference/automation/get-templates"},{"title":"Create templates.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/template","href":"/api-reference/automation/create-templates"},{"title":"Daily job performance by UTC day and job template.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/automation/performance/jobs","href":"/api-reference/automation/daily-job-performance-by-utc-day-and-job-template"},{"title":"Daily performance for one job template.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/automation/template/{jobTemplateId}/performance","href":"/api-reference/automation/daily-performance-for-one-job-template"},{"title":"Get template.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/automation/template/{jobTemplateId}","href":"/api-reference/automation/get-template"},{"title":"Update template.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/automation/template/{jobTemplateId}","href":"/api-reference/automation/update-template"},{"title":"Run template by exact ID or unique name.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/template/{jobTemplateId}/run","href":"/api-reference/automation/run-template-by-exact-id-or-unique-name"},{"title":"Delete template.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/template/delete","href":"/api-reference/automation/delete-template"},{"title":"Restore template.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/template/{jobTemplateId}/restore","href":"/api-reference/automation/restore-template"},{"title":"Schedule get all.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/automation/schedule","href":"/api-reference/automation/schedule-get-all"},{"title":"Schedule create.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/schedule","href":"/api-reference/automation/schedule-create"},{"title":"Schedule get one.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/automation/schedule/{scheduleId}","href":"/api-reference/automation/schedule-get-one"},{"title":"Schedule update.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/automation/schedule/{scheduleId}","href":"/api-reference/automation/schedule-update"},{"title":"Schedule trigger now.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/schedule/{scheduleId}/run","href":"/api-reference/automation/schedule-trigger-now"},{"title":"Schedule resume.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/schedule/{scheduleId}/activate","href":"/api-reference/automation/schedule-resume"},{"title":"Schedule pause.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/schedule/{scheduleId}/disable","href":"/api-reference/automation/schedule-pause"},{"title":"Schedule delete.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/schedule/delete","href":"/api-reference/automation/schedule-delete"},{"title":"Restore deleted schedule.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/schedule/{scheduleId}/restore","href":"/api-reference/automation/restore-deleted-schedule"},{"title":"Get event history.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/automation/eventHistory","href":"/api-reference/automation/get-event-history"},{"title":"Get event history detailed.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/automation/eventHistory/{eventId}","href":"/api-reference/automation/get-event-history-detailed"},{"title":"Delete event history.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/eventHistory/delete","href":"/api-reference/automation/delete-event-history"},{"title":"Replay event history.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/eventHistory/replay","href":"/api-reference/automation/replay-event-history"},{"title":"Restore event history.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/eventHistory/{eventId}/restore","href":"/api-reference/automation/restore-event-history"},{"title":"List native automation event types with production producers. Custom events are configured separately.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/automation/event-types","href":"/api-reference/automation/list-native-automation-event-types-with-production-producers-custom-events-are-configured-separately"},{"title":"Get events.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/automation/event","href":"/api-reference/automation/get-events"},{"title":"Create events.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/event","href":"/api-reference/automation/create-events"},{"title":"Get event.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/automation/event/{eventId}","href":"/api-reference/automation/get-event"},{"title":"Update event.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/automation/event/{eventId}","href":"/api-reference/automation/update-event"},{"title":"Trigger event.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/event/{eventId}/run","href":"/api-reference/automation/trigger-event"},{"title":"Activate event.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/event/{eventId}/activate","href":"/api-reference/automation/activate-event"},{"title":"Disable event.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/event/{eventId}/disable","href":"/api-reference/automation/disable-event"},{"title":"Delete event.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/event/delete","href":"/api-reference/automation/delete-event"},{"title":"Restore event.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/event/{eventId}/restore","href":"/api-reference/automation/restore-event"},{"title":"List accepted schedule occurrences and their execution references.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/automation/schedule-history","href":"/api-reference/automation/list-accepted-schedule-occurrences-and-their-execution-references"},{"title":"Get one schedule occurrence, its target snapshot and dispatch outcome.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/automation/schedule-history/{scheduleHistoryId}","href":"/api-reference/automation/get-one-schedule-occurrence-its-target-snapshot-and-dispatch-outcome"},{"title":"Get webhooks.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/automation/webhook","href":"/api-reference/automation/get-webhooks"},{"title":"Create webhook.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/webhook","href":"/api-reference/automation/create-webhook"},{"title":"Get webhooks.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/automation/webhook/{webhookId}","href":"/api-reference/automation/get-webhooks-1"},{"title":"List webhook delivery attempts without duplicating the request.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/automation/webhook/{webhookId}/attempts","href":"/api-reference/automation/list-webhook-delivery-attempts-without-duplicating-the-request"},{"title":"Cancel webhooks.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/webhook/cancel","href":"/api-reference/automation/cancel-webhooks"},{"title":"Delete webhook.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/webhook/delete","href":"/api-reference/automation/delete-webhook"},{"title":"Get webhooks.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/webhook/{webhookId}/restore","href":"/api-reference/automation/get-webhooks-2"},{"title":"Preview jobs matching a bulk operation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/jobs/bulk/{action}/preview","href":"/api-reference/automation/preview-jobs-matching-a-bulk-operation"},{"title":"Cancel jobs by IDs or filter as a durable bulk operation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/jobs/bulk/cancel","href":"/api-reference/automation/cancel-jobs-by-ids-or-filter-as-a-durable-bulk-operation"},{"title":"Retry jobs by IDs or filter as a durable bulk operation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/jobs/bulk/retry","href":"/api-reference/automation/retry-jobs-by-ids-or-filter-as-a-durable-bulk-operation"},{"title":"Delete jobs by IDs or filter as a durable bulk operation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/jobs/bulk/delete","href":"/api-reference/automation/delete-jobs-by-ids-or-filter-as-a-durable-bulk-operation"},{"title":"Preview webhooks matching a bulk operation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/webhooks/bulk/{action}/preview","href":"/api-reference/automation/preview-webhooks-matching-a-bulk-operation"},{"title":"Cancel webhooks by IDs or filter as a durable bulk operation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/webhooks/bulk/cancel","href":"/api-reference/automation/cancel-webhooks-by-ids-or-filter-as-a-durable-bulk-operation"},{"title":"Retry webhooks by IDs or filter as a durable bulk operation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/webhooks/bulk/retry","href":"/api-reference/automation/retry-webhooks-by-ids-or-filter-as-a-durable-bulk-operation"},{"title":"Delete webhooks by IDs or filter as a durable bulk operation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/automation/webhooks/bulk/delete","href":"/api-reference/automation/delete-webhooks-by-ids-or-filter-as-a-durable-bulk-operation"},{"title":"Read automation bulk operation progress.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/automation/bulk-operations/{operationId}","href":"/api-reference/automation/read-automation-bulk-operation-progress"},{"title":"Read up to 100 resource outcomes. Use nextCursor for the next page.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/automation/bulk-operations/{operationId}/items","href":"/api-reference/automation/read-up-to-100-resource-outcomes-use-nextcursor-for-the-next-page"}]},{"group":"Assistant","pages":[{"title":"Read Assistant configuration capabilities.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/assistant/configuration","href":"/api-reference/assistant/read-assistant-configuration-capabilities"},{"title":"Validate Assistant configuration without creating a thread.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/assistant/configuration/validate","href":"/api-reference/assistant/validate-assistant-configuration-without-creating-a-thread"},{"title":"Create realtime transcription session.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/assistant/audio/transcription-sessions","href":"/api-reference/assistant/create-realtime-transcription-session"},{"title":"Transcribe recorded assistant audio.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/assistant/audio/transcriptions","href":"/api-reference/assistant/transcribe-recorded-assistant-audio"},{"title":"Get all threads.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/assistant/threads","href":"/api-reference/assistant/get-all-threads"},{"title":"Create thread.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/assistant/threads","href":"/api-reference/assistant/create-thread"},{"title":"Get a thread.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/assistant/threads/{id}","href":"/api-reference/assistant/get-a-thread"},{"title":"Delete thread.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/assistant/threads/{id}","href":"/api-reference/assistant/delete-thread"},{"title":"Get thread goal.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/assistant/threads/{id}/goal","href":"/api-reference/assistant/get-thread-goal"},{"title":"Set thread goal.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/assistant/threads/{id}/goal","href":"/api-reference/assistant/set-thread-goal"},{"title":"Clear thread goal.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/assistant/threads/{id}/goal","href":"/api-reference/assistant/clear-thread-goal"},{"title":"Pause thread goal.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/assistant/threads/{id}/goal/pause","href":"/api-reference/assistant/pause-thread-goal"},{"title":"Resume thread goal.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/assistant/threads/{id}/goal/resume","href":"/api-reference/assistant/resume-thread-goal"},{"title":"Report an assistant conversation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/assistant/threads/{id}/report","href":"/api-reference/assistant/report-an-assistant-conversation"},{"title":"Get thread share state.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/assistant/threads/{id}/share","href":"/api-reference/assistant/get-thread-share-state"},{"title":"Enable thread sharing.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/assistant/threads/{id}/share","href":"/api-reference/assistant/enable-thread-sharing"},{"title":"Disable thread sharing.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/assistant/threads/{id}/share","href":"/api-reference/assistant/disable-thread-sharing"},{"title":"Get a shared thread.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/assistant/shared/{shareId}","href":"/api-reference/assistant/get-a-shared-thread"},{"title":"Get shared thread messages.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/assistant/shared/{shareId}/messages","href":"/api-reference/assistant/get-shared-thread-messages"},{"title":"Get shared assistant message execution details.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/assistant/shared/{shareId}/messages/{messageId}/details","href":"/api-reference/assistant/get-shared-assistant-message-execution-details"},{"title":"Get shared assistant message artifact.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/assistant/shared/{shareId}/messages/{messageId}/artifacts/{artifactId}","href":"/api-reference/assistant/get-shared-assistant-message-artifact"},{"title":"Fork a shared thread from a message.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/assistant/shared/{shareId}/messages/{messageId}/fork","href":"/api-reference/assistant/fork-a-shared-thread-from-a-message"},{"title":"Create lightweight assistant response.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/assistant/responses","href":"/api-reference/assistant/create-lightweight-assistant-response"},{"title":"Create lightweight assistant response with streaming.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/assistant/responses/stream","href":"/api-reference/assistant/create-lightweight-assistant-response-with-streaming"},{"title":"Create thread with streaming.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/assistant/threads/stream","href":"/api-reference/assistant/create-thread-with-streaming"},{"title":"Restore thread.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/assistant/threads/{id}/restore","href":"/api-reference/assistant/restore-thread"},{"title":"Get messages of a thread.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/assistant/threads/{id}/messages","href":"/api-reference/assistant/get-messages-of-a-thread"},{"title":"Send message to a thread.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/assistant/threads/{id}/messages","href":"/api-reference/assistant/send-message-to-a-thread"},{"title":"Delete one assistant message attachment.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/assistant/threads/{id}/messages/{messageId}/attachments/{storageEntryId}","href":"/api-reference/assistant/delete-one-assistant-message-attachment"},{"title":"Get assistant message execution details.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/assistant/threads/{id}/messages/{messageId}/details","href":"/api-reference/assistant/get-assistant-message-execution-details"},{"title":"Get assistant message artifact.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/assistant/threads/{id}/messages/{messageId}/artifacts/{artifactId}","href":"/api-reference/assistant/get-assistant-message-artifact"},{"title":"Steer a processing thread.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/assistant/threads/{id}/steer","href":"/api-reference/assistant/steer-a-processing-thread"},{"title":"Rename a thread.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/assistant/threads/{id}/title","href":"/api-reference/assistant/rename-a-thread"},{"title":"Update thread metadata.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/assistant/threads/{id}/metadata","href":"/api-reference/assistant/update-thread-metadata"},{"title":"Fork a thread from a message.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/assistant/threads/{id}/messages/{messageId}/fork","href":"/api-reference/assistant/fork-a-thread-from-a-message"},{"title":"Retry a thread message.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/assistant/threads/{id}/messages/{messageId}/retry","href":"/api-reference/assistant/retry-a-thread-message"},{"title":"Retry a thread message with streaming.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/assistant/threads/{id}/messages/{messageId}/retry/stream","href":"/api-reference/assistant/retry-a-thread-message-with-streaming"},{"title":"Send message to a thread with streaming.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/assistant/threads/{id}/messages/stream","href":"/api-reference/assistant/send-message-to-a-thread-with-streaming"},{"title":"Steer a processing thread with streaming.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/assistant/threads/{id}/steer/stream","href":"/api-reference/assistant/steer-a-processing-thread-with-streaming"},{"title":"Resolve a pending assistant action.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/assistant/threads/{id}/actions/{actionId}/resolve","href":"/api-reference/assistant/resolve-a-pending-assistant-action"},{"title":"Submit a one-time browser credential without persisting the value.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/assistant/threads/{id}/actions/{actionId}/browser-credential","href":"/api-reference/assistant/submit-a-one-time-browser-credential-without-persisting-the-value"},{"title":"Continue a pending browser action after verified human completion in Live Preview","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/assistant/threads/{id}/actions/{actionId}/browser-completion","href":"/api-reference/assistant/continue-a-pending-browser-action-after-verified-human-completion-in-live-preview"},{"title":"Resolve a pending assistant action with streaming.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/assistant/threads/{id}/actions/{actionId}/resolve/stream","href":"/api-reference/assistant/resolve-a-pending-assistant-action-with-streaming"},{"title":"Cancel thread.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/assistant/threads/{id}/cancel","href":"/api-reference/assistant/cancel-thread"},{"title":"Resume a streamed assistant message.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/assistant/threads/{id}/messages/{messageId}/stream","href":"/api-reference/assistant/resume-a-streamed-assistant-message"},{"title":"Compact thread.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/assistant/threads/{id}/compact","href":"/api-reference/assistant/compact-thread"}]},{"group":"Agent Terminals","pages":[{"title":"Explicitly request local legacy profile names from an authorized foreground runner; personal sessions only","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/terminals/{agentTerminalId}/browser-profile-imports/catalog","href":"/api-reference/agent-terminals/explicitly-request-local-legacy-profile-names-from-an-authorized-foreground-runner;-personal-sessions-only"},{"title":"Import a selected local legacy profile into a new private Vault profile; never overwrites an existing profile","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/terminals/{agentTerminalId}/browser-profile-imports","href":"/api-reference/agent-terminals/import-a-selected-local-legacy-profile-into-a-new-private-vault-profile;-never-overwrites-an-existing-profile"},{"title":"Read metadata-only progress of the caller own profile import without replaying it","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/terminals/{agentTerminalId}/browser-profile-imports/{requestId}","href":"/api-reference/agent-terminals/read-metadata-only-progress-of-the-caller-own-profile-import-without-replaying-it"},{"title":"Open an assigned profile in a separate owned browser context; repeat the request ID to check progress","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/terminals/{agentTerminalId}/browser-profiles/{browserProfileId}/open","href":"/api-reference/agent-terminals/open-an-assigned-profile-in-a-separate-owned-browser-context;-repeat-the-request-id-to-check-progress"},{"title":"Open an assigned profile in a separate owned browser context; repeat the request ID to check progress","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/vault/terminals/{agentTerminalId}/browser-profiles/{browserProfileId}/open","href":"/api-reference/agent-terminals/open-an-assigned-profile-in-a-separate-owned-browser-context;-repeat-the-request-id-to-check-progress-1"},{"title":"List owned persisted browser recordings after a session has ended","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/terminals/{agentTerminalId}/browser-recordings","href":"/api-reference/agent-terminals/list-owned-persisted-browser-recordings-after-a-session-has-ended"},{"title":"List owned persisted browser recordings after a session has ended","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/vault/terminals/{agentTerminalId}/browser-recordings","href":"/api-reference/agent-terminals/list-owned-persisted-browser-recordings-after-a-session-has-ended-1"},{"title":"Provision an explicitly requested private browser recording upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/terminals/{agentTerminalId}/browser-recordings/{recordingId}/provision","href":"/api-reference/agent-terminals/provision-an-explicitly-requested-private-browser-recording-upload"},{"title":"Provision an explicitly requested private browser recording upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/vault/terminals/{agentTerminalId}/browser-recordings/{recordingId}/provision","href":"/api-reference/agent-terminals/provision-an-explicitly-requested-private-browser-recording-upload-1"},{"title":"Verify and finalize a finished private browser recording upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/terminals/{agentTerminalId}/browser-recordings/{recordingId}/finalize","href":"/api-reference/agent-terminals/verify-and-finalize-a-finished-private-browser-recording-upload"},{"title":"Verify and finalize a finished private browser recording upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/vault/terminals/{agentTerminalId}/browser-recordings/{recordingId}/finalize","href":"/api-reference/agent-terminals/verify-and-finalize-a-finished-private-browser-recording-upload-1"},{"title":"List current owned browser contexts for Live Preview in one assistant thread","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/terminals/{agentTerminalId}/browser-sessions","href":"/api-reference/agent-terminals/list-current-owned-browser-contexts-for-live-preview-in-one-assistant-thread"},{"title":"List current owned browser contexts for Live Preview in one assistant thread","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/vault/terminals/{agentTerminalId}/browser-sessions","href":"/api-reference/agent-terminals/list-current-owned-browser-contexts-for-live-preview-in-one-assistant-thread-1"},{"title":"Register a pending workspace on an existing owned device without changing its identity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/terminals/{agentTerminalId}/workspaces/register","href":"/api-reference/agent-terminals/register-a-pending-workspace-on-an-existing-owned-device-without-changing-its-identity"},{"title":"Register a pending workspace on an existing owned device without changing its identity","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/vault/terminals/{agentTerminalId}/workspaces/register","href":"/api-reference/agent-terminals/register-a-pending-workspace-on-an-existing-owned-device-without-changing-its-identity-1"},{"title":"Update workspace browser preferences without changing execution permissions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/terminals/{agentTerminalId}/workspaces/{workspaceId}/browser-settings","href":"/api-reference/agent-terminals/update-workspace-browser-preferences-without-changing-execution-permissions"},{"title":"Update workspace browser preferences without changing execution permissions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/vault/terminals/{agentTerminalId}/workspaces/{workspaceId}/browser-settings","href":"/api-reference/agent-terminals/update-workspace-browser-preferences-without-changing-execution-permissions-1"},{"title":"Atomically replace workspace grants using the expected device revision","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/terminals/{agentTerminalId}/workspaces","href":"/api-reference/agent-terminals/atomically-replace-workspace-grants-using-the-expected-device-revision"},{"title":"Atomically replace workspace grants using the expected device revision","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/vault/terminals/{agentTerminalId}/workspaces","href":"/api-reference/agent-terminals/atomically-replace-workspace-grants-using-the-expected-device-revision-1"},{"title":"List current terminal grants and recent removal history","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/terminals","href":"/api-reference/agent-terminals/list-current-terminal-grants-and-recent-removal-history"},{"title":"List current terminal grants and recent removal history","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/vault/terminals","href":"/api-reference/agent-terminals/list-current-terminal-grants-and-recent-removal-history-1"},{"title":"Search ACL-visible agent terminals by name, workspace or ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/terminals/search","href":"/api-reference/agent-terminals/search-acl-visible-agent-terminals-by-name-workspace-or-id"},{"title":"Search ACL-visible agent terminals by name, workspace or ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/vault/terminals/search","href":"/api-reference/agent-terminals/search-acl-visible-agent-terminals-by-name-workspace-or-id-1"},{"title":"Page through agent terminals visible to this user, including owned pending requests","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/terminals/grid","href":"/api-reference/agent-terminals/page-through-agent-terminals-visible-to-this-user-including-owned-pending-requests"},{"title":"Page through agent terminals visible to this user, including owned pending requests","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/vault/terminals/grid","href":"/api-reference/agent-terminals/page-through-agent-terminals-visible-to-this-user-including-owned-pending-requests-1"},{"title":"Register a pending terminal for explicit browser approval","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/terminals/pair","href":"/api-reference/agent-terminals/register-a-pending-terminal-for-explicit-browser-approval"},{"title":"Register a pending terminal for explicit browser approval","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/vault/terminals/pair","href":"/api-reference/agent-terminals/register-a-pending-terminal-for-explicit-browser-approval-1"},{"title":"List immutable terminal configuration snapshots for the owner","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/terminals/{agentTerminalId}/versions","href":"/api-reference/agent-terminals/list-immutable-terminal-configuration-snapshots-for-the-owner"},{"title":"List immutable terminal configuration snapshots for the owner","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/vault/terminals/{agentTerminalId}/versions","href":"/api-reference/agent-terminals/list-immutable-terminal-configuration-snapshots-for-the-owner-1"},{"title":"Search terminal connection and command activity with a stable cursor","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/terminals/activity","href":"/api-reference/agent-terminals/search-terminal-connection-and-command-activity-with-a-stable-cursor"},{"title":"Search terminal connection and command activity with a stable cursor","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/vault/terminals/activity","href":"/api-reference/agent-terminals/search-terminal-connection-and-command-activity-with-a-stable-cursor-1"},{"title":"Get one terminal activity entry with bounded stdout and stderr","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/terminals/activity/{activityId}","href":"/api-reference/agent-terminals/get-one-terminal-activity-entry-with-bounded-stdout-and-stderr"},{"title":"Get one terminal activity entry with bounded stdout and stderr","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/vault/terminals/activity/{activityId}","href":"/api-reference/agent-terminals/get-one-terminal-activity-entry-with-bounded-stdout-and-stderr-1"},{"title":"Get the current bounded shell output for one execution","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/terminals/activity/execution/{executionId}","href":"/api-reference/agent-terminals/get-the-current-bounded-shell-output-for-one-execution"},{"title":"Get the current bounded shell output for one execution","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/vault/terminals/activity/execution/{executionId}","href":"/api-reference/agent-terminals/get-the-current-bounded-shell-output-for-one-execution-1"},{"title":"Approve a pending personal terminal grant from the browser","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/terminals/{agentTerminalId}/approve","href":"/api-reference/agent-terminals/approve-a-pending-personal-terminal-grant-from-the-browser"},{"title":"Approve a pending personal terminal grant from the browser","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/vault/terminals/{agentTerminalId}/approve","href":"/api-reference/agent-terminals/approve-a-pending-personal-terminal-grant-from-the-browser-1"},{"title":"Change command review mode for an approved terminal without disconnecting it","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/terminals/{agentTerminalId}/mode","href":"/api-reference/agent-terminals/change-command-review-mode-for-an-approved-terminal-without-disconnecting-it"},{"title":"Change command review mode for an approved terminal without disconnecting it","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/vault/terminals/{agentTerminalId}/mode","href":"/api-reference/agent-terminals/change-command-review-mode-for-an-approved-terminal-without-disconnecting-it-1"},{"title":"Change network permission for an approved terminal without disconnecting it","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/terminals/{agentTerminalId}/network-mode","href":"/api-reference/agent-terminals/change-network-permission-for-an-approved-terminal-without-disconnecting-it"},{"title":"Change network permission for an approved terminal without disconnecting it","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/vault/terminals/{agentTerminalId}/network-mode","href":"/api-reference/agent-terminals/change-network-permission-for-an-approved-terminal-without-disconnecting-it-1"},{"title":"Set instance sharing and user/group ACL for an owned approved terminal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/terminals/{agentTerminalId}/access","href":"/api-reference/agent-terminals/set-instance-sharing-and-usergroup-acl-for-an-owned-approved-terminal"},{"title":"Set instance sharing and user/group ACL for an owned approved terminal","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/vault/terminals/{agentTerminalId}/access","href":"/api-reference/agent-terminals/set-instance-sharing-and-usergroup-acl-for-an-owned-approved-terminal-1"},{"title":"Remove a personal terminal grant and retain a bounded audit record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/terminals/{agentTerminalId}/revoke","href":"/api-reference/agent-terminals/remove-a-personal-terminal-grant-and-retain-a-bounded-audit-record"},{"title":"Remove a personal terminal grant and retain a bounded audit record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/vault/terminals/{agentTerminalId}/revoke","href":"/api-reference/agent-terminals/remove-a-personal-terminal-grant-and-retain-a-bounded-audit-record-1"}]},{"group":"Browser Profiles","pages":[{"title":"List authorized Vault browser profile metadata without authentication state","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/vault/browser-profiles","href":"/api-reference/browser-profiles/list-authorized-vault-browser-profile-metadata-without-authentication-state"},{"title":"Create a private encrypted browser profile; access and assignments are explicit","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/vault/browser-profiles","href":"/api-reference/browser-profiles/create-a-private-encrypted-browser-profile;-access-and-assignments-are-explicit"},{"title":"Read one authorized profile metadata record without website authentication state","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/vault/browser-profiles/{browserProfileId}","href":"/api-reference/browser-profiles/read-one-authorized-profile-metadata-record-without-website-authentication-state"},{"title":"Owner updates profile metadata and grants; access changes fence previous writers","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/vault/browser-profiles/{browserProfileId}","href":"/api-reference/browser-profiles/owner-updates-profile-metadata-and-grants;-access-changes-fence-previous-writers"},{"title":"List active profile leases; owners see all, grantees only their own sessions","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/vault/browser-profiles/{browserProfileId}/sessions","href":"/api-reference/browser-profiles/list-active-profile-leases;-owners-see-all-grantees-only-their-own-sessions"},{"title":"Owner or session actor stops one context without clearing the last saved authentication state","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/vault/browser-profiles/{browserProfileId}/sessions/{browserSessionId}/close","href":"/api-reference/browser-profiles/owner-or-session-actor-stops-one-context-without-clearing-the-last-saved-authentication-state"},{"title":"Owner clears saved website authentication and rotates its data key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/vault/browser-profiles/{browserProfileId}/clear","href":"/api-reference/browser-profiles/owner-clears-saved-website-authentication-and-rotates-its-data-key"},{"title":"Owner removes the profile, its assignments and active writer leases","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/vault/browser-profiles/{browserProfileId}/remove","href":"/api-reference/browser-profiles/owner-removes-the-profile-its-assignments-and-active-writer-leases"}]},{"group":"Agent Memory","pages":[{"title":"Get the logged-in user canonical memory digest","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/memory/me/digest","href":"/api-reference/agent-memory/get-the-logged-in-user-canonical-memory-digest"},{"title":"Create or update the logged-in user canonical memory digest","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/agents/memory/me/digest","href":"/api-reference/agent-memory/create-or-update-the-logged-in-user-canonical-memory-digest"},{"title":"Clear the logged-in user canonical memory digest","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/agents/memory/me/digest","href":"/api-reference/agent-memory/clear-the-logged-in-user-canonical-memory-digest"},{"title":"Edit existing memory text with literal replacements and a base version.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/memory/{agentMemoryId}/edit","href":"/api-reference/agent-memory/edit-existing-memory-text-with-literal-replacements-and-a-base-version"},{"title":"List agent runtime memory","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/memory","href":"/api-reference/agent-memory/list-agent-runtime-memory"},{"title":"Create Agent memory","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/memory","href":"/api-reference/agent-memory/create-agent-memory"},{"title":"Get Agent memory","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/memory/{agentMemoryId}","href":"/api-reference/agent-memory/get-agent-memory"},{"title":"Delete Agent memory","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/agents/memory/{agentMemoryId}","href":"/api-reference/agent-memory/delete-agent-memory"},{"title":"Update Agent memory","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/agents/memory/{agentMemoryId}","href":"/api-reference/agent-memory/update-agent-memory"},{"title":"Delete multiple Agent memory entries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/memory/delete","href":"/api-reference/agent-memory/delete-multiple-agent-memory-entries"},{"title":"Restore Agent memory","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/memory/{agentMemoryId}/restore","href":"/api-reference/agent-memory/restore-agent-memory"}]},{"group":"Agents","pages":[{"title":"List Agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents","href":"/api-reference/agents/list-agents"},{"title":"Create an Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents","href":"/api-reference/agents/create-an-agent"},{"title":"Get the Agent tool registry","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/toolRegistry","href":"/api-reference/agents/get-the-agent-tool-registry"},{"title":"Read inherited Agent plugin attachments","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/pluginDefaults","href":"/api-reference/agents/read-inherited-agent-plugin-attachments"},{"title":"Find selectable Agent terminals","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/terminalCandidates","href":"/api-reference/agents/find-selectable-agent-terminals"},{"title":"Find selectable terminals for an Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/{agentId}/terminals","href":"/api-reference/agents/find-selectable-terminals-for-an-agent"},{"title":"Summarize readable Agent workspace storage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/{agentId}/storage/summary","href":"/api-reference/agents/summarize-readable-agent-workspace-storage"},{"title":"List accessible Agent conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/conversations","href":"/api-reference/agents/list-accessible-agent-conversations"},{"title":"Explore an Agent workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/{agentId}/storage","href":"/api-reference/agents/explore-an-agent-workspace"},{"title":"Archive Agent workspace entries","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/agents/{agentId}/storage/bulk/archive","href":"/api-reference/agents/archive-agent-workspace-entries"},{"title":"Create an Agent workspace download URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/{agentId}/storage/{storageEntryId}/download","href":"/api-reference/agents/create-an-agent-workspace-download-url"},{"title":"Create an Agent workspace preview URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/{agentId}/storage/{storageEntryId}/preview","href":"/api-reference/agents/create-an-agent-workspace-preview-url"},{"title":"Create an Agent workspace thumbnail URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/{agentId}/storage/{storageEntryId}/thumbnail","href":"/api-reference/agents/create-an-agent-workspace-thumbnail-url"},{"title":"Create an Agent workspace folder","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/{agentId}/storage/folders","href":"/api-reference/agents/create-an-agent-workspace-folder"},{"title":"Create an Agent workspace upload session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/{agentId}/storage/uploads","href":"/api-reference/agents/create-an-agent-workspace-upload-session"},{"title":"Get an Agent workspace upload session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/{agentId}/storage/uploads/{storageUploadSessionId}","href":"/api-reference/agents/get-an-agent-workspace-upload-session"},{"title":"Finalize an Agent workspace upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/agents/{agentId}/storage/uploads/{storageUploadSessionId}/finalize","href":"/api-reference/agents/finalize-an-agent-workspace-upload"},{"title":"Abort an Agent workspace upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/agents/{agentId}/storage/uploads/{storageUploadSessionId}/abort","href":"/api-reference/agents/abort-an-agent-workspace-upload"},{"title":"Assign an Agent workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json put /api/v1/agents/{agentId}/workspace","href":"/api-reference/agents/assign-an-agent-workspace"},{"title":"Get an Agent run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/runs/{agentRunId}","href":"/api-reference/agents/get-an-agent-run"},{"title":"Report an agent run conversation.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/runs/{agentRunId}/report","href":"/api-reference/agents/report-an-agent-run-conversation"},{"title":"Get an Agent session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/sessions/{agentSessionId}","href":"/api-reference/agents/get-an-agent-session"},{"title":"Archive an Agent conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/agents/sessions/{agentSessionId}/conversation","href":"/api-reference/agents/archive-an-agent-conversation"},{"title":"List Agent run events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/runs/{agentRunId}/events","href":"/api-reference/agents/list-agent-run-events"},{"title":"List Assistant threads linked to an Agent run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/runs/{agentRunId}/threads","href":"/api-reference/agents/list-assistant-threads-linked-to-an-agent-run"},{"title":"Request an Agent run tick","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/runs/{agentRunId}/tick","href":"/api-reference/agents/request-an-agent-run-tick"},{"title":"Resume an Agent run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/runs/{agentRunId}/resume","href":"/api-reference/agents/resume-an-agent-run"},{"title":"Retry an Agent run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/runs/{agentRunId}/retry","href":"/api-reference/agents/retry-an-agent-run"},{"title":"Continue an Agent run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/runs/{agentRunId}/continue","href":"/api-reference/agents/continue-an-agent-run"},{"title":"Queue an operator response to the latest Agent conversation action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/runs/{agentRunId}/actions/{actionId}/resolve","href":"/api-reference/agents/queue-an-operator-response-to-the-latest-agent-conversation-action"},{"title":"Cancel an Agent run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/runs/{agentRunId}/cancel","href":"/api-reference/agents/cancel-an-agent-run"},{"title":"List Agent inbox items","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/{agentId}/inbox","href":"/api-reference/agents/list-agent-inbox-items"},{"title":"Create an Agent inbox item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/{agentId}/inbox","href":"/api-reference/agents/create-an-agent-inbox-item"},{"title":"Claim the next Agent inbox item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/{agentId}/claim-inbox","href":"/api-reference/agents/claim-the-next-agent-inbox-item"},{"title":"List memory for an Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/{agentId}/memory","href":"/api-reference/agents/list-memory-for-an-agent"},{"title":"Create memory for an Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/{agentId}/memory","href":"/api-reference/agents/create-memory-for-an-agent"},{"title":"Get memory for an Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/{agentId}/memory/{agentMemoryId}","href":"/api-reference/agents/get-memory-for-an-agent"},{"title":"Delete memory for an Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/agents/{agentId}/memory/{agentMemoryId}","href":"/api-reference/agents/delete-memory-for-an-agent"},{"title":"Update memory for an Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/agents/{agentId}/memory/{agentMemoryId}","href":"/api-reference/agents/update-memory-for-an-agent"},{"title":"Restore memory for an Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/{agentId}/memory/{agentMemoryId}/restore","href":"/api-reference/agents/restore-memory-for-an-agent"},{"title":"Get an Agent inbox item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/{agentId}/inbox/{agentInboxItemId}","href":"/api-reference/agents/get-an-agent-inbox-item"},{"title":"Delete an Agent inbox item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/agents/{agentId}/inbox/{agentInboxItemId}","href":"/api-reference/agents/delete-an-agent-inbox-item"},{"title":"Update an Agent inbox item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/agents/{agentId}/inbox/{agentInboxItemId}","href":"/api-reference/agents/update-an-agent-inbox-item"},{"title":"Reconcile Agent runtime state","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/reconcile","href":"/api-reference/agents/reconcile-agent-runtime-state"},{"title":"Get an Agent summary","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/{agentId}/summary","href":"/api-reference/agents/get-an-agent-summary"},{"title":"Get an Agent overview","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/{agentId}/overview","href":"/api-reference/agents/get-an-agent-overview"},{"title":"Get an Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/{agentId}","href":"/api-reference/agents/get-an-agent"},{"title":"Delete an Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/agents/{agentId}","href":"/api-reference/agents/delete-an-agent"},{"title":"Update an Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/agents/{agentId}","href":"/api-reference/agents/update-an-agent"},{"title":"Upload an Agent avatar","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/{agentId}/uploadAvatar","href":"/api-reference/agents/upload-an-agent-avatar"},{"title":"Generate an Agent avatar","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/{agentId}/generateAvatar","href":"/api-reference/agents/generate-an-agent-avatar"},{"title":"Clear an Agent avatar","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/{agentId}/clearAvatar","href":"/api-reference/agents/clear-an-agent-avatar"},{"title":"Restore an Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/{agentId}/restore","href":"/api-reference/agents/restore-an-agent"},{"title":"List durable Agent conversations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/{agentId}/conversations","href":"/api-reference/agents/list-durable-agent-conversations"},{"title":"List runs for an Agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agents/{agentId}/runs","href":"/api-reference/agents/list-runs-for-an-agent"},{"title":"Start an Agent run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agents/{agentId}/run","href":"/api-reference/agents/start-an-agent-run"},{"title":"Generate an avatar image for an editable profile, group, Agent or plugin.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/avatars/generate","href":"/api-reference/agents/generate-an-avatar-image-for-an-editable-profile-group-agent-or-plugin"},{"title":"Import a public HTTPS image for cropping and persistent avatar upload.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/avatars/import","href":"/api-reference/agents/import-a-public-https-image-for-cropping-and-persistent-avatar-upload"}]},{"group":"Agent Plugins","pages":[{"title":"Edit existing plugin text with literal replacements and a base version.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agent/plugins/{agentPluginId}/edit","href":"/api-reference/agent-plugins/edit-existing-plugin-text-with-literal-replacements-and-a-base-version"},{"title":"List agent plugins","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agent/plugins","href":"/api-reference/agent-plugins/list-agent-plugins"},{"title":"Create an agent plugin","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agent/plugins","href":"/api-reference/agent-plugins/create-an-agent-plugin"},{"title":"List active MCP plugins requesting a personal Vault binding","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agent/plugins/personal-vault-requirements","href":"/api-reference/agent-plugins/list-active-mcp-plugins-requesting-a-personal-vault-binding"},{"title":"Find active component-backed Tools eligible for personal Vault access","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agent/plugins/personal-vault-tools","href":"/api-reference/agent-plugins/find-active-component-backed-tools-eligible-for-personal-vault-access"},{"title":"Delete agent plugins","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agent/plugins/delete","href":"/api-reference/agent-plugins/delete-agent-plugins"},{"title":"Get an agent plugin","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/agent/plugins/{agentPluginId}","href":"/api-reference/agent-plugins/get-an-agent-plugin"},{"title":"Delete an agent plugin","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /api/v1/agent/plugins/{agentPluginId}","href":"/api-reference/agent-plugins/delete-an-agent-plugin"},{"title":"Update an agent plugin","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/agent/plugins/{agentPluginId}","href":"/api-reference/agent-plugins/update-an-agent-plugin"},{"title":"Set a public HTTPS icon URL for an agent plugin or package.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /api/v1/agent/plugins/{agentPluginId}/icon-url","href":"/api-reference/agent-plugins/set-a-public-https-icon-url-for-an-agent-plugin-or-package"},{"title":"Upload an agent plugin icon.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agent/plugins/{agentPluginId}/upload-icon","href":"/api-reference/agent-plugins/upload-an-agent-plugin-icon"},{"title":"Clear an agent plugin icon.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agent/plugins/{agentPluginId}/clear-icon","href":"/api-reference/agent-plugins/clear-an-agent-plugin-icon"},{"title":"Test an agent plugin","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agent/plugins/{agentPluginId}/test","href":"/api-reference/agent-plugins/test-an-agent-plugin"},{"title":"Sync an agent plugin","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agent/plugins/{agentPluginId}/sync","href":"/api-reference/agent-plugins/sync-an-agent-plugin"},{"title":"Synchronize this account's personal MCP tools","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agent/plugins/{agentPluginId}/sync-personal","href":"/api-reference/agent-plugins/synchronize-this-accounts-personal-mcp-tools"},{"title":"Restore an agent plugin","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/agent/plugins/{agentPluginId}/restore","href":"/api-reference/agent-plugins/restore-an-agent-plugin"}]},{"group":"Share","pages":[{"title":"Create a short-lived share link for the current instance.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /api/v1/share","href":"/api-reference/share/create-a-short-lived-share-link-for-the-current-instance"},{"title":"Resolve a share link for the current instance.","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /api/v1/share/{shareId}","href":"/api-reference/share/resolve-a-share-link-for-the-current-instance"}]}]}]},{"tab":"Changelog","icon":"clock-rotate-left","pages":[{"title":"Changelog","href":"/releases/changelog"}]}]},"basePath":"","title":"agent.get() - RevoEngine","buildId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","deploymentId":"dpl_FWZhTb2vab28gFGFH4ojka6qEznQ","dynamics":[],"chunks":[]}
