{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Runtools.ai","colors":{"primary":"#0f172a","light":"#f8fafc","dark":"#020617"},"logo":{"light":"https://mintcdn.com/runtools/w_g7vQbhuzfUXBfI/icon-main.png?fit=max\u0026auto=format\u0026n=w_g7vQbhuzfUXBfI\u0026q=85\u0026s=21a9915bb615a6efa8321adfdef521a9","dark":"https://mintcdn.com/runtools/w_g7vQbhuzfUXBfI/icon-white.png?fit=max\u0026auto=format\u0026n=w_g7vQbhuzfUXBfI\u0026q=85\u0026s=98ac80700d2a5c1af6778a43c7c9f588"},"favicon":"https://mintcdn.com/runtools/w_g7vQbhuzfUXBfI/icon-main.png?fit=max\u0026auto=format\u0026n=w_g7vQbhuzfUXBfI\u0026q=85\u0026s=21a9915bb615a6efa8321adfdef521a9","api":{},"background":{"color":{"light":"#f1f5f9","dark":"#000000"}},"search":{"prompt":"Search Runtools docs..."},"seo":{},"contextual":{"options":["copy","view","chatgpt","claude","perplexity","mcp","cursor","vscode"],"display":"header"},"styling":{"latex":false},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"runtools","hasAudioNarration":false,"actualSubdomain":"runtools","customDomains":["docs.runtools.ai"],"gitSource":{"type":"github","owner":"runtools-ai","repo":"runtools.ai","deployBranch":"master","contentDirectory":"docs","isPrivate":true,"mountPath":"","label":""},"entitlements":{},"buildId":"6ae947abd388ef32a6c56925:success","clientVersion":"0.0.4102","searchFilterCounts":[{"language":"default","tag":"API Reference","count":221},{"language":"default","tag":"Documentation","count":25},{"language":"default","tag":"Sandboxes","count":20},{"language":"default","tag":"Projects","count":13},{"language":"default","tag":"RunMesh","count":12},{"language":"default","tag":"SDK","count":12},{"language":"default","tag":"TypeScript SDK","count":12},{"language":"default","tag":"Workspace files","count":12},{"language":"default","tag":"Agents","count":11},{"language":"default","tag":"Advanced","count":10}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true},"basePath":"","hasChatPermissions":false,"hasWebMcpPermissions":false,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-rbac-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"rbac-expansion","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"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":[],"page":{"pagePath":"api-reference/channels/connect-an-agent-channel","slug":"/api-reference/channels/connect-an-agent-channel","pageMetadata":{"title":"Connect an agent channel","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/agent-channels","href":"/api-reference/channels/connect-an-agent-channel","autogeneratedByOpenApi":true},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Connect an agent channel","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/agent-channels","href":"/api-reference/channels/connect-an-agent-channel","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"tags":["Channels"],"summary":"Connect an agent channel","operationId":"createAgentChannel","requestBody":"335568ef-9ece-48d8-bca5-79e98b57c314","responses":{"201":"234c0cfa-bab3-42d4-ada3-4df4e7ca1989"},"method":"post","type":"path","servers":["b52c1363-5673-41aa-956d-7b042da5d713","994bc159-9700-426f-9876-b8d0fc7a8439","ec1d2397-cfda-4103-a22c-749e92185cb0","a402b849-92c4-4ad0-b9f2-cf9af86bc4db","28191e3e-6158-4a1b-8683-eeb1115f7f52"],"security":["805f79c0-8b62-4cb2-904f-d78f7a5674c6","3c14c0a4-a39f-40b7-b925-78e7b25052df"],"path":"/v1/agent-channels","baseUrlOptions":["https://api.runtools.ai","https://auth.runtools.ai","https://tools.runtools.ai","https://billing.runtools.ai","https://storage.runtools.ai"],"title":"Connect an agent channel","description":"","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","required":["agent","provider","mode","botTokenSecretName"],"properties":{"agent":{"type":"string","isRequired":true,"uniqueKey":"agent","typeLabel":"string"},"provider":{"type":"string","enum":["telegram"],"isRequired":true,"uniqueKey":"provider","typeLabel":"enum\u003cstring>"},"mode":{"type":"string","enum":["byok"],"isRequired":true,"uniqueKey":"mode","typeLabel":"enum\u003cstring>"},"botTokenSecretName":{"type":"string","isRequired":true,"uniqueKey":"botTokenSecretName","typeLabel":"string"},"autoReply":{"type":"boolean","uniqueKey":"autoReply","typeLabel":"boolean"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"agent":"\u003cstring>","provider":"telegram","mode":"byok","botTokenSecretName":"\u003cstring>","autoReply":true}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"234c0cfa-bab3-42d4-ada3-4df4e7ca1989":{"description":"Channel created.","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"object","properties":{"channel":{"type":"object","properties":{"id":{"type":"string","format":"uuid","uniqueKey":"data.channel.id","typeLabel":"string\u003cuuid>"},"agentId":{"type":"string","format":"uuid","uniqueKey":"data.channel.agentId","typeLabel":"string\u003cuuid>"},"agentSlug":{"oneOf":[{"type":"string","uniqueKey":"data.channel.agentSlug.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.channel.agentSlug.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.channel.agentSlug","typeLabel":"string | null"},"agentName":{"oneOf":[{"type":"string","uniqueKey":"data.channel.agentName.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.channel.agentName.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.channel.agentName","typeLabel":"string | null"},"provider":{"type":"string","example":"telegram","uniqueKey":"data.channel.provider","typeLabel":"string"},"mode":{"type":"string","enum":["managed","byok"],"uniqueKey":"data.channel.mode","typeLabel":"enum\u003cstring>"},"status":{"type":"string","enum":["pending_setup","connected","disabled","error"],"uniqueKey":"data.channel.status","typeLabel":"enum\u003cstring>"},"credentialRef":{"oneOf":[{"type":"string","uniqueKey":"data.channel.credentialRef.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.channel.credentialRef.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.channel.credentialRef","typeLabel":"string | null"},"externalAccountId":{"oneOf":[{"type":"string","uniqueKey":"data.channel.externalAccountId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.channel.externalAccountId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.channel.externalAccountId","typeLabel":"string | null"},"externalSenderId":{"oneOf":[{"type":"string","uniqueKey":"data.channel.externalSenderId.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.channel.externalSenderId.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.channel.externalSenderId","typeLabel":"string | null"},"webhookUrl":{"oneOf":[{"type":"string","uniqueKey":"data.channel.webhookUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.channel.webhookUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.channel.webhookUrl","typeLabel":"string | null"},"config":{"type":"object","properties":{"botUsername":{"oneOf":[{"type":"string","uniqueKey":"data.channel.config.botUsername.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.channel.config.botUsername.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.channel.config.botUsername","typeLabel":"string | null"},"autoReply":{"type":"boolean","uniqueKey":"data.channel.config.autoReply","typeLabel":"boolean"},"deepLinkUrl":{"oneOf":[{"type":"string","uniqueKey":"data.channel.config.deepLinkUrl.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.channel.config.deepLinkUrl.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.channel.config.deepLinkUrl","typeLabel":"string | null"},"privacy":{"type":"object","properties":{"mode":{"type":"string","enum":["approved_only","public","disabled"],"isRequired":true,"uniqueKey":"data.channel.config.privacy.mode","typeLabel":"enum\u003cstring>"},"allowPrivateChats":{"type":"boolean","isRequired":true,"uniqueKey":"data.channel.config.privacy.allowPrivateChats","typeLabel":"boolean"},"allowGroups":{"type":"boolean","isRequired":true,"uniqueKey":"data.channel.config.privacy.allowGroups","typeLabel":"boolean"},"unauthorizedReply":{"type":"string","enum":["silent","message"],"isRequired":true,"uniqueKey":"data.channel.config.privacy.unauthorizedReply","typeLabel":"enum\u003cstring>"}},"required":["mode","allowPrivateChats","allowGroups","unauthorizedReply"],"uniqueKey":"data.channel.config.privacy","typeLabel":"object"}},"uniqueKey":"data.channel.config","typeLabel":"object"},"lastError":{"oneOf":[{"type":"string","uniqueKey":"data.channel.lastError.oneOf.0","typeLabel":"string"},{"type":"null","uniqueKey":"data.channel.lastError.oneOf.1","typeLabel":"null"}],"uniqueKey":"data.channel.lastError","typeLabel":"string | null"},"createdAt":{"type":"string","format":"date-time","uniqueKey":"data.channel.createdAt","typeLabel":"string\u003cdate-time>"},"updatedAt":{"type":"string","format":"date-time","uniqueKey":"data.channel.updatedAt","typeLabel":"string\u003cdate-time>"}},"uniqueKey":"data.channel","typeLabel":"object"}},"uniqueKey":"data","typeLabel":"object"}},"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"data":{"channel":{"id":"3c90c3cc-0d44-4b50-8888-8dd25736052a","agentId":"3c90c3cc-0d44-4b50-8888-8dd25736052a","agentSlug":"\u003cstring>","agentName":"\u003cstring>","provider":"telegram","mode":"managed","status":"pending_setup","credentialRef":"\u003cstring>","externalAccountId":"\u003cstring>","externalSenderId":"\u003cstring>","webhookUrl":"\u003cstring>","config":{"botUsername":"\u003cstring>","autoReply":true,"deepLinkUrl":"\u003cstring>","privacy":{"mode":"approved_only","allowPrivateChats":true,"allowGroups":true,"unauthorizedReply":"silent"}},"lastError":"\u003cstring>","createdAt":"2023-11-07T05:31:56Z","updatedAt":"2023-11-07T05:31:56Z"}}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"805f79c0-8b62-4cb2-904f-d78f7a5674c6":{"bearer":{"type":"http","scheme":"bearer","description":"WorkOS session token or RunTools API key (`rt_live_*` / `rt_test_*`).\nUsed in `Authorization: Bearer \u003ctoken>` header.\n","scopes":[]}},"3c14c0a4-a39f-40b7-b925-78e7b25052df":{"apiKey":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Alternative location for a RunTools API key (`rt_live_*` / `rt_test_*`).","scopes":[]}}},"servers":{"b52c1363-5673-41aa-956d-7b042da5d713":{"url":"https://api.runtools.ai","description":"Orchestrator (control plane)"},"994bc159-9700-426f-9876-b8d0fc7a8439":{"url":"https://auth.runtools.ai","description":"Auth service"},"ec1d2397-cfda-4103-a22c-749e92185cb0":{"url":"https://tools.runtools.ai","description":"Tools service"},"a402b849-92c4-4ad0-b9f2-cf9af86bc4db":{"url":"https://billing.runtools.ai","description":"Billing service"},"28191e3e-6158-4a1b-8683-eeb1115f7f52":{"url":"https://storage.runtools.ai","description":"Storage service (workspace files)"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"WorkOS session token or RunTools API key (`rt_live_*` / `rt_test_*`).\nUsed in `Authorization: Bearer \u003ctoken>` header.\n","scopes":[]},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"WorkOS session token or RunTools API key (`rt_live_*` / `rt_test_*`).\nUsed in `Authorization: Bearer \u003ctoken>` header.\n","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearer","name":"Authorization"}],"title":"bearer"},{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"X-API-Key","description":"Alternative location for a RunTools API key (`rt_live_*` / `rt_test_*`).","scopes":[]},"schema":{"title":"X-API-Key","type":"string","description":"Alternative location for a RunTools API key (`rt_live_*` / `rt_test_*`).","isRequired":true,"typeLabel":"string","deprecated":false},"schemeName":"apiKey","name":"X-API-Key"}],"title":"apiKey"}]},"originalFileLocation":"api-reference/openapi.yaml"},"subdomain":"runtools","siteName":"Runtools.ai","title":"Connect an agent channel - Runtools.ai","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-07-24T20:19:50.865Z","originalFileLocation":"api-reference/channels/connect-an-agent-channel.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=\"application-name\" content=\"Runtools.ai\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/runtools/6hOqBMG5K3M7qmua/_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/runtools/6hOqBMG5K3M7qmua/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/runtools/6hOqBMG5K3M7qmua/_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/runtools/6hOqBMG5K3M7qmua/_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/runtools/6hOqBMG5K3M7qmua/_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/runtools/6hOqBMG5K3M7qmua/_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/runtools/6hOqBMG5K3M7qmua/_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/runtools/6hOqBMG5K3M7qmua/_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/runtools/6hOqBMG5K3M7qmua/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Connect an agent channel - Runtools.ai\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Runtools.ai\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.runtools.ai/api-reference/channels/connect-an-agent-channel\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://runtools.mintlify.site/_mintlify/api/og/v2?division=Channels\u0026amp;title=Connect+an+agent+channel\u0026amp;theme=22347206e190c2fc55a9fc84\u0026amp;signature=337ebc8a0fce90ef4bdb0d2c868d007fae5babf31a32fb234097b70142b89ca3\">\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=\"Connect an agent channel - Runtools.ai\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://runtools.mintlify.site/_mintlify/api/og/v2?division=Channels\u0026amp;title=Connect+an+agent+channel\u0026amp;theme=22347206e190c2fc55a9fc84\u0026amp;signature=337ebc8a0fce90ef4bdb0d2c868d007fae5babf31a32fb234097b70142b89ca3\">\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/runtools/6hOqBMG5K3M7qmua/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Runtools.ai\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0f172a\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.runtools.ai/api-reference/channels/connect-an-agent-channel\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/channels/connect-an-agent-channel.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.runtools.ai/#organization\",\"name\":\"Runtools.ai\",\"url\":\"https://docs.runtools.ai\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/runtools/w_g7vQbhuzfUXBfI/icon-main.png?fit=max\u0026auto=format\u0026n=w_g7vQbhuzfUXBfI\u0026q=85\u0026s=21a9915bb615a6efa8321adfdef521a9\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.runtools.ai#website\",\"name\":\"Runtools.ai\",\"url\":\"https://docs.runtools.ai\",\"publisher\":{\"@id\":\"https://docs.runtools.ai/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.runtools.ai/api-reference/channels/connect-an-agent-channel#webpage\",\"url\":\"https://docs.runtools.ai/api-reference/channels/connect-an-agent-channel\",\"name\":\"Connect an agent channel\",\"dateModified\":\"2026-07-24T20:19:50.865Z\",\"isPartOf\":{\"@id\":\"https://docs.runtools.ai#website\"},\"breadcrumb\":{\"@id\":\"https://docs.runtools.ai/api-reference/channels/connect-an-agent-channel#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.runtools.ai/api-reference/channels/connect-an-agent-channel#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Channels\",\"item\":\"https://docs.runtools.ai/api-reference/channels/list-agent-channels\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Connect an agent channel\",\"item\":\"https://docs.runtools.ai/api-reference/channels/connect-an-agent-channel\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.runtools.ai/api-reference/channels/connect-an-agent-channel#apireference\",\"headline\":\"Connect an agent channel\",\"name\":\"Connect an agent channel\",\"url\":\"https://docs.runtools.ai/api-reference/channels/connect-an-agent-channel\",\"mainEntityOfPage\":{\"@id\":\"https://docs.runtools.ai/api-reference/channels/connect-an-agent-channel#webpage\"},\"dateModified\":\"2026-07-24T20:19:50.865Z\",\"publisher\":{\"@id\":\"https://docs.runtools.ai/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.runtools.ai#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Runtools.ai\",\"publisher\":{\"@type\":\"Organization\",\"name\":\"Runtools.ai\"},\"provider\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","agentPointerHref":"/api-reference/channels/connect-an-agent-channel.md","siteName":"Runtools.ai","nav":{"global":null,"tabs":[{"tab":"Documentation","icon":"book-open","pages":[{"title":"Documentation","href":"/introduction"}]},{"tab":"API Reference","icon":"terminal","groups":[{"group":"Overview","icon":"book-open","pages":[{"title":"API Overview","icon":"book","href":"/api-reference/overview"},{"title":"Authentication","icon":"key","href":"/api-reference/authentication"},{"title":"Billing","api":"GET /v1/billing/my-usage","icon":"credit-card","href":"/api-reference/billing"},{"title":"Activity","api":"GET /v1/activity","icon":"clock-rotate-left","href":"/api-reference/activity"},{"title":"Models","api":"GET /v1/models/available","icon":"brain","href":"/api-reference/models"}]},{"group":"Agents","icon":"robot","pages":[{"title":"Create Agent","api":"POST /v1/agents","icon":"robot","href":"/api-reference/agents/create-runtime"},{"title":"Deployments","icon":"box","href":"/api-reference/agents/create-deployment"},{"title":"Run Agent","api":"POST /v1/run","icon":"play","href":"/api-reference/agents/run"},{"title":"Stream Runs \u0026 Threads","api":"POST /v1/run","icon":"radio","href":"/api-reference/agents/stream"},{"title":"Threads","api":"GET /v1/threads","icon":"book-open","href":"/api-reference/threads"}]},{"group":"Sandboxes","icon":"server","pages":[{"title":"List Sandboxes","api":"GET /v1/sandboxes","icon":"list","href":"/api-reference/sandboxes/list"},{"title":"Create Sandbox","api":"POST /v1/sandboxes","icon":"square-plus","href":"/api-reference/sandboxes/create"},{"title":"Get Sandbox","api":"GET /v1/sandboxes/{id}","icon":"server","href":"/api-reference/sandboxes/get"},{"title":"Execute Command","api":"POST /v1/sandboxes/{id}/exec","icon":"terminal","href":"/api-reference/sandboxes/exec"},{"title":"Pause Sandbox","api":"POST /v1/sandboxes/{id}/pause","icon":"pause","href":"/api-reference/sandboxes/pause"},{"title":"Resume Sandbox","api":"POST /v1/sandboxes/{id}/resume","icon":"play","href":"/api-reference/sandboxes/resume"},{"title":"Delete Sandbox","api":"DELETE /v1/sandboxes/{id}","icon":"trash","href":"/api-reference/sandboxes/delete"}]},{"group":"Tools","icon":"wrench","pages":[{"title":"Search Tool Hub","api":"GET /v1/marketplace/search","icon":"search","href":"/api-reference/tools/search"},{"title":"List Tools","api":"GET /v1/tools","icon":"list","href":"/api-reference/tools/list"},{"title":"Install Tool","api":"POST /v1/tools/{slug}/install","icon":"download","href":"/api-reference/tools/install"},{"title":"Execute Tool","api":"POST /v1/tools/{slug}/execute","icon":"play","href":"/api-reference/tools/execute"}]},{"group":"Channels","icon":"signal-bars","pages":[{"title":"Channels","api":"GET /v1/agent-channels","icon":"signal-bars","href":"/api-reference/channels"}]},{"group":"Workspaces","icon":"folder-tree","pages":[{"title":"Manage Workspaces","api":"GET /v1/workspaces","icon":"folder-tree","href":"/api-reference/workspaces/manage"},{"title":"Workspace Files","api":"GET /v1/workspaces/{id}/files","icon":"folder-open","href":"/api-reference/workspaces/files"}]},{"group":"RunMesh","icon":"server","pages":[{"title":"RunMesh","api":"GET /v1/runmesh/nodes","icon":"server","href":"/api-reference/runmesh"}]},{"group":"Channels","pages":[{"title":"List agent channels","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/agent-channels","href":"/api-reference/channels/list-agent-channels"},{"title":"Connect an agent channel","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/agent-channels","href":"/api-reference/channels/connect-an-agent-channel"},{"title":"Register a channel webhook","description":null,"deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/agent-channels/{channelId}/register-webhook","href":"/api-reference/channels/register-a-channel-webhook"},{"title":"Get channel privacy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/agent-channels/{channelId}/privacy","href":"/api-reference/channels/get-channel-privacy"},{"title":"Update channel privacy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v1/agent-channels/{channelId}/privacy","href":"/api-reference/channels/update-channel-privacy"},{"title":"Approve a channel access request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/agent-channels/{channelId}/privacy/requests/{requestId}/approve","href":"/api-reference/channels/approve-a-channel-access-request"},{"title":"Deny a channel access request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/agent-channels/{channelId}/privacy/requests/{requestId}/deny","href":"/api-reference/channels/deny-a-channel-access-request"},{"title":"Approve a known channel conversation","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/agent-channels/{channelId}/privacy/grants","href":"/api-reference/channels/approve-a-known-channel-conversation"},{"title":"Revoke channel access","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/agent-channels/{channelId}/privacy/grants/{grantId}","href":"/api-reference/channels/revoke-channel-access"}]},{"group":"Health","pages":[{"title":"Service liveness probe","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /health","href":"/api-reference/health/service-liveness-probe"},{"title":"Service readiness (DB connectivity)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /ready","href":"/api-reference/health/service-readiness-db-connectivity"}]},{"group":"Profile","pages":[{"title":"Get current user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/me","href":"/api-reference/profile/get-current-user"},{"title":"Update current user","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v1/me","href":"/api-reference/profile/update-current-user"}]},{"group":"Organizations","pages":[{"title":"List user's organizations","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/organizations","href":"/api-reference/organizations/list-users-organizations"},{"title":"Create a new organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/organizations","href":"/api-reference/organizations/create-a-new-organization"},{"title":"Get the active organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/organizations/current","href":"/api-reference/organizations/get-the-active-organization"},{"title":"Get tool install policy","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/organizations/current/tool-policy","href":"/api-reference/organizations/get-tool-install-policy"},{"title":"Update tool install policy (admin only)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v1/organizations/current/tool-policy","href":"/api-reference/organizations/update-tool-install-policy-admin-only"},{"title":"Get an organization","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/organizations/{id}","href":"/api-reference/organizations/get-an-organization"},{"title":"Update organization name/settings (admin only)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v1/organizations/{id}","href":"/api-reference/organizations/update-organization-namesettings-admin-only"},{"title":"List org members","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/organizations/{id}/members","href":"/api-reference/organizations/list-org-members"}]},{"group":"Projects","pages":[{"title":"List org projects","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/projects","href":"/api-reference/projects/list-org-projects"},{"title":"Create a project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/projects","href":"/api-reference/projects/create-a-project"},{"title":"Get a project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/projects/{id}","href":"/api-reference/projects/get-a-project"},{"title":"Delete a project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/projects/{id}","href":"/api-reference/projects/delete-a-project"},{"title":"Rename or update a project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v1/projects/{id}","href":"/api-reference/projects/rename-or-update-a-project"},{"title":"List pinned agents for a project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/projects/{id}/agent-pins","href":"/api-reference/projects/list-pinned-agents-for-a-project"},{"title":"Replace pinned agents","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/projects/{id}/agent-pins","href":"/api-reference/projects/replace-pinned-agents"},{"title":"List pinned sandboxes for a project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/projects/{id}/sandbox-pins","href":"/api-reference/projects/list-pinned-sandboxes-for-a-project"},{"title":"Replace pinned sandboxes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/projects/{id}/sandbox-pins","href":"/api-reference/projects/replace-pinned-sandboxes"},{"title":"List pinned workflows for a project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/projects/{id}/workflow-pins","href":"/api-reference/projects/list-pinned-workflows-for-a-project"},{"title":"Replace pinned workflows","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/projects/{id}/workflow-pins","href":"/api-reference/projects/replace-pinned-workflows"},{"title":"List all mixed pinned resources for a project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/projects/{id}/resource-pins","href":"/api-reference/projects/list-all-mixed-pinned-resources-for-a-project"},{"title":"Replace mixed pinned resources","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/projects/{id}/resource-pins","href":"/api-reference/projects/replace-mixed-pinned-resources"}]},{"group":"Sandboxes","pages":[{"title":"List sandboxes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/sandboxes","href":"/api-reference/sandboxes/list-sandboxes"},{"title":"Create a sandbox","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/sandboxes","href":"/api-reference/sandboxes/create-a-sandbox"},{"title":"Get a sandbox","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/sandboxes/{id}","href":"/api-reference/sandboxes/get-a-sandbox"},{"title":"Delete a sandbox","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/sandboxes/{id}","href":"/api-reference/sandboxes/delete-a-sandbox"},{"title":"Update sandbox metadata","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v1/sandboxes/{id}","href":"/api-reference/sandboxes/update-sandbox-metadata"},{"title":"Live sandbox stats","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/sandboxes/{id}/stats","href":"/api-reference/sandboxes/live-sandbox-stats"},{"title":"Execute a command in a sandbox","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/sandboxes/{id}/exec","href":"/api-reference/sandboxes/execute-a-command-in-a-sandbox"},{"title":"Mint a capability dev URL","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/sandboxes/{id}/url","href":"/api-reference/sandboxes/mint-a-capability-dev-url"},{"title":"Pause a sandbox","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/sandboxes/{id}/pause","href":"/api-reference/sandboxes/pause-a-sandbox"},{"title":"Resume a paused sandbox","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/sandboxes/{id}/resume","href":"/api-reference/sandboxes/resume-a-paused-sandbox"},{"title":"Get SSH connection info","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/sandboxes/{id}/ssh","href":"/api-reference/sandboxes/get-ssh-connection-info"},{"title":"Get VNC connection info (desktop sandboxes)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/sandboxes/{id}/vnc","href":"/api-reference/sandboxes/get-vnc-connection-info-desktop-sandboxes"},{"title":"Get sandbox logs (tail)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/sandboxes/{id}/logs","href":"/api-reference/sandboxes/get-sandbox-logs-tail"}]},{"group":"Activity","pages":[{"title":"Sandbox activity events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/sandboxes/{id}/activity","href":"/api-reference/activity/sandbox-activity-events"},{"title":"Activity events scoped to a thread","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/threads/{threadId}/activity","href":"/api-reference/activity/activity-events-scoped-to-a-thread"},{"title":"Activity scoped to an install","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/installable-agents/installs/{installId}/activity","href":"/api-reference/activity/activity-scoped-to-an-install"},{"title":"Workspace activity events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/workspaces/{id}/activity","href":"/api-reference/activity/workspace-activity-events"},{"title":"Activity for a RunMesh device","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/runmesh/devices/{id}/activity","href":"/api-reference/activity/activity-for-a-runmesh-device"},{"title":"List customer activity events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/activity","href":"/api-reference/activity/list-customer-activity-events"},{"title":"Activity scoped to a tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tools/{slug}/activity","href":"/api-reference/activity/activity-scoped-to-a-tool"}]},{"group":"Agents","pages":[{"title":"List agents in the org","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/agents","href":"/api-reference/agents/list-agents-in-the-org"},{"title":"Create or upsert an agent (by slug)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/agents","href":"/api-reference/agents/create-or-upsert-an-agent-by-slug"},{"title":"Get an agent","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/agents/{slug}","href":"/api-reference/agents/get-an-agent"},{"title":"Delete an agent (soft delete)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/agents/{slug}","href":"/api-reference/agents/delete-an-agent-soft-delete"},{"title":"Update an agent (partial)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v1/agents/{slug}","href":"/api-reference/agents/update-an-agent-partial"},{"title":"Assign or change agent's linked sandbox","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v1/agents/{slug}/sandbox","href":"/api-reference/agents/assign-or-change-agents-linked-sandbox"}]},{"group":"Agent marketplace","pages":[{"title":"Publish or unpublish an agent (admin only)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v1/agents/{slug}/publish","href":"/api-reference/agent-marketplace/publish-or-unpublish-an-agent-admin-only"},{"title":"Install a marketplace agent into the caller's org","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/agents/{slug}/install","href":"/api-reference/agent-marketplace/install-a-marketplace-agent-into-the-callers-org"},{"title":"List published marketplace agents (public)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/agents/marketplace","href":"/api-reference/agent-marketplace/list-published-marketplace-agents-public"}]},{"group":"Agent runs","pages":[{"title":"List recent agent runs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/run","href":"/api-reference/agent-runs/list-recent-agent-runs"},{"title":"Run an agent (streaming or one-shot)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/run","href":"/api-reference/agent-runs/run-an-agent-streaming-or-one-shot"},{"title":"Get an agent run by ID","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/run/{id}","href":"/api-reference/agent-runs/get-an-agent-run-by-id"},{"title":"Cancel an agent run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/run/{id}/cancel","href":"/api-reference/agent-runs/cancel-an-agent-run"},{"title":"List threads for an agent (legacy run-scoped path)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/run/threads","href":"/api-reference/agent-runs/list-threads-for-an-agent-legacy-run-scoped-path"},{"title":"Get a thread with messages (agent-scoped path)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/run/threads/{threadId}","href":"/api-reference/agent-runs/get-a-thread-with-messages-agent-scoped-path"},{"title":"Delete a thread (agent-scoped path)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/run/threads/{threadId}","href":"/api-reference/agent-runs/delete-a-thread-agent-scoped-path"}]},{"group":"Threads","pages":[{"title":"List threads","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/threads","href":"/api-reference/threads/list-threads"},{"title":"Get a thread snapshot","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/threads/{threadId}","href":"/api-reference/threads/get-a-thread-snapshot"},{"title":"Delete a thread (cascade)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/threads/{threadId}","href":"/api-reference/threads/delete-a-thread-cascade"},{"title":"Rename or archive a thread","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v1/threads/{threadId}","href":"/api-reference/threads/rename-or-archive-a-thread"},{"title":"List rollouts (run instances) for a thread","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/threads/{threadId}/rollouts","href":"/api-reference/threads/list-rollouts-run-instances-for-a-thread"},{"title":"List durable thread events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/threads/{threadId}/events","href":"/api-reference/threads/list-durable-thread-events"},{"title":"Append durable thread events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/threads/{threadId}/events","href":"/api-reference/threads/append-durable-thread-events"},{"title":"Manually compact a thread","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/threads/{threadId}/compact","href":"/api-reference/threads/manually-compact-a-thread"}]},{"group":"Installable agents","pages":[{"title":"List the installable-agent catalog","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/installable-agents","href":"/api-reference/installable-agents/list-the-installable-agent-catalog"},{"title":"List install records (active + recovering)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/installable-agents/installs","href":"/api-reference/installable-agents/list-install-records-active-+-recovering"},{"title":"Install an installable agent into a sandbox+workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/installable-agents/{slug}/install","href":"/api-reference/installable-agents/install-an-installable-agent-into-a-sandbox+workspace"},{"title":"Get an install record","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/installable-agents/installs/{installId}","href":"/api-reference/installable-agents/get-an-install-record"},{"title":"Uninstall or forget an install","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/installable-agents/installs/{installId}","href":"/api-reference/installable-agents/uninstall-or-forget-an-install"},{"title":"Configure a Hermes install's provider/model","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/installable-agents/installs/{installId}/configure","href":"/api-reference/installable-agents/configure-a-hermes-installs-providermodel"},{"title":"List Hermes threads inside the install","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/installable-agents/installs/{installId}/threads","href":"/api-reference/installable-agents/list-hermes-threads-inside-the-install"},{"title":"Send a chat message to Hermes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/installable-agents/installs/{installId}/chat","href":"/api-reference/installable-agents/send-a-chat-message-to-hermes"}]},{"group":"Attachments","pages":[{"title":"Create an attachment upload target","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/agent-attachments","href":"/api-reference/attachments/create-an-attachment-upload-target"},{"title":"Finalize an attachment after upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/agent-attachments/{id}/complete","href":"/api-reference/attachments/finalize-an-attachment-after-upload"},{"title":"Resolve an attachment for a specific model","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/agent-attachments/{id}/resolve","href":"/api-reference/attachments/resolve-an-attachment-for-a-specific-model"}]},{"group":"Workspaces","pages":[{"title":"List workspaces in the org","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/workspaces","href":"/api-reference/workspaces/list-workspaces-in-the-org"},{"title":"Create a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/workspaces","href":"/api-reference/workspaces/create-a-workspace"},{"title":"Get a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/workspaces/{id}","href":"/api-reference/workspaces/get-a-workspace"},{"title":"Delete a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/workspaces/{id}","href":"/api-reference/workspaces/delete-a-workspace"},{"title":"Rename a workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v1/workspaces/{id}","href":"/api-reference/workspaces/rename-a-workspace"},{"title":"Workspace reference summary","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/workspaces/{id}/usage","href":"/api-reference/workspaces/workspace-reference-summary"}]},{"group":"Workspace files","pages":[{"title":"List directory entries at workspace root","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/workspaces/{id}/files","href":"/api-reference/workspace-files/list-directory-entries-at-workspace-root"},{"title":"Batch operation at workspace root","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/workspaces/{id}/files","href":"/api-reference/workspace-files/batch-operation-at-workspace-root"},{"title":"Create an entry at workspace root","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/workspaces/{id}/files","href":"/api-reference/workspace-files/create-an-entry-at-workspace-root"},{"title":"Delete entries by ID at workspace root","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/workspaces/{id}/files","href":"/api-reference/workspace-files/delete-entries-by-id-at-workspace-root"},{"title":"List entries at a sub-path","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/workspaces/{id}/files/{path}","href":"/api-reference/workspace-files/list-entries-at-a-sub-path"},{"title":"Mutate a single entry at a sub-path","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/workspaces/{id}/files/{path}","href":"/api-reference/workspace-files/mutate-a-single-entry-at-a-sub-path"},{"title":"Create an entry at a sub-path","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/workspaces/{id}/files/{path}","href":"/api-reference/workspace-files/create-an-entry-at-a-sub-path"},{"title":"Workspace drive info (used/free bytes)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/workspaces/{id}/info","href":"/api-reference/workspace-files/workspace-drive-info-usedfree-bytes"},{"title":"Get info for a path inside the workspace","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/workspaces/{id}/info/{path}","href":"/api-reference/workspace-files/get-info-for-a-path-inside-the-workspace"},{"title":"Upload a file to the workspace root","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/workspaces/{id}/upload","href":"/api-reference/workspace-files/upload-a-file-to-the-workspace-root"},{"title":"Upload a file to a sub-path","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/workspaces/{id}/upload/{path}","href":"/api-reference/workspace-files/upload-a-file-to-a-sub-path"},{"title":"Stream a file directly","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/workspaces/{id}/direct","href":"/api-reference/workspace-files/stream-a-file-directly"}]},{"group":"Models","pages":[{"title":"Available platform and BYOK models","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/models/available","href":"/api-reference/models/available-platform-and-byok-models"}]},{"group":"Model proxy","pages":[{"title":"Invoke a platform-tier model (non-streaming)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/model-proxy","href":"/api-reference/model-proxy/invoke-a-platform-tier-model-non-streaming"},{"title":"Invoke a platform-tier model (streaming)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/model-proxy/stream","href":"/api-reference/model-proxy/invoke-a-platform-tier-model-streaming"}]},{"group":"Calendar","pages":[{"title":"List Google Calendar connections","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/calendar/connections","href":"/api-reference/calendar/list-google-calendar-connections"},{"title":"Disconnect a specific calendar","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/calendar/connections/{connectionId}","href":"/api-reference/calendar/disconnect-a-specific-calendar"},{"title":"Update label or color","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v1/calendar/connections/{connectionId}","href":"/api-reference/calendar/update-label-or-color"},{"title":"Get the first calendar connection (legacy)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/calendar/connection","href":"/api-reference/calendar/get-the-first-calendar-connection-legacy"},{"title":"Disconnect all calendars (legacy)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/calendar/connection","href":"/api-reference/calendar/disconnect-all-calendars-legacy"},{"title":"Begin Google OAuth flow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/calendar/oauth/init","href":"/api-reference/calendar/begin-google-oauth-flow"},{"title":"Complete Google OAuth flow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/calendar/oauth/callback","href":"/api-reference/calendar/complete-google-oauth-flow"},{"title":"List calendar events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/calendar/events","href":"/api-reference/calendar/list-calendar-events"},{"title":"Create a calendar event","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/calendar/events","href":"/api-reference/calendar/create-a-calendar-event"}]},{"group":"RunMesh","pages":[{"title":"Begin a device-link flow (unauthenticated)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/runmesh/devices/link/start","href":"/api-reference/runmesh/begin-a-device-link-flow-unauthenticated"},{"title":"Poll for link approval (unauthenticated)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/runmesh/devices/link/poll","href":"/api-reference/runmesh/poll-for-link-approval-unauthenticated"},{"title":"Approve a pending device-link request","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/runmesh/devices/link/approve","href":"/api-reference/runmesh/approve-a-pending-device-link-request"},{"title":"Counts of online/offline nodes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/runmesh/overview","href":"/api-reference/runmesh/counts-of-onlineoffline-nodes"},{"title":"List RunMesh nodes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/runmesh/nodes","href":"/api-reference/runmesh/list-runmesh-nodes"},{"title":"Get a RunMesh node","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/runmesh/nodes/{id}","href":"/api-reference/runmesh/get-a-runmesh-node"},{"title":"Revoke a RunMesh node","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/runmesh/nodes/{id}","href":"/api-reference/runmesh/revoke-a-runmesh-node"},{"title":"Rename a RunMesh node","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v1/runmesh/nodes/{id}","href":"/api-reference/runmesh/rename-a-runmesh-node"},{"title":"Revoke a node (POST alias)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/runmesh/nodes/{id}/revoke","href":"/api-reference/runmesh/revoke-a-node-post-alias"},{"title":"Generate WireGuard peer config for a node","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/runmesh/nodes/{id}/config","href":"/api-reference/runmesh/generate-wireguard-peer-config-for-a-node"},{"title":"List recent RunMesh audit events","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/runmesh/audit","href":"/api-reference/runmesh/list-recent-runmesh-audit-events"}]},{"group":"Terminal","pages":[{"title":"Mint a one-time browser terminal session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/terminal/sandbox-sessions","href":"/api-reference/terminal/mint-a-one-time-browser-terminal-session"}]},{"group":"Auth","pages":[{"title":"Verify a JWT or API key (internal-friendly)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/auth/verify","href":"/api-reference/auth/verify-a-jwt-or-api-key-internal-friendly"},{"title":"Get a WorkOS logout URL for a session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/auth/logout-url","href":"/api-reference/auth/get-a-workos-logout-url-for-a-session"}]},{"group":"API keys","pages":[{"title":"List API keys for the caller","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/api-keys","href":"/api-reference/api-keys/list-api-keys-for-the-caller"},{"title":"Create an API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/api-keys","href":"/api-reference/api-keys/create-an-api-key"},{"title":"List allowed API key scopes (with descriptions)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/api-keys/scopes/list","href":"/api-reference/api-keys/list-allowed-api-key-scopes-with-descriptions"},{"title":"Get an API key (metadata only)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/api-keys/{id}","href":"/api-reference/api-keys/get-an-api-key-metadata-only"},{"title":"Revoke an API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/api-keys/{id}","href":"/api-reference/api-keys/revoke-an-api-key"},{"title":"Update an API key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v1/api-keys/{id}","href":"/api-reference/api-keys/update-an-api-key"}]},{"group":"SSH keys","pages":[{"title":"List SSH keys for the caller","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/ssh-keys","href":"/api-reference/ssh-keys/list-ssh-keys-for-the-caller"},{"title":"Upload an SSH public key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/ssh-keys","href":"/api-reference/ssh-keys/upload-an-ssh-public-key"},{"title":"Get an SSH key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/ssh-keys/{id}","href":"/api-reference/ssh-keys/get-an-ssh-key"},{"title":"Delete an SSH key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/ssh-keys/{id}","href":"/api-reference/ssh-keys/delete-an-ssh-key"},{"title":"Update an SSH key","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v1/ssh-keys/{id}","href":"/api-reference/ssh-keys/update-an-ssh-key"},{"title":"Mark a key as the caller's default","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/ssh-keys/{id}/set-default","href":"/api-reference/ssh-keys/mark-a-key-as-the-callers-default"},{"title":"Toggle always-include for org-wide keys (admin only)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/ssh-keys/{id}/set-always-include","href":"/api-reference/ssh-keys/toggle-always-include-for-org-wide-keys-admin-only"}]},{"group":"LangTerm","pages":[{"title":"List LangTerm connections","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/langterm-connections","href":"/api-reference/langterm/list-langterm-connections"},{"title":"Create a LangTerm connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/langterm-connections","href":"/api-reference/langterm/create-a-langterm-connection"},{"title":"Get a LangTerm connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/langterm-connections/{id}","href":"/api-reference/langterm/get-a-langterm-connection"},{"title":"Delete a LangTerm connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/langterm-connections/{id}","href":"/api-reference/langterm/delete-a-langterm-connection"}]},{"group":"OAuth connections","pages":[{"title":"List OAuth provider descriptors","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/oauth/providers","href":"/api-reference/oauth-connections/list-oauth-provider-descriptors"},{"title":"Begin a redirect OAuth flow","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/oauth/start/{provider}","href":"/api-reference/oauth-connections/begin-a-redirect-oauth-flow"},{"title":"OAuth callback (provider redirects here)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/oauth/callback/{provider}","href":"/api-reference/oauth-connections/oauth-callback-provider-redirects-here"},{"title":"Begin a device-code OAuth flow (e.g. OpenAI Codex)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/oauth/device/start/{provider}","href":"/api-reference/oauth-connections/begin-a-device-code-oauth-flow-eg-openai-codex"},{"title":"Poll the device-code status","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/oauth/device/status/{provider}","href":"/api-reference/oauth-connections/poll-the-device-code-status"},{"title":"List OAuth connections for the caller","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/oauth/connections","href":"/api-reference/oauth-connections/list-oauth-connections-for-the-caller"},{"title":"Get an OAuth connection (metadata only)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/oauth/connections/{id}","href":"/api-reference/oauth-connections/get-an-oauth-connection-metadata-only"},{"title":"Delete an OAuth connection","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/oauth/connections/{id}","href":"/api-reference/oauth-connections/delete-an-oauth-connection"},{"title":"Mark an OAuth connection as default","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/oauth/connections/{id}/set-default","href":"/api-reference/oauth-connections/mark-an-oauth-connection-as-default"},{"title":"Check if a provider is connected","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/oauth/status/{provider}","href":"/api-reference/oauth-connections/check-if-a-provider-is-connected"}]},{"group":"BYOA configs","pages":[{"title":"List BYOA configs for the org","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/oauth/configs","href":"/api-reference/byoa-configs/list-byoa-configs-for-the-org"},{"title":"Upsert a BYOA provider configuration","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/oauth/configs","href":"/api-reference/byoa-configs/upsert-a-byoa-provider-configuration"},{"title":"Delete a BYOA config","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/oauth/configs/{provider}","href":"/api-reference/byoa-configs/delete-a-byoa-config"},{"title":"Enable/disable a BYOA config","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v1/oauth/configs/{provider}","href":"/api-reference/byoa-configs/enabledisable-a-byoa-config"}]},{"group":"Secrets","pages":[{"title":"List secret metadata","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/secrets","href":"/api-reference/secrets/list-secret-metadata"},{"title":"Create or update an encrypted secret","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/secrets","href":"/api-reference/secrets/create-or-update-an-encrypted-secret"},{"title":"Get a secret's metadata","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/secrets/{name}","href":"/api-reference/secrets/get-a-secrets-metadata"},{"title":"Delete a secret","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/secrets/{name}","href":"/api-reference/secrets/delete-a-secret"},{"title":"Reveal a secret value (audit-logged)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/secrets/{name}/reveal","href":"/api-reference/secrets/reveal-a-secret-value-audit-logged"}]},{"group":"Tools (marketplace)","pages":[{"title":"List public marketplace tools","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/marketplace","href":"/api-reference/tools-marketplace/list-public-marketplace-tools"},{"title":"Search public marketplace tools","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/marketplace/search","href":"/api-reference/tools-marketplace/search-public-marketplace-tools"},{"title":"Batch-fetch action schemas","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/marketplace/schemas","href":"/api-reference/tools-marketplace/batch-fetch-action-schemas"},{"title":"Get a specific public tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/marketplace/{slug}","href":"/api-reference/tools-marketplace/get-a-specific-public-tool"}]},{"group":"Tools (installed)","pages":[{"title":"List installed tools for the caller's org","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tools","href":"/api-reference/tools-installed/list-installed-tools-for-the-callers-org"},{"title":"Install a tool for the org","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/tools/{slug}/install","href":"/api-reference/tools-installed/install-a-tool-for-the-org"},{"title":"Uninstall a tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/tools/{slug}","href":"/api-reference/tools-installed/uninstall-a-tool"},{"title":"Force-uninstall every org install (admin only)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/tools/{slug}/force-uninstall","href":"/api-reference/tools-installed/force-uninstall-every-org-install-admin-only"},{"title":"Check whether stored credentials exist","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tools/{slug}/credentials","href":"/api-reference/tools-installed/check-whether-stored-credentials-exist"},{"title":"Store credentials for an installed tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/tools/{slug}/credentials","href":"/api-reference/tools-installed/store-credentials-for-an-installed-tool"},{"title":"Remove stored credentials for a tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/tools/{slug}/credentials","href":"/api-reference/tools-installed/remove-stored-credentials-for-a-tool"}]},{"group":"Tool execution","pages":[{"title":"Execute a tool action","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/tools/{slug}/execute","href":"/api-reference/tool-execution/execute-a-tool-action"}]},{"group":"Tools (custom)","pages":[{"title":"List custom tools visible to the caller","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tools/custom","href":"/api-reference/tools-custom/list-custom-tools-visible-to-the-caller"},{"title":"Create or update a custom tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/tools/custom","href":"/api-reference/tools-custom/create-or-update-a-custom-tool"},{"title":"Get a custom tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/tools/custom/{slug}","href":"/api-reference/tools-custom/get-a-custom-tool"},{"title":"Soft-delete a custom tool","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml delete /v1/tools/custom/{slug}","href":"/api-reference/tools-custom/soft-delete-a-custom-tool"},{"title":"Set visibility (admin only)","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml patch /v1/tools/custom/{slug}/publish","href":"/api-reference/tools-custom/set-visibility-admin-only"}]},{"group":"Billing","pages":[{"title":"Public pricing reference","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/pricing","href":"/api-reference/billing/public-pricing-reference"},{"title":"Get the org's credit balance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/billing/credits","href":"/api-reference/billing/get-the-orgs-credit-balance"},{"title":"Get credit ledger history","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/billing/credits/history","href":"/api-reference/billing/get-credit-ledger-history"},{"title":"Get the org's billing summary","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/billing/plan","href":"/api-reference/billing/get-the-orgs-billing-summary"},{"title":"Get aggregate or per-user usage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/billing/my-usage","href":"/api-reference/billing/get-aggregate-or-per-user-usage"},{"title":"Create a Stripe Checkout session for a credit top-up","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/billing/topup","href":"/api-reference/billing/create-a-stripe-checkout-session-for-a-credit-top-up"},{"title":"Eager-sync a completed Stripe checkout session","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/billing/success","href":"/api-reference/billing/eager-sync-a-completed-stripe-checkout-session"},{"title":"Get auto-top-up settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml get /v1/billing/auto-topup","href":"/api-reference/billing/get-auto-top-up-settings"},{"title":"Update auto-top-up settings","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml put /v1/billing/auto-topup","href":"/api-reference/billing/update-auto-top-up-settings"},{"title":"Redeem a promo code","deprecated":null,"version":null,"openapi":"/api-reference/openapi.yaml post /v1/billing/promo-codes/redeem","href":"/api-reference/billing/redeem-a-promo-code"}]}]},{"tab":"SDK","icon":"cube","pages":[{"title":"SDK","href":"/sdk/overview"}]},{"tab":"CLI","icon":"terminal","pages":[{"title":"CLI","href":"/cli/overview"}]}]},"basePath":"","title":"Connect an agent channel - Runtools.ai","buildId":"dpl_596ePT575z4qnAFksq1biRW97aLY","deploymentId":"dpl_596ePT575z4qnAFksq1biRW97aLY","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-C9Wu0MeN.js","utils-jWgu-6Qf.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-DBD8f9qn.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-BGuX1ui5.js","snippetPresets-Evy63nQB.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","ApiExamples-BQHO1lnV.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-B6C8m-t_.js","shallow-BG4cT0fH.js","getApiPlaygroundDisplay-CgEPrE-D.js","CodeSnippet-CU8JyZ9N.js","CodeSnippets-BnxHU32T.js","Page-D6S0Yh6q.js","getPastedJson-CwiYOonh.js","icon-DYDpWmDf.js","MethodPill-C-J-l7_c.js","DuplicateIcon-B6ARwg9w.js","createIcon-Dsv4MtDq.js","DynamicMarkdown-CtasenyM.js","SectionHeading-YNcgYwjB.js","axios-vUo_bRtp.js","Markdown-CwLx6PAg.js","clsx-C3kuh_dz.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-CmKHfscc.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-U3mI6Ljh.js"]}