Partially updates a workspace. Omit a field to leave it unchanged. Set archived to true to archive, false to restore. The workspace key cannot be changed.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Orq.ai Documentation","colors":{"primary":"#027f6b","light":"#00d2b5","dark":"#027f6b"},"logo":{"light":"https://mintcdn.com/orqai/OG_14djpK9Yasgfk/images/Orq_ai_Symbol_Dark.svg?fit=max\u0026auto=format\u0026n=OG_14djpK9Yasgfk\u0026q=85\u0026s=d01651850182afdbc6309808b688d470","dark":"https://mintcdn.com/orqai/BYq_L5I_ZDBWL_Pf/images/Orq_ai_Symbol_Light.svg?fit=max\u0026auto=format\u0026n=BYq_L5I_ZDBWL_Pf\u0026q=85\u0026s=3e372f93174202f20c31d2c045af92b9","href":"/ai-gateway/get-started/introduction"},"favicon":"https://mintcdn.com/orqai/rmwcfFw4PPljHRCz/favicon.svg?fit=max\u0026auto=format\u0026n=rmwcfFw4PPljHRCz\u0026q=85\u0026s=1827beca4e1fb46e074d8bda067f3fb1","api":{"openapi":"openapi.json","examples":{"languages":["curl","typescript","python"]}},"background":{"color":{"light":"#f7f6f5","dark":"#171717"}},"navbar":{"links":[],"primary":{"type":"button","label":"Get Started","href":"https://my.orq.ai/auth/signup"}},"footer":{"socials":{"github":"https://github.com/orq-ai","x":"https://x.com/orq_ai","linkedin":"https://www.linkedin.com/company/orqai","website":"https://orq.ai"}},"seo":{"metatags":{"author":"Orq.ai","og:type":"website","og:site_name":"Orq.ai Documentation","og:locale":"en_US","twitter:card":"summary_large_image","twitter:site":"@orq_ai","twitter:creator":"@orq_ai","viewport":"width=device-width, initial-scale=1.0","robots":"index, follow","language":"English"},"organization":{"id":"https://docs.orq.ai/#organization","name":"Orq.ai","legalName":"Orq.AI Holding B.V.","url":"https://orq.ai","logo":"https://docs.orq.ai/images/Orq_ai_Symbol_Dark.svg","sameAs":["https://github.com/orq-ai","https://x.com/orq_ai","https://www.linkedin.com/company/orqai/"]},"indexing":"all"},"fonts":{"heading":{"family":"ES Klarheit Kurrent Semibold","weight":600,"source":"https://framerusercontent.com/assets/HiovZWjG27S5NQhE8dyeECDMc.woff2","format":"woff2"},"body":{"family":"Inter","source":"https://cdn.jsdelivr.net/npm/@fontsource/inter@5.0.8/files/inter-latin-400-normal.woff2","format":"woff2"}},"styling":{"codeblocks":{"theme":{"light":"github-light","dark":"github-dark"}},"latex":true},"integrations":{"posthog":{"apiKey":"phc_MKGkZTCrnrBUKVqT0XxWbfDqCwik8EF2GIob0NhCU3C","apiHost":"https://eu.i.posthog.com"}},"contextual":{"options":["copy","download-spec","chatgpt","claude","view"],"display":"header"},"interaction":{"drilldown":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"orqai","hasAudioNarration":false,"actualSubdomain":"orqai","customDomains":["docs.orq.ai"],"gitSource":{"type":"github","owner":"orq-ai","repo":"orquesta-web","deployBranch":"main","contentDirectory":"documentation/mintlify","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae126c9282ca4391afebeec","collectionId":"d39ae0d7-37db-4a5f-bcfd-37c215e0c4fd","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae126c9282ca4391afebeec"},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae126c9282ca4391afebeec","clientVersion":"0.0.3990","searchFilterCounts":[{"language":"default","tag":"API Reference","count":410},{"language":"default","tag":"Platform APIs","count":263},{"language":"default","tag":"Integrations","count":93},{"language":"default","tag":"Orq SDK","count":71},{"language":"default","tag":"AI Gateway","count":69},{"language":"default","tag":"Management APIs","count":68},{"language":"default","tag":"SDK Reference","count":68},{"language":"default","tag":"Cookbooks","count":34},{"language":"default","tag":"Model Providers","count":31},{"language":"default","tag":"Frameworks \u0026 SDKs","count":30}],"searchSettings":{"maxResults":15}},"assistantConfig":{"enableStarterQuestions":true,"enableContextualStarterQuestions":true,"deflection":{"enabled":true,"email":"support@orq.ai","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"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":"editor-v7-file-tree","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":"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":"pause-universal-search-reconcile","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":"per-site-search-delta","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":"editor-private-page-search","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":"editor-nav-generations","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":"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":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-agent-model-picker","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","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":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"isAtlas":false,"googleFontsInlined":false},"customCss":[{"filePath":"custom.css","content":".nav-anchor img{border-radius:50%}.ig-root{scroll-margin-top:6rem}.ig-search{width:100%;padding:10px 14px 10px 38px;border-radius:8px;border:1px solid rgba(0,0,0,.15);font-size:14px;outline:0;margin-bottom:20px;background:0 0;box-sizing:border-box;background-image:url(\"data:image/svg+xml,%3Csvg xmlns='http://www.w3.org/2000/svg' width='16' height='16' fill='none' viewBox='0 0 24 24'%3E%3Cpath stroke='%23999' stroke-linecap='round' stroke-linejoin='round' stroke-width='2' d='m21 21-4.35-4.35M17 11A6 6 0 1 1 5 11a6 6 0 0 1 12 0Z'/%3E%3C/svg%3E\");background-repeat:no-repeat;background-position:12px center}.dark .ig-search{border-color:rgba(255,255,255,.15)}.ig-search:focus{border-color:#027f6b}.ig-tabs{display:flex;border-bottom:1px solid rgba(0,0,0,.1);margin-bottom:20px;gap:0}.dark .ig-tabs{border-bottom-color:rgba(255,255,255,.1)}.ig-tab{padding:8px 16px;background:0 0;border:0;border-bottom:2px solid transparent;margin-bottom:-1px;cursor:pointer;font-size:14px;font-weight:500;color:#888;white-space:nowrap}.ig-tab:hover{color:#027f6b}.dark .ig-tab:hover{color:#677f78}.ig-tab-active{border-bottom-color:#027f6b!important;color:#027f6b!important}.dark .ig-tab-active{border-bottom-color:#677f78!important;color:#677f78!important}.ig-grid{display:grid;grid-template-columns:repeat(4,1fr);gap:6px}@media (max-width:768px){.ig-grid{grid-template-columns:repeat(3,1fr)}}@media (max-width:480px){.ig-grid{grid-template-columns:repeat(2,1fr)}}.ig-card{display:flex;align-items:center;gap:8px;padding:10px 14px;border:1px solid rgba(0,0,0,.1);border-radius:6px;text-decoration:none!important;color:inherit!important;font-size:14px;font-weight:500;transition:background .12s,border-color .12s}.ig-card:hover{background:rgba(2,127,107,.05);border-color:rgba(2,127,107,.25)}.dark .ig-card{border-color:rgba(255,255,255,.1)}.dark .ig-card:hover{background:rgba(103,127,120,.1);border-color:rgba(103,127,120,.3)}.ig-card-icon{width:20px;height:20px;object-fit:contain;flex-shrink:0}.ig-tab-count{display:inline-flex;align-items:center;justify-content:center;margin-left:6px;padding:0 5px;min-width:18px;height:18px;border-radius:9px;font-size:11px;font-weight:600;background:rgba(0,0,0,.08);color:inherit}.dark .ig-tab-count{background:rgba(255,255,255,.12)}.ig-tab-active .ig-tab-count{background:rgba(2,127,107,.15)}.dark .ig-tab-active .ig-tab-count{background:rgba(103,127,120,.25)}.ig-empty{text-align:center;padding:48px 24px;color:#999;font-size:14px;grid-column:1/-1}kbd.key,kbd.key *{color:#fff!important}kbd.key{background:#242424;border-radius:5px;padding:2px 8px;font-size:.85em;display:inline-flex;align-items:center;gap:6px;border:1px solid #3a3a3a;font-family:inherit;white-space:nowrap}#sidebar-content .flex-1:has(>svg.flex-shrink-0){flex:none!important}#sidebar-content{width:16rem!important;min-width:16rem!important}@media (min-width:1024px){.lg\\:pl-56{padding-left:16rem!important}}.topbar-right-container nav[aria-label=Main] .navbar-link a,.topbar-right-container nav[aria-label=Main] .navbar-link a:hover{background-color:transparent!important}@media (min-width:1024px){.topbar-right-container nav[aria-label=Main] ul{gap:1rem!important}.topbar-right-container nav[aria-label=Main] .navbar-link a{padding-left:0!important;padding-right:0!important}#page-title{font-size:2rem!important;line-height:1.2!important}}.nav-tabs-item:has(a[href^='/reference']){display:none!important}#navbar .nav-tabs-item[href='/ai-studio/integrations/overview']{position:relative}#navbar .nav-tabs-item[href='/ai-studio/integrations/overview']::before{content:'';position:absolute;top:50%;left:-12px;transform:translateY(-50%);height:55%;width:1px;background:rgba(0,0,0,.15)}.dark #navbar .nav-tabs-item[href='/ai-studio/integrations/overview']::before{background:rgba(255,255,255,.15)}@media (min-width:1280px){#content-container{padding-left:3rem!important;padding-right:2rem!important}#content-side-layout{max-width:20rem!important}#content-area{width:calc(100% - 20rem)!important}}.md-export-list{display:none}"}],"page":{"pagePath":"reference/workspaces/update-a-workspace","slug":"/reference/workspaces/update-a-workspace","pageMetadata":{"openapi":"patch /v2/workspaces/{key}","title":"Update a workspace","description":"Partially updates a workspace. Omit a field to leave it unchanged. Set `archived` to true to archive, false to restore. The workspace key cannot be changed.","href":"/reference/workspaces/update-a-workspace"},"description":{"compiledSource":"\"use strict\";\nconst {jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n code: \"code\",\n p: \"p\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_components.p, {\n children: [\"Partially updates a workspace. Omit a field to leave it unchanged. Set \", _jsx(_components.code, {\n children: \"archived\"\n }), \" to true to archive, false to restore. The workspace key cannot be changed.\"]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"codeStyling":{"theme":{"light":"github-light","dark":"github-dark"}},"config":{},"pageMetadata":{"openapi":"patch /v2/workspaces/{key}","title":"Update a workspace","description":"Partially updates a workspace. Omit a field to leave it unchanged. Set `archived` to true to archive, false to restore. The workspace key cannot be changed.","href":"/reference/workspaces/update-a-workspace"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/orqai/19ee3574279bbaa0/gtm.js","/_mintlify/custom/orqai/1f1a49b99957b631/commonroom-signals.js"],"openApiReferenceData":{"operation":{"tags":["Workspaces"],"summary":"Update a workspace","description":"Partially updates a workspace. Omit a field to leave it unchanged. Set `archived` to true to archive, false to restore. The workspace key cannot be changed.","operationId":"WorkspaceUpdate","parameters":["fe23054c-e4d2-45ad-9922-ff42d682dab5"],"requestBody":"bf77b93d-dbb9-4ca6-b274-67247285f04a","responses":{"200":"dd90d8e3-2d77-4563-97e3-a264b1f7292a","401":"e02cf06d-59f9-4e40-8d46-8b5dad09b525"},"x-speakeasy-group":"workspaces","x-speakeasy-name-override":"update","method":"patch","type":"path","servers":["adcb47b8-aba4-4af5-9c63-0bb140d849da"],"security":["34c064c7-ee3d-4bbd-bd3b-42ee6ee0b117"],"path":"/v2/workspaces/{key}","baseUrlOptions":["https://my.orq.ai"],"title":"Update a workspace","codeSamples":[],"requestExampleLanguages":["bash","typescript","python"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"fe23054c-e4d2-45ad-9922-ff42d682dab5":{"name":"key","in":"path","required":true,"schema":{"type":"string","isRequired":true,"uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"required":[],"type":"object","properties":{"display_name":{"type":"string","uniqueKey":"display_name","typeLabel":"string"},"logo_url":{"type":"string","uniqueKey":"logo_url","typeLabel":"string"},"archived":{"type":"boolean","uniqueKey":"archived","typeLabel":"boolean"},"settings":{"type":"object","properties":{"same_project_entities_enabled":{"type":"boolean","uniqueKey":"settings.same_project_entities_enabled","typeLabel":"boolean"},"model_garden_settings":{"type":"object","uniqueKey":"settings.model_garden_settings","typeLabel":"object"},"plugins":{"type":"object","uniqueKey":"settings.plugins","typeLabel":"object"}},"uniqueKey":"settings","typeLabel":"object"},"metadata":{"type":"object","uniqueKey":"metadata","typeLabel":"object"},"enforce_enabled_models":{"type":"boolean","uniqueKey":"enforce_enabled_models","typeLabel":"boolean"},"chat_kit":{"type":"object","properties":{"items":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"chat_kit.\\items.items.[INDEX].id","typeLabel":"string"},"display_name":{"type":"string","uniqueKey":"chat_kit.\\items.items.[INDEX].display_name","typeLabel":"string"},"resource_id":{"type":"string","uniqueKey":"chat_kit.\\items.items.[INDEX].resource_id","typeLabel":"string"},"resource_type":{"type":"string","uniqueKey":"chat_kit.\\items.items.[INDEX].resource_type","typeLabel":"string"}},"uniqueKey":"chat_kit.\\items.items.[INDEX]","typeLabel":"object"},"uniqueKey":"chat_kit.\\items","typeLabel":"object[]"}},"uniqueKey":"chat_kit","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"display_name":"\u003cstring>","logo_url":"\u003cstring>","archived":true,"settings":{"same_project_entities_enabled":true,"model_garden_settings":{},"plugins":{}},"metadata":{},"enforce_enabled_models":true,"chat_kit":{"items":[{"id":"\u003cstring>","display_name":"\u003cstring>","resource_id":"\u003cstring>","resource_type":"\u003cstring>"}]}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"dd90d8e3-2d77-4563-97e3-a264b1f7292a":{"description":"OK","content":{"application/json":{"schema":{"required":["workspace"],"type":"object","properties":{"workspace":{"required":["id","key","display_name"],"type":"object","properties":{"id":{"type":"string","isRequired":true,"uniqueKey":"workspace.id","typeLabel":"string"},"key":{"type":"string","isRequired":true,"uniqueKey":"workspace.key","typeLabel":"string"},"display_name":{"type":"string","isRequired":true,"uniqueKey":"workspace.display_name","typeLabel":"string"},"logo_url":{"type":"string","uniqueKey":"workspace.logo_url","typeLabel":"string"},"archived_on":{"type":"string","format":"date-time","uniqueKey":"workspace.archived_on","typeLabel":"string\u003cdate-time>"},"archived_by_id":{"type":"string","uniqueKey":"workspace.archived_by_id","typeLabel":"string"},"organization":{"type":"object","properties":{"id":{"type":"string","uniqueKey":"workspace.organization.id","typeLabel":"string"},"key":{"type":"string","uniqueKey":"workspace.organization.key","typeLabel":"string"}},"uniqueKey":"workspace.organization","typeLabel":"object"},"settings":{"type":"object","properties":{"same_project_entities_enabled":{"type":"boolean","uniqueKey":"workspace.settings.same_project_entities_enabled","typeLabel":"boolean"},"model_garden_settings":{"type":"object","uniqueKey":"workspace.settings.model_garden_settings","typeLabel":"object"},"plugins":{"type":"object","uniqueKey":"workspace.settings.plugins","typeLabel":"object"}},"uniqueKey":"workspace.settings","typeLabel":"object"},"sidebar_version":{"type":"string","uniqueKey":"workspace.sidebar_version","typeLabel":"string"},"features":{"type":"object","uniqueKey":"workspace.features","typeLabel":"object"},"total_members":{"type":"integer","format":"int32","uniqueKey":"workspace.total_members","typeLabel":"integer\u003cint32>"},"metadata":{"type":"object","uniqueKey":"workspace.metadata","typeLabel":"object"},"capabilities":{"type":"object","properties":{"roles":{"type":"array","items":{"type":"string","uniqueKey":"workspace.capabilities.roles.items.[INDEX]","typeLabel":"string"},"uniqueKey":"workspace.capabilities.roles","typeLabel":"string[]"},"projects":{"type":"array","items":{"type":"string","uniqueKey":"workspace.capabilities.projects.items.[INDEX]","typeLabel":"string"},"uniqueKey":"workspace.capabilities.projects","typeLabel":"string[]"}},"uniqueKey":"workspace.capabilities","typeLabel":"object"}},"isRequired":true,"uniqueKey":"workspace","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"workspace":{"id":"\u003cstring>","key":"\u003cstring>","display_name":"\u003cstring>","logo_url":"\u003cstring>","archived_on":"2023-11-07T05:31:56Z","archived_by_id":"\u003cstring>","organization":{"id":"\u003cstring>","key":"\u003cstring>"},"settings":{"same_project_entities_enabled":true,"model_garden_settings":{},"plugins":{}},"sidebar_version":"\u003cstring>","features":{},"total_members":123,"metadata":{},"capabilities":{"roles":["\u003cstring>"],"projects":["\u003cstring>"]}}}}},"exampleType":"generated"}},"exampleType":"generated"},"e02cf06d-59f9-4e40-8d46-8b5dad09b525":{"description":"Authentication required. See https://docs.orq.ai/reference/errors for the error codes.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string","description":"Human-readable error message.","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"integer","description":"gRPC status code, when the service reports one.","uniqueKey":"code","typeLabel":"integer"},"details":{"type":"array","items":{"oneOf":[{}],"uniqueKey":"details.items.[INDEX]","typeLabel":"any"},"description":"Additional error details, when the service reports any.","uniqueKey":"details","typeLabel":"any[]"}},"required":["message"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"message":"\u003cstring>","code":123,"details":["\u003cunknown>"]}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"34c064c7-ee3d-4bbd-bd3b-42ee6ee0b117":{"ApiKey":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"ApiKey"}}},"servers":{"adcb47b8-aba4-4af5-9c63-0bb140d849da":{"url":"https://my.orq.ai"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"ApiKey"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"Bearer authentication header of the form `Bearer \u003ctoken>`, where `\u003ctoken>` is your auth token.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"ApiKey","name":"Authorization"}],"title":"ApiKey"}]},"originalFileLocation":"openapi.json"},"subdomain":"orqai","siteName":"Orq.ai Documentation","title":"Update a workspace - Orq.ai Documentation","contextualStarterQuestions":[{"_id":"6aac4d0439b22901a9933560","deploymentId":"68c9bcd7a1b07562da8b036b","questionText":"What fields can I update?","status":"active","generatedBy":"contextual","path":"reference/workspaces/update-a-workspace","createdAt":"2026-09-17T20:26:44.214Z","updatedAt":"2026-09-17T20:26:44.214Z","__v":0},{"_id":"6aac4d0439b22901a993355e","deploymentId":"68c9bcd7a1b07562da8b036b","questionText":"How do I archive a workspace?","status":"active","generatedBy":"contextual","path":"reference/workspaces/update-a-workspace","createdAt":"2026-09-17T20:26:44.214Z","updatedAt":"2026-09-17T20:26:44.214Z","__v":0},{"_id":"6aac4d0439b22901a993355f","deploymentId":"68c9bcd7a1b07562da8b036b","questionText":"Can I change the workspace key?","status":"active","generatedBy":"contextual","path":"reference/workspaces/update-a-workspace","createdAt":"2026-09-17T20:26:44.214Z","updatedAt":"2026-09-17T20:26:44.214Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-09-17T20:26:25.334Z","originalFileLocation":"reference/workspaces/update-a-workspace.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=\"Partially updates a workspace. Omit a field to leave it unchanged. Set archived to true to archive, false to restore. The workspace key cannot be changed.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Orq.ai Documentation\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"index, follow\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/orqai/5zquLIiRlftT1q7X/_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/orqai/5zquLIiRlftT1q7X/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/orqai/5zquLIiRlftT1q7X/_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/orqai/5zquLIiRlftT1q7X/_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/orqai/5zquLIiRlftT1q7X/_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/orqai/5zquLIiRlftT1q7X/_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/orqai/5zquLIiRlftT1q7X/_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/orqai/5zquLIiRlftT1q7X/_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/orqai/5zquLIiRlftT1q7X/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Update a workspace - Orq.ai Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Partially updates a workspace. Omit a field to leave it unchanged. Set archived to true to archive, false to restore. The workspace key cannot be changed.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Orq.ai Documentation\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.orq.ai/reference/workspaces/update-a-workspace\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://orqai.mintlify.app/_mintlify/api/og/v2?division=Workspaces\u0026amp;title=Update+a+workspace\u0026amp;description=Partially+updates+a+workspace.+Omit+a+field+to+leave+it+unchanged.+Set+%60archived%60+to+true+to+archive%2C+false+to+restore.+The+workspace+key+cannot+be+changed.\u0026amp;theme=0116d0baa6ba6403f431e631\u0026amp;signature=a348a8b626e5008a398b4a288aedca1c93bb82455abf4d3beaa748842f3c6b06\">\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=\"Update a workspace - Orq.ai Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Partially updates a workspace. Omit a field to leave it unchanged. Set archived to true to archive, false to restore. The workspace key cannot be changed.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://orqai.mintlify.app/_mintlify/api/og/v2?division=Workspaces\u0026amp;title=Update+a+workspace\u0026amp;description=Partially+updates+a+workspace.+Omit+a+field+to+leave+it+unchanged.+Set+%60archived%60+to+true+to+archive%2C+false+to+restore.+The+workspace+key+cannot+be+changed.\u0026amp;theme=0116d0baa6ba6403f431e631\u0026amp;signature=a348a8b626e5008a398b4a288aedca1c93bb82455abf4d3beaa748842f3c6b06\">\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/orqai/5zquLIiRlftT1q7X/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Orq.ai Documentation\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#027f6b\">\u003cmeta data-mint-head name=\"og:locale\" content=\"en_US\">\u003cmeta data-mint-head name=\"author\" content=\"Orq.ai\">\u003cmeta data-mint-head name=\"twitter:creator\" content=\"@orq_ai\">\u003cmeta data-mint-head name=\"viewport\" content=\"width=device-width, initial-scale=1.0\">\u003cmeta data-mint-head name=\"language\" content=\"English\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.orq.ai/reference/workspaces/update-a-workspace\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/workspaces/update-a-workspace.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.orq.ai/#organization\",\"name\":\"Orq.ai\",\"legalName\":\"Orq.AI Holding B.V.\",\"url\":\"https://orq.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://docs.orq.ai/images/Orq_ai_Symbol_Dark.svg\"},\"sameAs\":[\"https://github.com/orq-ai\",\"https://x.com/orq_ai\",\"https://www.linkedin.com/company/orqai/\"]},{\"@type\":\"WebSite\",\"@id\":\"https://docs.orq.ai#website\",\"name\":\"Orq.ai Documentation\",\"url\":\"https://docs.orq.ai\",\"publisher\":{\"@id\":\"https://docs.orq.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.orq.ai/reference/workspaces/update-a-workspace#webpage\",\"url\":\"https://docs.orq.ai/reference/workspaces/update-a-workspace\",\"name\":\"Update a workspace\",\"description\":\"Partially updates a workspace. Omit a field to leave it unchanged. Set archived to true to archive, false to restore. The workspace key cannot be changed.\",\"dateModified\":\"2026-09-17T20:26:25.334Z\",\"isPartOf\":{\"@id\":\"https://docs.orq.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.orq.ai/reference/workspaces/update-a-workspace#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.orq.ai/reference/workspaces/update-a-workspace#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Management APIs\",\"item\":\"https://docs.orq.ai/management-apis/overview\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Workspaces\",\"item\":\"https://docs.orq.ai/reference/workspaces/list-workspaces\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Update a workspace\",\"item\":\"https://docs.orq.ai/reference/workspaces/update-a-workspace\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.orq.ai/reference/workspaces/update-a-workspace#apireference\",\"headline\":\"Update a workspace\",\"name\":\"Update a workspace\",\"description\":\"Partially updates a workspace. Omit a field to leave it unchanged. Set archived to true to archive, false to restore. The workspace key cannot be changed.\",\"url\":\"https://docs.orq.ai/reference/workspaces/update-a-workspace\",\"mainEntityOfPage\":{\"@id\":\"https://docs.orq.ai/reference/workspaces/update-a-workspace#webpage\"},\"dateModified\":\"2026-09-17T20:26:25.334Z\",\"publisher\":{\"@id\":\"https://docs.orq.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.orq.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Orq.ai Documentation\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Orq.ai Documentation","nav":{"global":null,"tabs":[{"tab":"AI Gateway","pages":[{"title":"AI Gateway","href":"/ai-gateway/get-started/introduction"}]},{"tab":"AI Observability","pages":[{"title":"AI Observability","href":"/ai-studio/observability/quickstart"}]},{"tab":"Managed agents","pages":[{"title":"Managed agents","href":"/ai-studio/ai-engineering/quickstart"}]},{"tab":"Administration","pages":[{"title":"Administration","href":"/ai-studio/organization/workspace-settings"}]},{"tab":"Integrations","pages":[{"title":"Integrations","href":"/ai-studio/integrations/overview"}]},{"tab":"API Reference","groups":[{"group":"Orq SDK","pages":[{"title":"Orq SDKs","sidebarTitle":"Overview","href":"/reference/client-libraries"},{"group":"SDK Reference","pages":[{"title":"Agents SDK Reference","href":"/reference/sdk/agents"},{"title":"Agents.External SDK Reference","sidebarTitle":"External","href":"/reference/sdk/external"},{"title":"Alerts SDK Reference","href":"/reference/sdk/alerts"},{"title":"Responses SDK Reference","href":"/reference/sdk/responses"},{"title":"Annotations SDK Reference","href":"/reference/sdk/annotations"},{"title":"Annotation Queues SDK Reference","href":"/reference/sdk/annotationqueues"},{"title":"API Keys SDK Reference","href":"/reference/sdk/apikeys"},{"title":"AuditLogDestinations SDK Reference","href":"/reference/sdk/auditlogdestinations"},{"title":"Budgets SDK Reference","href":"/reference/sdk/budgets"},{"title":"Chunking SDK Reference","href":"/reference/sdk/chunking"},{"title":"Datasets SDK Reference","href":"/reference/sdk/datasets"},{"title":"Deployments SDK Reference","href":"/reference/sdk/deployments"},{"title":"Environments SDK Reference","href":"/reference/sdk/environments"},{"title":"Evals SDK Reference","href":"/reference/sdk/evals"},{"title":"Feedback SDK Reference","href":"/reference/sdk/feedback"},{"title":"Files SDK Reference","href":"/reference/sdk/files"},{"title":"FileSystems SDK Reference","href":"/reference/sdk/filesystems"},{"title":"Guardrail Rules SDK Reference","href":"/reference/sdk/guardrailrules"},{"title":"Hub SDK Reference","href":"/reference/sdk/hub"},{"title":"Human Review Sets SDK Reference","href":"/reference/sdk/humanreviewsets"},{"title":"Identities SDK Reference","href":"/reference/sdk/identities"},{"title":"Knowledge SDK Reference","href":"/reference/sdk/knowledge"},{"title":"Logs SDK Reference","href":"/reference/sdk/logs"},{"title":"Management Keys SDK Reference","href":"/reference/sdk/managementkeys"},{"title":"MCP Gateways SDK Reference","href":"/reference/sdk/mcpgateways"},{"title":"MCP Servers SDK Reference","href":"/reference/sdk/mcpservers"},{"title":"Memory Stores SDK Reference","href":"/reference/sdk/memorystores"},{"title":"Model Catalog SDK Reference","href":"/reference/sdk/modelcatalog"},{"title":"ModelFusions SDK Reference","href":"/reference/sdk/modelfusions"},{"title":"Models SDK Reference","href":"/reference/sdk/models"},{"title":"Monitors SDK Reference","href":"/reference/sdk/monitors"},{"title":"Notifiers SDK Reference","href":"/reference/sdk/notifiers"},{"title":"Agents.Responses SDK Reference","sidebarTitle":"Responses","href":"/reference/sdk/orqresponses"},{"title":"PII SDK Reference","href":"/reference/sdk/pii"},{"title":"Policies SDK Reference","href":"/reference/sdk/policies"},{"title":"Projects SDK Reference","href":"/reference/sdk/projects"},{"title":"Prompts SDK Reference","href":"/reference/sdk/prompts"},{"title":"Reporting SDK Reference","href":"/reference/sdk/reporting"},{"title":"Routing Rules SDK Reference","href":"/reference/sdk/routingrules"},{"title":"Schedules SDK Reference","href":"/reference/sdk/schedules"},{"title":"Sessions SDK Reference","href":"/reference/sdk/sessions"},{"title":"Skills SDK Reference","href":"/reference/sdk/skills"},{"title":"Smart Routers SDK Reference","href":"/reference/sdk/smartrouters"},{"title":"Telemetry SDK Reference","href":"/reference/sdk/telemetry"},{"title":"Tools SDK Reference","href":"/reference/sdk/tools"},{"title":"Traces SDK Reference","href":"/reference/sdk/traces"},{"title":"Users SDK Reference","href":"/reference/sdk/users"},{"title":"Views SDK Reference","href":"/reference/sdk/views"},{"title":"Webhooks SDK Reference","href":"/reference/sdk/webhooks"},{"title":"Websearch SDK Reference","href":"/reference/sdk/websearch"},{"title":"Wikis SDK Reference","href":"/reference/sdk/wikis"},{"title":"Workspaces SDK Reference","href":"/reference/sdk/workspaces"},{"title":"Workspace Security SDK Reference","href":"/reference/sdk/workspacesecurity"},{"title":"Workspace Settings SDK Reference","href":"/reference/sdk/workspacesettings"},{"group":"Router","pages":[{"title":"Router SDK Reference","href":"/reference/sdk/router"},{"title":"Router.Completions SDK Reference","sidebarTitle":"Completions","href":"/reference/sdk/completions"},{"title":"Router.Chat.Completions SDK Reference","sidebarTitle":"Completions","href":"/reference/sdk/orqcompletions"},{"title":"Router.Embeddings SDK Reference","sidebarTitle":"Embeddings","href":"/reference/sdk/embeddings"},{"title":"Router.Audio.Speech SDK Reference","sidebarTitle":"Speech","href":"/reference/sdk/speech"},{"title":"Router.Audio.Transcriptions SDK Reference","sidebarTitle":"Transcriptions","href":"/reference/sdk/transcriptions"},{"title":"Router.Audio.Translations SDK Reference","sidebarTitle":"Translations","href":"/reference/sdk/translations"},{"title":"Router.Images.Generations SDK Reference","sidebarTitle":"Generations","href":"/reference/sdk/generations"},{"title":"Router.Images.Edits SDK Reference","sidebarTitle":"Edits","href":"/reference/sdk/edits"},{"title":"Router.Images.Variations SDK Reference","sidebarTitle":"Variations","href":"/reference/sdk/variations"},{"title":"Router.Moderations SDK Reference","sidebarTitle":"Moderations","href":"/reference/sdk/moderations"},{"title":"Router.Rerank SDK Reference","sidebarTitle":"Rerank","href":"/reference/sdk/rerank"},{"title":"Router.Classify SDK Reference","sidebarTitle":"Classify","href":"/reference/sdk/classify"},{"title":"Router.Decisions SDK Reference","sidebarTitle":"Decisions","href":"/reference/sdk/decisions"}]}]},{"title":"API Error Codes","href":"/reference/errors"},{"title":"Base URLs","href":"/reference/base-urls"}]},{"group":"Terminal \u0026 Agents","pages":[{"title":"Orq CLI","sidebarTitle":"Orq CLI","tag":"Beta","href":"/reference/cli"},{"title":"Orq MCP Server tools and quickstart","sidebarTitle":"Orq MCP","href":"/ai-studio/integrations/code-assistants/orq-mcp"},{"title":"Orq Skills for code assistants","sidebarTitle":"Orq Skills","href":"/ai-studio/integrations/code-assistants/orq-skills"}]},{"group":"Terraform","pages":[{"title":"Terraform","sidebarTitle":"Overview","href":"/reference/terraform"},{"title":"Terraform Quickstart","sidebarTitle":"Quickstart","href":"/reference/terraform/quickstart"},{"title":"Terraform Resources","sidebarTitle":"Resources","href":"/reference/terraform/resources"},{"title":"Importing an Existing Workspace","sidebarTitle":"Importing resources","href":"/reference/terraform/importing"},{"title":"Enterprise Baseline","sidebarTitle":"Enterprise baseline","href":"/reference/terraform/enterprise-baseline"}]},{"group":"Platform APIs","pages":[{"group":"Agent Feedback","pages":[{"openapi":"post /v3/submit-feedback","title":"Submit feedback","href":"/reference/agent-feedback/submit-feedback"}]},{"group":"Agent Schedules","pages":[{"openapi":"get /v3/agents/{agent_key}/schedules","title":"List schedules","href":"/reference/agent-schedules/list-schedules"},{"openapi":"post /v3/agents/{agent_key}/schedules","title":"Create schedule","href":"/reference/agent-schedules/create-schedule"},{"openapi":"get /v3/agents/{agent_key}/schedules/{schedule_id}","title":"Retrieve schedule","href":"/reference/agent-schedules/retrieve-schedule"},{"openapi":"delete /v3/agents/{agent_key}/schedules/{schedule_id}","title":"Delete schedule","href":"/reference/agent-schedules/delete-schedule"},{"openapi":"patch /v3/agents/{agent_key}/schedules/{schedule_id}","title":"Update schedule","href":"/reference/agent-schedules/update-schedule"},{"openapi":"post /v3/agents/{agent_key}/schedules/{schedule_id}/execution","title":"Trigger schedule execution","href":"/reference/agent-schedules/trigger-schedule-execution"}]},{"group":"Agents","pages":[{"openapi":"get /v2/agents","title":"List agents","href":"/reference/agents/list-agents"},{"openapi":"post /v2/agents","title":"Create agent","href":"/reference/agents/create-agent"},{"openapi":"get /v2/agents/{agent_key}","title":"Retrieve agent","href":"/reference/agents/retrieve-agent"},{"openapi":"delete /v2/agents/{agent_key}","title":"Delete agent","href":"/reference/agents/delete-agent"},{"openapi":"patch /v2/agents/{agent_key}","title":"Update agent","href":"/reference/agents/update-agent"},{"group":"External Agents","pages":[{"openapi":"get /v2/agents/external","title":"List external agents","href":"/reference/agents/list-external-agents"},{"openapi":"post /v2/agents/external","title":"Create external agent","href":"/reference/agents/create-external-agent"},{"openapi":"get /v2/agents/external/{agent_key}","title":"Retrieve external agent","href":"/reference/agents/retrieve-external-agent"},{"openapi":"patch /v2/agents/external/{agent_key}","title":"Update external agent","href":"/reference/agents/update-external-agent"},{"openapi":"delete /v2/agents/external/{agent_key}","title":"Delete external agent","href":"/reference/agents/delete-external-agent"},{"openapi":"post /v2/agents/external/{agent_key}:refreshCard","title":"Refresh external agent card","href":"/reference/agents/refresh-external-agent-card"},{"openapi":"post /v2/agents/external/{agent_key}:testConnection","title":"Test external agent connection","href":"/reference/agents/test-external-agent-connection"}]},{"openapi":"post /v3/router/responses","title":"Invoke an agent","href":"/reference/agents/invoke-agent"},{"group":"Legacy","pages":[{"openapi":"post /v2/agents/{agent_key}/responses","title":"Create an agent response","deprecated":true,"href":"/reference/agents/create-response"},{"openapi":"get /v2/agents/{agent_key}/responses/{task_id}","title":"Get response","href":"/reference/agents/get-response"},{"openapi":"post /v2/agents/{key}/task","deprecated":true,"title":"Execute an agent task","href":"/reference/agents/execute-an-agent-task"},{"openapi":"post /v2/agents/run","deprecated":true,"title":"Run an agent with configuration","href":"/reference/agents/run-an-agent-with-configuration"},{"openapi":"post /v2/agents/stream-run","deprecated":true,"title":"Run agent with streaming response","href":"/reference/agents/run-agent-with-streaming-response"},{"openapi":"post /v2/agents/{key}/stream-task","deprecated":true,"title":"Stream agent execution in real-time","href":"/reference/agents/stream-agent-execution-in-real-time"}]}]},{"group":"Annotation Queues","pages":[{"openapi":"get /v2/annotation-queues","title":"List annotation queues","href":"/reference/annotation-queues/list-annotation-queues"},{"openapi":"post /v2/annotation-queues","title":"Create an annotation queue","href":"/reference/annotation-queue/create-an-annotation-queue"},{"openapi":"get /v2/annotation-queues/{annotation_queue_id}","title":"Retrieve an annotation queue","href":"/reference/annotation-queues/retrieve-an-annotation-queue"},{"openapi":"patch /v2/annotation-queues/{annotation_queue_id}","title":"Update an annotation queue","href":"/reference/annotation-queue/edit-an-annotation-queue"},{"openapi":"delete /v2/annotation-queues/{annotation_queue_id}","title":"Delete an annotation queue","href":"/reference/annotation-queue/delete-an-annotation-queue"},{"openapi":"delete /v2/annotation-queues/{annotation_queue_id}/clear","title":"Clear an annotation queue","href":"/reference/annotation-queues/delete-all-items"},{"openapi":"post /v2/annotation-queues/{annotation_queue_id}/items","title":"Add items to an annotation queue","href":"/reference/annotation-queue/add-items-to-an-annotation-queue"},{"openapi":"post /v2/annotation-queues/{annotation_queue_id}/items/remove","title":"Remove items from an annotation queue","href":"/reference/annotation-queue/remove-annotation-queue-items"},{"openapi":"get /v2/annotation-queues/{annotation_queue_id}/items","title":"Query items from an annotation queue","href":"/reference/annotation-queue/query-items-from-an-annotation-queue"},{"openapi":"get /v2/annotation-queues/{annotation_queue_id}/items/{item_id}","title":"Retrieve an annotation queue item","href":"/reference/annotation-queue/retrieve-an-annotation-queue-item"}]},{"group":"Annotations","pages":[{"openapi":"post /v2/traces/{trace_id}/spans/{span_id}/annotation","title":"Annotate a span","href":"/reference/annotations/annotate-a-span"},{"openapi":"delete /v2/traces/{trace_id}/spans/{span_id}/annotation","title":"Remove an annotation from a span","href":"/reference/annotations/remove-an-annotation-from-a-span"}]},{"group":"Audio","pages":[{"openapi":"post /v2/router/audio/speech","title":"Create speech","href":"/reference/audio/create-speech"},{"openapi":"post /v2/router/audio/transcriptions","title":"Create transcription","href":"/reference/audio/create-transcription"},{"openapi":"post /v2/router/audio/translations","title":"Create translation","href":"/reference/audio/create-translation"}]},{"group":"Chat","pages":[{"openapi":"post /v2/router/chat/completions","title":"Create chat completion","href":"/reference/chat/create-chat-completion"}]},{"group":"Chunking","pages":[{"openapi":"post /v2/chunking","title":"Parse text","href":"/reference/chunking/parse-text"}]},{"group":"Classify","pages":[{"openapi":"post /v3/router/classify","deprecated":true,"title":"Classify","href":"/reference/classify/create-classify"}]},{"group":"Completions","pages":[{"openapi":"post /v2/router/completions","title":"Create completion","href":"/reference/completions/create-completion"}]},{"group":"Datasets","pages":[{"openapi":"get /v2/datasets","title":"List datasets","href":"/reference/datasets/list-datasets"},{"openapi":"post /v2/datasets","title":"Create a dataset","href":"/reference/datasets/create-a-dataset"},{"openapi":"get /v2/datasets/{dataset_id}","title":"Retrieve a dataset","href":"/reference/datasets/retrieve-a-dataset"},{"openapi":"delete /v2/datasets/{dataset_id}","title":"Delete a dataset","href":"/reference/datasets/delete-a-dataset"},{"openapi":"patch /v2/datasets/{dataset_id}","title":"Update a dataset","href":"/reference/datasets/update-a-dataset"},{"openapi":"get /v2/datasets/{dataset_id}/datapoints","title":"List datapoints","href":"/reference/datasets/list-datapoints"},{"openapi":"post /v2/datasets/{dataset_id}/datapoints","title":"Create a datapoint","href":"/reference/datasets/create-a-datapoint"},{"openapi":"get /v2/datasets/{dataset_id}/datapoints/{datapoint_id}","title":"Retrieve a datapoint","href":"/reference/datasets/retrieve-a-datapoint"},{"openapi":"delete /v2/datasets/{dataset_id}/datapoints/{datapoint_id}","title":"Delete a datapoint","href":"/reference/datasets/delete-a-datapoint"},{"openapi":"patch /v2/datasets/{dataset_id}/datapoints/{datapoint_id}","title":"Update a datapoint","href":"/reference/datasets/update-a-datapoint"},{"openapi":"delete /v2/datasets/{dataset_id}/clear","title":"Delete all datapoints","href":"/reference/datasets/delete-all-datapoints"}]},{"group":"Decisions","pages":[{"openapi":"post /v3/router/decisions","title":"Create decisions","href":"/reference/decisions/create-decisions"}]},{"group":"Deployments","pages":[{"openapi":"get /v2/deployments","title":"List all deployments","href":"/reference/deployments/list-all-deployments"},{"openapi":"get /v2/deployments/{keyOrID}/versions","title":"List deployment versions","href":"/reference/deployments/list-deployment-versions"},{"title":"Invoke a deployment","openapi":"post /v2/deployments/invoke","href":"/reference/deployments/invoke"},{"openapi":"post /v2/deployments/stream","title":"Stream a deployment","href":"/reference/deployments/stream"},{"openapi":"post /v2/deployments/get_config","title":"Get config","href":"/reference/deployments/get-config"}]},{"group":"Embeddings","pages":[{"openapi":"post /v2/router/embeddings","title":"Create embeddings","href":"/reference/embeddings/create-embeddings"}]},{"group":"Evaluators","pages":[{"openapi":"get /v2/evaluators","title":"Get all Evaluators","href":"/reference/evals/get-all-evaluators"},{"openapi":"get /v2/evaluators/{id}","title":"Retrieve an Evaluator","href":"/reference/evals/retrieve-an-evaluator"},{"openapi":"post /v2/evaluators","title":"Create an Evaluator","href":"/reference/evals/create-an-evaluator"},{"openapi":"delete /v2/evaluators/{id}","title":"Delete an Evaluator","href":"/reference/evals/delete-an-evaluator"},{"openapi":"patch /v2/evaluators/{id}","title":"Update an Evaluator","href":"/reference/evals/update-an-evaluator"},{"openapi":"post /v3/evaluators/{id}/invoke","title":"Invoke a Custom Evaluator","href":"/reference/evals/invoke-a-custom-evaluator"},{"openapi":"get /v2/evaluators/{id}/versions","title":"List evaluator versions","href":"/reference/evals/list-evaluator-versions"},{"openapi":"post /v2/evaluators/{id}/duplicate","title":"Duplicate an Evaluator","href":"/reference/evals/duplicate-an-evaluator"},{"openapi":"get /v2/evaluators/{id}/versions/{version_id}","title":"Get evaluator version","href":"/reference/evals/get-evaluator-version"}]},{"group":"Files","pages":[{"openapi":"get /v2/files","title":"List all files","href":"/reference/files/list-all-files"},{"openapi":"post /v2/files","title":"Upload a file","href":"/reference/files/upload-a-file"},{"openapi":"get /v2/files/{file_id}","title":"Retrieve a file","href":"/reference/files/retrieve-a-file"},{"openapi":"delete /v2/files/{file_id}","title":"Delete a file","href":"/reference/files/delete-a-file"},{"openapi":"patch /v2/files/{file_id}","title":"Update a file","href":"/reference/files/update-a-file"},{"openapi":"get /v2/files/{file_id_or_path}/content","title":"Download file content","href":"/reference/files/download-file-content"}]},{"group":"Feedback","pages":[{"openapi":"post /v2/feedback","title":"Submit feedback","href":"/reference/feedback/post-v2feedback"},{"openapi":"post /v2/feedback/remove","title":"Remove feedback","href":"/reference/feedback/post-v2feedbackremove"}]},{"group":"File Systems","pages":[{"openapi":"get /v2/file-systems","title":"List file systems","href":"/reference/file-systems/list-file-systems"},{"openapi":"post /v2/file-systems","title":"Create file system","href":"/reference/file-systems/create-file-system"},{"openapi":"get /v2/file-systems/{file_system_key}","title":"Retrieve file system","href":"/reference/file-systems/retrieve-file-system"},{"openapi":"delete /v2/file-systems/{file_system_key}","title":"Delete file system","href":"/reference/file-systems/delete-file-system"},{"openapi":"patch /v2/file-systems/{file_system_key}","title":"Update file system","href":"/reference/file-systems/update-file-system"},{"openapi":"get /v2/file-systems/{file_system_key}/files","title":"List files","href":"/reference/file-systems/list-files"},{"openapi":"delete /v2/file-systems/{file_system_key}/files","title":"Delete file","href":"/reference/file-systems/delete-file"},{"openapi":"post /v2/file-systems/{file_system_key}/files/move","title":"Move file","href":"/reference/file-systems/move-file"},{"openapi":"get /v2/file-systems/{file_system_key}/files/stat","title":"Stat file","href":"/reference/file-systems/stat-file"},{"openapi":"post /v2/file-systems/{file_system_key}/folders","title":"Create folder","href":"/reference/file-systems/create-folder"}]},{"group":"Guardrail Rules","pages":[{"openapi":"get /v2/guardrail-rules","title":"List guardrail rules","href":"/reference/guardrail-rules/list-guardrail-rules"},{"openapi":"post /v2/guardrail-rules","title":"Create a guardrail rule","href":"/reference/guardrail-rules/create-guardrail-rule"},{"openapi":"get /v2/guardrail-rules/{guardrail_rule_id}","title":"Retrieve a guardrail rule","href":"/reference/guardrail-rules/get-guardrail-rule"},{"openapi":"delete /v2/guardrail-rules/{guardrail_rule_id}","title":"Delete a guardrail rule","href":"/reference/guardrail-rules/delete-guardrail-rule"},{"openapi":"patch /v2/guardrail-rules/{guardrail_rule_id}","title":"Update a guardrail rule","href":"/reference/guardrail-rules/update-guardrail-rule"},{"openapi":"get /v2/guardrail-rules/used-guardrails","title":"List guardrails used by guardrail rules","href":"/reference/guardrail-rules/list-used-guardrails"}]},{"group":"Hub","pages":[{"openapi":"get /v2/hub/search","title":"Search hub items","href":"/reference/hub/search-hub-items"},{"openapi":"get /v2/hub/{id}","title":"Get a hub item","href":"/reference/hub/get-a-hub-item"}]},{"group":"Human Review Sets","pages":[{"openapi":"get /v2/human-eval-sets","title":"Get all human review sets","href":"/reference/human-review-sets/get-all-human-review-sets"},{"openapi":"post /v2/human-eval-sets","title":"Create a human review set","href":"/reference/human-review-sets/create-a-human-review-set"},{"openapi":"get /v2/human-eval-sets/{id}","title":"Get a human review set by ID","href":"/reference/human-review-sets/get-a-human-review-set-by-id"},{"openapi":"delete /v2/human-eval-sets/{id}","title":"Delete a human review set","href":"/reference/human-review-sets/delete-a-human-review-set"},{"openapi":"patch /v2/human-eval-sets/{id}","title":"Update a human review set","href":"/reference/human-review-sets/update-a-human-review-set"}]},{"group":"Images","pages":[{"openapi":"post /v2/router/images/generations","title":"Create image","href":"/reference/images/create-image"},{"openapi":"post /v2/router/images/edits","title":"Create image edit","href":"/reference/images/create-image-edit"},{"openapi":"post /v2/router/images/variations","title":"Create image variation","href":"/reference/images/create-image-variation"}]},{"group":"Knowledge Bases","pages":[{"openapi":"get /v2/knowledge","title":"List all knowledge bases","href":"/reference/knowledge-bases/list-all-knowledge-bases"},{"openapi":"post /v2/knowledge","title":"Create a knowledge base","href":"/reference/knowledge-bases/create-a-knowledge"},{"openapi":"get /v2/knowledge/{knowledge_id}","title":"Retrieve a knowledge base","href":"/reference/knowledge-bases/retrieves-a-knowledge-base"},{"openapi":"delete /v2/knowledge/{knowledge_id}","title":"Delete a knowledge base","href":"/reference/knowledge-bases/deletes-a-knowledge"},{"openapi":"patch /v2/knowledge/{knowledge_id}","title":"Update a knowledge base","href":"/reference/knowledge-bases/updates-a-knowledge"},{"openapi":"post /v2/knowledge/{knowledge_id}/search","title":"Search knowledge base","href":"/reference/knowledge-bases/search-knowledge-base"},{"openapi":"get /v2/knowledge/{knowledge_id}/datasources","title":"List all datasources","href":"/reference/knowledge-bases/list-all-datasources"},{"openapi":"post /v2/knowledge/{knowledge_id}/datasources","title":"Create a new datasource","href":"/reference/knowledge-bases/create-a-new-datasource"},{"openapi":"get /v2/knowledge/{knowledge_id}/datasources/{datasource_id}","title":"Retrieve a datasource","href":"/reference/knowledge-bases/retrieve-a-datasource"},{"openapi":"delete /v2/knowledge/{knowledge_id}/datasources/{datasource_id}","title":"Delete a datasource","href":"/reference/knowledge-bases/deletes-a-datasource"},{"openapi":"patch /v2/knowledge/{knowledge_id}/datasources/{datasource_id}","title":"Update a datasource","href":"/reference/knowledge-bases/update-a-datasource"},{"openapi":"get /v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks","title":"List all chunks for a datasource","href":"/reference/knowledge-bases/list-all-chunks-for-a-datasource"},{"openapi":"post /v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks","title":"Create chunks for a datasource","href":"/reference/knowledge-bases/create-chunks-for-a-datasource"},{"openapi":"delete /v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks","title":"Delete multiple chunks","href":"/reference/knowledge-bases/delete-multiple-chunks"},{"openapi":"post /v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks/list","title":"List chunks with offset-based pagination","href":"/reference/knowledge-bases/list-chunks-with-offset-based-pagination"},{"openapi":"post /v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks/count","title":"Get chunks total count","href":"/reference/knowledge-bases/get-chunks-total-count"},{"openapi":"get /v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks/{chunk_id}","title":"Retrieve a chunk","href":"/reference/knowledge-bases/retrieve-a-chunk"},{"openapi":"delete /v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks/{chunk_id}","title":"Delete a chunk","href":"/reference/knowledge-bases/delete-a-chunk"},{"openapi":"patch /v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks/{chunk_id}","title":"Update a chunk","href":"/reference/knowledge-bases/update-a-chunk"},{"openapi":"post /v2/knowledge/{knowledge_id}/datasources/preview-chunks","title":"Preview datasource chunks","href":"/reference/knowledge-bases/preview-datasource-chunks"},{"openapi":"patch /v2/knowledge/{knowledge_id}/datasources/{datasource_id}/chunks/{chunk_id}/enabled","title":"Set a chunk's enabled status","href":"/reference/knowledge-bases/set-a-chunks-enabled-status"},{"openapi":"get /v2/knowledge/{knowledge_id}/datasources/{datasource_id}/datasource-processing-status","title":"Retrieve datasource processing status","href":"/reference/knowledge-bases/retrieve-datasource-processing-status"},{"openapi":"get /v2/knowledge/{knowledge_id}/upload-file","title":"Retrieve a file upload URL","href":"/reference/knowledge-bases/retrieve-a-file-upload-url"}]},{"group":"Logs","pages":[{"openapi":"post /v3/logs/aggregate","title":"Aggregate logs","href":"/reference/logs/aggregate-logs"},{"openapi":"post /v3/logs/facets","title":"List log facets","href":"/reference/logs/list-log-facets"},{"openapi":"get /v3/logs/facets/{field}","title":"List facet values","href":"/reference/logs/list-facet-values"},{"openapi":"get /v3/logs/fields","title":"List log fields","href":"/reference/logs/list-log-fields"},{"openapi":"post /v3/logs/patterns","title":"Find log patterns","href":"/reference/logs/find-log-patterns"},{"openapi":"post /v3/logs/query","title":"Query logs with OQL","href":"/reference/logs/query-logs-with-oql"},{"openapi":"post /v3/logs/search","title":"Search logs","href":"/reference/logs/search-logs"},{"openapi":"get /v3/logs/{id}","title":"Get a single log","href":"/reference/logs/get-a-single-log"},{"openapi":"post /v3/logs/{id}/context","title":"Get surrounding log context","href":"/reference/logs/get-surrounding-log-context"},{"openapi":"get /v3/traces/{trace_id}/logs","title":"List logs for a trace","href":"/reference/logs/list-logs-for-a-trace"}]},{"group":"MCP Gateways","pages":[{"openapi":"get /v2/mcp-gateways","title":"List MCP gateways","href":"/reference/mcp-gateway/list-mcp-gateways"},{"openapi":"post /v2/mcp-gateways","title":"Create an MCP gateway","href":"/reference/mcp-gateway/create-an-mcp-gateway"},{"openapi":"get /v2/mcp-gateways/{id}","title":"Retrieve an MCP gateway","href":"/reference/mcp-gateway/retrieve-an-mcp-gateway"},{"openapi":"delete /v2/mcp-gateways/{id}","title":"Delete an MCP gateway","href":"/reference/mcp-gateway/delete-an-mcp-gateway"},{"openapi":"patch /v2/mcp-gateways/{id}","title":"Update an MCP gateway","href":"/reference/mcp-gateway/update-an-mcp-gateway"},{"openapi":"get /v2/mcp-gateways/{gateway_id}/tools","title":"List exposed tools for a gateway","href":"/reference/mcp-gateway/list-exposed-tools-for-a-gateway"}]},{"group":"MCP Servers","pages":[{"openapi":"get /v2/mcp-servers","title":"List MCP servers","href":"/reference/mcp-gateway/list-mcp-servers"},{"openapi":"post /v2/mcp-servers","title":"Create an MCP server","href":"/reference/mcp-gateway/create-an-mcp-server"},{"openapi":"get /v2/mcp-servers/{id}","title":"Retrieve an MCP server","href":"/reference/mcp-gateway/retrieve-an-mcp-server"},{"openapi":"delete /v2/mcp-servers/{id}","title":"Delete an MCP server","href":"/reference/mcp-gateway/delete-an-mcp-server"},{"openapi":"patch /v2/mcp-servers/{id}","title":"Update an MCP server","href":"/reference/mcp-gateway/update-an-mcp-server"},{"openapi":"post /v2/mcp-servers/{id}:sync","title":"Sync an MCP server","href":"/reference/mcp-gateway/sync-an-mcp-server"},{"openapi":"post /v2/mcp-servers/{id}/tools:test","title":"Test an MCP server tool","href":"/reference/mcp-gateway/test-an-mcp-server-tool"}]},{"group":"Memory Stores","pages":[{"openapi":"get /v2/memory-stores","title":"List memory stores","href":"/reference/memory-stores/list-memory-stores"},{"openapi":"post /v2/memory-stores","title":"Create memory store","href":"/reference/memory-stores/create-memory-store"},{"openapi":"get /v2/memory-stores/{memory_store_key}","title":"Retrieve memory store","href":"/reference/memory-stores/retrieve-memory-store"},{"openapi":"delete /v2/memory-stores/{memory_store_key}","title":"Delete memory store","href":"/reference/memory-stores/delete-memory-store"},{"openapi":"patch /v2/memory-stores/{memory_store_key}","title":"Update memory store","href":"/reference/memory-stores/update-memory-store"},{"openapi":"get /v2/memory-stores/{memory_store_key}/memories","title":"List all memories","href":"/reference/memory-stores/list-all-memories"},{"openapi":"post /v2/memory-stores/{memory_store_key}/memories","title":"Create a new memory","href":"/reference/memory-stores/create-a-new-memory"},{"openapi":"get /v2/memory-stores/{memory_store_key}/memories/{memory_entity_id}","title":"Retrieve a specific memory","href":"/reference/memory-stores/retrieve-a-specific-memory"},{"openapi":"delete /v2/memory-stores/{memory_store_key}/memories/{memory_entity_id}","title":"Delete a specific memory","href":"/reference/memory-stores/delete-a-specific-memory"},{"openapi":"patch /v2/memory-stores/{memory_store_key}/memories/{memory_entity_id}","title":"Update a specific memory","href":"/reference/memory-stores/update-a-specific-memory"},{"openapi":"get /v2/memory-stores/{memory_store_key}/memories/{memory_entity_id}/documents","title":"List all documents for a memory","href":"/reference/memory-stores/list-all-documents-for-a-memory"},{"openapi":"post /v2/memory-stores/{memory_store_key}/memories/{memory_entity_id}/documents","title":"Create a new memory document","href":"/reference/memory-stores/create-a-new-memory-document"},{"openapi":"get /v2/memory-stores/{memory_store_key}/memories/{memory_entity_id}/documents/{document_id}","title":"Retrieve a specific memory document","href":"/reference/memory-stores/retrieve-a-specific-memory-document"},{"openapi":"delete /v2/memory-stores/{memory_store_key}/memories/{memory_entity_id}/documents/{document_id}","title":"Delete a specific memory document","href":"/reference/memory-stores/delete-a-specific-memory-document"},{"openapi":"patch /v2/memory-stores/{memory_store_key}/memories/{memory_entity_id}/documents/{document_id}","title":"Update a specific memory document","href":"/reference/memory-stores/update-a-specific-memory-document"}]},{"group":"Model Catalog","pages":[{"openapi":"get /v2/model-catalog","sidebarTitle":"List catalog models","title":"List the model catalog","href":"/reference/model-catalog/list-the-model-catalog"},{"openapi":"get /v2/model-catalog/{model}/offerings","sidebarTitle":"List model offerings","title":"List model catalog offerings","href":"/reference/model-catalog/list-model-catalog-offerings"},{"openapi":"get /v2/model-catalog/{id}","sidebarTitle":"Get catalog entry","title":"Retrieve a model catalog entry","href":"/reference/model-catalog/retrieve-a-model-catalog-entry"}]},{"group":"Models","pages":[{"openapi":"get /v2/models","title":"List workspace models","href":"/reference/models/list-models"},{"openapi":"get /v3/router/models","title":"List router models","href":"/reference/models/list-router-models"},{"openapi":"post /v2/models","title":"Create custom model","href":"/reference/models/create-custom-model"},{"openapi":"post /v2/models/aws-bedrock","title":"Create AWS Bedrock custom model","href":"/reference/models/create-aws-bedrock-custom-model"},{"openapi":"post /v2/models/aws-bedrock/validate","title":"Validate AWS Bedrock inference profile","href":"/reference/models/validate-aws-bedrock-inference-profile"},{"openapi":"patch /v2/models/aws-bedrock/{id}","title":"Update AWS Bedrock custom model","href":"/reference/models/update-aws-bedrock-custom-model"},{"openapi":"post /v2/models/azure-foundry/deployments","title":"List Azure Foundry deployments under a resource","href":"/reference/models/list-azure-foundry-deployments-under-a-resource"},{"openapi":"post /v2/models/litellm/import","title":"Import models from LiteLLM","href":"/reference/models/import-models-from-litellm"},{"openapi":"get /v2/models/litellm/models","title":"List models from configured LiteLLM instance","href":"/reference/models/list-models-from-configured-litellm-instance"},{"openapi":"post /v2/models/openai-like","title":"Create OpenAI-compatible custom model","href":"/reference/models/create-openai-compatible-custom-model"},{"openapi":"patch /v2/models/openai-like/{id}","title":"Update OpenAI-compatible custom model","href":"/reference/models/update-openai-compatible-custom-model"},{"openapi":"post /v2/models/validate","title":"Validate model endpoint","href":"/reference/models/validate-model-endpoint"},{"openapi":"post /v2/models/vertex","title":"Create Vertex AI custom model","href":"/reference/models/create-vertex-ai-custom-model"},{"openapi":"delete /v2/models/{id}","title":"Delete custom model","href":"/reference/models/delete-custom-model"},{"openapi":"patch /v2/models/{id}","title":"Update custom model","href":"/reference/models/update-custom-model"}]},{"group":"Moderations","pages":[{"openapi":"post /v2/router/moderations","title":"Create moderation","href":"/reference/moderations/create-moderation"}]},{"group":"OCR","pages":[{"openapi":"post /v2/router/ocr","title":null,"href":"/reference/ocr/create-ocr"}]},{"group":"PII","pages":[{"openapi":"get /v2/pii/capabilities","title":"Get PII capabilities","href":"/reference/pii/get-pii-capabilities"},{"openapi":"post /v2/pii/detect","title":"Detect PII","href":"/reference/pii/detect-pii"},{"openapi":"post /v2/pii/redact","title":"Redact PII","href":"/reference/pii/redact-pii"},{"openapi":"post /v2/pii/restore","title":"Restore redacted text","href":"/reference/pii/restore-pii"}]},{"group":"Policies","pages":[{"openapi":"get /v2/policies","title":"List policies","href":"/reference/policies/list-policies"},{"openapi":"post /v2/policies","title":"Create policy","href":"/reference/policies/create-policy"},{"openapi":"get /v2/policies/{policy_id}","title":"Get policy","href":"/reference/policies/get-policy"},{"openapi":"delete /v2/policies/{policy_id}","title":"Delete policy","href":"/reference/policies/delete-policy"},{"openapi":"patch /v2/policies/{policy_id}","title":"Update policy","href":"/reference/policies/update-policy"}]},{"group":"Prompts","pages":[{"openapi":"get /v2/prompts","title":"List all prompts","href":"/reference/prompts/list-all-prompts"},{"openapi":"post /v2/prompts","title":"Create a prompt","href":"/reference/prompts/create-a-prompt"},{"openapi":"get /v2/prompts/{id}","title":"Retrieve a prompt","href":"/reference/prompts/retrieve-a-prompt"},{"openapi":"delete /v2/prompts/{id}","title":"Delete a prompt","href":"/reference/prompts/delete-a-prompt"},{"openapi":"patch /v2/prompts/{id}","title":"Update a prompt","href":"/reference/prompts/update-a-prompt"},{"openapi":"get /v2/prompts/{prompt_id}/versions","title":"List all prompt versions","href":"/reference/prompts/list-all-prompt-versions"},{"openapi":"get /v2/prompts/{prompt_id}/versions/{version_id}","title":"Retrieve a prompt version","href":"/reference/prompts/retrieve-a-prompt-version"}]},{"group":"Reporting API","pages":[{"openapi":"post /v2/reporting","title":"Query reporting metrics","href":"/reference/reporting/query-reporting-metrics"}]},{"group":"Rerank","pages":[{"openapi":"post /v2/router/rerank","title":"Create rerank","href":"/reference/rerank/create-rerank"}]},{"group":"Responses","pages":[{"openapi":"post /v3/router/responses","title":"Create response","href":"/reference/responses/create-response"},{"openapi":"get /v3/router/responses/{response_id}","title":"Retrieve response","href":"/reference/responses/retrieve-response"}]},{"group":"Routing Rules","pages":[{"openapi":"get /v2/routing-rules","title":"List routing rules","href":"/reference/routing-rules/list-routing-rules"},{"openapi":"post /v2/routing-rules","title":"Create a routing rule","href":"/reference/routing-rules/create-routing-rule"},{"openapi":"get /v2/routing-rules/{routing_rule_id}","title":"Retrieve a routing rule","href":"/reference/routing-rules/get-routing-rule"},{"openapi":"delete /v2/routing-rules/{routing_rule_id}","title":"Delete a routing rule","href":"/reference/routing-rules/delete-routing-rule"},{"openapi":"patch /v2/routing-rules/{routing_rule_id}","title":"Update a routing rule","href":"/reference/routing-rules/update-routing-rule"},{"openapi":"get /v2/routing-rules/used-models","title":"List models used by routing rules","href":"/reference/routing-rules/list-used-models"}]},{"group":"Smart Routers","pages":[{"openapi":"get /v2/smart-routers","title":"List Smart Routers","href":"/reference/smart-routers/list-smart-routers"},{"openapi":"post /v2/smart-routers","title":"Create a Smart Router","href":"/reference/smart-routers/create-a-smart-router"},{"openapi":"get /v2/smart-routers/{smart_router_id}","title":"Retrieve a Smart Router","href":"/reference/smart-routers/retrieve-a-smart-router"},{"openapi":"delete /v2/smart-routers/{smart_router_id}","title":"Delete a Smart Router","href":"/reference/smart-routers/delete-a-smart-router"},{"openapi":"patch /v2/smart-routers/{smart_router_id}","title":"Update a Smart Router","href":"/reference/smart-routers/update-a-smart-router"}]},{"group":"Threads","pages":[{"openapi":"post /v2/sessions","title":"Create trace thread","href":"/reference/threads/create-trace-thread"},{"openapi":"post /v2/sessions/count","title":"Get thread count","href":"/reference/threads/get-thread-count"},{"openapi":"post /v2/sessions/query","title":"List trace threads","href":"/reference/threads/list-trace-threads"},{"openapi":"get /v2/sessions/tags","title":"List thread tags","href":"/reference/threads/list-thread-tags"},{"openapi":"get /v2/sessions/{session_id}","title":"Get trace thread","href":"/reference/threads/get-trace-thread"},{"openapi":"delete /v2/sessions/{session_id}","title":"Delete trace thread","href":"/reference/threads/delete-trace-thread"},{"openapi":"patch /v2/sessions/{session_id}","title":"Update trace thread","href":"/reference/threads/update-trace-thread"}]},{"group":"Skills","pages":[{"openapi":"get /v2/skills","title":"List all skills","href":"/reference/skills/list-all-skills"},{"openapi":"post /v2/skills","title":"Create a new skill","href":"/reference/skills/create-a-new-skill"},{"openapi":"get /v2/skills/{skill_id}","title":"Retrieve a skill","href":"/reference/skills/retrieve-a-skill"},{"openapi":"delete /v2/skills/{skill_id}","title":"Delete a skill","href":"/reference/skills/delete-a-skill"},{"openapi":"patch /v2/skills/{skill_id}","title":"Update a skill","href":"/reference/skills/update-a-skill"}]},{"group":"Tools","pages":[{"openapi":"get /v2/tools","title":"List tools","href":"/reference/tools/list-tools"},{"openapi":"post /v2/tools","title":"Create tool","href":"/reference/tools/create-tool"},{"openapi":"get /v2/tools/{tool_id}","title":"Retrieve tool","href":"/reference/tools/retrieve-tool"},{"openapi":"delete /v2/tools/{tool_id}","title":"Delete tool","href":"/reference/tools/delete-tool"},{"openapi":"patch /v2/tools/{tool_id}","title":"Update tool","href":"/reference/tools/update-tool"},{"openapi":"get /v2/tools/{tool_id}/versions","title":"List tool versions","href":"/reference/tools/list-tool-versions"},{"openapi":"get /v2/tools/{tool_id}/versions/{version_id}","title":"Get tool version","href":"/reference/tools/get-tool-version"}]},{"group":"Telemetry","pages":[{"openapi":"post /v3/telemetry/query","title":"Query telemetry","href":"/reference/telemetry/query-telemetry"},{"openapi":"get /v3/telemetry/capabilities","title":"List telemetry capabilities","href":"/reference/telemetry/list-telemetry-capabilities"},{"openapi":"post /v3/telemetry/facet-values","title":"List telemetry facet values","href":"/reference/telemetry/list-telemetry-facet-values"}]},{"group":"Traces","pages":[{"openapi":"post /v3/traces/aggregate","title":"Aggregate traces","href":"/reference/traces/aggregate-traces"},{"openapi":"post /v3/traces/search","title":"Search traces","href":"/reference/traces/search-traces"},{"openapi":"post /v3/traces/query","title":"Query traces with OQL","href":"/reference/traces/query-traces-with-oql"},{"openapi":"get /v3/traces/{trace_id}","title":"Get trace","href":"/reference/traces/get-trace"},{"openapi":"get /v3/traces/{trace_id}/spans","title":"List trace spans","href":"/reference/traces/list-trace-spans"},{"openapi":"get /v3/traces/{trace_id}/spans/{span_id}","title":"Get trace span","href":"/reference/traces/get-trace-span"},{"openapi":"get /v3/traces/{trace_id}/conversation","title":"Get trace conversation","href":"/reference/traces/get-trace-conversation"},{"openapi":"get /v3/traces/fields","title":"List trace fields","href":"/reference/traces/list-trace-fields"},{"openapi":"get /v3/traces/facets","title":"List trace facets","href":"/reference/traces/list-trace-facets"},{"openapi":"get /v3/traces/facets/{field}","title":"List trace facet values","href":"/reference/traces/list-trace-facet-values"}]},{"group":"Views","pages":[{"openapi":"post /v3/views","title":"Create a saved view","href":"/reference/views/create-a-saved-view"},{"openapi":"get /v3/views","title":"List visible saved views","href":"/reference/views/list-saved-views"},{"openapi":"get /v3/views/{view_id}","title":"Retrieve a saved view","href":"/reference/views/retrieve-a-saved-view"},{"openapi":"patch /v3/views/{view_id}","title":"Update a saved view","href":"/reference/views/update-a-saved-view"},{"openapi":"delete /v3/views/{view_id}","title":"Delete a saved view","href":"/reference/views/delete-a-saved-view"}]},{"group":"Webhooks","pages":[{"openapi":"get /v2/webhooks","title":"List webhooks","href":"/reference/webhooks/list-webhooks"},{"openapi":"get /v2/webhooks/secret","title":"Generate a webhook secret","href":"/reference/webhooks/generate-a-webhook-secret"},{"openapi":"post /v2/webhooks","title":"Create a webhook","href":"/reference/webhooks/create-a-webhook"},{"openapi":"get /v2/webhooks/count","title":"Count webhooks","href":"/reference/webhooks/count-webhooks"},{"openapi":"get /v2/webhooks/{id}","title":"Retrieve a webhook","href":"/reference/webhooks/retrieve-a-webhook"},{"openapi":"patch /v2/webhooks/{id}","title":"Update a webhook","href":"/reference/webhooks/update-a-webhook"},{"openapi":"delete /v2/webhooks/{id}","title":"Delete a webhook","href":"/reference/webhooks/delete-a-webhook"},{"openapi":"post /v2/webhooks/query","deprecated":true,"title":"Query webhooks","href":"/reference/webhooks/query-webhooks"}]}]},{"group":"Management APIs","pages":[{"title":"Management APIs","sidebarTitle":"Overview","href":"/management-apis/overview"},{"group":"API Keys","pages":[{"openapi":"get /v2/api-keys","title":"List API keys","href":"/reference/api-keys/list-api-keys"},{"openapi":"post /v2/api-keys","title":"Create a new API key","href":"/reference/api-keys/create-a-new-api-key"},{"openapi":"get /v2/api-keys/capabilities","title":"List capability catalog","href":"/reference/api-keys/list-capability-catalog"},{"openapi":"get /v2/api-keys/{api_key_id}","title":"Retrieve an API key","href":"/reference/api-keys/retrieve-an-api-key"},{"openapi":"delete /v2/api-keys/{api_key_id}","title":"Delete an API key","href":"/reference/api-keys/delete-an-api-key"},{"openapi":"patch /v2/api-keys/{api_key_id}","title":"Update an API key","href":"/reference/api-keys/update-an-api-key"}]},{"group":"Management Keys","pages":[{"openapi":"get /v2/management-keys","title":"List management keys","href":"/reference/management-keys/list-management-keys"},{"openapi":"post /v2/management-keys","title":"Create a new management key","href":"/reference/management-keys/create-a-new-management-key"},{"openapi":"get /v2/management-keys/capabilities","title":"List management capability catalog","href":"/reference/management-keys/list-management-capability-catalog"},{"openapi":"get /v2/management-keys/{management_key_id}","title":"Retrieve a management key","href":"/reference/management-keys/retrieve-a-management-key"},{"openapi":"delete /v2/management-keys/{management_key_id}","title":"Delete a management key","href":"/reference/management-keys/delete-a-management-key"},{"openapi":"patch /v2/management-keys/{management_key_id}","title":"Update a management key","href":"/reference/management-keys/update-a-management-key"}]},{"group":"Budgets","pages":[{"openapi":"get /v2/budgets","title":"List budgets","href":"/reference/budgets/list-budgets"},{"openapi":"post /v2/budgets","title":"Create a new budget","href":"/reference/budgets/create-a-new-budget"},{"openapi":"get /v2/budgets/{budget_id}","title":"Retrieve a budget","href":"/reference/budgets/retrieve-a-budget"},{"openapi":"delete /v2/budgets/{budget_id}","title":"Delete a budget","href":"/reference/budgets/delete-a-budget"},{"openapi":"patch /v2/budgets/{budget_id}","title":"Update a budget","href":"/reference/budgets/update-a-budget"},{"openapi":"post /v2/budgets/{budget_id}/reset-consumption","title":"Reset budget consumption","href":"/reference/budgets/reset-budget-consumption"}]},{"group":"Projects","pages":[{"openapi":"get /v2/projects","title":"List all projects","href":"/reference/projects/list-all-projects"},{"openapi":"post /v2/projects","title":"Create a new project","href":"/reference/projects/create-a-new-project"},{"openapi":"get /v2/projects/{project_id}","title":"Retrieve a project","href":"/reference/projects/retrieve-a-project"},{"openapi":"delete /v2/projects/{project_id}","title":"Delete a project","href":"/reference/projects/delete-a-project"},{"openapi":"patch /v2/projects/{project_id}","title":"Update a project","href":"/reference/projects/update-a-project"}]},{"group":"Alerts","pages":[{"openapi":"get /v2/alerts","title":"List alerts","href":"/reference/alerts/list-alerts"},{"openapi":"post /v2/alerts","title":"Create an alert","href":"/reference/alerts/create-an-alert"},{"openapi":"get /v2/alerts/{alert_id}","title":"Retrieve an alert","href":"/reference/alerts/retrieve-an-alert"},{"openapi":"delete /v2/alerts/{alert_id}","title":"Delete an alert","href":"/reference/alerts/delete-an-alert"},{"openapi":"patch /v2/alerts/{alert_id}","title":"Update an alert","href":"/reference/alerts/update-an-alert"},{"openapi":"get /v2/alerts/{alert_id}/triggers","title":"List alert triggers","href":"/reference/alerts/list-alert-triggers"},{"openapi":"get /v2/alerts/{alert_id}/triggers/{trigger_id}/events","title":"List alert trigger events","href":"/reference/alerts/list-alert-trigger-events"}]},{"group":"Notifiers","pages":[{"openapi":"get /v2/notifiers","title":"List notifiers","href":"/reference/notifiers/list-notifiers"},{"openapi":"post /v2/notifiers","title":"Create a notifier","href":"/reference/notifiers/create-a-notifier"},{"openapi":"get /v2/notifiers/{notifier_id}","title":"Retrieve a notifier","href":"/reference/notifiers/retrieve-a-notifier"},{"openapi":"delete /v2/notifiers/{notifier_id}","title":"Delete a notifier","href":"/reference/notifiers/delete-a-notifier"},{"openapi":"patch /v2/notifiers/{notifier_id}","title":"Update a notifier","href":"/reference/notifiers/update-a-notifier"}]},{"group":"Monitors","pages":[{"openapi":"get /v2/monitors","title":"List monitors","href":"/reference/monitors/list-monitors"},{"openapi":"post /v2/monitors","title":"Create a monitor","href":"/reference/monitors/create-a-monitor"},{"openapi":"get /v2/monitors/{monitor_id}","title":"Retrieve a monitor","href":"/reference/monitors/retrieve-a-monitor"},{"openapi":"delete /v2/monitors/{monitor_id}","title":"Delete a monitor","href":"/reference/monitors/delete-a-monitor"},{"openapi":"patch /v2/monitors/{monitor_id}","title":"Update a monitor","href":"/reference/monitors/update-a-monitor"},{"openapi":"get /v2/monitors/presets","title":"List monitor presets","href":"/reference/monitors/list-monitor-presets"}]},{"group":"Audit Logs","pages":[{"openapi":"post /v2/audit-logs/query","title":"Query audit logs","href":"/reference/audit-logs/query-audit-logs"}]},{"group":"Identities","pages":[{"openapi":"get /v2/identities","title":"List identities","href":"/reference/identities/list-identities"},{"openapi":"post /v2/identities","title":"Create an identity","href":"/reference/identities/create-an-identity"},{"openapi":"get /v2/identities/{id}","title":"Retrieve an identity","href":"/reference/identities/retrieve-an-identity"},{"openapi":"delete /v2/identities/{id}","title":"Delete an identity","href":"/reference/identities/delete-an-identity"},{"openapi":"patch /v2/identities/{id}","title":"Update an identity","href":"/reference/identities/update-an-identity"}]},{"group":"Workspaces","pages":[{"openapi":"get /v2/workspaces","title":"List workspaces","href":"/reference/workspaces/list-workspaces"},{"openapi":"get /v2/workspaces/{key}","title":"Retrieve a workspace","description":"Retrieves a workspace by its key. A user session must be a member and does not need a workspace-scoped token. A management key may only retrieve the workspace bound to the key.","href":"/reference/workspaces/retrieve-a-workspace"},{"openapi":"patch /v2/workspaces/{key}","title":"Update a workspace","href":"/reference/workspaces/update-a-workspace"}]},{"group":"Users","pages":[{"openapi":"get /v3/users","title":"List workspace users","description":"Returns all users in the current workspace, including their team memberships and workspace roles. Requires a Management Key with user permissions or an authenticated workspace admin session. Standard API keys are not supported.","href":"/reference/users/list-workspace-users"},{"openapi":"post /v3/users/{id}","title":"Create or add workspace users","href":"/reference/users/create-or-add-workspace-users"},{"openapi":"get /v3/users/{id}","title":"Retrieve a workspace user","href":"/reference/users/retrieve-a-workspace-user"},{"openapi":"patch /v3/users/{id}","title":"Update a workspace user","href":"/reference/users/update-a-workspace-user"},{"openapi":"delete /v3/users/{id}","title":"Delete a workspace user","href":"/reference/users/delete-a-workspace-user"}]},{"group":"Workspace Settings","pages":[{"openapi":"get /v2/workspace-settings","title":"Retrieve workspace settings","href":"/reference/workspace-settings/retrieve-workspace-settings"},{"openapi":"patch /v2/workspace-settings","title":"Update workspace settings","href":"/reference/workspace-settings/update-workspace-settings"}]},{"group":"Workspace Security","pages":[{"openapi":"get /v2/workspaces/{workspace_key}/domains","title":"List verified domains","href":"/reference/workspace-security/list-verified-domains"},{"openapi":"post /v2/workspaces/{workspace_key}/domains","title":"Add a domain","href":"/reference/workspace-security/add-a-domain"},{"openapi":"delete /v2/workspaces/{workspace_key}/domains/{domain_id}","title":"Delete a domain","href":"/reference/workspace-security/delete-a-domain"},{"openapi":"post /v2/workspaces/{workspace_key}/domains/{domain_id}/verify","title":"Verify a domain","href":"/reference/workspace-security/verify-a-domain"},{"openapi":"get /v2/workspaces/{workspace_key}/ip-allowlist","title":"Retrieve the IP allowlist","href":"/reference/workspace-security/retrieve-the-ip-allowlist"},{"openapi":"patch /v2/workspaces/{workspace_key}/ip-allowlist","title":"Enable or disable the IP allowlist","href":"/reference/workspace-security/enable-or-disable-the-ip-allowlist"},{"openapi":"post /v2/workspaces/{workspace_key}/ip-allowlist/entries","title":"Add an IP range","href":"/reference/workspace-security/add-an-ip-range"},{"openapi":"delete /v2/workspaces/{workspace_key}/ip-allowlist/entries/{range_id}","title":"Delete an IP range","href":"/reference/workspace-security/delete-an-ip-range"}]},{"group":"Workspace Models","pages":[{"openapi":"post /v2/workspace-models","title":"Enable model for workspace","href":"/reference/models/enable-model-for-workspace"},{"openapi":"delete /v2/workspace-models/{model_id}","title":"Disable model for workspace","href":"/reference/models/disable-model-for-workspace"}]}]}]},{"tab":"Cookbooks","hidden":true,"pages":[{"title":"Cookbooks","href":"/ai-studio/cookbooks/cookbooks"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog/release-4-17"}]}]},"title":"Update a workspace - Orq.ai Documentation","buildId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","deploymentId":"dpl_2oYXwqkEXirXBPk8wV1FtM5USFWi","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-WRhTSUDL.js","utils-ChMov4Kr.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-_REmC2bI.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp6nVRCu.js","snippetPresets-DZadmXoU.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CY2WdoTl.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-DwYG-Q4l.js","shallow-BXQIGwv4.js","getApiPlaygroundDisplay-CK5nK5B9.js","CodeSnippet-TH4a2aGW.js","CodeSnippets-DwsQiOFS.js","Page-R3M_BF4L.js","getPastedJson-DD7kUzi_.js","icon-holE3QoJ.js","MethodPill-DUW0T8us.js","DuplicateIcon-CI_p4be-.js","createIcon-BdbRvavb.js","DynamicMarkdown-DN96a4Ur.js","SectionHeading-SCu36A9d.js","axios-vUo_bRtp.js","Markdown-CCeGv-zI.js","clsx-BGBGWFTt.js","lib--scc4DXi.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cv_O2fky.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-2C5OB2eV.js"]}