Syncs the upstream catalogs and returns discovery outcomes. Resource catalogs and capabilities discovered with user-specific credentials or discovery variables are returned only to the caller.
{"docsConfig":{"theme":"aspen","$schema":"https://mintlify.com/docs.json","name":"Orq.ai Documentation","description":"Documentation for Orq.ai, the EU-built control plane for enterprise AI: govern every LLM and MCP call with the AI Gateway, and ship backlog work with the Software Factory.","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","weight":400,"source":"fonts/inter-latin-400-normal.woff2","format":"woff2"}},"styling":{"codeblocks":{"theme":{"light":"github-light","dark":"github-dark"}},"latex":true},"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":""},"feedback":{"thumbs":true,"agentFeedback":true},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6af310c039d0955f17813fe9","clientVersion":"0.0.4094","searchFilterCounts":[{"language":"default","tag":"API Reference","count":439},{"language":"default","tag":"Platform APIs","count":288},{"language":"default","tag":"Integrations","count":93},{"language":"default","tag":"Management APIs","count":74},{"language":"default","tag":"AI Gateway","count":70},{"language":"default","tag":"Orq SDK","count":69},{"language":"default","tag":"SDK Reference","count":66},{"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":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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}],"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, 0.15);font-size:14px;outline:none;margin-bottom:20px;background:transparent;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, 0.15)}.ig-search:focus{border-color:#027f6b}.ig-tabs{display:flex;border-bottom:1px solid rgba(0, 0, 0, 0.1);margin-bottom:20px;gap:0}.dark .ig-tabs{border-bottom-color:rgba(255, 255, 255, 0.1)}.ig-tab{padding:8px 16px;background:none;border:none;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, 0.1);border-radius:6px;text-decoration:none!important;color:inherit!important;font-size:14px;font-weight:500;transition:background 0.12s, border-color 0.12s}.ig-card:hover{background:rgba(2, 127, 107, 0.05);border-color:rgba(2, 127, 107, 0.25)}.dark .ig-card{border-color:rgba(255, 255, 255, 0.1)}.dark .ig-card:hover{background:rgba(103, 127, 120, 0.1);border-color:rgba(103, 127, 120, 0.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, 0.08);color:inherit}.dark .ig-tab-count{background:rgba(255, 255, 255, 0.12)}.ig-tab-active .ig-tab-count{background:rgba(2, 127, 107, 0.15)}.dark .ig-tab-active .ig-tab-count{background:rgba(103, 127, 120, 0.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:0.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, 0.15)}.dark #navbar .nav-tabs-item[href=\"/ai-studio/integrations/overview\"]::before{background:rgba(255, 255, 255, 0.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}@font-face{font-family:'Inter';src:url('/fonts/inter-latin-400-normal.woff2') format('woff2');font-style:normal;font-weight:400;font-display:optional}"}],"page":{"pagePath":"reference/mcp-gateway/sync-an-mcp-server","slug":"/reference/mcp-gateway/sync-an-mcp-server","pageMetadata":{"openapi":"post /v2/mcp-servers/{id}:sync","title":"Sync an MCP server","description":"Syncs the upstream catalogs and returns discovery outcomes. Resource catalogs and capabilities discovered with user-specific credentials or discovery variables are returned only to the caller.","href":"/reference/mcp-gateway/sync-an-mcp-server"},"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: \"Syncs the upstream catalogs and returns discovery outcomes. Resource catalogs and capabilities discovered with user-specific credentials or discovery variables are returned only to the caller.\"\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{jsx:_jsx,jsxs:_jsxs}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){const _components={a:`a`,p:`p`,strong:`strong`,..._provideComponents(),...props.components},{Note}=_components;if(!Note)_missingMdxReference(`Note`,true);return _jsx(Note,{children:_jsxs(_components.p,{children:[_jsx(_components.strong,{children:`Related guide`}),`: MCP gateways guide. See the `,_jsx(_components.a,{href:`/ai-gateway/mcp-portal/mcp-gateways`,children:`MCP gateways guide`}),` for a walkthrough with examples.`]})})}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":{"codeStyling":{"theme":{"light":"github-light","dark":"github-dark"}},"config":{},"pageMetadata":{"openapi":"post /v2/mcp-servers/{id}:sync","title":"Sync an MCP server","description":"Syncs the upstream catalogs and returns discovery outcomes. Resource catalogs and capabilities discovered with user-specific credentials or discovery variables are returned only to the caller.","href":"/reference/mcp-gateway/sync-an-mcp-server"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/orqai/19ee3574279bbaa0/gtm.js","/_mintlify/custom/orqai/1f1a49b99957b631/commonroom-signals.js"],"openApiReferenceData":{"operation":{"tags":["MCP Gateway"],"summary":"Sync an MCP server","description":"Syncs the upstream catalogs and returns discovery outcomes. Resource catalogs and capabilities discovered with user-specific credentials or discovery variables are returned only to the caller.","operationId":"McpServerSync","parameters":["0be8e1be-ce82-450d-b06c-67f4dc7364b2"],"requestBody":"343bc77d-d7c4-4412-b7b3-698d45ed29e7","responses":{"200":"db498b5a-b61d-4191-821d-1ad1b85a7939","401":"e7ab5246-9824-4f06-a203-98acecaf09b2"},"x-speakeasy-group":"mcpServers","x-speakeasy-name-override":"sync","x-cli-group":"mcpServers","x-cli-name":"sync","x-code-samples":[{"lang":"curl","label":"Core - Sync the tool catalog","source":"curl --request POST \\\n --url 'https://my.orq.ai/v2/mcp-servers/01JQ0K5R8N2ZC7X4M9T3V6HWBD:sync' \\\n --header \"Authorization: Bearer $ORQ_API_KEY\" \\\n --header 'Content-Type: application/json' \\\n --data '{}'\n"},{"lang":"curl","label":"Core - Sync a server that uses template variables","source":"curl --request POST \\\n --url 'https://my.orq.ai/v2/mcp-servers/01JQ0K5R8N2ZC7X4M9T3V6HWBD:sync' \\\n --header \"Authorization: Bearer $ORQ_API_KEY\" \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"discovery_variables\": { \"github_token\": \"ghp_example_token\" }\n }'\n"},{"lang":"python","label":"Python - Sync the tool catalog","source":"import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nresult = client.mcp_servers.sync(id=\"01JQ0K5R8N2ZC7X4M9T3V6HWBD\")\n\nstate = result.mcp_server.sync_state\n# A sync that discovers nothing still reports SYNCED with tools_total 0.\nprint(state.status, state.tools_added, state.tools_removed)\n"},{"lang":"typescript","label":"Node.js - Sync the tool catalog","source":"import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst result = await client.mcpServers.sync({\n id: '01JQ0K5R8N2ZC7X4M9T3V6HWBD',\n});\n\nconst state = result.mcpServer.syncState;\n// A sync that discovers nothing still reports SYNCED with toolsTotal 0.\nconsole.log(state.status, state.toolsAdded, state.toolsRemoved);\n"}],"method":"post","type":"path","servers":["5eea2133-7793-4625-8037-fe5f8884a07f"],"security":["373453b5-0382-45f3-955e-deddc3bea0f3"],"path":"/v2/mcp-servers/{id}:sync","baseUrlOptions":["https://my.orq.ai"],"title":"Sync an MCP server","codeSamples":[{"label":"Core - Sync the tool catalog","lang":"curl","source":"curl --request POST \\\n --url 'https://my.orq.ai/v2/mcp-servers/01JQ0K5R8N2ZC7X4M9T3V6HWBD:sync' \\\n --header \"Authorization: Bearer $ORQ_API_KEY\" \\\n --header 'Content-Type: application/json' \\\n --data '{}'\n"},{"label":"Core - Sync a server that uses template variables","lang":"curl","source":"curl --request POST \\\n --url 'https://my.orq.ai/v2/mcp-servers/01JQ0K5R8N2ZC7X4M9T3V6HWBD:sync' \\\n --header \"Authorization: Bearer $ORQ_API_KEY\" \\\n --header 'Content-Type: application/json' \\\n --data '{\n \"discovery_variables\": { \"github_token\": \"ghp_example_token\" }\n }'\n"},{"label":"Python - Sync the tool catalog","lang":"python","source":"import os\nfrom orq_ai_sdk import Orq\n\nclient = Orq(api_key=os.environ[\"ORQ_API_KEY\"])\n\nresult = client.mcp_servers.sync(id=\"01JQ0K5R8N2ZC7X4M9T3V6HWBD\")\n\nstate = result.mcp_server.sync_state\n# A sync that discovers nothing still reports SYNCED with tools_total 0.\nprint(state.status, state.tools_added, state.tools_removed)\n"},{"label":"Node.js - Sync the tool catalog","lang":"typescript","source":"import { Orq } from '@orq-ai/node';\n\nconst client = new Orq({\n apiKey: process.env.ORQ_API_KEY,\n});\n\nconst result = await client.mcpServers.sync({\n id: '01JQ0K5R8N2ZC7X4M9T3V6HWBD',\n});\n\nconst state = result.mcpServer.syncState;\n// A sync that discovers nothing still reports SYNCED with toolsTotal 0.\nconsole.log(state.status, state.toolsAdded, state.toolsRemoved);\n"}],"requestExampleLanguages":["bash","typescript","python"],"requiredOnlyExamples":false,"requestExampleType":"codeSamples","responseExampleType":"generated"},"dependencies":{"parameters":{"0be8e1be-ce82-450d-b06c-67f4dc7364b2":{"name":"id","in":"path","description":"Unique identifier of the MCP server.","required":true,"schema":{"type":"string","isRequired":true,"description":"Unique identifier of the MCP server.","uniqueKey":"","typeLabel":"string"}}},"requestBody":{"content":{"application/json":{"schema":{"required":[],"type":"object","properties":{"discovery_variables":{"type":"object","additionalProperties":{"type":"string","uniqueKey":"discovery_variables.additionalProperties","typeLabel":"string"},"description":"Values for the server's `template_variables`; treated as sensitive and not persisted.","uniqueKey":"discovery_variables","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"discovery_variables":{}}}},"exampleType":"generated"}},"required":true,"exampleType":"generated"},"responses":{"db498b5a-b61d-4191-821d-1ad1b85a7939":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"mcp_server":{"type":"object","properties":{"id":{"type":"string","description":"Unique identifier of the MCP server.","uniqueKey":"mcp_server.id","typeLabel":"string"},"key":{"type":"string","description":"Lowercase slug of letters, digits, hyphens and underscores, max 64 characters, unique per workspace; prefixes this server's tool names in gateways.","uniqueKey":"mcp_server.key","typeLabel":"string"},"display_name":{"type":"string","description":"Human readable name shown in the workspace.","uniqueKey":"mcp_server.display_name","typeLabel":"string"},"description":{"type":"string","description":"Free-form note about what this server is for.","uniqueKey":"mcp_server.description","typeLabel":"string"},"connection":{"type":"object","description":"How the gateway dials the upstream server.","required":["type","url"],"properties":{"type":{"type":"string","enum":["MCP_CONNECTION_TYPE_HTTP","MCP_CONNECTION_TYPE_SSE","MCP_CONNECTION_TYPE_STDIO","MCP_CONNECTION_TYPE_OPENAPI"],"description":"Transport the gateway uses to dial the upstream server.","isRequired":true,"uniqueKey":"mcp_server.connection.type","typeLabel":"enum\u003cstring>"},"url":{"type":"string","description":"Upstream endpoint; must use the http or https scheme.","isRequired":true,"uniqueKey":"mcp_server.connection.url","typeLabel":"string"}},"uniqueKey":"mcp_server.connection","typeLabel":"object"},"auth":{"type":"object","description":"Credentials the gateway sends upstream; send `type: NONE` explicitly for public servers.","required":["type"],"properties":{"type":{"type":"string","enum":["MCP_AUTH_TYPE_NONE","MCP_AUTH_TYPE_STATIC_HEADERS","MCP_AUTH_TYPE_OAUTH_CLIENT_CREDENTIALS","MCP_AUTH_TYPE_PER_USER_OAUTH","MCP_AUTH_TYPE_ENTERPRISE_MANAGED"],"description":"Credential scheme used to authenticate to this upstream server.","isRequired":true,"uniqueKey":"mcp_server.auth.type","typeLabel":"enum\u003cstring>"},"static_headers":{"type":"array","items":{"type":"object","properties":{"key":{"type":"string","description":"Header name sent to the upstream server.","uniqueKey":"mcp_server.auth.static_headers.items.[INDEX].key","typeLabel":"string"},"masked_value":{"type":"string","description":"Redacted preview of `value`, returned in its place.","uniqueKey":"mcp_server.auth.static_headers.items.[INDEX].masked_value","typeLabel":"string"}},"uniqueKey":"mcp_server.auth.static_headers.items.[INDEX]","typeLabel":"object"},"description":"Headers sent upstream on every request; at least one entry when type is STATIC_HEADERS.","uniqueKey":"mcp_server.auth.static_headers","typeLabel":"object[]"},"oauth":{"type":"object","description":"OAuth client for the upstream authorization server; set when type is OAUTH_CLIENT_CREDENTIALS, PER_USER_OAUTH or ENTERPRISE_MANAGED.","properties":{"client_id":{"type":"string","description":"OAuth client identifier presented to the upstream authorization server.","uniqueKey":"mcp_server.auth.oauth.client_id","typeLabel":"string"},"token_url":{"type":"string","description":"Token endpoint for OAUTH_CLIENT_CREDENTIALS; PER_USER_OAUTH and ENTERPRISE_MANAGED discover it from `resource`.","uniqueKey":"mcp_server.auth.oauth.token_url","typeLabel":"string"},"scopes":{"type":"array","items":{"type":"string","uniqueKey":"mcp_server.auth.oauth.scopes.items.[INDEX]","typeLabel":"string"},"description":"Scopes requested when minting upstream access tokens.","uniqueKey":"mcp_server.auth.oauth.scopes","typeLabel":"string[]"},"masked_value":{"type":"string","description":"Redacted preview of `client_secret`, returned in its place.","uniqueKey":"mcp_server.auth.oauth.masked_value","typeLabel":"string"},"issuer":{"type":"string","description":"Exact authorization-server issuer; pins discovery for PER_USER_OAUTH and ENTERPRISE_MANAGED.","uniqueKey":"mcp_server.auth.oauth.issuer","typeLabel":"string"},"resource":{"type":"string","description":"Protected resource identifier; defaults to the upstream connection URL.","uniqueKey":"mcp_server.auth.oauth.resource","typeLabel":"string"}},"uniqueKey":"mcp_server.auth.oauth","typeLabel":"object"},"enterprise":{"type":"object","description":"Superseded by `oauth` for ENTERPRISE_MANAGED; accepted on write and mirrored on read.","deprecated":true,"properties":{"resource":{"type":"string","description":"RFC 9728 resource identifier the tokens are bound to; defaults to the connection URL.","uniqueKey":"mcp_server.auth.enterprise.resource","typeLabel":"string"},"client_id":{"type":"string","description":"OAuth client identifier registered at the upstream authorization server.","uniqueKey":"mcp_server.auth.enterprise.client_id","typeLabel":"string"},"masked_value":{"type":"string","description":"Redacted preview of `client_secret`, returned in its place.","uniqueKey":"mcp_server.auth.enterprise.masked_value","typeLabel":"string"},"scopes":{"type":"array","items":{"type":"string","uniqueKey":"mcp_server.auth.enterprise.scopes.items.[INDEX]","typeLabel":"string"},"description":"Scopes requested when redeeming the identity assertion grant.","uniqueKey":"mcp_server.auth.enterprise.scopes","typeLabel":"string[]"}},"uniqueKey":"mcp_server.auth.enterprise","typeLabel":"object"}},"uniqueKey":"mcp_server.auth","typeLabel":"object"},"default_tool_exposure":{"type":"object","description":"Fallback exposure used by any gateway link that does not set its own.","required":["mode"],"properties":{"mode":{"type":"string","enum":["MCP_TOOL_EXPOSURE_MODE_ALL","MCP_TOOL_EXPOSURE_MODE_SELECTED","MCP_TOOL_EXPOSURE_MODE_NONE"],"description":"Selection strategy: ALL, SELECTED or NONE.","isRequired":true,"uniqueKey":"mcp_server.default_tool_exposure.mode","typeLabel":"enum\u003cstring>"},"read_only":{"type":"boolean","description":"Keeps only the tools the upstream annotates as read-only.","uniqueKey":"mcp_server.default_tool_exposure.read_only","typeLabel":"boolean"},"tool_ids":{"type":"array","items":{"type":"string","uniqueKey":"mcp_server.default_tool_exposure.tool_ids.items.[INDEX]","typeLabel":"string"},"description":"`McpTool.id` values to expose when mode is SELECTED; a tool renamed upstream gets a new id on the next sync.","uniqueKey":"mcp_server.default_tool_exposure.tool_ids","typeLabel":"string[]"},"excluded_tool_ids":{"type":"array","items":{"type":"string","uniqueKey":"mcp_server.default_tool_exposure.excluded_tool_ids.items.[INDEX]","typeLabel":"string"},"description":"`McpTool.id` values deliberately left unexposed when mode is SELECTED; an active tool in neither list is new to this selection.","uniqueKey":"mcp_server.default_tool_exposure.excluded_tool_ids","typeLabel":"string[]"}},"uniqueKey":"mcp_server.default_tool_exposure","typeLabel":"object"},"sync_state":{"type":"object","description":"Result of the last `:sync`; a new server has no tools until synced.","properties":{"status":{"type":"string","enum":["SYNC_STATUS_SYNCED","SYNC_STATUS_FAILED","SYNC_STATUS_PENDING"],"description":"Outcome of the last sync; a sync that discovers zero tools still reports SYNCED.","uniqueKey":"mcp_server.sync_state.status","typeLabel":"enum\u003cstring>"},"tools_total":{"type":"integer","description":"Tools in the catalog after the last sync.","format":"int32","uniqueKey":"mcp_server.sync_state.tools_total","typeLabel":"integer\u003cint32>"},"tools_added":{"type":"integer","description":"Tools the last sync discovered for the first time.","format":"int32","uniqueKey":"mcp_server.sync_state.tools_added","typeLabel":"integer\u003cint32>"},"tools_removed":{"type":"integer","description":"Tools the last sync no longer found upstream and marked MISSING.","format":"int32","uniqueKey":"mcp_server.sync_state.tools_removed","typeLabel":"integer\u003cint32>"},"last_synced_at":{"type":"string","description":"ISO 8601 timestamp of the last sync attempt.","uniqueKey":"mcp_server.sync_state.last_synced_at","typeLabel":"string"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"mcp_server.sync_state.errors.items.[INDEX]","typeLabel":"string"},"description":"Failures reported by the last sync.","uniqueKey":"mcp_server.sync_state.errors","typeLabel":"string[]"}},"uniqueKey":"mcp_server.sync_state","typeLabel":"object"},"tools":{"type":"array","items":{"type":"object","properties":{"name":{"type":"string","description":"Bare tool name as advertised by the upstream server.","uniqueKey":"mcp_server.tools.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","description":"Tool description advertised upstream, passed through to MCP clients.","uniqueKey":"mcp_server.tools.items.[INDEX].description","typeLabel":"string"},"input_schema":{"type":"object","description":"JSON Schema for the tool arguments, as advertised upstream.","uniqueKey":"mcp_server.tools.items.[INDEX].input_schema","typeLabel":"object"},"status":{"type":"string","description":"`ACTIVE`, or `MISSING` when the last sync no longer found the tool upstream.","uniqueKey":"mcp_server.tools.items.[INDEX].status","typeLabel":"string"},"id":{"readOnly":true,"type":"string","description":"Assigned once on first discovery and preserved across sync.","uniqueKey":"mcp_server.tools.items.[INDEX].id","typeLabel":"string"},"title":{"type":"string","description":"Human-readable label advertised upstream, when the server sends one.","uniqueKey":"mcp_server.tools.items.[INDEX].title","typeLabel":"string"},"annotations":{"type":"object","description":"Behaviour hints claimed by the upstream server.","properties":{"read_only":{"type":"boolean","description":"Upstream claims the tool does not modify state.","uniqueKey":"mcp_server.tools.items.[INDEX].annotations.read_only","typeLabel":"boolean"},"destructive":{"type":"boolean","description":"Upstream claims the tool can perform destructive updates.","uniqueKey":"mcp_server.tools.items.[INDEX].annotations.destructive","typeLabel":"boolean"},"idempotent":{"type":"boolean","description":"Upstream claims repeated calls with the same arguments have no extra effect.","uniqueKey":"mcp_server.tools.items.[INDEX].annotations.idempotent","typeLabel":"boolean"},"open_world":{"type":"boolean","description":"Upstream claims the tool reaches systems outside its own domain.","uniqueKey":"mcp_server.tools.items.[INDEX].annotations.open_world","typeLabel":"boolean"}},"uniqueKey":"mcp_server.tools.items.[INDEX].annotations","typeLabel":"object"}},"uniqueKey":"mcp_server.tools.items.[INDEX]","typeLabel":"object"},"description":"Tool catalog discovered by the last successful `:sync`.","uniqueKey":"mcp_server.tools","typeLabel":"object[]"},"created":{"type":"string","description":"ISO 8601 timestamp of when the server was created.","uniqueKey":"mcp_server.created","typeLabel":"string"},"updated":{"type":"string","description":"ISO 8601 timestamp of the most recent change to the server.","uniqueKey":"mcp_server.updated","typeLabel":"string"},"sharing":{"type":"object","description":"Which projects in the workspace may use this server.","properties":{"all_projects":{"type":"object","description":"Visible to every project in the workspace.","properties":{},"uniqueKey":"mcp_server.sharing.all_projects","typeLabel":"object"},"selected":{"type":"object","description":"Visible to the listed projects only.","properties":{"project_ids":{"type":"array","items":{"type":"string","uniqueKey":"mcp_server.sharing.selected.project_ids.items.[INDEX]","typeLabel":"string"},"description":"Projects allowed to use the entity. An empty list shares it with no project.","uniqueKey":"mcp_server.sharing.selected.project_ids","typeLabel":"string[]"}},"uniqueKey":"mcp_server.sharing.selected","typeLabel":"object"},"allow_version_pin":{"type":"boolean","description":"Consuming projects may pin a specific version instead of tracking\n the latest version.","uniqueKey":"mcp_server.sharing.allow_version_pin","typeLabel":"boolean"},"allow_fork":{"type":"boolean","description":"Projects may duplicate this entity into a detached project-owned\n copy.","uniqueKey":"mcp_server.sharing.allow_fork","typeLabel":"boolean"},"auto_grant_new_projects":{"type":"boolean","description":"New projects created after this sharing config is applied should\n receive access automatically.","uniqueKey":"mcp_server.sharing.auto_grant_new_projects","typeLabel":"boolean"}},"uniqueKey":"mcp_server.sharing","typeLabel":"object"},"template_variables":{"readOnly":true,"type":"array","items":{"type":"string","uniqueKey":"mcp_server.template_variables.items.[INDEX]","typeLabel":"string"},"description":"Names of `{{variable}}` placeholders found in the connection or auth config; supply values as `discovery_variables` on test, sync and tool calls.","x-speakeasy-ignore":true,"uniqueKey":"mcp_server.template_variables","typeLabel":"string[]"},"created_by_id":{"readOnly":true,"type":"string","description":"Account that created the server.","uniqueKey":"mcp_server.created_by_id","typeLabel":"string"},"openapi":{"type":"object","description":"Source of the tools of an `MCP_CONNECTION_TYPE_OPENAPI` server.","properties":{"document_url":{"type":"string","description":"URL the document is fetched from; `:sync` fetches it again.","uniqueKey":"mcp_server.openapi.document_url","typeLabel":"string"},"operations":{"type":"array","items":{"type":"string","uniqueKey":"mcp_server.openapi.operations.items.[INDEX]","typeLabel":"string"},"description":"Tool names of the operations to expose; empty exposes every operation.","uniqueKey":"mcp_server.openapi.operations","typeLabel":"string[]"},"title":{"readOnly":true,"type":"string","description":"`info.title` of the compiled document.","uniqueKey":"mcp_server.openapi.title","typeLabel":"string"},"version":{"readOnly":true,"type":"string","description":"`info.version` of the compiled document.","uniqueKey":"mcp_server.openapi.version","typeLabel":"string"}},"uniqueKey":"mcp_server.openapi","typeLabel":"object"},"capabilities":{"type":"object","description":"Capabilities from shared MCP discovery or the caller's current sync.","properties":{"tools":{"type":"boolean","uniqueKey":"mcp_server.capabilities.tools","typeLabel":"boolean"},"resources":{"type":"boolean","uniqueKey":"mcp_server.capabilities.resources","typeLabel":"boolean"},"prompts":{"type":"boolean","uniqueKey":"mcp_server.capabilities.prompts","typeLabel":"boolean"},"completions":{"type":"boolean","uniqueKey":"mcp_server.capabilities.completions","typeLabel":"boolean"}},"uniqueKey":"mcp_server.capabilities","typeLabel":"object"},"resource_catalog":{"type":"object","description":"Get returns the shared catalog. Sync returns the caller's catalog for user-specific credentials or discovery variables. List omits this field.","properties":{"resources":{"type":"array","items":{"type":"object","properties":{"uri":{"type":"string","uniqueKey":"mcp_server.resource_catalog.resources.items.[INDEX].uri","typeLabel":"string"},"name":{"type":"string","uniqueKey":"mcp_server.resource_catalog.resources.items.[INDEX].name","typeLabel":"string"},"title":{"type":"string","uniqueKey":"mcp_server.resource_catalog.resources.items.[INDEX].title","typeLabel":"string"},"description":{"type":"string","uniqueKey":"mcp_server.resource_catalog.resources.items.[INDEX].description","typeLabel":"string"},"mime_type":{"type":"string","uniqueKey":"mcp_server.resource_catalog.resources.items.[INDEX].mime_type","typeLabel":"string"},"size":{"type":"string","uniqueKey":"mcp_server.resource_catalog.resources.items.[INDEX].size","typeLabel":"string"},"annotations":{"type":"object","properties":{"audience":{"type":"array","items":{"type":"string","uniqueKey":"mcp_server.resource_catalog.resources.items.[INDEX].annotations.audience.items.[INDEX]","typeLabel":"string"},"uniqueKey":"mcp_server.resource_catalog.resources.items.[INDEX].annotations.audience","typeLabel":"string[]"},"last_modified":{"type":"string","uniqueKey":"mcp_server.resource_catalog.resources.items.[INDEX].annotations.last_modified","typeLabel":"string"},"priority":{"type":"number","format":"double","uniqueKey":"mcp_server.resource_catalog.resources.items.[INDEX].annotations.priority","typeLabel":"number\u003cdouble>"}},"description":"Upstream annotations shared by resource and resource template descriptors.","uniqueKey":"mcp_server.resource_catalog.resources.items.[INDEX].annotations","typeLabel":"object"},"icons":{"type":"array","items":{"type":"object","properties":{"src":{"type":"string","description":"Icon URI, including HTTPS URLs and base64 data URIs.","uniqueKey":"mcp_server.resource_catalog.resources.items.[INDEX].icons.items.[INDEX].src","typeLabel":"string"},"mime_type":{"type":"string","description":"Optional MIME type override.","uniqueKey":"mcp_server.resource_catalog.resources.items.[INDEX].icons.items.[INDEX].mime_type","typeLabel":"string"},"sizes":{"type":"array","items":{"type":"string","uniqueKey":"mcp_server.resource_catalog.resources.items.[INDEX].icons.items.[INDEX].sizes.items.[INDEX]","typeLabel":"string"},"description":"Supported sizes such as \"48x48\" or \"any\".","uniqueKey":"mcp_server.resource_catalog.resources.items.[INDEX].icons.items.[INDEX].sizes","typeLabel":"string[]"},"theme":{"type":"string","description":"Optional background theme this icon was designed for.","uniqueKey":"mcp_server.resource_catalog.resources.items.[INDEX].icons.items.[INDEX].theme","typeLabel":"string"}},"uniqueKey":"mcp_server.resource_catalog.resources.items.[INDEX].icons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"mcp_server.resource_catalog.resources.items.[INDEX].icons","typeLabel":"object[]"},"meta":{"type":"object","description":"Resource `_meta` advertised upstream.","uniqueKey":"mcp_server.resource_catalog.resources.items.[INDEX].meta","typeLabel":"object"},"selection_id":{"readOnly":true,"type":"string","description":"Opaque selection ID scoped to this saved server and its upstream origin. Omitted on connection probes.","uniqueKey":"mcp_server.resource_catalog.resources.items.[INDEX].selection_id","typeLabel":"string"}},"uniqueKey":"mcp_server.resource_catalog.resources.items.[INDEX]","typeLabel":"object"},"uniqueKey":"mcp_server.resource_catalog.resources","typeLabel":"object[]"},"resource_templates":{"type":"array","items":{"type":"object","properties":{"uri_template":{"type":"string","uniqueKey":"mcp_server.resource_catalog.resource_templates.items.[INDEX].uri_template","typeLabel":"string"},"name":{"type":"string","uniqueKey":"mcp_server.resource_catalog.resource_templates.items.[INDEX].name","typeLabel":"string"},"title":{"type":"string","uniqueKey":"mcp_server.resource_catalog.resource_templates.items.[INDEX].title","typeLabel":"string"},"description":{"type":"string","uniqueKey":"mcp_server.resource_catalog.resource_templates.items.[INDEX].description","typeLabel":"string"},"mime_type":{"type":"string","uniqueKey":"mcp_server.resource_catalog.resource_templates.items.[INDEX].mime_type","typeLabel":"string"},"annotations":{"type":"object","properties":{"audience":{"type":"array","items":{"type":"string","uniqueKey":"mcp_server.resource_catalog.resource_templates.items.[INDEX].annotations.audience.items.[INDEX]","typeLabel":"string"},"uniqueKey":"mcp_server.resource_catalog.resource_templates.items.[INDEX].annotations.audience","typeLabel":"string[]"},"last_modified":{"type":"string","uniqueKey":"mcp_server.resource_catalog.resource_templates.items.[INDEX].annotations.last_modified","typeLabel":"string"},"priority":{"type":"number","format":"double","uniqueKey":"mcp_server.resource_catalog.resource_templates.items.[INDEX].annotations.priority","typeLabel":"number\u003cdouble>"}},"description":"Upstream annotations shared by resource and resource template descriptors.","uniqueKey":"mcp_server.resource_catalog.resource_templates.items.[INDEX].annotations","typeLabel":"object"},"icons":{"type":"array","items":{"type":"object","properties":{"src":{"type":"string","description":"Icon URI, including HTTPS URLs and base64 data URIs.","uniqueKey":"mcp_server.resource_catalog.resource_templates.items.[INDEX].icons.items.[INDEX].src","typeLabel":"string"},"mime_type":{"type":"string","description":"Optional MIME type override.","uniqueKey":"mcp_server.resource_catalog.resource_templates.items.[INDEX].icons.items.[INDEX].mime_type","typeLabel":"string"},"sizes":{"type":"array","items":{"type":"string","uniqueKey":"mcp_server.resource_catalog.resource_templates.items.[INDEX].icons.items.[INDEX].sizes.items.[INDEX]","typeLabel":"string"},"description":"Supported sizes such as \"48x48\" or \"any\".","uniqueKey":"mcp_server.resource_catalog.resource_templates.items.[INDEX].icons.items.[INDEX].sizes","typeLabel":"string[]"},"theme":{"type":"string","description":"Optional background theme this icon was designed for.","uniqueKey":"mcp_server.resource_catalog.resource_templates.items.[INDEX].icons.items.[INDEX].theme","typeLabel":"string"}},"uniqueKey":"mcp_server.resource_catalog.resource_templates.items.[INDEX].icons.items.[INDEX]","typeLabel":"object"},"uniqueKey":"mcp_server.resource_catalog.resource_templates.items.[INDEX].icons","typeLabel":"object[]"},"meta":{"type":"object","description":"Resource template `_meta` advertised upstream.","uniqueKey":"mcp_server.resource_catalog.resource_templates.items.[INDEX].meta","typeLabel":"object"},"selection_id":{"readOnly":true,"type":"string","description":"Opaque ID for strict selection on a saved server. Omitted on probes and when template variables cannot be matched unambiguously.","uniqueKey":"mcp_server.resource_catalog.resource_templates.items.[INDEX].selection_id","typeLabel":"string"}},"uniqueKey":"mcp_server.resource_catalog.resource_templates.items.[INDEX]","typeLabel":"object"},"uniqueKey":"mcp_server.resource_catalog.resource_templates","typeLabel":"object[]"},"resources_status":{"type":"string","enum":["MCP_DISCOVERY_STATUS_SYNCED","MCP_DISCOVERY_STATUS_UNSUPPORTED","MCP_DISCOVERY_STATUS_FAILED"],"uniqueKey":"mcp_server.resource_catalog.resources_status","typeLabel":"enum\u003cstring>"},"resource_templates_status":{"type":"string","enum":["MCP_DISCOVERY_STATUS_SYNCED","MCP_DISCOVERY_STATUS_UNSUPPORTED","MCP_DISCOVERY_STATUS_FAILED"],"uniqueKey":"mcp_server.resource_catalog.resource_templates_status","typeLabel":"enum\u003cstring>"}},"uniqueKey":"mcp_server.resource_catalog","typeLabel":"object"}},"uniqueKey":"mcp_server","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"mcp_server":{"id":"\u003cstring>","key":"\u003cstring>","display_name":"\u003cstring>","description":"\u003cstring>","connection":{"type":"MCP_CONNECTION_TYPE_HTTP","url":"\u003cstring>"},"auth":{"type":"MCP_AUTH_TYPE_NONE","static_headers":[{"key":"\u003cstring>","masked_value":"\u003cstring>"}],"oauth":{"client_id":"\u003cstring>","token_url":"\u003cstring>","scopes":["\u003cstring>"],"masked_value":"\u003cstring>","issuer":"\u003cstring>","resource":"\u003cstring>"},"enterprise":{"resource":"\u003cstring>","client_id":"\u003cstring>","masked_value":"\u003cstring>","scopes":["\u003cstring>"]}},"default_tool_exposure":{"mode":"MCP_TOOL_EXPOSURE_MODE_ALL","read_only":true,"tool_ids":["\u003cstring>"],"excluded_tool_ids":["\u003cstring>"]},"sync_state":{"status":"SYNC_STATUS_SYNCED","tools_total":123,"tools_added":123,"tools_removed":123,"last_synced_at":"\u003cstring>","errors":["\u003cstring>"]},"tools":[{"name":"\u003cstring>","description":"\u003cstring>","input_schema":{},"status":"\u003cstring>","id":"\u003cstring>","title":"\u003cstring>","annotations":{"read_only":true,"destructive":true,"idempotent":true,"open_world":true}}],"created":"\u003cstring>","updated":"\u003cstring>","sharing":{"all_projects":{},"selected":{"project_ids":["\u003cstring>"]},"allow_version_pin":true,"allow_fork":true,"auto_grant_new_projects":true},"template_variables":["\u003cstring>"],"created_by_id":"\u003cstring>","openapi":{"document_url":"\u003cstring>","operations":["\u003cstring>"],"title":"\u003cstring>","version":"\u003cstring>"},"capabilities":{"tools":true,"resources":true,"prompts":true,"completions":true},"resource_catalog":{"resources":[{"uri":"\u003cstring>","name":"\u003cstring>","title":"\u003cstring>","description":"\u003cstring>","mime_type":"\u003cstring>","size":"\u003cstring>","annotations":{"audience":["\u003cstring>"],"last_modified":"\u003cstring>","priority":123},"icons":[{"src":"\u003cstring>","mime_type":"\u003cstring>","sizes":["\u003cstring>"],"theme":"\u003cstring>"}],"meta":{},"selection_id":"\u003cstring>"}],"resource_templates":[{"uri_template":"\u003cstring>","name":"\u003cstring>","title":"\u003cstring>","description":"\u003cstring>","mime_type":"\u003cstring>","annotations":{"audience":["\u003cstring>"],"last_modified":"\u003cstring>","priority":123},"icons":[{"src":"\u003cstring>","mime_type":"\u003cstring>","sizes":["\u003cstring>"],"theme":"\u003cstring>"}],"meta":{},"selection_id":"\u003cstring>"}],"resources_status":"MCP_DISCOVERY_STATUS_SYNCED","resource_templates_status":"MCP_DISCOVERY_STATUS_SYNCED"}}}}},"exampleType":"generated"}},"exampleType":"generated"},"e7ab5246-9824-4f06-a203-98acecaf09b2":{"description":"Authentication required. See https://docs.orq.ai/reference/errors for the error codes.","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"description":"Human-readable error message.","type":"string","isRequired":true,"uniqueKey":"message","typeLabel":"string"},"code":{"type":"integer","description":"Numeric error code, when one is available.","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":{"373453b5-0382-45f3-955e-deddc3bea0f3":{"ApiKey":{"type":"http","scheme":"bearer","bearerFormat":"JWT","scopes":[],"schemeName":"ApiKey"}}},"servers":{"5eea2133-7793-4625-8037-fe5f8884a07f":{"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":"Sync an MCP server - Orq.ai Documentation","contextualStarterQuestions":[{"_id":"6af1c70c2db34fb576ada4ed","deploymentId":"68c9bcd7a1b07562da8b036b","questionText":"How do I sync an MCP server?","status":"active","generatedBy":"contextual","path":"reference/mcp-gateway/sync-an-mcp-server","createdAt":"2026-11-09T13:13:48.612Z","updatedAt":"2026-11-09T13:13:48.612Z","__v":0},{"_id":"6af1c70c2db34fb576ada4ee","deploymentId":"68c9bcd7a1b07562da8b036b","questionText":"What catalogs are discovered?","status":"active","generatedBy":"contextual","path":"reference/mcp-gateway/sync-an-mcp-server","createdAt":"2026-11-09T13:13:48.612Z","updatedAt":"2026-11-09T13:13:48.612Z","__v":0},{"_id":"6af1c70c2db34fb576ada4ef","deploymentId":"68c9bcd7a1b07562da8b036b","questionText":"How do credentials work in sync?","status":"active","generatedBy":"contextual","path":"reference/mcp-gateway/sync-an-mcp-server","createdAt":"2026-11-09T13:13:48.612Z","updatedAt":"2026-11-09T13:13:48.612Z","__v":0}],"navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-11-09T13:13:43.047Z","originalFileLocation":"reference/mcp-gateway/sync-an-mcp-server.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=\"Syncs the upstream catalogs and returns discovery outcomes. Resource catalogs and capabilities discovered with user-specific credentials or discovery variables are returned only to the caller.\">\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=\"Sync an MCP server - Orq.ai Documentation\">\u003cmeta data-mint-head property=\"og:description\" content=\"Syncs the upstream catalogs and returns discovery outcomes. Resource catalogs and capabilities discovered with user-specific credentials or discovery variables are returned only to the caller.\">\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/mcp-gateway/sync-an-mcp-server\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://orqai.mintlify.site/_mintlify/api/og/v2?division=MCP+Servers\u0026amp;title=Sync+an+MCP+server\u0026amp;description=Syncs+the+upstream+catalogs+and+returns+discovery+outcomes.+Resource+catalogs+and+capabilities+discovered+with+user-specific+credentials+or+discovery+variables+\u0026amp;theme=3624f44f3669d4325dc81433\u0026amp;signature=0182788d55dd5a3a61a28d700f66d6d5895af2d88089b074bbeaddcfb8c6556f\">\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=\"Sync an MCP server - Orq.ai Documentation\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Syncs the upstream catalogs and returns discovery outcomes. Resource catalogs and capabilities discovered with user-specific credentials or discovery variables are returned only to the caller.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://orqai.mintlify.site/_mintlify/api/og/v2?division=MCP+Servers\u0026amp;title=Sync+an+MCP+server\u0026amp;description=Syncs+the+upstream+catalogs+and+returns+discovery+outcomes.+Resource+catalogs+and+capabilities+discovered+with+user-specific+credentials+or+discovery+variables+\u0026amp;theme=3624f44f3669d4325dc81433\u0026amp;signature=0182788d55dd5a3a61a28d700f66d6d5895af2d88089b074bbeaddcfb8c6556f\">\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/mcp-gateway/sync-an-mcp-server\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/mcp-gateway/sync-an-mcp-server.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/mcp-gateway/sync-an-mcp-server#webpage\",\"url\":\"https://docs.orq.ai/reference/mcp-gateway/sync-an-mcp-server\",\"name\":\"Sync an MCP server\",\"description\":\"Syncs the upstream catalogs and returns discovery outcomes. Resource catalogs and capabilities discovered with user-specific credentials or discovery variables are returned only to the caller.\",\"dateModified\":\"2026-11-09T13:13:43.047Z\",\"isPartOf\":{\"@id\":\"https://docs.orq.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.orq.ai/reference/mcp-gateway/sync-an-mcp-server#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.orq.ai/reference/mcp-gateway/sync-an-mcp-server#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Platform APIs\",\"item\":\"https://docs.orq.ai/reference/agent-feedback/submit-feedback\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"MCP Servers\",\"item\":\"https://docs.orq.ai/reference/mcp-gateway/list-mcp-servers\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Sync an MCP server\",\"item\":\"https://docs.orq.ai/reference/mcp-gateway/sync-an-mcp-server\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.orq.ai/reference/mcp-gateway/sync-an-mcp-server#apireference\",\"headline\":\"Sync an MCP server\",\"name\":\"Sync an MCP server\",\"description\":\"Syncs the upstream catalogs and returns discovery outcomes. Resource catalogs and capabilities discovered with user-specific credentials or discovery variables are returned only to the caller.\",\"url\":\"https://docs.orq.ai/reference/mcp-gateway/sync-an-mcp-server\",\"mainEntityOfPage\":{\"@id\":\"https://docs.orq.ai/reference/mcp-gateway/sync-an-mcp-server#webpage\"},\"dateModified\":\"2026-11-09T13:13:43.047Z\",\"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":"Experiments SDK Reference","href":"/reference/sdk/experiments"},{"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":"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":"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":"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}","deprecated":true,"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":"Batches","pages":[{"openapi":"post /v3/router/batches","title":"Create batch","href":"/reference/batches/create-batch"},{"openapi":"get /v3/router/batches","title":"List batches","href":"/reference/batches/list-batches"},{"openapi":"get /v3/router/batches/{batch_id}","title":"Retrieve batch","href":"/reference/batches/retrieve-batch"},{"openapi":"get /v3/router/batches/{batch_id}/results","title":"Download batch results","href":"/reference/batches/download-batch-results"},{"openapi":"post /v3/router/batches/{batch_id}/cancel","title":"Cancel batch","href":"/reference/batches/cancel-batch"}]},{"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":"Experiments","pages":[{"openapi":"get /v3/experiments","title":"List experiments","href":"/reference/experiments/list-experiments"},{"openapi":"post /v3/experiments","title":"Create an experiment","href":"/reference/experiments/create-an-experiment"},{"openapi":"get /v3/experiments/{experiment_id}","title":"Get an experiment","href":"/reference/experiments/get-an-experiment"},{"openapi":"patch /v3/experiments/{experiment_id}","title":"Update an experiment","href":"/reference/experiments/update-an-experiment"},{"openapi":"delete /v3/experiments/{experiment_id}","title":"Delete an experiment","href":"/reference/experiments/delete-an-experiment"},{"group":"Runs","pages":[{"openapi":"get /v3/experiments/{experiment_id}/runs","title":"List runs","href":"/reference/experiments/list-runs"},{"openapi":"post /v3/experiments/{experiment_id}/runs","title":"Create a run","href":"/reference/experiments/create-a-run"},{"openapi":"get /v3/experiments/{experiment_id}/runs/{run_id}","title":"Get a run","href":"/reference/experiments/get-a-run"},{"openapi":"patch /v3/experiments/{experiment_id}/runs/{run_id}","title":"Update a run","href":"/reference/experiments/update-a-run"},{"openapi":"delete /v3/experiments/{experiment_id}/runs/{run_id}","title":"Delete a run","href":"/reference/experiments/delete-a-run"},{"openapi":"post /v3/experiments/{experiment_id}/runs/{run_id}/execute","title":"Execute a run","href":"/reference/experiments/execute-a-run"},{"openapi":"post /v3/experiments/{experiment_id}/runs/{run_id}/cancel","title":"Cancel a run","href":"/reference/experiments/cancel-a-run"},{"openapi":"post /v3/experiments/{experiment_id}/runs/{run_id}/query","title":"Query run cells","href":"/reference/experiments/query-run-cells"},{"openapi":"get /v3/experiments/{experiment_id}/runs/{run_id}/export","title":"Export a run","href":"/reference/experiments/export-a-run"},{"openapi":"get /v3/experiments/{experiment_id}/runs/{run_id}/metrics","title":"Get run metrics","href":"/reference/experiments/get-run-metrics"}]},{"group":"Columns","pages":[{"openapi":"get /v3/experiments/{experiment_id}/runs/{run_id}/tasks","title":"List task columns","href":"/reference/experiments/list-task-columns"},{"openapi":"post /v3/experiments/{experiment_id}/runs/{run_id}/tasks","title":"Add a task column","href":"/reference/experiments/add-a-task-column"},{"openapi":"patch /v3/experiments/{experiment_id}/runs/{run_id}/tasks/{task_id}","title":"Update a task column","href":"/reference/experiments/update-a-task-column"},{"openapi":"delete /v3/experiments/{experiment_id}/runs/{run_id}/tasks/{task_id}","title":"Delete a task column","href":"/reference/experiments/delete-a-task-column"},{"openapi":"get /v3/experiments/{experiment_id}/runs/{run_id}/evaluators","title":"List eval columns","href":"/reference/experiments/list-eval-columns"},{"openapi":"post /v3/experiments/{experiment_id}/runs/{run_id}/evaluators","title":"Add an eval column","href":"/reference/experiments/add-an-eval-column"},{"openapi":"delete /v3/experiments/{experiment_id}/runs/{run_id}/evaluators/{eval_id}","title":"Remove an eval column","href":"/reference/experiments/remove-an-eval-column"},{"openapi":"get /v3/experiments/{experiment_id}/runs/{run_id}/reviews","title":"List human review columns","href":"/reference/experiments/list-human-review-columns"},{"openapi":"post /v3/experiments/{experiment_id}/runs/{run_id}/reviews","title":"Add a human review column","href":"/reference/experiments/add-a-human-review-column"},{"openapi":"patch /v3/experiments/{experiment_id}/runs/{run_id}/reviews/{review_id}","title":"Update review column metadata","href":"/reference/experiments/update-review-column-metadata"},{"openapi":"delete /v3/experiments/{experiment_id}/runs/{run_id}/reviews/{review_id}","title":"Remove a human review column","href":"/reference/experiments/remove-a-human-review-column"},{"openapi":"patch /v3/experiments/{experiment_id}/runs/{run_id}/columns/layout","title":"Update column layout","href":"/reference/experiments/update-column-layout"}]},{"group":"Rows","pages":[{"openapi":"post /v3/experiments/{experiment_id}/runs/{run_id}/rows/{row_id}/duplicate","title":"Duplicate a row","href":"/reference/experiments/duplicate-a-row"},{"openapi":"post /v3/experiments/{experiment_id}/runs/{run_id}/rows/bulk-delete","title":"Delete rows","href":"/reference/experiments/delete-rows"}]}]},{"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":"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","description":"Updates mutable fields of an existing MCP server. Omitted optional fields keep their current values.","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","description":"Executes a single tool on an upstream MCP server for testing. Connects to the server, invokes the tool with the provided arguments, and returns the result.","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":"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","deprecated":true,"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"},{"openapi":"post /v1/responses/compact","title":"Compact response","href":"/reference/responses/compact-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":"Model Fusions","pages":[{"title":"List Model Fusions","openapi":"get /v3/model-fusions","href":"/reference/model-fusions/list-model-fusions"},{"title":"Create a Model Fusion","openapi":"post /v3/model-fusions","href":"/reference/model-fusions/create-model-fusion"},{"title":"Retrieve a Model Fusion","openapi":"get /v3/model-fusions/{model_fusion_id}","href":"/reference/model-fusions/retrieve-model-fusion"},{"title":"Update a Model Fusion","openapi":"put /v3/model-fusions/{model_fusion_id}","href":"/reference/model-fusions/update-model-fusion"},{"title":"Delete a Model Fusion","openapi":"delete /v3/model-fusions/{model_fusion_id}","href":"/reference/model-fusions/delete-model-fusion"},{"title":"Enable or disable a Model Fusion","openapi":"post /v3/model-fusions/{model_fusion_id}/enabled","href":"/reference/model-fusions/set-model-fusion-enabled"}]},{"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","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","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-18"}]}]},"basePath":"","title":"Sync an MCP server - Orq.ai Documentation","buildId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","deploymentId":"dpl_42LwxxU1kGN114H4XzwGYXa9ZDah","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C-hEh3I2.js","utils-CnF4QiUD.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-C7PVNbel.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-8ytevL2A.js","snippetPresets-BT1alx3v.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BLXC0i_W.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CyLIGI9_.js","shallow-DC0lGVIW.js","getApiPlaygroundDisplay-CgDQ85tN.js","CodeSnippet-6-I-Gpv9.js","CodeSnippets-BAk1kDdu.js","Page-C945cI-W.js","getPastedJson-B276RuWN.js","icon-BqP8etTm.js","MethodPill-DM6sbxG1.js","DuplicateIcon-PyJglOaE.js","createIcon-CMeOMAc_.js","DynamicMarkdown-BoyYAA8K.js","SectionHeading-DAYv3gvZ.js","axios-vUo_bRtp.js","Markdown-BhTTmazV.js","clsx-CR-RHrVC.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CBUH0-zX.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-BmARFYNC.js"]}