Partially updates an existing tool router session. Inline fields update only the supplied settings. Alternatively, experimental.session_config_id applies the latest active saved config from this project, replacing toolkit, tool, and tag access while preserving other settings. Later saved-config edits do not sync automatically. Uses optimistic concurrency control and retains the previous policy in config history.
Your Composio project API key. Create or copy it from the Composio dashboard.
Path Parameters
session_id
string<toolRouterSessionId>
required
The unique identifier of the tool router session
Example:
"trs_1a2b3c4d5e6f"
Body
application/json
toolkits
object
Toolkit configuration - specify either enable toolkits (allowlist) or disable toolkits (denylist). Mutually exclusive. Experimentally, it can also list toolkits whose tools need approval, with or without a filter.
Option 1
Option 2
Option 3
Show child attributes
auth_configs
object
The auth configs to use for the session. This will override the default behavior and use the given auth config when specific toolkits are being executed
The connected accounts to use for the session, as an array of nano-IDs per toolkit. This overrides the default behaviour and pins specific connected accounts when toolkits are executed. Each account must exist (not deleted or disabled) and belong to the same user_id as the session. Multi-account sessions can pin multiple; non-multi-account sessions are capped at length 1.
Show child attributes
instant
enum<boolean>object
Controls instant usage, subject to project permission and session toolkit and tool restrictions. False disables instant usage. Omission on create or an empty object enables it with charges hidden. On PATCH, omitted fields are preserved; an object re-enables a disabled setting.
Available options:
false
manage_connections
object | null
Show child attributes
tools
object
Tool-level configuration per toolkit. Allows you to enable, disable, or filter by tags for specific tools within each toolkit, and experimentally to list tools that need approval. Every tool slug must be a valid Composio tool slug for that toolkit — invalid or typo'd slugs fail session creation with a clear error listing which ones didn't match.
Show child attributes
tags
enum<string>[]object
Session-wide tags for filtering tools. Array format is treated as an enabled list. Object format supports enable (a tool must have at least one) and disable (a tool must have none), and experimentally the tags whose tools need approval. If a toolkit sets tools.<toolkit>.tags, its tools use that object instead of this one.
Preload configuration. Use an explicit list for frequently used tool slugs, or "all" to dynamically expose every app tool allowed by positive toolkits/tools/tags filters.
Show child attributes
search
object
Show child attributes
execute
object
Show child attributes
hooks
object[] | null
Hooks that run on this session's tool calls. A hook can block a call before it runs, or block its result before the agent sees it.
Maximum array length: 20
Option 1
Option 2
Show child attributes
experimental
object | null
Show child attributes
Response
Session config successfully patched.
session_id
string<toolRouterSessionId>
required
The identifier of the session
Example:
"trs_1a2b3c4d5e6f"
mcp
object
required
Show child attributes
tool_router_tools
string[]
required
List of available tools in this session
config
object
required
The configuration used to create this session
Show child attributes
config_version
integer
required
Monotonic version of the config. Incremented on each PATCH. Use for optimistic concurrency control.
experimental
object
Experimental v3.1 features
Show child attributes
warnings
object[]
Advisory list — the session exists and is usable, but the listed issues may warrant attention.
Show child attributes
Example:
[ { "code": "PRELOAD_TOOLS_HIGH_CONTEXT_USAGE", "message": "Session preloads 25 tools; each preloaded tool adds to the agent context window. Consider keeping the list at or under ~20 tools." } ]
{"docsConfig":{"theme":"sequoia","$schema":"https://mintlify.com/docs.json","name":"Composio Docs","description":"Build AI agents with 1,700+ apps. Connect LLMs to external services like GitHub, Slack, Gmail, and more.","colors":{"primary":"#0007CD","light":"#5B8BF0","dark":"#5B8BF0"},"logo":{"light":"https://mintcdn.com/composio-preview/cL3pOAF8H-TYHF1S/Composio%20Logo.svg?fit=max\u0026auto=format\u0026n=cL3pOAF8H-TYHF1S\u0026q=85\u0026s=c959b1b97e22caccd03fe5d3d71ab52b","dark":"https://mintcdn.com/composio-preview/cL3pOAF8H-TYHF1S/Composio%20Logo%20Dark.svg?fit=max\u0026auto=format\u0026n=cL3pOAF8H-TYHF1S\u0026q=85\u0026s=1b31206b6350aa17315c7ea06c829de5","href":"/docs"},"favicon":{"light":"https://mintcdn.com/composio-preview/cL3pOAF8H-TYHF1S/favicon.ico?fit=max\u0026auto=format\u0026n=cL3pOAF8H-TYHF1S\u0026q=85\u0026s=1e12b5b301d9c338a1c87e58589a4e99","dark":"https://mintcdn.com/composio-preview/cL3pOAF8H-TYHF1S/favicon.ico?fit=max\u0026auto=format\u0026n=cL3pOAF8H-TYHF1S\u0026q=85\u0026s=1e12b5b301d9c338a1c87e58589a4e99"},"api":{"playground":{"display":"interactive"},"examples":{"languages":["python","typescript","bash","go","java","csharp","rust"]}},"appearance":{"default":"dark"},"navbar":{"links":[{"icon":{"style":"brands","name":"github","library":"fontawesome"},"href":"https://github.com/composiohq/composio","type":"github"},{"icon":{"style":"brands","name":"x-twitter","library":"fontawesome"},"href":"https://x.com/composiodevs","label":""}],"primary":{"type":"button","label":"Playground","href":"https://dashboard.composio.dev/~/project/playground?utm_source=docs\u0026utm_medium=navbar\u0026utm_campaign=playground"}},"seo":{"metatags":{"og:site_name":"Composio Docs","robots":"noindex"},"indexing":"all"},"fonts":{"family":"ABC Diatype","weight":400,"source":"fonts/ABCDiatype-Regular.woff2","format":"woff2"},"contextual":{"options":["copy","view","assistant","chatgpt","claude","perplexity","mcp","download-spec"],"display":"header"},"interaction":{"drilldown":true},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"composio-preview","hasAudioNarration":false,"actualSubdomain":"composio-preview","customDomains":[],"gitSource":{"type":"github","owner":"mintlify-onboarding","repo":"composio-preview","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"REMOVE_BRANDING":{"status":"ENABLED"},"CONTEXTUAL_FEEDBACK":{"status":"ENABLED"},"CODE_SNIPPET_FEEDBACK":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6aee717af538f2c21575e5ef","clientVersion":"0.0.4128","searchFilterCounts":[{"language":"default","tag":"Reference","count":403},{"language":"default","tag":"API Reference","count":180},{"language":"default","tag":"Docs","count":80},{"language":"default","tag":"Platform","count":77},{"language":"default","tag":"Toolkits","count":48},{"language":"default","tag":"MCP","count":44},{"language":"default","tag":"Connected Accounts","count":36},{"language":"default","tag":"Triggers","count":34},{"language":"default","tag":"Sessions (prev Tool Router)","count":33},{"language":"default","tag":"Sessions (Prev Tool Router)","count":33}]},"assistantConfig":{},"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":"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":"site-roles","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"full-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-dual-write","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"approve-review-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-metadata","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"sso-setup-deadline-banner","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"turbopuffer-serve","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"live-agents","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"starter-pricing","enabled":true,"variant":{"name":"control","enabled":true,"payload":{"type":"string","value":"control"},"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"wildcard-email-auth","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"styles.css","content":":root{--composio-brand: #0007cd}.dark{--composio-brand: #5b8bf0}.hero-agent-demo{--hero-demo-brand: #0007cd;min-height:420px}.dark .hero-agent-demo{--hero-demo-brand: #5b8bf0}.hero-layout{grid-template-columns:minmax(0, 1fr)}@media (min-width: 1024px){.hero-layout{grid-template-columns:minmax(0, 1.05fr) minmax(0, 0.95fr)}}.hero-agent-window{position:absolute;inset-block:0;right:0;display:flex;width:100%;max-width:340px;flex-direction:column;overflow:hidden;border:1px solid rgb(0 7 205 / 22%);background:rgb(255 255 255 / 88%);box-shadow:0 1px 0 rgb(15 15 15 / 4%);backdrop-filter:blur(16px)}.dark .hero-agent-window{border-color:rgb(91 139 240 / 32%);background:rgb(15 23 42 / 92%)}.hero-agent-dot,.hero-agent-send,.hero-running-dot,.hero-running-ping{background:var(--hero-demo-brand)}.hero-agent-header{animation:hero-header-in 9.5s ease-in-out infinite}.hero-agent-message{animation:hero-message-cycle 9.5s cubic-bezier(0.4, 0, 0.2, 1) infinite;transform-origin:center}.hero-agent-thinking{animation:hero-thinking-cycle 9.5s ease-in-out infinite}.hero-agent-thinking span{width:6px;height:6px;animation:hero-pulse-dot 1.4s ease-in-out infinite;background:var(--hero-demo-brand)}.hero-agent-thinking span:nth-child(2){animation-delay:180ms}.hero-agent-thinking span:nth-child(3){animation-delay:360ms}.hero-tool-call{animation:hero-tool-call-cycle 9.5s cubic-bezier(0.4, 0, 0.2, 1) infinite,\n hero-shimmer-text 2s ease-in-out infinite}.hero-tool-shimmer{color:transparent;background-image:linear-gradient(\n 90deg,\n rgb(15 15 15 / 35%) 0%,\n rgb(15 15 15 / 70%) 40%,\n rgb(15 15 15) 50%,\n rgb(15 15 15 / 70%) 60%,\n rgb(15 15 15 / 35%) 100%\n );background-size:200% 100%;background-clip:text}.dark .hero-tool-shimmer{background-image:linear-gradient(\n 90deg,\n rgb(245 245 247 / 35%) 0%,\n rgb(245 245 247 / 70%) 40%,\n rgb(245 245 247) 50%,\n rgb(245 245 247 / 70%) 60%,\n rgb(245 245 247 / 35%) 100%\n )}.hero-agent-connector{position:absolute;z-index:5;top:32%;right:340px;width:60px;height:10%;overflow:visible;color:var(--hero-demo-brand);pointer-events:none}.hero-agent-connector-glow,.hero-agent-connector-line{stroke-dasharray:1;stroke-dashoffset:1;animation:hero-connector-cycle 9.5s cubic-bezier(0.4, 0, 0.2, 1) infinite}.hero-agent-connector-glow{opacity:0;filter:drop-shadow(0 0 6px var(--hero-demo-brand))}.hero-agent-connector-line{opacity:0}.hero-tool-panel{position:absolute;bottom:24px;left:175px;z-index:10;display:flex;width:320px;max-height:60%;flex-direction:column;overflow:hidden;border:1px solid rgb(226 232 240);background:rgb(255 255 255 / 96%);font-family:ui-monospace, SFMono-Regular, Menlo, Monaco, Consolas, monospace;box-shadow:0 24px 48px -18px rgb(15 15 15 / 32%);transform:translateX(-46%);animation:hero-panel-cycle 9.5s cubic-bezier(0.4, 0, 0.2, 1) infinite}.dark .hero-tool-panel{border-color:rgb(51 65 85);background:rgb(15 23 42 / 96%);box-shadow:0 24px 48px -18px rgb(0 0 0 / 62%)}.hero-tool-running{color:var(--hero-demo-brand)}.hero-running-ping{animation:hero-running-ping 1s cubic-bezier(0, 0, 0.2, 1) infinite;opacity:0.6}.hero-tool-results{flex:1;overflow:hidden}.hero-tool-result-row{display:flex;align-items:center;gap:8px;border:1px solid rgb(226 232 240);background:white;padding:6px 8px}.dark .hero-tool-result-row{border-color:rgb(51 65 85);background:rgb(2 6 23)}@keyframes hero-header-in{0%,3%{opacity:0;transform:translateY(6px)}7%,92%{opacity:1;transform:translateY(0)}100%{opacity:0;transform:translateY(-6px)}}@keyframes hero-message-cycle{0%,5%{opacity:0;transform:translateY(8px) scale(0.97)}10%,18%{opacity:1;transform:translateY(0) scale(1)}24%,92%{opacity:0.45;transform:translateY(0) scale(1)}100%{opacity:0;transform:scale(0.97)}}@keyframes hero-thinking-cycle{0%,11%,24%,100%{opacity:0;transform:translateY(6px)}14%,21%{opacity:1;transform:translateY(0)}}@keyframes hero-tool-call-cycle{0%,20%{opacity:0;transform:translateY(8px) scale(0.97)}27%,92%{opacity:1;transform:translateY(0) scale(1)}100%{opacity:0;transform:scale(0.97)}}@keyframes hero-panel-cycle{0%,22%{opacity:0;transform:translateX(-46%) translateX(-8px)}29%,92%{opacity:1;transform:translateX(-46%) translateX(0)}100%{opacity:0;transform:translateX(-46%) translateX(-8px)}}@keyframes hero-connector-cycle{0%,22%{opacity:0;stroke-dashoffset:1}29%,36%{opacity:1;stroke-dashoffset:0}52%,100%{opacity:0;stroke-dashoffset:0}}@keyframes hero-shimmer-text{from{background-position:100% 0}to{background-position:-100% 0}}@keyframes hero-pulse-dot{0%,100%{opacity:1}50%{opacity:0.3}}@keyframes hero-running-ping{75%,100%{opacity:0;transform:scale(2)}}@media (prefers-reduced-motion: reduce){.hero-agent-header,.hero-agent-message,.hero-agent-thinking,.hero-tool-call,.hero-agent-connector-glow,.hero-agent-connector-line,.hero-tool-panel,.hero-running-ping{animation:none!important}.hero-agent-header,.hero-agent-message,.hero-tool-call,.hero-tool-panel{opacity:1}.hero-agent-thinking,.hero-agent-connector-glow,.hero-agent-connector-line{opacity:0}}"}],"page":{"pagePath":"reference/api-reference/tool-router/patchToolRouterSessionBySessionId","slug":"/reference/api-reference/tool-router/patchToolRouterSessionBySessionId","pageMetadata":{"title":"Patch a tool router session config (v3.1)","description":"Partially updates an existing tool router session. Inline fields update only the supplied settings. Alternatively, experimental.session_config_id applies the latest active saved config from this project, replacing toolkit, tool, and tag access while preserving other settings. Later saved-config edits do not sync automatically. Uses optimistic concurrency control and retains the previous policy in config history.","openapi":"api-reference/openapi.json PATCH /api/v3.1/tool_router/session/{session_id}","href":"/reference/api-reference/tool-router/patchToolRouterSessionBySessionId"},"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: \"Partially updates an existing tool router session. Inline fields update only the supplied settings. Alternatively, experimental.session_config_id applies the latest active saved config from this project, replacing toolkit, tool, and tag access while preserving other settings. Later saved-config edits do not sync automatically. Uses optimistic concurrency control and retains the previous policy in config history.\"\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Patch a tool router session config (v3.1)","description":"Partially updates an existing tool router session. Inline fields update only the supplied settings. Alternatively, experimental.session_config_id applies the latest active saved config from this project, replacing toolkit, tool, and tag access while preserving other settings. Later saved-config edits do not sync automatically. Uses optimistic concurrency control and retains the previous policy in config history.","openapi":"api-reference/openapi.json PATCH /api/v3.1/tool_router/session/{session_id}","href":"/reference/api-reference/tool-router/patchToolRouterSessionBySessionId"}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":["/_mintlify/custom/composio-preview/3e74df7724d07010/pixelated-circle-worklet.js"],"openApiReferenceData":{"operation":{"summary":"Patch a tool router session config (v3.1)","description":"Partially updates an existing tool router session. Inline fields update only the supplied settings. Alternatively, experimental.session_config_id applies the latest active saved config from this project, replacing toolkit, tool, and tag access while preserving other settings. Later saved-config edits do not sync automatically. Uses optimistic concurrency control and retains the previous policy in config history.","tags":["Tool Router"],"operationId":"patchToolRouterSessionBySessionId","security":["f5eb1c25-3f51-416e-b40f-11935eff6f3e"],"parameters":["08b0e5cf-9594-4a94-88f1-7defb9d7d64a"],"requestBody":"b26f985f-c492-4acd-8ca5-7a24405ce420","responses":{"200":"72ad9778-8f14-464b-8cfa-a200663390a7","400":"ad0edb16-a6d9-45cb-8e75-032390d0a5ca","401":"6569cc66-8e4e-4bb9-bc50-d908539c39f4","403":"359ef005-6f33-485c-909f-266f8160ed62","404":"977a8c20-0031-48d6-b642-01a4c48e6bad","408":"ded9ecf2-3b60-45d9-b8ff-93a1739d9136","409":"43f99d69-5278-4cf4-be6c-8655b5a0402e","429":"08c53222-c031-4e1d-974c-78f67cd7c5f5","500":"e6f11a5c-e5b6-4c00-8d8b-9cfd7b37ea26"},"x-api-version":"3.1","x-mint":{"metadata":{"title":"Patch a tool router session config (v3.1)","description":"Partially updates an existing tool router session. Inline fields update only the supplied settings. Alternatively, experimental.session_config_id applies the latest active saved config from this project, replacing toolkit, tool, and tag access while preserving other settings. Later saved-config edits do not sync automatically. Uses optimistic concurrency control and retains the previous policy in config history.","deprecated":false},"content":"","href":"/reference/api-reference/tool-router/patchToolRouterSessionBySessionId"},"method":"patch","type":"path","servers":["88115a90-88a8-44fd-bf64-8d389b2a91c2"],"path":"/api/v3.1/tool_router/session/{session_id}","baseUrlOptions":["https://backend.composio.dev"],"title":"Patch a tool router session config (v3.1)","codeSamples":[],"requestExampleLanguages":["python","typescript","bash","go","java","csharp","rust"],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{"08b0e5cf-9594-4a94-88f1-7defb9d7d64a":{"schema":{"type":"string","format":"toolRouterSessionId","description":"The unique identifier of the tool router session","example":"trs_1a2b3c4d5e6f","isRequired":true,"uniqueKey":"","typeLabel":"string\u003ctoolRouterSessionId>"},"required":true,"description":"The unique identifier of the tool router session","name":"session_id","in":"path"}},"requestBody":{"content":{"application/json":{"schema":{"type":"object","properties":{"toolkits":{"oneOf":[{"type":"object","description":"Toolkit configuration - specify either enable toolkits (allowlist) or disable toolkits (denylist). Mutually exclusive. Experimentally, it can also list toolkits whose tools need approval, with or without a filter.","required":["enable"],"properties":{"enable":{"type":"array","items":{"type":"string","uniqueKey":"toolkits.oneOf.0.enable.items.[INDEX]","typeLabel":"string"},"description":"Only these specific toolkits will be enabled","example":["gmail","slack","github"],"isRequired":true,"uniqueKey":"toolkits.oneOf.0.enable","typeLabel":"string[]"},"require_approval":{"type":"array","items":{"type":"string","uniqueKey":"toolkits.oneOf.0.require_approval.items.[INDEX]","typeLabel":"string"},"minItems":1,"description":"Tool calls matched here pause until the user approves them. A tool needs approval if its toolkit, the tool itself or any of its tags is listed. A toolkit's own lists in `tools` replace the session-wide tag list for that toolkit.","x-experimental":true,"example":["github"],"uniqueKey":"toolkits.oneOf.0.require_approval","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"toolkits.oneOf.0","typeLabel":"object"},{"type":"object","description":"Toolkit configuration - specify either enable toolkits (allowlist) or disable toolkits (denylist). Mutually exclusive. Experimentally, it can also list toolkits whose tools need approval, with or without a filter.","required":["disable"],"properties":{"disable":{"type":"array","items":{"type":"string","uniqueKey":"toolkits.oneOf.1.disable.items.[INDEX]","typeLabel":"string"},"description":"These specific toolkits will be disabled","example":["gmail","slack"],"isRequired":true,"uniqueKey":"toolkits.oneOf.1.disable","typeLabel":"string[]"},"require_approval":{"type":"array","items":{"type":"string","uniqueKey":"toolkits.oneOf.1.require_approval.items.[INDEX]","typeLabel":"string"},"minItems":1,"description":"Tool calls matched here pause until the user approves them. A tool needs approval if its toolkit, the tool itself or any of its tags is listed. A toolkit's own lists in `tools` replace the session-wide tag list for that toolkit.","x-experimental":true,"example":["github"],"uniqueKey":"toolkits.oneOf.1.require_approval","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"toolkits.oneOf.1","typeLabel":"object"},{"type":"object","description":"Toolkit configuration - specify either enable toolkits (allowlist) or disable toolkits (denylist). Mutually exclusive. Experimentally, it can also list toolkits whose tools need approval, with or without a filter.","required":["require_approval"],"properties":{"require_approval":{"type":"array","items":{"type":"string","uniqueKey":"toolkits.oneOf.2.require_approval.items.[INDEX]","typeLabel":"string"},"minItems":1,"description":"Tool calls matched here pause until the user approves them. A tool needs approval if its toolkit, the tool itself or any of its tags is listed. A toolkit's own lists in `tools` replace the session-wide tag list for that toolkit.","x-experimental":true,"example":["github"],"isRequired":true,"uniqueKey":"toolkits.oneOf.2.require_approval","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"toolkits.oneOf.2","typeLabel":"object"}],"uniqueKey":"toolkits","typeLabel":"object"},"auth_configs":{"type":"object","additionalProperties":{"type":"string","format":"authConfigId","uniqueKey":"auth_configs.additionalProperties","typeLabel":"string\u003cauthConfigId>"},"description":"The auth configs to use for the session. This will override the default behavior and use the given auth config when specific toolkits are being executed","example":{"gmail":"ac_1a2b3c4d5e6f","slack":"ac_7g8h9i0j1k2l"},"uniqueKey":"auth_configs","typeLabel":"object"},"connected_accounts":{"oneOf":[{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","format":"connectedAccountId","uniqueKey":"connected_accounts.oneOf.0.additionalProperties.items.[INDEX]","typeLabel":"string\u003cconnectedAccountId>"},"minItems":1,"uniqueKey":"connected_accounts.oneOf.0.additionalProperties","typeLabel":"string\u003cconnectedAccountId>[]"},"description":"The connected accounts to use for the session, as an array of nano-IDs per toolkit. This overrides the default behaviour and pins specific connected accounts when toolkits are executed. Each account must exist (not deleted or disabled) and belong to the same `user_id` as the session. Multi-account sessions can pin multiple; non-multi-account sessions are capped at length 1.","uniqueKey":"connected_accounts.oneOf.0","typeLabel":"object"},{"type":"null","additionalProperties":{"type":"array","items":{"type":"string","format":"connectedAccountId","uniqueKey":"connected_accounts.oneOf.1.additionalProperties.items.[INDEX]","typeLabel":"string\u003cconnectedAccountId>"},"minItems":1,"uniqueKey":"connected_accounts.oneOf.1.additionalProperties","typeLabel":"string\u003cconnectedAccountId>[]"},"description":"The connected accounts to use for the session, as an array of nano-IDs per toolkit. This overrides the default behaviour and pins specific connected accounts when toolkits are executed. Each account must exist (not deleted or disabled) and belong to the same `user_id` as the session. Multi-account sessions can pin multiple; non-multi-account sessions are capped at length 1.","uniqueKey":"connected_accounts.oneOf.1","typeLabel":"null"}],"uniqueKey":"connected_accounts","typeLabel":"object | null"},"instant":{"oneOf":[{"type":"boolean","description":"Controls instant usage, subject to project permission and session toolkit and tool restrictions. False disables instant usage. Omission on create or an empty object enables it with charges hidden. On PATCH, omitted fields are preserved; an object re-enables a disabled setting.","enum":[false],"uniqueKey":"instant.oneOf.0","typeLabel":"enum\u003cboolean>"},{"type":"object","description":"Controls instant usage, subject to project permission and session toolkit and tool restrictions. False disables instant usage. Omission on create or an empty object enables it with charges hidden. On PATCH, omitted fields are preserved; an object re-enables a disabled setting.","properties":{"toolkits":{"oneOf":[{"type":"object","description":"Toolkit configuration - specify either enable toolkits (allowlist) or disable toolkits (denylist). Mutually exclusive.","required":["enable"],"properties":{"enable":{"type":"array","items":{"type":"string","uniqueKey":"instant.oneOf.1.toolkits.oneOf.0.enable.items.[INDEX]","typeLabel":"string"},"description":"Only these specific toolkits will be enabled","example":["gmail","slack","github"],"isRequired":true,"uniqueKey":"instant.oneOf.1.toolkits.oneOf.0.enable","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"instant.oneOf.1.toolkits.oneOf.0","typeLabel":"object"},{"type":"object","description":"Toolkit configuration - specify either enable toolkits (allowlist) or disable toolkits (denylist). Mutually exclusive.","required":["disable"],"properties":{"disable":{"type":"array","items":{"type":"string","uniqueKey":"instant.oneOf.1.toolkits.oneOf.1.disable.items.[INDEX]","typeLabel":"string"},"description":"These specific toolkits will be disabled","example":["gmail","slack"],"isRequired":true,"uniqueKey":"instant.oneOf.1.toolkits.oneOf.1.disable","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"instant.oneOf.1.toolkits.oneOf.1","typeLabel":"object"}],"uniqueKey":"instant.oneOf.1.toolkits","typeLabel":"object"},"tools":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["enable"],"properties":{"enable":{"type":"array","items":{"type":"string","uniqueKey":"instant.oneOf.1.tools.additionalProperties.oneOf.0.enable.items.[INDEX]","typeLabel":"string"},"description":"Only these specific tools will be available for this toolkit","example":["GMAIL_SEND_EMAIL","GMAIL_FETCH_EMAILS"],"isRequired":true,"uniqueKey":"instant.oneOf.1.tools.additionalProperties.oneOf.0.enable","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"instant.oneOf.1.tools.additionalProperties.oneOf.0","typeLabel":"object"},{"type":"object","required":["disable"],"properties":{"disable":{"type":"array","items":{"type":"string","uniqueKey":"instant.oneOf.1.tools.additionalProperties.oneOf.1.disable.items.[INDEX]","typeLabel":"string"},"description":"These specific tools will be disabled for this toolkit","example":["SLACK_ADD_EMOJI"],"isRequired":true,"uniqueKey":"instant.oneOf.1.tools.additionalProperties.oneOf.1.disable","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"instant.oneOf.1.tools.additionalProperties.oneOf.1","typeLabel":"object"}],"uniqueKey":"instant.oneOf.1.tools.additionalProperties","typeLabel":"object"},"description":"Per-toolkit enable or disable lists that restrict instant usage. Toolkits absent from the map have no additional tool restriction. On PATCH, a supplied map replaces all existing tool filters; an empty map clears them, and omission preserves them.","uniqueKey":"instant.oneOf.1.tools","typeLabel":"object"},"return_instant_charge":{"type":"boolean","description":"Return the top-level instant_charge in session tool responses when a charge is available. Defaults to false on create; omission on PATCH preserves the current value. Controls response visibility only; it does not enable or disable instant usage.","uniqueKey":"instant.oneOf.1.return_instant_charge","typeLabel":"boolean"},"return_prices_in_search":{"type":"boolean","description":"Experimental. Show each instant tool's price in tool search results, under instant_account.prices. Defaults to false on create; omit on PATCH to keep the current value. Does not turn instant usage on or off.","x-experimental":true,"uniqueKey":"instant.oneOf.1.return_prices_in_search","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"instant.oneOf.1","typeLabel":"object"}],"uniqueKey":"instant","typeLabel":"enum\u003cboolean> | object"},"manage_connections":{"oneOf":[{"type":"object","properties":{"enable":{"oneOf":[{"type":"boolean","description":"Whether to enable the connection manager for automatic connection handling. If true, we will provide a tool your agent can use to initiate connections to toolkits if it doesnt exist. If set to false, then you have to manage connections manually.","example":true,"uniqueKey":"manage_connections.oneOf.0.enable.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Whether to enable the connection manager for automatic connection handling. If true, we will provide a tool your agent can use to initiate connections to toolkits if it doesnt exist. If set to false, then you have to manage connections manually.","example":true,"uniqueKey":"manage_connections.oneOf.0.enable.oneOf.1","typeLabel":"null"}],"uniqueKey":"manage_connections.oneOf.0.enable","typeLabel":"boolean | null"},"callback_url":{"type":"string","format":"uri","description":"The URL to redirect to after a user completes authentication for a connected account. This allows you to handle the auth callback in your own application.","example":"https://your-app.com/auth/callback","uniqueKey":"manage_connections.oneOf.0.callback_url","typeLabel":"string\u003curi>"},"enable_wait_for_connections":{"oneOf":[{"type":"boolean","description":"When true, the COMPOSIO_WAIT_FOR_CONNECTIONS tool is available for agents to poll connection status after sharing auth URLs. Default is false (disabled). May not work reliably with GPT models.","example":false,"uniqueKey":"manage_connections.oneOf.0.enable_wait_for_connections.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"When true, the COMPOSIO_WAIT_FOR_CONNECTIONS tool is available for agents to poll connection status after sharing auth URLs. Default is false (disabled). May not work reliably with GPT models.","example":false,"uniqueKey":"manage_connections.oneOf.0.enable_wait_for_connections.oneOf.1","typeLabel":"null"}],"uniqueKey":"manage_connections.oneOf.0.enable_wait_for_connections","typeLabel":"boolean | null"},"enable_connection_removal":{"oneOf":[{"type":"boolean","description":"Enable the \"remove\" action in COMPOSIO_MANAGE_CONNECTIONS to allow deleting connected accounts. Default true.","uniqueKey":"manage_connections.oneOf.0.enable_connection_removal.oneOf.0","typeLabel":"boolean"},{"type":"null","description":"Enable the \"remove\" action in COMPOSIO_MANAGE_CONNECTIONS to allow deleting connected accounts. Default true.","uniqueKey":"manage_connections.oneOf.0.enable_connection_removal.oneOf.1","typeLabel":"null"}],"uniqueKey":"manage_connections.oneOf.0.enable_connection_removal","typeLabel":"boolean | null"}},"additionalProperties":false,"uniqueKey":"manage_connections.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"enable":{"oneOf":[{"type":"boolean","description":"Whether to enable the connection manager for automatic connection handling. If true, we will provide a tool your agent can use to initiate connections to toolkits if it doesnt exist. If set to false, then you have to manage connections manually.","example":true},{"type":"null","description":"Whether to enable the connection manager for automatic connection handling. If true, we will provide a tool your agent can use to initiate connections to toolkits if it doesnt exist. If set to false, then you have to manage connections manually.","example":true}]},"callback_url":{"type":"string","format":"uri","description":"The URL to redirect to after a user completes authentication for a connected account. This allows you to handle the auth callback in your own application.","example":"https://your-app.com/auth/callback"},"enable_wait_for_connections":{"oneOf":[{"type":"boolean","description":"When true, the COMPOSIO_WAIT_FOR_CONNECTIONS tool is available for agents to poll connection status after sharing auth URLs. Default is false (disabled). May not work reliably with GPT models.","example":false},{"type":"null","description":"When true, the COMPOSIO_WAIT_FOR_CONNECTIONS tool is available for agents to poll connection status after sharing auth URLs. Default is false (disabled). May not work reliably with GPT models.","example":false}]},"enable_connection_removal":{"oneOf":[{"type":"boolean","description":"Enable the \"remove\" action in COMPOSIO_MANAGE_CONNECTIONS to allow deleting connected accounts. Default true."},{"type":"null","description":"Enable the \"remove\" action in COMPOSIO_MANAGE_CONNECTIONS to allow deleting connected accounts. Default true."}]}},"additionalProperties":false,"uniqueKey":"manage_connections.oneOf.1","typeLabel":"null"}],"uniqueKey":"manage_connections","typeLabel":"object | null"},"tools":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["enable"],"properties":{"enable":{"type":"array","items":{"type":"string","uniqueKey":"tools.additionalProperties.oneOf.0.enable.items.[INDEX]","typeLabel":"string"},"description":"Only these specific tools will be available for this toolkit","example":["GMAIL_SEND_EMAIL","GMAIL_FETCH_EMAILS"],"isRequired":true,"uniqueKey":"tools.additionalProperties.oneOf.0.enable","typeLabel":"string[]"},"require_approval":{"type":"array","items":{"type":"string","uniqueKey":"tools.additionalProperties.oneOf.0.require_approval.items.[INDEX]","typeLabel":"string"},"description":"Tool calls matched here pause until the user approves them. Setting this toolkit's own list, even an empty one, replaces the session-wide `tags.require_approval` for its tools.","x-experimental":true,"example":["GITHUB_DELETE_A_REPOSITORY"],"uniqueKey":"tools.additionalProperties.oneOf.0.require_approval","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"tools.additionalProperties.oneOf.0","typeLabel":"object"},{"type":"object","required":["disable"],"properties":{"disable":{"type":"array","items":{"type":"string","uniqueKey":"tools.additionalProperties.oneOf.1.disable.items.[INDEX]","typeLabel":"string"},"description":"These specific tools will be disabled for this toolkit","example":["SLACK_ADD_EMOJI"],"isRequired":true,"uniqueKey":"tools.additionalProperties.oneOf.1.disable","typeLabel":"string[]"},"require_approval":{"type":"array","items":{"type":"string","uniqueKey":"tools.additionalProperties.oneOf.1.require_approval.items.[INDEX]","typeLabel":"string"},"description":"Tool calls matched here pause until the user approves them. Setting this toolkit's own list, even an empty one, replaces the session-wide `tags.require_approval` for its tools.","x-experimental":true,"example":["GITHUB_DELETE_A_REPOSITORY"],"uniqueKey":"tools.additionalProperties.oneOf.1.require_approval","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"tools.additionalProperties.oneOf.1","typeLabel":"object"},{"type":"object","required":["tags"],"properties":{"tags":{"oneOf":[{"type":"array","items":{"type":"string","enum":["readOnlyHint","createHint","updateHint","destructiveHint","idempotentHint","openWorldHint"],"uniqueKey":"tools.additionalProperties.oneOf.2.tags.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Tags for this toolkit. Any `tags` object here fully replaces the session-wide `tags` for this toolkit, including one that only sets `require_approval`. Array format is treated as an enabled list.","example":{"disable":["openWorldHint"],"require_approval":["destructiveHint"]},"isRequired":true,"uniqueKey":"tools.additionalProperties.oneOf.2.tags.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"object","description":"Tags for this toolkit. Any `tags` object here fully replaces the session-wide `tags` for this toolkit, including one that only sets `require_approval`. Array format is treated as an enabled list.","example":{"disable":["openWorldHint"],"require_approval":["destructiveHint"]},"properties":{"enable":{"type":"array","items":{"type":"string","enum":["readOnlyHint","createHint","updateHint","destructiveHint","idempotentHint","openWorldHint"],"uniqueKey":"tools.additionalProperties.oneOf.2.tags.oneOf.1.enable.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"tools.additionalProperties.oneOf.2.tags.oneOf.1.enable","typeLabel":"enum\u003cstring>[]"},"disable":{"type":"array","items":{"type":"string","enum":["readOnlyHint","createHint","updateHint","destructiveHint","idempotentHint","openWorldHint"],"uniqueKey":"tools.additionalProperties.oneOf.2.tags.oneOf.1.disable.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"tools.additionalProperties.oneOf.2.tags.oneOf.1.disable","typeLabel":"enum\u003cstring>[]"},"require_approval":{"type":"array","items":{"type":"string","enum":["readOnlyHint","createHint","updateHint","destructiveHint","idempotentHint","openWorldHint"],"uniqueKey":"tools.additionalProperties.oneOf.2.tags.oneOf.1.require_approval.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Tool calls matched here pause until the user approves them. Setting this toolkit's own list, even an empty one, replaces the session-wide `tags.require_approval` for its tools.","x-experimental":true,"example":["destructiveHint"],"uniqueKey":"tools.additionalProperties.oneOf.2.tags.oneOf.1.require_approval","typeLabel":"enum\u003cstring>[]"}},"isRequired":true,"uniqueKey":"tools.additionalProperties.oneOf.2.tags.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"tools.additionalProperties.oneOf.2.tags","typeLabel":"enum\u003cstring>[] | object"},"require_approval":{"type":"array","items":{"type":"string","uniqueKey":"tools.additionalProperties.oneOf.2.require_approval.items.[INDEX]","typeLabel":"string"},"description":"Tool calls matched here pause until the user approves them. Setting this toolkit's own list, even an empty one, replaces the session-wide `tags.require_approval` for its tools.","x-experimental":true,"example":["GITHUB_DELETE_A_REPOSITORY"],"uniqueKey":"tools.additionalProperties.oneOf.2.require_approval","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"tools.additionalProperties.oneOf.2","typeLabel":"object"},{"type":"object","required":["require_approval"],"properties":{"require_approval":{"type":"array","items":{"type":"string","uniqueKey":"tools.additionalProperties.oneOf.3.require_approval.items.[INDEX]","typeLabel":"string"},"description":"Tool calls matched here pause until the user approves them. Setting this toolkit's own list, even an empty one, replaces the session-wide `tags.require_approval` for its tools.","x-experimental":true,"example":["GITHUB_DELETE_A_REPOSITORY"],"isRequired":true,"uniqueKey":"tools.additionalProperties.oneOf.3.require_approval","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"tools.additionalProperties.oneOf.3","typeLabel":"object"}],"uniqueKey":"tools.additionalProperties","typeLabel":"object"},"description":"Tool-level configuration per toolkit. Allows you to enable, disable, or filter by tags for specific tools within each toolkit, and experimentally to list tools that need approval. Every tool slug must be a valid Composio tool slug for that toolkit — invalid or typo'd slugs fail session creation with a clear error listing which ones didn't match.","uniqueKey":"tools","typeLabel":"object"},"tags":{"oneOf":[{"type":"array","items":{"type":"string","enum":["readOnlyHint","createHint","updateHint","destructiveHint","idempotentHint","openWorldHint"],"uniqueKey":"tags.oneOf.0.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Session-wide tags for filtering tools. Array format is treated as an enabled list. Object format supports `enable` (a tool must have at least one) and `disable` (a tool must have none), and experimentally the tags whose tools need approval. If a toolkit sets `tools.\u003ctoolkit>.tags`, its tools use that object instead of this one.","example":{"disable":["openWorldHint"],"require_approval":["destructiveHint"]},"uniqueKey":"tags.oneOf.0","typeLabel":"enum\u003cstring>[]"},{"type":"object","description":"Session-wide tags for filtering tools. Array format is treated as an enabled list. Object format supports `enable` (a tool must have at least one) and `disable` (a tool must have none), and experimentally the tags whose tools need approval. If a toolkit sets `tools.\u003ctoolkit>.tags`, its tools use that object instead of this one.","example":{"disable":["openWorldHint"],"require_approval":["destructiveHint"]},"properties":{"enable":{"type":"array","items":{"type":"string","enum":["readOnlyHint","createHint","updateHint","destructiveHint","idempotentHint","openWorldHint"],"uniqueKey":"tags.oneOf.1.enable.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"tags.oneOf.1.enable","typeLabel":"enum\u003cstring>[]"},"disable":{"type":"array","items":{"type":"string","enum":["readOnlyHint","createHint","updateHint","destructiveHint","idempotentHint","openWorldHint"],"uniqueKey":"tags.oneOf.1.disable.items.[INDEX]","typeLabel":"enum\u003cstring>"},"uniqueKey":"tags.oneOf.1.disable","typeLabel":"enum\u003cstring>[]"},"require_approval":{"type":"array","items":{"type":"string","enum":["readOnlyHint","createHint","updateHint","destructiveHint","idempotentHint","openWorldHint"],"uniqueKey":"tags.oneOf.1.require_approval.items.[INDEX]","typeLabel":"enum\u003cstring>"},"minItems":1,"description":"Tool calls matched here pause until the user approves them. A tool needs approval if its toolkit, the tool itself or any of its tags is listed. A toolkit's own lists in `tools` replace the session-wide tag list for that toolkit.","x-experimental":true,"example":["destructiveHint"],"uniqueKey":"tags.oneOf.1.require_approval","typeLabel":"enum\u003cstring>[]"}},"uniqueKey":"tags.oneOf.1","typeLabel":"object"}],"uniqueKey":"tags","typeLabel":"enum\u003cstring>[] | object"},"workbench":{"oneOf":[{"type":"object","properties":{"enable":{"type":"boolean","description":"Set to false to disable the workbench entirely. When disabled, no code execution tools are available in the session.","example":true,"uniqueKey":"workbench.oneOf.0.enable","typeLabel":"boolean"},"enable_tool_execution":{"type":"boolean","description":"Whether Composio tool execution is enabled inside the workbench. Defaults to true. When false, run_composio_tool, invoke_llm, and web_search are unavailable; Python analysis and file helpers remain available. Proxy execution defaults to true and still permits authenticated connected-app HTTP requests. Set enable_proxy_execution to false as well to block both Composio tool and proxy access through Workbench credentials. These flags do not restrict network access or independently supplied credentials. Changing this flag recreates the sandbox: notebook state and local files are lost, but /mnt/files/ persists. Tool descriptions and search guidance reflect the updated flag, but assistive_prompt is returned only at session creation and is not regenerated by PATCH; callers must update any previously retained prompt guidance.","uniqueKey":"workbench.oneOf.0.enable_tool_execution","typeLabel":"boolean"},"enable_proxy_execution":{"type":"boolean","description":"Whether proxy execution is enabled. When enabled, workbench can call URLs and APIs directly.","example":true,"uniqueKey":"workbench.oneOf.0.enable_proxy_execution","typeLabel":"boolean"},"auto_offload_threshold":{"type":"number","description":"Character threshold for automatic offloading. When workbench response exceeds this threshold, it will be automatically offloaded. Default is picked automatically based on the response size.","example":20000,"exclusiveMinimum":0,"uniqueKey":"workbench.oneOf.0.auto_offload_threshold","typeLabel":"number"},"sandbox_size":{"type":"string","enum":["standard","medium","large","xlarge"],"description":"Sandbox compute tier: standard (1 vCPU / 1 GB), medium (2 vCPU / 2 GB), large (4 vCPU / 4 GB), xlarge (8 vCPU / 8 GB). Patching this value recreates the sandbox on next access — sandbox FS state is lost, but /mnt/files/ R2 mount persists.","example":"large","uniqueKey":"workbench.oneOf.0.sandbox_size","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"uniqueKey":"workbench.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"enable":{"type":"boolean","description":"Set to false to disable the workbench entirely. When disabled, no code execution tools are available in the session.","example":true},"enable_tool_execution":{"type":"boolean","description":"Whether Composio tool execution is enabled inside the workbench. Defaults to true. When false, run_composio_tool, invoke_llm, and web_search are unavailable; Python analysis and file helpers remain available. Proxy execution defaults to true and still permits authenticated connected-app HTTP requests. Set enable_proxy_execution to false as well to block both Composio tool and proxy access through Workbench credentials. These flags do not restrict network access or independently supplied credentials. Changing this flag recreates the sandbox: notebook state and local files are lost, but /mnt/files/ persists. Tool descriptions and search guidance reflect the updated flag, but assistive_prompt is returned only at session creation and is not regenerated by PATCH; callers must update any previously retained prompt guidance."},"enable_proxy_execution":{"type":"boolean","description":"Whether proxy execution is enabled. When enabled, workbench can call URLs and APIs directly.","example":true},"auto_offload_threshold":{"type":"number","description":"Character threshold for automatic offloading. When workbench response exceeds this threshold, it will be automatically offloaded. Default is picked automatically based on the response size.","example":20000,"exclusiveMinimum":0},"sandbox_size":{"type":"string","enum":["standard","medium","large","xlarge"],"description":"Sandbox compute tier: standard (1 vCPU / 1 GB), medium (2 vCPU / 2 GB), large (4 vCPU / 4 GB), xlarge (8 vCPU / 8 GB). Patching this value recreates the sandbox on next access — sandbox FS state is lost, but /mnt/files/ R2 mount persists.","example":"large"}},"additionalProperties":false,"uniqueKey":"workbench.oneOf.1","typeLabel":"null"}],"uniqueKey":"workbench","typeLabel":"object | null"},"multi_account":{"oneOf":[{"type":"object","properties":{"enable":{"type":"boolean","description":"When true, enables multi-account mode for this session. When not set, falls back to org/project-level configuration.","example":true,"uniqueKey":"multi_account.oneOf.0.enable","typeLabel":"boolean"},"max_accounts_per_toolkit":{"type":"integer","minimum":2,"maximum":10,"description":"Maximum number of connected accounts allowed per toolkit. Must be between 2 and 10.","example":5,"uniqueKey":"multi_account.oneOf.0.max_accounts_per_toolkit","typeLabel":"integer"},"require_explicit_selection":{"type":"boolean","description":"When true, the agent must explicitly select which account to use. When false (default), the first/default account is used automatically.","example":false,"uniqueKey":"multi_account.oneOf.0.require_explicit_selection","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"multi_account.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"enable":{"type":"boolean","description":"When true, enables multi-account mode for this session. When not set, falls back to org/project-level configuration.","example":true},"max_accounts_per_toolkit":{"type":"integer","minimum":2,"maximum":10,"description":"Maximum number of connected accounts allowed per toolkit. Must be between 2 and 10.","example":5},"require_explicit_selection":{"type":"boolean","description":"When true, the agent must explicitly select which account to use. When false (default), the first/default account is used automatically.","example":false}},"additionalProperties":false,"uniqueKey":"multi_account.oneOf.1","typeLabel":"null"}],"uniqueKey":"multi_account","typeLabel":"object | null"},"proxy_execute":{"oneOf":[{"type":"object","properties":{"enable":{"type":"boolean","description":"When true, the agent can make authenticated HTTP requests to connected app APIs outside the workbench. When false, proxy execution is also disabled inside the workbench, regardless of workbench.enable_proxy_execution. When not set, proxy execute is disabled outside the workbench.","example":true,"isRequired":true,"uniqueKey":"proxy_execute.oneOf.0.enable","typeLabel":"boolean"}},"required":["enable"],"additionalProperties":false,"uniqueKey":"proxy_execute.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"enable":{"type":"boolean","description":"When true, the agent can make authenticated HTTP requests to connected app APIs outside the workbench. When false, proxy execution is also disabled inside the workbench, regardless of workbench.enable_proxy_execution. When not set, proxy execute is disabled outside the workbench.","example":true}},"required":["enable"],"additionalProperties":false,"uniqueKey":"proxy_execute.oneOf.1","typeLabel":"null"}],"uniqueKey":"proxy_execute","typeLabel":"object | null"},"preload":{"type":"object","properties":{"tools":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"preload.tools.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Explicit tool slugs to preload, or \"all\" to dynamically expose all current and future app tools allowed by the positive session filters. \"all\" is capped at 1000 tools and is not supported without a positive allowlist.","example":"all","uniqueKey":"preload.tools.oneOf.0","typeLabel":"string[]"},{"type":"string","description":"Explicit tool slugs to preload, or \"all\" to dynamically expose all current and future app tools allowed by the positive session filters. \"all\" is capped at 1000 tools and is not supported without a positive allowlist.","example":"all","uniqueKey":"preload.tools.oneOf.1","typeLabel":"string"}],"uniqueKey":"preload.tools","typeLabel":"string[] | string"}},"additionalProperties":false,"description":"Preload configuration. Use an explicit list for frequently used tool slugs, or \"all\" to dynamically expose every app tool allowed by positive toolkits/tools/tags filters.","uniqueKey":"preload","typeLabel":"object"},"search":{"type":"object","properties":{"enable":{"type":"boolean","default":true,"uniqueKey":"search.enable","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"search","typeLabel":"object"},"execute":{"type":"object","properties":{"enable_multi_execute":{"type":"boolean","default":true,"uniqueKey":"execute.enable_multi_execute","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"execute","typeLabel":"object"},"hooks":{"oneOf":[{"type":"array","items":{"oneOf":[{"type":"object","required":["type","id","applies_to","handler"],"properties":{"type":{"type":"string","enum":["before_execute"],"isRequired":true,"uniqueKey":"hooks.oneOf.0.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","pattern":"^[a-z0-9_-]{1,64}$","description":"Unique within the session. Shows up in results and logs.","isRequired":true,"uniqueKey":"hooks.oneOf.0.items.[INDEX].oneOf.0.id","typeLabel":"string"},"applies_to":{"oneOf":[{"type":"string","description":"Which tools the hook covers: \"all\" for all of them, or only the listed toolkits.","enum":["all"],"isRequired":true,"uniqueKey":"hooks.oneOf.0.items.[INDEX].oneOf.0.applies_to.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"object","description":"Which tools the hook covers: \"all\" for all of them, or only the listed toolkits.","required":["toolkits"],"properties":{"toolkits":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"hooks.oneOf.0.items.[INDEX].oneOf.0.applies_to.oneOf.1.toolkits.items.[INDEX]","typeLabel":"string"},"minItems":1,"description":"Toolkit slugs","isRequired":true,"uniqueKey":"hooks.oneOf.0.items.[INDEX].oneOf.0.applies_to.oneOf.1.toolkits","typeLabel":"string[]"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"hooks.oneOf.0.items.[INDEX].oneOf.0.applies_to.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"hooks.oneOf.0.items.[INDEX].oneOf.0.applies_to","typeLabel":"enum\u003cstring> | object"},"handler":{"type":"object","properties":{"type":{"type":"string","enum":["condition_check"],"isRequired":true,"uniqueKey":"hooks.oneOf.0.items.[INDEX].oneOf.0.handler.type","typeLabel":"enum\u003cstring>"},"condition":{"type":"string","minLength":1,"maxLength":2000,"description":"What to block, written as a plain sentence. For example: \"Sending email to anyone outside example.org\".","isRequired":true,"uniqueKey":"hooks.oneOf.0.items.[INDEX].oneOf.0.handler.condition","typeLabel":"string"},"action":{"type":"string","enum":["block"],"isRequired":true,"uniqueKey":"hooks.oneOf.0.items.[INDEX].oneOf.0.handler.action","typeLabel":"enum\u003cstring>"}},"required":["type","condition","action"],"additionalProperties":false,"isRequired":true,"uniqueKey":"hooks.oneOf.0.items.[INDEX].oneOf.0.handler","typeLabel":"object"},"name":{"type":"string","minLength":1,"maxLength":120,"description":"A readable name. The agent sees it when this hook blocks a call.","uniqueKey":"hooks.oneOf.0.items.[INDEX].oneOf.0.name","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"hooks.oneOf.0.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["type","id","applies_to","handler"],"properties":{"type":{"type":"string","enum":["after_execute"],"isRequired":true,"uniqueKey":"hooks.oneOf.0.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","pattern":"^[a-z0-9_-]{1,64}$","description":"Unique within the session. Shows up in results and logs.","isRequired":true,"uniqueKey":"hooks.oneOf.0.items.[INDEX].oneOf.1.id","typeLabel":"string"},"applies_to":{"oneOf":[{"type":"string","description":"Which tools the hook covers: \"all\" for all of them, or only the listed toolkits.","enum":["all"],"isRequired":true,"uniqueKey":"hooks.oneOf.0.items.[INDEX].oneOf.1.applies_to.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"object","description":"Which tools the hook covers: \"all\" for all of them, or only the listed toolkits.","required":["toolkits"],"properties":{"toolkits":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"hooks.oneOf.0.items.[INDEX].oneOf.1.applies_to.oneOf.1.toolkits.items.[INDEX]","typeLabel":"string"},"minItems":1,"description":"Toolkit slugs","isRequired":true,"uniqueKey":"hooks.oneOf.0.items.[INDEX].oneOf.1.applies_to.oneOf.1.toolkits","typeLabel":"string[]"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"hooks.oneOf.0.items.[INDEX].oneOf.1.applies_to.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"hooks.oneOf.0.items.[INDEX].oneOf.1.applies_to","typeLabel":"enum\u003cstring> | object"},"handler":{"oneOf":[{"type":"object","required":["type","condition","action"],"properties":{"type":{"type":"string","enum":["condition_check"],"isRequired":true,"uniqueKey":"hooks.oneOf.0.items.[INDEX].oneOf.1.handler.oneOf.0.type","typeLabel":"enum\u003cstring>"},"condition":{"type":"string","minLength":1,"maxLength":2000,"description":"What to block, written as a plain sentence. For example: \"Sending email to anyone outside example.org\".","isRequired":true,"uniqueKey":"hooks.oneOf.0.items.[INDEX].oneOf.1.handler.oneOf.0.condition","typeLabel":"string"},"action":{"type":"string","enum":["block"],"isRequired":true,"uniqueKey":"hooks.oneOf.0.items.[INDEX].oneOf.1.handler.oneOf.0.action","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"hooks.oneOf.0.items.[INDEX].oneOf.1.handler.oneOf.0","typeLabel":"object"},{"type":"object","description":"Blocks a tool response that tries to manipulate the agent: override its instructions, change its role, or make it take actions the user didn't ask for.","required":["type","action"],"properties":{"type":{"type":"string","enum":["prompt_injection_check"],"isRequired":true,"uniqueKey":"hooks.oneOf.0.items.[INDEX].oneOf.1.handler.oneOf.1.type","typeLabel":"enum\u003cstring>"},"action":{"type":"string","enum":["block"],"isRequired":true,"uniqueKey":"hooks.oneOf.0.items.[INDEX].oneOf.1.handler.oneOf.1.action","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"hooks.oneOf.0.items.[INDEX].oneOf.1.handler.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"hooks.oneOf.0.items.[INDEX].oneOf.1.handler","typeLabel":"object"},"name":{"type":"string","minLength":1,"maxLength":120,"description":"A readable name. The agent sees it when this hook blocks a call.","uniqueKey":"hooks.oneOf.0.items.[INDEX].oneOf.1.name","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"hooks.oneOf.0.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"hooks.oneOf.0.items.[INDEX]","typeLabel":"object"},"maxItems":20,"description":"Hooks that run on this session's tool calls. A hook can block a call before it runs, or block its result before the agent sees it.","uniqueKey":"hooks.oneOf.0","typeLabel":"object[]"},{"type":"null","items":{"oneOf":[{"type":"object","required":["type","id","applies_to","handler"],"properties":{"type":{"type":"string","enum":["before_execute"]},"id":{"type":"string","pattern":"^[a-z0-9_-]{1,64}$","description":"Unique within the session. Shows up in results and logs."},"name":{"type":"string","minLength":1,"maxLength":120,"description":"A readable name. The agent sees it when this hook blocks a call."},"applies_to":{"oneOf":[{"type":"string","description":"Which tools the hook covers: \"all\" for all of them, or only the listed toolkits.","enum":["all"]},{"type":"object","description":"Which tools the hook covers: \"all\" for all of them, or only the listed toolkits.","required":["toolkits"],"properties":{"toolkits":{"type":"array","items":{"type":"string","minLength":1},"minItems":1,"description":"Toolkit slugs"}},"additionalProperties":false}]},"handler":{"type":"object","properties":{"type":{"type":"string","enum":["condition_check"]},"condition":{"type":"string","minLength":1,"maxLength":2000,"description":"What to block, written as a plain sentence. For example: \"Sending email to anyone outside example.org\"."},"action":{"type":"string","enum":["block"]}},"required":["type","condition","action"],"additionalProperties":false}},"additionalProperties":false},{"type":"object","required":["type","id","applies_to","handler"],"properties":{"type":{"type":"string","enum":["after_execute"]},"id":{"type":"string","pattern":"^[a-z0-9_-]{1,64}$","description":"Unique within the session. Shows up in results and logs."},"name":{"type":"string","minLength":1,"maxLength":120,"description":"A readable name. The agent sees it when this hook blocks a call."},"applies_to":{"oneOf":[{"type":"string","description":"Which tools the hook covers: \"all\" for all of them, or only the listed toolkits.","enum":["all"]},{"type":"object","description":"Which tools the hook covers: \"all\" for all of them, or only the listed toolkits.","required":["toolkits"],"properties":{"toolkits":{"type":"array","items":{"type":"string","minLength":1},"minItems":1,"description":"Toolkit slugs"}},"additionalProperties":false}]},"handler":{"oneOf":[{"type":"object","required":["type","condition","action"],"properties":{"type":{"type":"string","enum":["condition_check"]},"condition":{"type":"string","minLength":1,"maxLength":2000,"description":"What to block, written as a plain sentence. For example: \"Sending email to anyone outside example.org\"."},"action":{"type":"string","enum":["block"]}},"additionalProperties":false},{"type":"object","description":"Blocks a tool response that tries to manipulate the agent: override its instructions, change its role, or make it take actions the user didn't ask for.","required":["type","action"],"properties":{"type":{"type":"string","enum":["prompt_injection_check"]},"action":{"type":"string","enum":["block"]}},"additionalProperties":false}]}},"additionalProperties":false}]},"maxItems":20,"description":"Hooks that run on this session's tool calls. A hook can block a call before it runs, or block its result before the agent sees it.","uniqueKey":"hooks.oneOf.1","typeLabel":"null"}],"uniqueKey":"hooks","typeLabel":"object[] | null"},"experimental":{"oneOf":[{"type":"object","properties":{"permissions":{"type":"object","properties":{"default":{"type":"string","enum":["allow_all","ask_every_call","ask_once_per_session"],"description":"Default elicitation behavior when no override matches. `allow_all` runs every tool without prompting; `ask_every_call` prompts on each invocation; `ask_once_per_session` prompts once and remembers the answer for the rest of the session.","isRequired":true,"uniqueKey":"experimental.oneOf.0.permissions.default","typeLabel":"enum\u003cstring>"},"overrides":{"type":"object","additionalProperties":{"type":"string","enum":["always_allow","always_deny","ask_once","ask_always"],"uniqueKey":"experimental.oneOf.0.permissions.overrides.additionalProperties","typeLabel":"enum\u003cstring>"},"description":"Per-tool overrides keyed by `${toolSlug}:${connectedAccountId ?? \"__none__\"}`, plus account-wide overrides keyed by `*:${connectedAccountId ?? \"__none__\"}`. Exact tool overrides take precedence over account-wide overrides. `always_allow` skips the prompt and runs the tool; `always_deny` blocks the tool; `ask_once` prompts once per session (allow/deny) and remembers; `ask_always` prompts on every call with allow-once/allow-session/deny, ignoring any cached session allow. Overrides take precedence over `default`.","uniqueKey":"experimental.oneOf.0.permissions.overrides","typeLabel":"object"}},"required":["default"],"description":"Per-tool elicitation permission config. Replaces the stored block when provided.","uniqueKey":"experimental.oneOf.0.permissions","typeLabel":"object"},"link_url_overwrite":{"type":"string","format":"uri","description":"Experimental base URL override for connection link redirects created from this tool-router session. When set, link creation returns `${link_url_overwrite}/link/{link_token}` instead of the default Composio Connect base URL. Use only when your integration needs links to open through a custom Connect host.","x-experimental":true,"uniqueKey":"experimental.oneOf.0.link_url_overwrite","typeLabel":"string\u003curi>"},"fast_mode":{"type":"boolean","description":"Fast mode reduces search latency. It is experimental, so tool search quality may be affected.","x-experimental":true,"uniqueKey":"experimental.oneOf.0.fast_mode","typeLabel":"boolean"},"submit_feedback":{"type":"object","properties":{"enable":{"type":"boolean","description":"Set to true to expose the COMPOSIO_SUBMIT_FEEDBACK helper tool in this session, false to hide it.","isRequired":true,"uniqueKey":"experimental.oneOf.0.submit_feedback.enable","typeLabel":"boolean"}},"required":["enable"],"additionalProperties":false,"description":"Exposes the COMPOSIO_SUBMIT_FEEDBACK helper tool in this session so the agent can report tool executions with empty, incorrect, or failed results. Replaces the stored block when provided; `enable` is required when the block is sent.","x-experimental":true,"uniqueKey":"experimental.oneOf.0.submit_feedback","typeLabel":"object"},"no_elicitation_support_fallback":{"type":"string","enum":["deny","allow"],"description":"What session MCP does with a tool call that needs approval when the MCP client can't ask the user. deny (default) rejects the call; allow runs it without approval.","x-experimental":true,"uniqueKey":"experimental.oneOf.0.no_elicitation_support_fallback","typeLabel":"enum\u003cstring>"},"session_config_id":{"type":"string","format":"sessionConfigId","description":"Apply the latest active Session config from this project to this Session. Replaces toolkit, tool, and tag access; preserves other settings. Cannot be combined with inline toolkits, tools, or tags. Later config edits do not update this Session automatically.","x-experimental":true,"uniqueKey":"experimental.oneOf.0.session_config_id","typeLabel":"string\u003csessionConfigId>"}},"additionalProperties":false,"x-experimental":true,"uniqueKey":"experimental.oneOf.0","typeLabel":"object"},{"type":"null","properties":{"permissions":{"type":"object","properties":{"default":{"type":"string","enum":["allow_all","ask_every_call","ask_once_per_session"],"description":"Default elicitation behavior when no override matches. `allow_all` runs every tool without prompting; `ask_every_call` prompts on each invocation; `ask_once_per_session` prompts once and remembers the answer for the rest of the session."},"overrides":{"type":"object","additionalProperties":{"type":"string","enum":["always_allow","always_deny","ask_once","ask_always"]},"description":"Per-tool overrides keyed by `${toolSlug}:${connectedAccountId ?? \"__none__\"}`, plus account-wide overrides keyed by `*:${connectedAccountId ?? \"__none__\"}`. Exact tool overrides take precedence over account-wide overrides. `always_allow` skips the prompt and runs the tool; `always_deny` blocks the tool; `ask_once` prompts once per session (allow/deny) and remembers; `ask_always` prompts on every call with allow-once/allow-session/deny, ignoring any cached session allow. Overrides take precedence over `default`."}},"required":["default"],"description":"Per-tool elicitation permission config. Replaces the stored block when provided."},"link_url_overwrite":{"type":"string","format":"uri","description":"Experimental base URL override for connection link redirects created from this tool-router session. When set, link creation returns `${link_url_overwrite}/link/{link_token}` instead of the default Composio Connect base URL. Use only when your integration needs links to open through a custom Connect host.","x-experimental":true},"fast_mode":{"type":"boolean","description":"Fast mode reduces search latency. It is experimental, so tool search quality may be affected.","x-experimental":true},"submit_feedback":{"type":"object","properties":{"enable":{"type":"boolean","description":"Set to true to expose the COMPOSIO_SUBMIT_FEEDBACK helper tool in this session, false to hide it."}},"required":["enable"],"additionalProperties":false,"description":"Exposes the COMPOSIO_SUBMIT_FEEDBACK helper tool in this session so the agent can report tool executions with empty, incorrect, or failed results. Replaces the stored block when provided; `enable` is required when the block is sent.","x-experimental":true},"no_elicitation_support_fallback":{"type":"string","enum":["deny","allow"],"description":"What session MCP does with a tool call that needs approval when the MCP client can't ask the user. deny (default) rejects the call; allow runs it without approval.","x-experimental":true},"session_config_id":{"type":"string","format":"sessionConfigId","description":"Apply the latest active Session config from this project to this Session. Replaces toolkit, tool, and tag access; preserves other settings. Cannot be combined with inline toolkits, tools, or tags. Later config edits do not update this Session automatically.","x-experimental":true}},"additionalProperties":false,"x-experimental":true,"uniqueKey":"experimental.oneOf.1","typeLabel":"null"}],"uniqueKey":"experimental","typeLabel":"object | null"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"toolkits":{"enable":["gmail","slack","github"],"require_approval":["github"]},"auth_configs":{"gmail":"ac_1a2b3c4d5e6f","slack":"ac_7g8h9i0j1k2l"},"connected_accounts":{},"instant":false,"manage_connections":{"enable":true,"callback_url":"https://your-app.com/auth/callback","enable_wait_for_connections":false,"enable_connection_removal":true},"tools":{},"tags":{"disable":["openWorldHint"],"require_approval":["destructiveHint"]},"workbench":{"enable":true,"enable_tool_execution":true,"enable_proxy_execution":true,"auto_offload_threshold":20000,"sandbox_size":"large"},"multi_account":{"enable":true,"max_accounts_per_toolkit":5,"require_explicit_selection":false},"proxy_execute":{"enable":true},"preload":{"tools":"all"},"search":{"enable":true},"execute":{"enable_multi_execute":true},"hooks":[{"type":"before_execute","id":"\u003cstring>","applies_to":"all","handler":{"type":"condition_check","condition":"\u003cstring>","action":"block"},"name":"\u003cstring>"}],"experimental":{"link_url_overwrite":"\u003cstring>","fast_mode":true,"session_config_id":"\u003cstring>"}}}},"exampleType":"generated"}},"exampleType":"generated"},"responses":{"72ad9778-8f14-464b-8cfa-a200663390a7":{"description":"Session config successfully patched.","content":{"application/json":{"schema":{"type":"object","properties":{"session_id":{"type":"string","format":"toolRouterSessionId","description":"The identifier of the session","example":"trs_1a2b3c4d5e6f","isRequired":true,"uniqueKey":"session_id","typeLabel":"string\u003ctoolRouterSessionId>"},"mcp":{"type":"object","properties":{"type":{"type":"string","enum":["http"],"description":"The type of the MCP server. Can be http","isRequired":true,"uniqueKey":"mcp.type","typeLabel":"enum\u003cstring>"},"url":{"type":"string","format":"uri","description":"The URL of the MCP server","example":"https://app.composio.dev/tool_router/v3/trs_1a2b3c4d5e6f/mcp","isRequired":true,"uniqueKey":"mcp.url","typeLabel":"string\u003curi>"}},"required":["type","url"],"isRequired":true,"uniqueKey":"mcp","typeLabel":"object"},"tool_router_tools":{"type":"array","items":{"type":"string","uniqueKey":"tool_router_tools.items.[INDEX]","typeLabel":"string"},"description":"List of available tools in this session","isRequired":true,"uniqueKey":"tool_router_tools","typeLabel":"string[]"},"config":{"type":"object","properties":{"user_id":{"type":"string","description":"User identifier for this session","isRequired":true,"uniqueKey":"config.user_id","typeLabel":"string"},"instant":{"oneOf":[{"type":"boolean","description":"Instant usage settings. False disables instant usage; an object permits it subject to project permission and session toolkit and tool restrictions.","enum":[false],"isRequired":true,"uniqueKey":"config.instant.oneOf.0","typeLabel":"enum\u003cboolean>"},{"type":"object","description":"Instant usage settings. False disables instant usage; an object permits it subject to project permission and session toolkit and tool restrictions.","required":["return_instant_charge","return_prices_in_search"],"properties":{"return_instant_charge":{"type":"boolean","description":"Whether session tool responses return a top-level instant_charge when a charge is available. Defaults to false; controls response visibility only.","isRequired":true,"uniqueKey":"config.instant.oneOf.1.return_instant_charge","typeLabel":"boolean"},"return_prices_in_search":{"type":"boolean","description":"Experimental. Whether tool search results show each instant tool's price, under instant_account.prices. Defaults to false.","x-experimental":true,"isRequired":true,"uniqueKey":"config.instant.oneOf.1.return_prices_in_search","typeLabel":"boolean"},"toolkits":{"oneOf":[{"type":"object","description":"Toolkits eligible for instant usage, as an enabled or disabled list. If absent, no additional toolkit restriction applies.","required":["enabled"],"properties":{"enabled":{"type":"array","items":{"type":"string","uniqueKey":"config.instant.oneOf.1.toolkits.oneOf.0.enabled.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"config.instant.oneOf.1.toolkits.oneOf.0.enabled","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"config.instant.oneOf.1.toolkits.oneOf.0","typeLabel":"object"},{"type":"object","description":"Toolkits eligible for instant usage, as an enabled or disabled list. If absent, no additional toolkit restriction applies.","required":["disabled"],"properties":{"disabled":{"type":"array","items":{"type":"string","uniqueKey":"config.instant.oneOf.1.toolkits.oneOf.1.disabled.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"config.instant.oneOf.1.toolkits.oneOf.1.disabled","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"config.instant.oneOf.1.toolkits.oneOf.1","typeLabel":"object"}],"uniqueKey":"config.instant.oneOf.1.toolkits","typeLabel":"object"},"tools":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"array","items":{"type":"string","uniqueKey":"config.instant.oneOf.1.tools.additionalProperties.oneOf.0.enabled.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"config.instant.oneOf.1.tools.additionalProperties.oneOf.0.enabled","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"config.instant.oneOf.1.tools.additionalProperties.oneOf.0","typeLabel":"object"},{"type":"object","required":["disabled"],"properties":{"disabled":{"type":"array","items":{"type":"string","uniqueKey":"config.instant.oneOf.1.tools.additionalProperties.oneOf.1.disabled.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"config.instant.oneOf.1.tools.additionalProperties.oneOf.1.disabled","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"config.instant.oneOf.1.tools.additionalProperties.oneOf.1","typeLabel":"object"}],"uniqueKey":"config.instant.oneOf.1.tools.additionalProperties","typeLabel":"object"},"description":"Per-toolkit enabled or disabled lists that restrict instant usage. Toolkits absent from this map have no additional tool restriction.","uniqueKey":"config.instant.oneOf.1.tools","typeLabel":"object"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"config.instant.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"config.instant","typeLabel":"enum\u003cboolean> | object"},"preload":{"type":"object","properties":{"tools":{"oneOf":[{"type":"array","items":{"type":"string","uniqueKey":"config.preload.tools.oneOf.0.items.[INDEX]","typeLabel":"string"},"description":"Explicit preloaded tool slugs, or \"all\" when the session dynamically exposes all app tools allowed by its filters.","isRequired":true,"uniqueKey":"config.preload.tools.oneOf.0","typeLabel":"string[]"},{"type":"string","description":"Explicit preloaded tool slugs, or \"all\" when the session dynamically exposes all app tools allowed by its filters.","enum":["all"],"isRequired":true,"uniqueKey":"config.preload.tools.oneOf.1","typeLabel":"enum\u003cstring>"}],"isRequired":true,"uniqueKey":"config.preload.tools","typeLabel":"string[] | enum\u003cstring>"}},"required":["tools"],"additionalProperties":false,"description":"Preload configuration. Explicit slugs are returned as an array; dynamic preload is returned as \"all\".","isRequired":true,"uniqueKey":"config.preload","typeLabel":"object"},"search":{"type":"object","properties":{"enable":{"type":"boolean","default":true,"uniqueKey":"config.search.enable","typeLabel":"boolean"}},"description":"Search helper configuration","isRequired":true,"uniqueKey":"config.search","typeLabel":"object"},"execute":{"type":"object","properties":{"enable_multi_execute":{"type":"boolean","default":true,"uniqueKey":"config.execute.enable_multi_execute","typeLabel":"boolean"}},"description":"Execute helper configuration","isRequired":true,"uniqueKey":"config.execute","typeLabel":"object"},"toolkits":{"oneOf":[{"type":"object","description":"Toolkit configuration - either enabled list or disabled list, or toolkits whose tools need approval","required":["enabled"],"properties":{"enabled":{"type":"array","items":{"type":"string","uniqueKey":"config.toolkits.oneOf.0.enabled.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"config.toolkits.oneOf.0.enabled","typeLabel":"string[]"},"require_approval":{"type":"array","items":{"type":"string","uniqueKey":"config.toolkits.oneOf.0.require_approval.items.[INDEX]","typeLabel":"string"},"description":"Tool calls matched here pause until the user approves them.","x-experimental":true,"uniqueKey":"config.toolkits.oneOf.0.require_approval","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"config.toolkits.oneOf.0","typeLabel":"object"},{"type":"object","description":"Toolkit configuration - either enabled list or disabled list, or toolkits whose tools need approval","required":["disabled"],"properties":{"disabled":{"type":"array","items":{"type":"string","uniqueKey":"config.toolkits.oneOf.1.disabled.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"config.toolkits.oneOf.1.disabled","typeLabel":"string[]"},"require_approval":{"type":"array","items":{"type":"string","uniqueKey":"config.toolkits.oneOf.1.require_approval.items.[INDEX]","typeLabel":"string"},"description":"Tool calls matched here pause until the user approves them.","x-experimental":true,"uniqueKey":"config.toolkits.oneOf.1.require_approval","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"config.toolkits.oneOf.1","typeLabel":"object"},{"type":"object","description":"Toolkit configuration - either enabled list or disabled list, or toolkits whose tools need approval","required":["require_approval"],"properties":{"require_approval":{"type":"array","items":{"type":"string","uniqueKey":"config.toolkits.oneOf.2.require_approval.items.[INDEX]","typeLabel":"string"},"description":"Tool calls matched here pause until the user approves them.","x-experimental":true,"isRequired":true,"uniqueKey":"config.toolkits.oneOf.2.require_approval","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"config.toolkits.oneOf.2","typeLabel":"object"}],"uniqueKey":"config.toolkits","typeLabel":"object"},"auth_configs":{"type":"object","additionalProperties":{"type":"string","format":"authConfigId","uniqueKey":"config.auth_configs.additionalProperties","typeLabel":"string\u003cauthConfigId>"},"description":"Auth config overrides per toolkit","uniqueKey":"config.auth_configs","typeLabel":"object"},"manage_connections":{"type":"object","properties":{"enabled":{"type":"boolean","default":true,"description":"Whether to enable the connection manager for automatic connection handling","uniqueKey":"config.manage_connections.enabled","typeLabel":"boolean"},"callback_url":{"type":"string","format":"uri","description":"Custom callback URL for connected account auth flows","uniqueKey":"config.manage_connections.callback_url","typeLabel":"string\u003curi>"},"enable_wait_for_connections":{"type":"boolean","default":false,"description":"Enable the COMPOSIO_WAIT_FOR_CONNECTIONS tool for polling connection status. Default false. May not work reliably with GPT models.","uniqueKey":"config.manage_connections.enable_wait_for_connections","typeLabel":"boolean"},"enable_connection_removal":{"type":"boolean","default":true,"description":"Enable the \"remove\" action in COMPOSIO_MANAGE_CONNECTIONS. Default true.","uniqueKey":"config.manage_connections.enable_connection_removal","typeLabel":"boolean"}},"description":"Manage connections configuration","uniqueKey":"config.manage_connections","typeLabel":"object"},"tools":{"type":"object","additionalProperties":{"oneOf":[{"type":"object","required":["enabled"],"properties":{"enabled":{"type":"array","items":{"type":"string","uniqueKey":"config.tools.additionalProperties.oneOf.0.enabled.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"config.tools.additionalProperties.oneOf.0.enabled","typeLabel":"string[]"},"require_approval":{"type":"array","items":{"type":"string","uniqueKey":"config.tools.additionalProperties.oneOf.0.require_approval.items.[INDEX]","typeLabel":"string"},"description":"Tool calls matched here pause until the user approves them.","x-experimental":true,"uniqueKey":"config.tools.additionalProperties.oneOf.0.require_approval","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"config.tools.additionalProperties.oneOf.0","typeLabel":"object"},{"type":"object","required":["disabled"],"properties":{"disabled":{"type":"array","items":{"type":"string","uniqueKey":"config.tools.additionalProperties.oneOf.1.disabled.items.[INDEX]","typeLabel":"string"},"isRequired":true,"uniqueKey":"config.tools.additionalProperties.oneOf.1.disabled","typeLabel":"string[]"},"require_approval":{"type":"array","items":{"type":"string","uniqueKey":"config.tools.additionalProperties.oneOf.1.require_approval.items.[INDEX]","typeLabel":"string"},"description":"Tool calls matched here pause until the user approves them.","x-experimental":true,"uniqueKey":"config.tools.additionalProperties.oneOf.1.require_approval","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"config.tools.additionalProperties.oneOf.1","typeLabel":"object"},{"type":"object","required":["tags"],"properties":{"tags":{"type":"object","properties":{"enabled":{"type":"array","items":{"type":"string","enum":["readOnlyHint","createHint","updateHint","destructiveHint","idempotentHint","openWorldHint"],"uniqueKey":"config.tools.additionalProperties.oneOf.2.tags.enabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Tags that the tool must have at least one of","uniqueKey":"config.tools.additionalProperties.oneOf.2.tags.enabled","typeLabel":"enum\u003cstring>[]"},"disabled":{"type":"array","items":{"type":"string","enum":["readOnlyHint","createHint","updateHint","destructiveHint","idempotentHint","openWorldHint"],"uniqueKey":"config.tools.additionalProperties.oneOf.2.tags.disabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Tags that the tool must NOT have any of","uniqueKey":"config.tools.additionalProperties.oneOf.2.tags.disabled","typeLabel":"enum\u003cstring>[]"},"require_approval":{"type":"array","items":{"type":"string","enum":["readOnlyHint","createHint","updateHint","destructiveHint","idempotentHint","openWorldHint"],"uniqueKey":"config.tools.additionalProperties.oneOf.2.tags.require_approval.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Tool calls matched here pause until the user approves them.","x-experimental":true,"uniqueKey":"config.tools.additionalProperties.oneOf.2.tags.require_approval","typeLabel":"enum\u003cstring>[]"}},"isRequired":true,"uniqueKey":"config.tools.additionalProperties.oneOf.2.tags","typeLabel":"object"},"require_approval":{"type":"array","items":{"type":"string","uniqueKey":"config.tools.additionalProperties.oneOf.2.require_approval.items.[INDEX]","typeLabel":"string"},"description":"Tool calls matched here pause until the user approves them.","x-experimental":true,"uniqueKey":"config.tools.additionalProperties.oneOf.2.require_approval","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"config.tools.additionalProperties.oneOf.2","typeLabel":"object"},{"type":"object","required":["require_approval"],"properties":{"require_approval":{"type":"array","items":{"type":"string","uniqueKey":"config.tools.additionalProperties.oneOf.3.require_approval.items.[INDEX]","typeLabel":"string"},"description":"Tool calls matched here pause until the user approves them.","x-experimental":true,"isRequired":true,"uniqueKey":"config.tools.additionalProperties.oneOf.3.require_approval","typeLabel":"string[]"}},"additionalProperties":false,"uniqueKey":"config.tools.additionalProperties.oneOf.3","typeLabel":"object"}],"uniqueKey":"config.tools.additionalProperties","typeLabel":"object"},"description":"Tool-level configuration per toolkit: tools to enable or disable, or tools that need approval","uniqueKey":"config.tools","typeLabel":"object"},"tags":{"type":"object","properties":{"enabled":{"type":"array","items":{"type":"string","enum":["readOnlyHint","createHint","updateHint","destructiveHint","idempotentHint","openWorldHint"],"uniqueKey":"config.tags.enabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Tags that the tool must have at least one of","uniqueKey":"config.tags.enabled","typeLabel":"enum\u003cstring>[]"},"disabled":{"type":"array","items":{"type":"string","enum":["readOnlyHint","createHint","updateHint","destructiveHint","idempotentHint","openWorldHint"],"uniqueKey":"config.tags.disabled.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Tags that the tool must NOT have any of","uniqueKey":"config.tags.disabled","typeLabel":"enum\u003cstring>[]"},"require_approval":{"type":"array","items":{"type":"string","enum":["readOnlyHint","createHint","updateHint","destructiveHint","idempotentHint","openWorldHint"],"uniqueKey":"config.tags.require_approval.items.[INDEX]","typeLabel":"enum\u003cstring>"},"description":"Tool calls matched here pause until the user approves them.","x-experimental":true,"uniqueKey":"config.tags.require_approval","typeLabel":"enum\u003cstring>[]"}},"description":"MCP tool annotation hints for filtering tools with enabled/disabled support, and experimentally the tags whose tools need approval. enabled: tags that the tool must have at least one of. disabled: tags that the tool must NOT have any of. Both conditions must be satisfied.","uniqueKey":"config.tags","typeLabel":"object"},"workbench":{"type":"object","properties":{"enable":{"type":"boolean","description":"Whether the workbench (code execution sandbox) is enabled. When false, COMPOSIO_REMOTE_WORKBENCH and COMPOSIO_REMOTE_BASH_TOOL are not exposed.","uniqueKey":"config.workbench.enable","typeLabel":"boolean"},"tool_execution_enabled":{"type":"boolean","description":"Whether tool execution is enabled in the workbench","uniqueKey":"config.workbench.tool_execution_enabled","typeLabel":"boolean"},"proxy_execution_enabled":{"type":"boolean","description":"Whether proxy execution is enabled in the workbench","uniqueKey":"config.workbench.proxy_execution_enabled","typeLabel":"boolean"},"auto_offload_threshold":{"type":"number","description":"Character threshold after which tool execution response are saved to a file in workbench. Default is 20k.","exclusiveMinimum":0,"uniqueKey":"config.workbench.auto_offload_threshold","typeLabel":"number"},"sandbox_size":{"type":"string","enum":["standard","medium","large","xlarge"],"description":"Sandbox compute tier: standard (1 vCPU / 1 GB), medium (2 vCPU / 2 GB), large (4 vCPU / 4 GB), xlarge (8 vCPU / 8 GB). Defaults to standard.","uniqueKey":"config.workbench.sandbox_size","typeLabel":"enum\u003cstring>"}},"default":{"enable":true,"proxy_execution_enabled":true},"description":"Workbench configuration","uniqueKey":"config.workbench","typeLabel":"object"},"multi_account":{"type":"object","properties":{"enable":{"type":"boolean","description":"When true, enables multi-account mode for this session. When not set, falls back to org/project-level configuration.","uniqueKey":"config.multi_account.enable","typeLabel":"boolean"},"max_accounts_per_toolkit":{"type":"integer","description":"Maximum number of connected accounts allowed per toolkit. Defaults to 5 when multi-account is enabled.","uniqueKey":"config.multi_account.max_accounts_per_toolkit","typeLabel":"integer"},"require_explicit_selection":{"type":"boolean","description":"When true, require explicit account selection when multiple accounts are connected. When false (default), use the first/default account.","uniqueKey":"config.multi_account.require_explicit_selection","typeLabel":"boolean"}},"description":"Multi-account configuration for this session.","uniqueKey":"config.multi_account","typeLabel":"object"},"proxy_execute":{"type":"object","properties":{"enable":{"type":"boolean","description":"When true, enables proxy execute outside the workbench. When false, also disables proxy execution inside the workbench.","isRequired":true,"uniqueKey":"config.proxy_execute.enable","typeLabel":"boolean"}},"required":["enable"],"description":"Proxy execute configuration for this session. Omitted when not set.","uniqueKey":"config.proxy_execute","typeLabel":"object"},"hooks":{"type":"array","items":{"oneOf":[{"type":"object","required":["type","id","applies_to","handler"],"properties":{"type":{"type":"string","enum":["before_execute"],"isRequired":true,"uniqueKey":"config.hooks.items.[INDEX].oneOf.0.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","pattern":"^[a-z0-9_-]{1,64}$","description":"Unique within the session. Shows up in results and logs.","isRequired":true,"uniqueKey":"config.hooks.items.[INDEX].oneOf.0.id","typeLabel":"string"},"applies_to":{"oneOf":[{"type":"string","description":"Which tools the hook covers: \"all\" for all of them, or only the listed toolkits.","enum":["all"],"isRequired":true,"uniqueKey":"config.hooks.items.[INDEX].oneOf.0.applies_to.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"object","description":"Which tools the hook covers: \"all\" for all of them, or only the listed toolkits.","required":["toolkits"],"properties":{"toolkits":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"config.hooks.items.[INDEX].oneOf.0.applies_to.oneOf.1.toolkits.items.[INDEX]","typeLabel":"string"},"minItems":1,"description":"Toolkit slugs","isRequired":true,"uniqueKey":"config.hooks.items.[INDEX].oneOf.0.applies_to.oneOf.1.toolkits","typeLabel":"string[]"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"config.hooks.items.[INDEX].oneOf.0.applies_to.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"config.hooks.items.[INDEX].oneOf.0.applies_to","typeLabel":"enum\u003cstring> | object"},"handler":{"type":"object","properties":{"type":{"type":"string","enum":["condition_check"],"isRequired":true,"uniqueKey":"config.hooks.items.[INDEX].oneOf.0.handler.type","typeLabel":"enum\u003cstring>"},"condition":{"type":"string","minLength":1,"maxLength":2000,"description":"What to block, written as a plain sentence. For example: \"Sending email to anyone outside example.org\".","isRequired":true,"uniqueKey":"config.hooks.items.[INDEX].oneOf.0.handler.condition","typeLabel":"string"},"action":{"type":"string","enum":["block"],"isRequired":true,"uniqueKey":"config.hooks.items.[INDEX].oneOf.0.handler.action","typeLabel":"enum\u003cstring>"}},"required":["type","condition","action"],"additionalProperties":false,"isRequired":true,"uniqueKey":"config.hooks.items.[INDEX].oneOf.0.handler","typeLabel":"object"},"name":{"type":"string","minLength":1,"maxLength":120,"description":"A readable name. The agent sees it when this hook blocks a call.","uniqueKey":"config.hooks.items.[INDEX].oneOf.0.name","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"config.hooks.items.[INDEX].oneOf.0","typeLabel":"object"},{"type":"object","required":["type","id","applies_to","handler"],"properties":{"type":{"type":"string","enum":["after_execute"],"isRequired":true,"uniqueKey":"config.hooks.items.[INDEX].oneOf.1.type","typeLabel":"enum\u003cstring>"},"id":{"type":"string","pattern":"^[a-z0-9_-]{1,64}$","description":"Unique within the session. Shows up in results and logs.","isRequired":true,"uniqueKey":"config.hooks.items.[INDEX].oneOf.1.id","typeLabel":"string"},"applies_to":{"oneOf":[{"type":"string","description":"Which tools the hook covers: \"all\" for all of them, or only the listed toolkits.","enum":["all"],"isRequired":true,"uniqueKey":"config.hooks.items.[INDEX].oneOf.1.applies_to.oneOf.0","typeLabel":"enum\u003cstring>"},{"type":"object","description":"Which tools the hook covers: \"all\" for all of them, or only the listed toolkits.","required":["toolkits"],"properties":{"toolkits":{"type":"array","items":{"type":"string","minLength":1,"uniqueKey":"config.hooks.items.[INDEX].oneOf.1.applies_to.oneOf.1.toolkits.items.[INDEX]","typeLabel":"string"},"minItems":1,"description":"Toolkit slugs","isRequired":true,"uniqueKey":"config.hooks.items.[INDEX].oneOf.1.applies_to.oneOf.1.toolkits","typeLabel":"string[]"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"config.hooks.items.[INDEX].oneOf.1.applies_to.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"config.hooks.items.[INDEX].oneOf.1.applies_to","typeLabel":"enum\u003cstring> | object"},"handler":{"oneOf":[{"type":"object","required":["type","condition","action"],"properties":{"type":{"type":"string","enum":["condition_check"],"isRequired":true,"uniqueKey":"config.hooks.items.[INDEX].oneOf.1.handler.oneOf.0.type","typeLabel":"enum\u003cstring>"},"condition":{"type":"string","minLength":1,"maxLength":2000,"description":"What to block, written as a plain sentence. For example: \"Sending email to anyone outside example.org\".","isRequired":true,"uniqueKey":"config.hooks.items.[INDEX].oneOf.1.handler.oneOf.0.condition","typeLabel":"string"},"action":{"type":"string","enum":["block"],"isRequired":true,"uniqueKey":"config.hooks.items.[INDEX].oneOf.1.handler.oneOf.0.action","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"config.hooks.items.[INDEX].oneOf.1.handler.oneOf.0","typeLabel":"object"},{"type":"object","description":"Blocks a tool response that tries to manipulate the agent: override its instructions, change its role, or make it take actions the user didn't ask for.","required":["type","action"],"properties":{"type":{"type":"string","enum":["prompt_injection_check"],"isRequired":true,"uniqueKey":"config.hooks.items.[INDEX].oneOf.1.handler.oneOf.1.type","typeLabel":"enum\u003cstring>"},"action":{"type":"string","enum":["block"],"isRequired":true,"uniqueKey":"config.hooks.items.[INDEX].oneOf.1.handler.oneOf.1.action","typeLabel":"enum\u003cstring>"}},"additionalProperties":false,"isRequired":true,"uniqueKey":"config.hooks.items.[INDEX].oneOf.1.handler.oneOf.1","typeLabel":"object"}],"isRequired":true,"uniqueKey":"config.hooks.items.[INDEX].oneOf.1.handler","typeLabel":"object"},"name":{"type":"string","minLength":1,"maxLength":120,"description":"A readable name. The agent sees it when this hook blocks a call.","uniqueKey":"config.hooks.items.[INDEX].oneOf.1.name","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"config.hooks.items.[INDEX].oneOf.1","typeLabel":"object"}],"uniqueKey":"config.hooks.items.[INDEX]","typeLabel":"object"},"maxItems":20,"description":"Hooks that run on this session's tool calls.","uniqueKey":"config.hooks","typeLabel":"object[]"},"connected_accounts":{"type":"object","additionalProperties":{"type":"array","items":{"type":"string","format":"connectedAccountId","uniqueKey":"config.connected_accounts.additionalProperties.items.[INDEX]","typeLabel":"string\u003cconnectedAccountId>"},"minItems":1,"uniqueKey":"config.connected_accounts.additionalProperties","typeLabel":"string\u003cconnectedAccountId>[]"},"description":"Per-toolkit connected account overrides (array of nano-IDs). Multi-account sessions can pin more than one account per toolkit; otherwise length is 1.","uniqueKey":"config.connected_accounts","typeLabel":"object"}},"required":["user_id","instant","preload","search","execute"],"description":"The configuration used to create this session","isRequired":true,"uniqueKey":"config","typeLabel":"object"},"config_version":{"type":"integer","description":"Monotonic version of the config. Incremented on each PATCH. Use for optimistic concurrency control.","isRequired":true,"uniqueKey":"config_version","typeLabel":"integer"},"experimental":{"type":"object","properties":{"assistive_prompt":{"type":"string","description":"The assistive system prompt for the tool router session","uniqueKey":"experimental.assistive_prompt","typeLabel":"string"},"custom_toolkits":{"type":"array","items":{"type":"object","properties":{"slug":{"type":"string","minLength":1,"pattern":"^[a-zA-Z0-9_-]+$","isRequired":true,"uniqueKey":"experimental.custom_toolkits.items.[INDEX].slug","typeLabel":"string"},"name":{"type":"string","minLength":1,"maxLength":128,"isRequired":true,"uniqueKey":"experimental.custom_toolkits.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","minLength":1,"maxLength":2048,"isRequired":true,"uniqueKey":"experimental.custom_toolkits.items.[INDEX].description","typeLabel":"string"},"tools":{"type":"array","items":{"type":"object","properties":{"slug":{"type":"string","description":"Prefixed tool slug (e.g. LOCAL_CRM_FIND_CUSTOMER)","isRequired":true,"uniqueKey":"experimental.custom_toolkits.items.[INDEX].tools.items.[INDEX].slug","typeLabel":"string"},"name":{"type":"string","minLength":1,"maxLength":128,"isRequired":true,"uniqueKey":"experimental.custom_toolkits.items.[INDEX].tools.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","minLength":1,"maxLength":5120,"isRequired":true,"uniqueKey":"experimental.custom_toolkits.items.[INDEX].tools.items.[INDEX].description","typeLabel":"string"},"input_schema":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"experimental.custom_toolkits.items.[INDEX].tools.items.[INDEX].input_schema.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"experimental.custom_toolkits.items.[INDEX].tools.items.[INDEX].input_schema","typeLabel":"object"},"original_slug":{"type":"string","description":"Original tool slug as provided by the user","isRequired":true,"uniqueKey":"experimental.custom_toolkits.items.[INDEX].tools.items.[INDEX].original_slug","typeLabel":"string"},"output_schema":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"experimental.custom_toolkits.items.[INDEX].tools.items.[INDEX].output_schema.additionalProperties","typeLabel":"any"},"uniqueKey":"experimental.custom_toolkits.items.[INDEX].tools.items.[INDEX].output_schema","typeLabel":"object"},"preload":{"type":"boolean","description":"Echoes the SDK-local preload hint provided for this tool","uniqueKey":"experimental.custom_toolkits.items.[INDEX].tools.items.[INDEX].preload","typeLabel":"boolean"}},"required":["slug","name","description","input_schema","original_slug"],"uniqueKey":"experimental.custom_toolkits.items.[INDEX].tools.items.[INDEX]","typeLabel":"object"},"isRequired":true,"uniqueKey":"experimental.custom_toolkits.items.[INDEX].tools","typeLabel":"object[]"},"preload":{"type":"boolean","description":"Echoes the SDK-local preload hint provided for this toolkit","uniqueKey":"experimental.custom_toolkits.items.[INDEX].preload","typeLabel":"boolean"}},"required":["slug","name","description","tools"],"uniqueKey":"experimental.custom_toolkits.items.[INDEX]","typeLabel":"object"},"description":"User-defined custom toolkits with grouped tools (no-auth)","uniqueKey":"experimental.custom_toolkits","typeLabel":"object[]"},"custom_tools":{"type":"array","items":{"type":"object","properties":{"slug":{"type":"string","description":"Prefixed tool slug (e.g. LOCAL_GMAIL_GET_IMPORTANT_EMAILS)","isRequired":true,"uniqueKey":"experimental.custom_tools.items.[INDEX].slug","typeLabel":"string"},"name":{"type":"string","minLength":1,"maxLength":128,"isRequired":true,"uniqueKey":"experimental.custom_tools.items.[INDEX].name","typeLabel":"string"},"description":{"type":"string","minLength":1,"maxLength":5120,"isRequired":true,"uniqueKey":"experimental.custom_tools.items.[INDEX].description","typeLabel":"string"},"input_schema":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"experimental.custom_tools.items.[INDEX].input_schema.additionalProperties","typeLabel":"any"},"isRequired":true,"uniqueKey":"experimental.custom_tools.items.[INDEX].input_schema","typeLabel":"object"},"original_slug":{"type":"string","description":"Original tool slug as provided by the user","isRequired":true,"uniqueKey":"experimental.custom_tools.items.[INDEX].original_slug","typeLabel":"string"},"output_schema":{"type":"object","additionalProperties":{"oneOf":[{}],"uniqueKey":"experimental.custom_tools.items.[INDEX].output_schema.additionalProperties","typeLabel":"any"},"uniqueKey":"experimental.custom_tools.items.[INDEX].output_schema","typeLabel":"object"},"extends_toolkit":{"type":"string","minLength":1,"uniqueKey":"experimental.custom_tools.items.[INDEX].extends_toolkit","typeLabel":"string"},"preload":{"type":"boolean","description":"Echoes the SDK-local preload hint provided for this tool","uniqueKey":"experimental.custom_tools.items.[INDEX].preload","typeLabel":"boolean"}},"required":["slug","name","description","input_schema","original_slug"],"uniqueKey":"experimental.custom_tools.items.[INDEX]","typeLabel":"object"},"description":"Custom tools — standalone or extending Composio toolkits","uniqueKey":"experimental.custom_tools","typeLabel":"object[]"},"no_elicitation_support_fallback":{"type":"string","enum":["deny","allow"],"description":"What session MCP does with a tool call that needs approval when the MCP client can't ask the user. Omitted when not set, which means deny.","x-experimental":true,"uniqueKey":"experimental.no_elicitation_support_fallback","typeLabel":"enum\u003cstring>"},"source_session_config":{"type":"object","properties":{"id":{"type":"string","format":"sessionConfigId","isRequired":true,"uniqueKey":"experimental.source_session_config.id","typeLabel":"string\u003csessionConfigId>"}},"required":["id"],"description":"Experimental provenance for the reusable Session config most recently applied to this Session.","x-experimental":true,"uniqueKey":"experimental.source_session_config","typeLabel":"object"}},"description":"Experimental v3.1 features","x-experimental":true,"uniqueKey":"experimental","typeLabel":"object"},"warnings":{"type":"array","items":{"type":"object","properties":{"code":{"type":"string","enum":["PRELOAD_TOOLS_HIGH_CONTEXT_USAGE"],"description":"Stable machine code identifying the advisory. Safe to switch on in client code.","example":"PRELOAD_TOOLS_HIGH_CONTEXT_USAGE","isRequired":true,"uniqueKey":"warnings.items.[INDEX].code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Human-readable description of the advisory. Suitable for logging or surfacing to end users.","example":"Session preloads 25 tools; each preloaded tool adds to the agent context window. Consider keeping the list at or under ~20 tools.","isRequired":true,"uniqueKey":"warnings.items.[INDEX].message","typeLabel":"string"}},"required":["code","message"],"uniqueKey":"warnings.items.[INDEX]","typeLabel":"object"},"default":[],"description":"Advisory list — the session exists and is usable, but the listed issues may warrant attention.","example":[{"code":"PRELOAD_TOOLS_HIGH_CONTEXT_USAGE","message":"Session preloads 25 tools; each preloaded tool adds to the agent context window. Consider keeping the list at or under ~20 tools."}],"uniqueKey":"warnings","typeLabel":"object[]"}},"required":["session_id","mcp","tool_router_tools","config","config_version"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"session_id":"trs_1a2b3c4d5e6f","mcp":{"type":"http","url":"https://app.composio.dev/tool_router/v3/trs_1a2b3c4d5e6f/mcp"},"tool_router_tools":["\u003cstring>"],"config":{"user_id":"\u003cstring>","instant":false,"preload":{"tools":["\u003cstring>"]},"search":{"enable":true},"execute":{"enable_multi_execute":true},"toolkits":{"enabled":["\u003cstring>"],"require_approval":["\u003cstring>"]},"auth_configs":{},"manage_connections":{"enabled":true,"callback_url":"\u003cstring>","enable_wait_for_connections":false,"enable_connection_removal":true},"tools":{},"tags":{"enabled":["readOnlyHint"],"disabled":["readOnlyHint"],"require_approval":["readOnlyHint"]},"workbench":{"enable":true,"proxy_execution_enabled":true},"multi_account":{"enable":true,"max_accounts_per_toolkit":123,"require_explicit_selection":true},"proxy_execute":{"enable":true},"hooks":[{"type":"before_execute","id":"\u003cstring>","applies_to":"all","handler":{"type":"condition_check","condition":"\u003cstring>","action":"block"},"name":"\u003cstring>"}],"connected_accounts":{}},"config_version":123,"experimental":{"assistive_prompt":"\u003cstring>","custom_toolkits":[{"slug":"\u003cstring>","name":"\u003cstring>","description":"\u003cstring>","tools":[{"slug":"\u003cstring>","name":"\u003cstring>","description":"\u003cstring>","input_schema":{},"original_slug":"\u003cstring>","output_schema":{},"preload":true}],"preload":true}],"custom_tools":[{"slug":"\u003cstring>","name":"\u003cstring>","description":"\u003cstring>","input_schema":{},"original_slug":"\u003cstring>","output_schema":{},"extends_toolkit":"\u003cstring>","preload":true}],"no_elicitation_support_fallback":"deny","source_session_config":{"id":"\u003cstring>"}},"warnings":[{"code":"PRELOAD_TOOLS_HIGH_CONTEXT_USAGE","message":"Session preloads 25 tools; each preloaded tool adds to the agent context window. Consider keeping the list at or under ~20 tools."}]}}},"exampleType":"generated"}},"exampleType":"generated"},"ad0edb16-a6d9-45cb-8e75-032390d0a5ca":{"description":"Bad request. Invalid config values.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"number","isRequired":true,"uniqueKey":"error.code","typeLabel":"number"},"slug":{"type":"string","isRequired":true,"uniqueKey":"error.slug","typeLabel":"string"},"status":{"type":"number","isRequired":true,"uniqueKey":"error.status","typeLabel":"number"},"request_id":{"type":"string","uniqueKey":"error.request_id","typeLabel":"string"},"suggested_fix":{"type":"string","uniqueKey":"error.suggested_fix","typeLabel":"string"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"error.errors.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.errors","typeLabel":"string[]"}},"required":["message","code","slug","status"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","code":123,"slug":"\u003cstring>","status":123,"request_id":"\u003cstring>","suggested_fix":"\u003cstring>","errors":["\u003cstring>"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"6569cc66-8e4e-4bb9-bc50-d908539c39f4":{"description":"Unauthorized.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"number","isRequired":true,"uniqueKey":"error.code","typeLabel":"number"},"slug":{"type":"string","isRequired":true,"uniqueKey":"error.slug","typeLabel":"string"},"status":{"type":"number","isRequired":true,"uniqueKey":"error.status","typeLabel":"number"},"request_id":{"type":"string","uniqueKey":"error.request_id","typeLabel":"string"},"suggested_fix":{"type":"string","uniqueKey":"error.suggested_fix","typeLabel":"string"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"error.errors.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.errors","typeLabel":"string[]"}},"required":["message","code","slug","status"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","code":123,"slug":"\u003cstring>","status":123,"request_id":"\u003cstring>","suggested_fix":"\u003cstring>","errors":["\u003cstring>"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"359ef005-6f33-485c-909f-266f8160ed62":{"description":"Session configs are not enabled for this project.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"number","isRequired":true,"uniqueKey":"error.code","typeLabel":"number"},"slug":{"type":"string","isRequired":true,"uniqueKey":"error.slug","typeLabel":"string"},"status":{"type":"number","isRequired":true,"uniqueKey":"error.status","typeLabel":"number"},"request_id":{"type":"string","uniqueKey":"error.request_id","typeLabel":"string"},"suggested_fix":{"type":"string","uniqueKey":"error.suggested_fix","typeLabel":"string"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"error.errors.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.errors","typeLabel":"string[]"}},"required":["message","code","slug","status"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","code":123,"slug":"\u003cstring>","status":123,"request_id":"\u003cstring>","suggested_fix":"\u003cstring>","errors":["\u003cstring>"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"977a8c20-0031-48d6-b642-01a4c48e6bad":{"description":"Session or active Session config not found in this project.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"number","isRequired":true,"uniqueKey":"error.code","typeLabel":"number"},"slug":{"type":"string","isRequired":true,"uniqueKey":"error.slug","typeLabel":"string"},"status":{"type":"number","isRequired":true,"uniqueKey":"error.status","typeLabel":"number"},"request_id":{"type":"string","uniqueKey":"error.request_id","typeLabel":"string"},"suggested_fix":{"type":"string","uniqueKey":"error.suggested_fix","typeLabel":"string"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"error.errors.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.errors","typeLabel":"string[]"}},"required":["message","code","slug","status"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","code":123,"slug":"\u003cstring>","status":123,"request_id":"\u003cstring>","suggested_fix":"\u003cstring>","errors":["\u003cstring>"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"ded9ecf2-3b60-45d9-b8ff-93a1739d9136":{"description":"Request timeout while validating patch.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"number","isRequired":true,"uniqueKey":"error.code","typeLabel":"number"},"slug":{"type":"string","isRequired":true,"uniqueKey":"error.slug","typeLabel":"string"},"status":{"type":"number","isRequired":true,"uniqueKey":"error.status","typeLabel":"number"},"request_id":{"type":"string","uniqueKey":"error.request_id","typeLabel":"string"},"suggested_fix":{"type":"string","uniqueKey":"error.suggested_fix","typeLabel":"string"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"error.errors.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.errors","typeLabel":"string[]"}},"required":["message","code","slug","status"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","code":123,"slug":"\u003cstring>","status":123,"request_id":"\u003cstring>","suggested_fix":"\u003cstring>","errors":["\u003cstring>"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"43f99d69-5278-4cf4-be6c-8655b5a0402e":{"description":"Config version conflict. Re-fetch the session and retry.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"number","isRequired":true,"uniqueKey":"error.code","typeLabel":"number"},"slug":{"type":"string","isRequired":true,"uniqueKey":"error.slug","typeLabel":"string"},"status":{"type":"number","isRequired":true,"uniqueKey":"error.status","typeLabel":"number"},"request_id":{"type":"string","uniqueKey":"error.request_id","typeLabel":"string"},"suggested_fix":{"type":"string","uniqueKey":"error.suggested_fix","typeLabel":"string"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"error.errors.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.errors","typeLabel":"string[]"}},"required":["message","code","slug","status"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","code":123,"slug":"\u003cstring>","status":123,"request_id":"\u003cstring>","suggested_fix":"\u003cstring>","errors":["\u003cstring>"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"08c53222-c031-4e1d-974c-78f67cd7c5f5":{"description":"Rate limit exceeded while validating the patch.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"number","isRequired":true,"uniqueKey":"error.code","typeLabel":"number"},"slug":{"type":"string","isRequired":true,"uniqueKey":"error.slug","typeLabel":"string"},"status":{"type":"number","isRequired":true,"uniqueKey":"error.status","typeLabel":"number"},"request_id":{"type":"string","uniqueKey":"error.request_id","typeLabel":"string"},"suggested_fix":{"type":"string","uniqueKey":"error.suggested_fix","typeLabel":"string"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"error.errors.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.errors","typeLabel":"string[]"}},"required":["message","code","slug","status"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","code":123,"slug":"\u003cstring>","status":123,"request_id":"\u003cstring>","suggested_fix":"\u003cstring>","errors":["\u003cstring>"]}}}},"exampleType":"generated"}},"exampleType":"generated"},"e6f11a5c-e5b6-4c00-8d8b-9cfd7b37ea26":{"description":"Internal server error.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"code":{"type":"number","isRequired":true,"uniqueKey":"error.code","typeLabel":"number"},"slug":{"type":"string","isRequired":true,"uniqueKey":"error.slug","typeLabel":"string"},"status":{"type":"number","isRequired":true,"uniqueKey":"error.status","typeLabel":"number"},"request_id":{"type":"string","uniqueKey":"error.request_id","typeLabel":"string"},"suggested_fix":{"type":"string","uniqueKey":"error.suggested_fix","typeLabel":"string"},"errors":{"type":"array","items":{"type":"string","uniqueKey":"error.errors.items.[INDEX]","typeLabel":"string"},"uniqueKey":"error.errors","typeLabel":"string[]"}},"required":["message","code","slug","status"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"error":{"message":"\u003cstring>","code":123,"slug":"\u003cstring>","status":123,"request_id":"\u003cstring>","suggested_fix":"\u003cstring>","errors":["\u003cstring>"]}}}},"exampleType":"generated"}},"exampleType":"generated"}},"security":{"f5eb1c25-3f51-416e-b40f-11935eff6f3e":{"ApiKeyAuth":{"type":"apiKey","in":"header","name":"x-api-key","description":"Your Composio project API key. Create or copy it from the Composio dashboard.","x-default":"your-project-api-key","scopes":[],"schemeName":"ApiKeyAuth"}}},"servers":{"88115a90-88a8-44fd-bf64-8d389b2a91c2":{"url":"https://backend.composio.dev","description":"Composio production API"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"apiKey","in":"header","name":"x-api-key","description":"Your Composio project API key. Create or copy it from the Composio dashboard.","x-default":"your-project-api-key","scopes":[],"schemeName":"ApiKeyAuth"},"schema":{"title":"x-api-key","type":"string","description":"Your Composio project API key. Create or copy it from the Composio dashboard.","isRequired":true,"default":"your-project-api-key","typeLabel":"string","deprecated":false},"schemeName":"ApiKeyAuth","name":"x-api-key"}],"title":"ApiKeyAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"composio-preview","siteName":"Composio Docs","title":"Patch a tool router session config (v3.1) - Composio Docs","navMaps":{"firstHrefInVersion":{"v3.1":{"href":"/reference/api-reference/tool-router/patchToolRouterSessionBySessionId","matchLevel":0},"v3.0":{"href":"/reference/v3","matchLevel":3}},"firstHrefInLanguage":{}},"lastModified":"2026-11-06T23:41:24.061Z","originalFileLocation":"reference/api-reference/tool-router/patchToolRouterSessionBySessionId.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=\"dark\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Partially updates an existing tool router session. Inline fields update only the supplied settings. Alternatively, experimental.session_config_id applies the latest active saved config from this project, replacing toolkit, tool, and tag access while preserving other settings. Later saved-config edits do not sync automatically. Uses optimistic concurrency control and retains the previous policy in config history.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Composio Docs\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003cmeta data-mint-head name=\"robots\" content=\"noindex\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/composio-preview/clZwxWuV-UjwHDpH/_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/composio-preview/clZwxWuV-UjwHDpH/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/composio-preview/clZwxWuV-UjwHDpH/_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/composio-preview/clZwxWuV-UjwHDpH/_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/composio-preview/clZwxWuV-UjwHDpH/_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/composio-preview/clZwxWuV-UjwHDpH/_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/composio-preview/clZwxWuV-UjwHDpH/_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/composio-preview/clZwxWuV-UjwHDpH/_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/composio-preview/clZwxWuV-UjwHDpH/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Patch a tool router session config (v3.1) - Composio Docs\">\u003cmeta data-mint-head property=\"og:description\" content=\"Partially updates an existing tool router session. Inline fields update only the supplied settings. Alternatively, experimental.session_config_id applies the latest active saved config from this project, replacing toolkit, tool, and tag access while preserving other settings. Later saved-config edits do not sync automatically. Uses optimistic concurrency control and retains the previous policy in config history.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Composio Docs\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://composio-preview.mintlify.app/reference/api-reference/tool-router/patchToolRouterSessionBySessionId\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://composio-preview.mintlify.site/_mintlify/api/og/v2?division=Sessions+%28prev+Tool+Router%29\u0026amp;title=Patch+a+tool+router+session+config+%28v3.1%29\u0026amp;description=Partially+updates+an+existing+tool+router+session.+Inline+fields+update+only+the+supplied+settings.+Alternatively%2C+experimental.session_config_id+applies+the+la\u0026amp;theme=2a6064aea71db6aefd788ca2\u0026amp;signature=f1b0d0c4169b4d0df6dd38d65889bca4dcf003244151bdb7f3136df523ae5514\">\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=\"Patch a tool router session config (v3.1) - Composio Docs\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Partially updates an existing tool router session. Inline fields update only the supplied settings. Alternatively, experimental.session_config_id applies the latest active saved config from this project, replacing toolkit, tool, and tag access while preserving other settings. Later saved-config edits do not sync automatically. Uses optimistic concurrency control and retains the previous policy in config history.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://composio-preview.mintlify.site/_mintlify/api/og/v2?division=Sessions+%28prev+Tool+Router%29\u0026amp;title=Patch+a+tool+router+session+config+%28v3.1%29\u0026amp;description=Partially+updates+an+existing+tool+router+session.+Inline+fields+update+only+the+supplied+settings.+Alternatively%2C+experimental.session_config_id+applies+the+la\u0026amp;theme=2a6064aea71db6aefd788ca2\u0026amp;signature=f1b0d0c4169b4d0df6dd38d65889bca4dcf003244151bdb7f3136df523ae5514\">\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/composio-preview/clZwxWuV-UjwHDpH/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Composio Docs\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#0007CD\">\u003clink data-mint-head rel=\"canonical\" href=\"https://composio-preview.mintlify.app/reference/api-reference/tool-router/patchToolRouterSessionBySessionId\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/reference/api-reference/tool-router/patchToolRouterSessionBySessionId.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://composio-preview.mintlify.app/#organization\",\"name\":\"Composio Docs\",\"url\":\"https://composio-preview.mintlify.app\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/composio-preview/cL3pOAF8H-TYHF1S/Composio%20Logo.svg?fit=max\u0026auto=format\u0026n=cL3pOAF8H-TYHF1S\u0026q=85\u0026s=c959b1b97e22caccd03fe5d3d71ab52b\"}},{\"@type\":\"WebSite\",\"@id\":\"https://composio-preview.mintlify.app#website\",\"name\":\"Composio Docs\",\"url\":\"https://composio-preview.mintlify.app\",\"publisher\":{\"@id\":\"https://composio-preview.mintlify.app/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://composio-preview.mintlify.app/reference/api-reference/tool-router/patchToolRouterSessionBySessionId#webpage\",\"url\":\"https://composio-preview.mintlify.app/reference/api-reference/tool-router/patchToolRouterSessionBySessionId\",\"name\":\"Patch a tool router session config (v3.1)\",\"description\":\"Partially updates an existing tool router session. Inline fields update only the supplied settings. Alternatively, experimental.session_config_id applies the latest active saved config from this project, replacing toolkit, tool, and tag access while preserving other settings. Later saved-config edits do not sync automatically. Uses optimistic concurrency control and retains the previous policy in config history.\",\"dateModified\":\"2026-11-06T23:41:24.061Z\",\"isPartOf\":{\"@id\":\"https://composio-preview.mintlify.app#website\"},\"breadcrumb\":{\"@id\":\"https://composio-preview.mintlify.app/reference/api-reference/tool-router/patchToolRouterSessionBySessionId#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://composio-preview.mintlify.app/reference/api-reference/tool-router/patchToolRouterSessionBySessionId#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"API Reference\",\"item\":\"https://composio-preview.mintlify.app/reference/api-reference/api-keys/postApiKeyRevocation\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Sessions (prev Tool Router)\",\"item\":\"https://composio-preview.mintlify.app/reference/api-reference/tool-router\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Patch a tool router session config (v3.1)\",\"item\":\"https://composio-preview.mintlify.app/reference/api-reference/tool-router/patchToolRouterSessionBySessionId\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://composio-preview.mintlify.app/reference/api-reference/tool-router/patchToolRouterSessionBySessionId#apireference\",\"headline\":\"Patch a tool router session config (v3.1)\",\"name\":\"Patch a tool router session config (v3.1)\",\"description\":\"Partially updates an existing tool router session. Inline fields update only the supplied settings. Alternatively, experimental.session_config_id applies the latest active saved config from this project, replacing toolkit, tool, and tag access while preserving other settings. Later saved-config edits do not sync automatically. Uses optimistic concurrency control and retains the previous policy in config history.\",\"url\":\"https://composio-preview.mintlify.app/reference/api-reference/tool-router/patchToolRouterSessionBySessionId\",\"mainEntityOfPage\":{\"@id\":\"https://composio-preview.mintlify.app/reference/api-reference/tool-router/patchToolRouterSessionBySessionId#webpage\"},\"dateModified\":\"2026-11-06T23:41:24.061Z\",\"publisher\":{\"@id\":\"https://composio-preview.mintlify.app/#organization\"},\"isPartOf\":{\"@id\":\"https://composio-preview.mintlify.app#website\"}}]}\u003c/script>","agentPointerHref":"/reference/api-reference/tool-router/patchToolRouterSessionBySessionId.md","siteName":"Composio Docs","nav":{"global":null,"tabs":[{"tab":"Docs","products":[{"product":"Platform","description":"Build agents with the Composio SDK.","groups":[{"group":"Get started","pages":[{"group":"Agent setup","root":{"title":"Overview","href":"/docs/agent-setup"},"directory":"accordion","pages":[{"title":"Authenticate an unattended agent","sidebarTitle":"Unattended Agent Auth","href":"/docs/agent-setup/unattended-authentication"},{"title":"Clients","href":"/docs/agent-setup/clients"}]},{"title":"Quickstart","href":"/docs/quickstart"},{"group":"SDKs and frameworks","root":{"title":"SDKs and frameworks","href":"/docs/providers/index"},"directory":"accordion","pages":[{"title":"Anthropic","href":"/docs/providers/anthropic"},{"title":"OpenAI","href":"/docs/providers/openai"},{"title":"Vercel AI SDK","href":"/docs/providers/vercel"},{"title":"Pi","href":"/docs/providers/pi"},{"title":"Eve","href":"/docs/providers/eve"},{"title":"Google","href":"/docs/providers/google"},{"title":"TypeSafe","href":"/docs/providers/typesafe"},{"title":"LangChain","href":"/docs/providers/langchain"},{"title":"AutoGen","href":"/docs/providers/autogen"},{"title":"CrewAI","href":"/docs/providers/crewai"},{"title":"LlamaIndex","href":"/docs/providers/llamaindex"},{"title":"Mastra","href":"/docs/providers/mastra"},{"group":"Custom providers","root":{"title":"Custom Providers","href":"/docs/providers/custom-providers/index"},"directory":"accordion","pages":[{"title":"TypeScript Custom Provider","href":"/docs/providers/custom-providers/typescript"},{"title":"Python Custom Provider","href":"/docs/providers/custom-providers/python"}]}]}]},{"group":"Build","pages":[{"group":"Sessions","pages":[{"title":"What is a session?","sidebarTitle":"What is a Session?","href":"/docs/how-composio-works"},{"title":"Configuring Sessions","href":"/docs/configuring-sessions"},{"title":"Using saved session configs","href":"/docs/session-configs"},{"title":"Using sessions via MCP","href":"/docs/sessions-via-mcp"}]},{"group":"Toolkits \u0026 Tools","pages":[{"title":"Toolkits","href":"/docs/toolkits"},{"title":"Instant Tools","href":"/docs/instant-tools"}]},{"group":"Governance","pages":[{"title":"Tool hints","href":"/docs/governance/tool-hints"},{"title":"Approvals","href":"/docs/governance/approvals"},{"title":"Firewall","href":"/docs/firewall"}]},{"group":"Authentication","root":{"title":"Authentication","href":"/docs/authentication/index"},"directory":"accordion","pages":[{"title":"Managed authentication for your own tools","href":"/docs/authentication/managed-auth-for-custom-tools"},{"title":"Managing multiple connected accounts","sidebarTitle":"Multiple connected accounts","href":"/docs/authentication/managing-multiple-connected-accounts"},{"title":"Controlling scopes","href":"/docs/authentication/controlling-scopes"},{"title":"Manual auth management","href":"/docs/authentication/manually-authenticating"},{"title":"Programmatic auth configs","href":"/docs/authentication/programmatic-auth-configs"},{"title":"Importing existing connections","href":"/docs/authentication/importing-existing-connections"}]},{"title":"Skills","href":"/docs/skills"},{"group":"Triggers","pages":[{"title":"Triggers","href":"/docs/triggers"},{"group":"Set up triggers","pages":[{"title":"Creating triggers","href":"/docs/setting-up-triggers/creating-triggers"},{"title":"Receiving events","href":"/docs/setting-up-triggers/subscribing-to-events"},{"title":"Managing triggers","href":"/docs/setting-up-triggers/managing-triggers"},{"title":"Custom OAuth webhooks","href":"/docs/setting-up-triggers/custom-oauth-webhooks"},{"title":"Troubleshooting triggers","href":"/docs/setting-up-triggers/troubleshooting"}]}]}]},{"group":"Customize","pages":[{"group":"Extend sessions","expanded":false,"pages":[{"title":"Proxy execute","href":"/docs/extending-sessions/proxy-execute"},{"title":"Custom Tools and Toolkits","href":"/docs/extending-sessions/custom-tools-and-toolkits"},{"title":"Shared connections","href":"/docs/extending-sessions/shared-connections"},{"title":"Custom MCP","href":"/docs/extending-sessions/custom-mcp"}]},{"group":"Sandboxes","expanded":false,"pages":[{"title":"Remote sandbox","href":"/docs/sandbox/remote"},{"title":"Local sandbox","href":"/docs/sandbox/local"}]},{"group":"Guides \u0026 Examples","pages":[{"title":"Examples","sidebarTitle":"Overview","href":"/examples/index"},{"title":"Design a consumer agent with Composio","href":"/docs/consumer-agents"},{"title":"Design a B2B agent with Composio","href":"/docs/b2b-agents"}]}]},{"group":"Ship","pages":[{"title":"Move from prototype to production","href":"/docs/production-readiness"},{"title":"White-labeling authentication","href":"/docs/authentication/white-labeling-authentication"},{"group":"Production readiness","pages":[{"title":"Managed vs custom auth","href":"/docs/authentication/custom-app-vs-managed-app"},{"title":"Rate Limits","sidebarTitle":"Rate limits","href":"/reference/rate-limits"},{"title":"Stream logs to a SIEM","href":"/docs/poc-to-prod/stream-logs-to-a-siem"}]},{"group":"Security and data","expanded":false,"pages":[{"title":"Security","href":"/docs/security/overview"},{"title":"Token custody architecture","href":"/docs/security/token-custody"},{"title":"Data retention and handling","href":"/docs/security/data-retention"},{"title":"Zero Data Retention","href":"/docs/security/zero-data-retention"}]}]},{"group":"Reference and Migration","pages":[{"group":"Migration and legacy","expanded":false,"pages":[{"title":"Sessions vs Direct Execution","href":"/docs/sessions-vs-direct-execution"},{"group":"Migration guides","root":{"title":"Migration guides","href":"/docs/migration-guide/index"},"expanded":false,"directory":"accordion","pages":[{"title":"Migrate from No Auth to Instant","href":"/docs/migration-guide/no-auth-to-instant"},{"title":"Migrating from Direct Tools to Sessions","href":"/docs/migration-guide/direct-to-sessions"},{"title":"Migrating from MCP servers to Sessions","href":"/docs/migration-guide/mcp-servers-to-sessions"},{"title":"Migrating from Experimental Tool Router","href":"/docs/migration-guide/tool-router-beta"},{"title":"Toolkit versioning migration","href":"/docs/migration-guide/toolkit-versioning"},{"title":"Our next generation SDKs","href":"/docs/migration-guide/new-sdk"}]},{"group":"Direct execution","expanded":false,"pages":[{"title":"Fetching tools and schemas","href":"/docs/tools-direct/fetching-tools"},{"title":"Authenticating Tools","href":"/docs/tools-direct/authenticating-tools"},{"title":"Executing tools directly","href":"/docs/tools-direct/executing-tools"},{"group":"Modify tool behavior","pages":[{"title":"Schema Modifiers","href":"/docs/tools-direct/modify-tool-behavior/schema-modifiers"},{"title":"Before Execution Modifiers","href":"/docs/tools-direct/modify-tool-behavior/before-execution-modifiers"},{"title":"After Execution Modifiers","href":"/docs/tools-direct/modify-tool-behavior/after-execution-modifiers"}]},{"title":"Toolkit Versioning","href":"/docs/tools-direct/toolkit-versioning"}]},{"group":"Direct auth","expanded":false,"pages":[{"title":"Custom Auth Configs","href":"/docs/auth-configuration/custom-auth-configs"},{"title":"White-labeling (direct execution)","href":"/docs/auth-configuration/white-labeling"},{"title":"Custom Auth Parameters","href":"/docs/auth-configuration/custom-auth-params"},{"title":"Connected Accounts","href":"/docs/auth-configuration/connected-accounts"},{"title":"Migrating from initiate() to link()","href":"/docs/auth-configuration/migrating-initiate-to-link"}]}]}]},{"group":"Shared resources","pages":[{"title":"Build with the Composio skill","href":"/docs/using-composio-skill"}]}]},{"product":"For You","description":"Connect your apps to AI clients.","groups":[{"group":"Get started","pages":[{"title":"Agent plugins","href":"/docs/agent-plugins"},{"title":"Composio CLI","href":"/docs/cli"},{"title":"Composio Connect","sidebarTitle":"Connect with MCP","href":"/docs/composio-connect"}]}]}]},{"tab":"Knowledge Base","pages":[{"title":"Knowledge Base","href":"/kb"}]},{"tab":"Examples","pages":[{"title":"Examples","href":"/examples/sdk-examples"}]},{"tab":"Toolkits","pages":[{"title":"Toolkits","href":"/toolkits"}]},{"tab":"Reference","versions":[{"version":"v3.1","default":true,"tag":"Latest","pages":[{"group":"Overview","pages":[{"title":"Overview","sidebarTitle":"API reference","href":"/reference"},{"title":"Changelog","mode":"center","href":"/reference/changelog"},{"title":"Errors","href":"/reference/errors"},{"title":"Glossary","href":"/reference/glossary"}]},{"group":"Authenticating to Composio","root":{"title":"Overview","href":"/reference/authenticating-to-composio/index"},"directory":"accordion","pages":[{"title":"Scoped Project API Key","href":"/reference/authenticating-to-composio/project-api-key-permissions"}]},{"group":"API Reference","expanded":true,"pages":[{"group":"API Keys","pages":[{"title":"Revoke Composio API keys","openapi":"api-reference/openapi.json POST /api/v3.1/api_key_revocation","href":"/reference/api-reference/api-keys/postApiKeyRevocation"}]},{"group":"Auth Configs","root":{"title":"Auth Configs","href":"/reference/api-reference/auth-configs/index"},"directory":"accordion","pages":[{"title":"List authentication configurations with optional filters","openapi":"api-reference/openapi.json GET /api/v3.1/auth_configs","href":"/reference/api-reference/auth-configs/getAuthConfigs"},{"title":"Get single authentication configuration by ID","openapi":"api-reference/openapi.json GET /api/v3.1/auth_configs/{nanoid}","href":"/reference/api-reference/auth-configs/getAuthConfigsByNanoid"},{"title":"Create new authentication configuration","openapi":"api-reference/openapi.json POST /api/v3.1/auth_configs","href":"/reference/api-reference/auth-configs/postAuthConfigs"},{"title":"Update an authentication configuration","openapi":"api-reference/openapi.json PATCH /api/v3.1/auth_configs/{nanoid}","href":"/reference/api-reference/auth-configs/patchAuthConfigsByNanoid"},{"title":"Enable or disable an authentication configuration (DEPRECATED)","openapi":"api-reference/openapi.json PATCH /api/v3.1/auth_configs/{nanoid}/{status}","deprecated":true,"href":"/reference/api-reference/auth-configs/patchAuthConfigsByNanoidByStatus"},{"title":"Delete an authentication configuration","openapi":"api-reference/openapi.json DELETE /api/v3.1/auth_configs/{nanoid}","href":"/reference/api-reference/auth-configs/deleteAuthConfigsByNanoid"}]},{"group":"Connected Accounts","root":{"title":"Connected Accounts","href":"/reference/api-reference/connected-accounts/index"},"directory":"accordion","pages":[{"title":"List connected accounts with optional filters","openapi":"api-reference/openapi.json GET /api/v3.1/connected_accounts","href":"/reference/api-reference/connected-accounts/getConnectedAccounts"},{"title":"Get connected account details by ID","openapi":"api-reference/openapi.json GET /api/v3.1/connected_accounts/{nanoid}","href":"/reference/api-reference/connected-accounts/getConnectedAccountsByNanoid"},{"title":"Create a new connected account","openapi":"api-reference/openapi.json POST /api/v3.1/connected_accounts","href":"/reference/api-reference/connected-accounts/postConnectedAccounts"},{"title":"Re-initiate authentication for a connected account (DEPRECATED)","openapi":"api-reference/openapi.json POST /api/v3.1/connected_accounts/{nanoid}/refresh","deprecated":true,"href":"/reference/api-reference/connected-accounts/postConnectedAccountsByNanoidRefresh"},{"title":"Revoke a connected account at the provider","openapi":"api-reference/openapi.json POST /api/v3.1/connected_accounts/{nanoid}/revoke","href":"/reference/api-reference/connected-accounts/postConnectedAccountsByNanoidRevoke"},{"title":"Complete a deferred OAuth connection after identity verification","openapi":"api-reference/openapi.json POST /api/v3.1/connected_accounts/complete_auth","href":"/reference/api-reference/connected-accounts/postConnectedAccountsCompleteAuth"},{"title":"Create a new auth link session","openapi":"api-reference/openapi.json POST /api/v3.1/connected_accounts/link","href":"/reference/api-reference/connected-accounts/postConnectedAccountsLink"},{"title":"Enable or disable a connected account (DEPRECATED)","openapi":"api-reference/openapi.json PATCH /api/v3.1/connected_accounts/{nanoId}/status","deprecated":true,"href":"/reference/api-reference/connected-accounts/patchConnectedAccountsByNanoIdStatus"},{"title":"Update a connected account","openapi":"api-reference/openapi.json PATCH /api/v3.1/connected_accounts/{nanoid}","href":"/reference/api-reference/connected-accounts/patchConnectedAccountsByNanoid"},{"title":"Delete a connected account","openapi":"api-reference/openapi.json DELETE /api/v3.1/connected_accounts/{nanoid}","href":"/reference/api-reference/connected-accounts/deleteConnectedAccountsByNanoid"}]},{"group":"Files","root":{"title":"Files","href":"/reference/api-reference/files/index"},"directory":"accordion","pages":[{"title":"List files with optional app and action filters (DEPRECATED)","openapi":"api-reference/openapi.json GET /api/v3.1/files/list","deprecated":true,"href":"/reference/api-reference/files/getFilesList"},{"title":"Create presigned URL for request file upload to S3","openapi":"api-reference/openapi.json POST /api/v3.1/files/upload/request","href":"/reference/api-reference/files/postFilesUploadRequest"}]},{"group":"Logs","root":{"title":"Logs","href":"/reference/api-reference/logs/index"},"directory":"accordion","pages":[{"title":"Get log details by ID","openapi":"api-reference/openapi.json GET /api/v3.1/logs/tool_execution/{id}","href":"/reference/api-reference/logs/getLogsToolExecutionById"},{"title":"Search and retrieve tool execution logs","openapi":"api-reference/openapi.json POST /api/v3.1/logs/tool_execution","href":"/reference/api-reference/logs/postLogsToolExecution"}]},{"group":"MCP","root":{"title":"MCP","href":"/reference/api-reference/mcp/index"},"directory":"accordion","pages":[{"title":"List MCP servers for a specific app","openapi":"api-reference/openapi.json GET /api/v3.1/mcp/app/{appKey}","deprecated":true,"href":"/reference/api-reference/mcp/getMcpAppByAppKey"},{"title":"Get MCP server details by ID","openapi":"api-reference/openapi.json GET /api/v3.1/mcp/{id}","deprecated":true,"href":"/reference/api-reference/mcp/getMcpById"},{"title":"List MCP servers with optional filters and pagination","openapi":"api-reference/openapi.json GET /api/v3.1/mcp/servers","deprecated":true,"href":"/reference/api-reference/mcp/getMcpServers"},{"title":"List all instances for an MCP server","openapi":"api-reference/openapi.json GET /api/v3.1/mcp/servers/{serverId}/instances","deprecated":true,"href":"/reference/api-reference/mcp/getMcpServersByServerIdInstances"},{"title":"Create a new MCP server","openapi":"api-reference/openapi.json POST /api/v3.1/mcp/servers","deprecated":true,"href":"/reference/api-reference/mcp/postMcpServers"},{"title":"Create a new MCP server instance","openapi":"api-reference/openapi.json POST /api/v3.1/mcp/servers/{serverId}/instances","deprecated":true,"href":"/reference/api-reference/mcp/postMcpServersByServerIdInstances"},{"title":"Create a new custom MCP server with multiple apps","openapi":"api-reference/openapi.json POST /api/v3.1/mcp/servers/custom","deprecated":true,"href":"/reference/api-reference/mcp/postMcpServersCustom"},{"title":"Generate MCP URL with custom parameters","openapi":"api-reference/openapi.json POST /api/v3.1/mcp/servers/generate","deprecated":true,"href":"/reference/api-reference/mcp/postMcpServersGenerate"},{"title":"Update MCP server configuration","openapi":"api-reference/openapi.json PATCH /api/v3.1/mcp/{id}","deprecated":true,"href":"/reference/api-reference/mcp/patchMcpById"},{"title":"Delete an MCP server","openapi":"api-reference/openapi.json DELETE /api/v3.1/mcp/{id}","deprecated":true,"href":"/reference/api-reference/mcp/deleteMcpById"},{"title":"Delete an MCP server instance and associated connected accounts","openapi":"api-reference/openapi.json DELETE /api/v3.1/mcp/servers/{serverId}/instances/{instanceId}","deprecated":true,"href":"/reference/api-reference/mcp/deleteMcpServersByServerIdInstancesByInstanceId"}]},{"group":"Organization","root":{"title":"Organization","href":"/reference/api-reference/organization/index"},"directory":"accordion","pages":[{"title":"Org usage breakdown","openapi":"api-reference/openapi.json POST /api/v3.1/org/usage/{entity_type}","href":"/reference/api-reference/organization/postOrgUsageByEntityType"},{"title":"Org usage summary","openapi":"api-reference/openapi.json POST /api/v3.1/org/usage/summary","href":"/reference/api-reference/organization/postOrgUsageSummary"}]},{"group":"Organization Management","pages":[{"title":"List organizations","openapi":"api-reference/openapi.json GET /api/v3.1/org/list","href":"/reference/api-reference/organization-management/getOrgList"}]},{"group":"Projects","root":{"title":"Projects","href":"/reference/api-reference/projects/index"},"directory":"accordion","pages":[{"title":"Get project details by ID With Org Api key","openapi":"api-reference/openapi.json GET /api/v3.1/org/owner/project/{nano_id}","href":"/reference/api-reference/projects/getOrgOwnerProjectByNanoId"},{"title":"List all projects","openapi":"api-reference/openapi.json GET /api/v3.1/org/owner/project/list","href":"/reference/api-reference/projects/getOrgOwnerProjectList"},{"title":"List all projects","openapi":"api-reference/openapi.json GET /api/v3.1/org/project/list","href":"/reference/api-reference/projects/getOrgProjectList"},{"title":"Delete and generate new API key for project","openapi":"api-reference/openapi.json POST /api/v3.1/org/owner/project/{nano_id}/regenerate_api_key","href":"/reference/api-reference/projects/postOrgOwnerProjectByNanoIdRegenerateApiKey"},{"title":"Create a new project","openapi":"api-reference/openapi.json POST /api/v3.1/org/owner/project/new","href":"/reference/api-reference/projects/postOrgOwnerProjectNew"},{"title":"Project usage breakdown","openapi":"api-reference/openapi.json POST /api/v3.1/project/usage/{entity_type}","href":"/reference/api-reference/projects/postProjectUsageByEntityType"},{"title":"Project usage summary","openapi":"api-reference/openapi.json POST /api/v3.1/project/usage/summary","href":"/reference/api-reference/projects/postProjectUsageSummary"},{"title":"Delete a project","openapi":"api-reference/openapi.json DELETE /api/v3.1/org/owner/project/{nano_id}","href":"/reference/api-reference/projects/deleteOrgOwnerProjectByNanoId"}]},{"group":"Sessions (prev Tool Router)","root":{"title":"Sessions (prev Tool Router)","href":"/reference/api-reference/tool-router/index"},"directory":"accordion","pages":[{"title":"List Session configs","openapi":"api-reference/openapi.json GET /api/v3.1/session_configs","href":"/reference/api-reference/tool-router/getSessionConfigs"},{"title":"Retrieve a Session config","openapi":"api-reference/openapi.json GET /api/v3.1/session_configs/{session_config_id}","href":"/reference/api-reference/tool-router/getSessionConfigsBySessionConfigId"},{"title":"Get a tool router session by ID (v3.1)","openapi":"api-reference/openapi.json GET /api/v3.1/tool_router/session/{session_id}","href":"/reference/api-reference/tool-router/getToolRouterSessionBySessionId"},{"title":"List a tool router session config history","openapi":"api-reference/openapi.json GET /api/v3.1/tool_router/session/{session_id}/config_history","href":"/reference/api-reference/tool-router/getToolRouterSessionBySessionIdConfigHistory"},{"title":"List files in a session mount","openapi":"api-reference/openapi.json GET /api/v3.1/tool_router/session/{session_id}/mounts/{mount_id}/items","href":"/reference/api-reference/tool-router/getToolRouterSessionBySessionIdMountsByMountIdItems"},{"title":"Get toolkits for a tool router session","openapi":"api-reference/openapi.json GET /api/v3.1/tool_router/session/{session_id}/toolkits","href":"/reference/api-reference/tool-router/getToolRouterSessionBySessionIdToolkits"},{"title":"List tools with schemas for a tool router session (v3.1)","openapi":"api-reference/openapi.json GET /api/v3.1/tool_router/session/{session_id}/tools","href":"/reference/api-reference/tool-router/getToolRouterSessionBySessionIdTools"},{"title":"Create a new tool router session","openapi":"api-reference/openapi.json POST /api/v3.1/tool_router/session","href":"/reference/api-reference/tool-router/postToolRouterSession"},{"title":"Attach to an existing tool router session (v3.1)","openapi":"api-reference/openapi.json POST /api/v3.1/tool_router/session/{session_id}/attach","href":"/reference/api-reference/tool-router/postToolRouterSessionBySessionIdAttach"},{"title":"Execute a tool within a tool router session","openapi":"api-reference/openapi.json POST /api/v3.1/tool_router/session/{session_id}/execute","href":"/reference/api-reference/tool-router/postToolRouterSessionBySessionIdExecute"},{"title":"Execute a meta tool within a tool router session","openapi":"api-reference/openapi.json POST /api/v3.1/tool_router/session/{session_id}/execute_meta","href":"/reference/api-reference/tool-router/postToolRouterSessionBySessionIdExecuteMeta"},{"title":"Create a link session for a toolkit in a tool router session","openapi":"api-reference/openapi.json POST /api/v3.1/tool_router/session/{session_id}/link","href":"/reference/api-reference/tool-router/postToolRouterSessionBySessionIdLink"},{"title":"Delete a file from a session mount","openapi":"api-reference/openapi.json POST /api/v3.1/tool_router/session/{session_id}/mounts/{mount_id}/delete","href":"/reference/api-reference/tool-router/postToolRouterSessionBySessionIdMountsByMountIdDelete"},{"title":"Create a presigned download URL for a mount file","openapi":"api-reference/openapi.json POST /api/v3.1/tool_router/session/{session_id}/mounts/{mount_id}/download_url","href":"/reference/api-reference/tool-router/postToolRouterSessionBySessionIdMountsByMountIdDownloadUrl"},{"title":"Create a presigned upload URL for a mount file","openapi":"api-reference/openapi.json POST /api/v3.1/tool_router/session/{session_id}/mounts/{mount_id}/upload_url","href":"/reference/api-reference/tool-router/postToolRouterSessionBySessionIdMountsByMountIdUploadUrl"},{"title":"Execute proxy request within a tool router session","openapi":"api-reference/openapi.json POST /api/v3.1/tool_router/session/{session_id}/proxy_execute","href":"/reference/api-reference/tool-router/postToolRouterSessionBySessionIdProxyExecute"},{"title":"Search for tools using a query","description":"Search for tools matching a use case query within an existing tool router session.","openapi":"api-reference/openapi.json POST /api/v3.1/tool_router/session/{session_id}/search","href":"/reference/api-reference/tool-router/postToolRouterSessionBySessionIdSearch"},{"title":"Patch a tool router session config (v3.1)","openapi":"api-reference/openapi.json PATCH /api/v3.1/tool_router/session/{session_id}","href":"/reference/api-reference/tool-router/patchToolRouterSessionBySessionId"},{"title":"Delete a tool router session","description":"Deletes a tool router session. The session immediately stops being retrievable and executable — subsequent requests against it (including its MCP URL) return 404 — and any compute sandboxes attached to the session are shut down. Deleting an already-deleted session returns 404.","openapi":"api-reference/openapi.json DELETE /api/v3.1/tool_router/session/{session_id}","href":"/reference/api-reference/tool-router/deleteToolRouterSessionBySessionId"}]},{"group":"Toolkits","root":{"title":"Toolkits","href":"/reference/api-reference/toolkits/index"},"directory":"accordion","pages":[{"title":"List available toolkits","openapi":"api-reference/openapi.json GET /api/v3.1/toolkits","href":"/reference/api-reference/toolkits/getToolkits"},{"title":"Get toolkit by slug","openapi":"api-reference/openapi.json GET /api/v3.1/toolkits/{slug}","href":"/reference/api-reference/toolkits/getToolkitsBySlug"},{"title":"List toolkit categories","openapi":"api-reference/openapi.json GET /api/v3.1/toolkits/categories","href":"/reference/api-reference/toolkits/getToolkitsCategories"},{"title":"Get toolkits changelog","openapi":"api-reference/openapi.json GET /api/v3.1/toolkits/changelog","href":"/reference/api-reference/toolkits/getToolkitsChangelog"},{"title":"List grant contexts","openapi":"api-reference/openapi.json GET /api/v3.1/toolkits/{toolkit_slug}/scopes/grant_context","href":"/reference/api-reference/toolkits/recommendToolkitScopesGrantContext"},{"title":"Create a custom toolkit","openapi":"api-reference/openapi.json POST /api/v3.1/custom/toolkits","href":"/reference/api-reference/toolkits/postCustomToolkits"},{"title":"Sync a custom toolkit","openapi":"api-reference/openapi.json POST /api/v3.1/custom/toolkits/sync","href":"/reference/api-reference/toolkits/postCustomToolkitsSync"},{"title":"Upsert a custom toolkit","openapi":"api-reference/openapi.json POST /api/v3.1/custom/toolkits/upsert","href":"/reference/api-reference/toolkits/postCustomToolkitsUpsert"},{"title":"Fetch multiple toolkits","openapi":"api-reference/openapi.json POST /api/v3.1/toolkits/multi","href":"/reference/api-reference/toolkits/postToolkitsMulti"},{"title":"Get required scopes","openapi":"api-reference/openapi.json POST /api/v3.1/toolkits/{toolkit_slug}/scopes/recommended","href":"/reference/api-reference/toolkits/recommendToolkitScopes"},{"title":"Update a custom toolkit","openapi":"api-reference/openapi.json PATCH /api/v3.1/custom/toolkits/{slug}","href":"/reference/api-reference/toolkits/patchCustomToolkitsBySlug"},{"title":"Delete a custom toolkit","openapi":"api-reference/openapi.json DELETE /api/v3.1/custom/toolkits/{slug}","href":"/reference/api-reference/toolkits/deleteCustomToolkitsBySlug"}]},{"group":"Tools","root":{"title":"Tools","href":"/reference/api-reference/tools/index"},"directory":"accordion","pages":[{"title":"List available tools","openapi":"api-reference/openapi.json GET /api/v3.1/tools","href":"/reference/api-reference/tools/getTools"},{"title":"Get tool by slug","openapi":"api-reference/openapi.json GET /api/v3.1/tools/{tool_slug}","href":"/reference/api-reference/tools/getToolsByToolSlug"},{"title":"Get tool enum list","openapi":"api-reference/openapi.json GET /api/v3.1/tools/enum","href":"/reference/api-reference/tools/getToolsEnum"},{"title":"Execute tool","openapi":"api-reference/openapi.json POST /api/v3.1/tools/execute/{tool_slug}","href":"/reference/api-reference/tools/postToolsExecuteByToolSlug"},{"title":"Generate tool inputs from natural language (DEPRECATED)","openapi":"api-reference/openapi.json POST /api/v3.1/tools/execute/{tool_slug}/input","deprecated":true,"href":"/reference/api-reference/tools/postToolsExecuteByToolSlugInput"},{"title":"Execute proxy request","openapi":"api-reference/openapi.json POST /api/v3.1/tools/execute/proxy","href":"/reference/api-reference/tools/postToolsExecuteProxy"},{"title":"Get required scopes for tools (DEPRECATED)","openapi":"api-reference/openapi.json POST /api/v3.1/tools/scopes/required","deprecated":true,"href":"/reference/api-reference/tools/postToolsScopesRequired"}]},{"group":"Triggers","root":{"title":"Triggers","href":"/reference/api-reference/triggers/index"},"directory":"accordion","pages":[{"title":"List active triggers","openapi":"api-reference/openapi.json GET /api/v3.1/trigger_instances/active","href":"/reference/api-reference/triggers/getTriggerInstancesActive"},{"title":"List trigger types","openapi":"api-reference/openapi.json GET /api/v3.1/triggers_types","href":"/reference/api-reference/triggers/getTriggersTypes"},{"title":"Get trigger type by slug","openapi":"api-reference/openapi.json GET /api/v3.1/triggers_types/{slug}","href":"/reference/api-reference/triggers/getTriggersTypesBySlug"},{"title":"List trigger type enums","openapi":"api-reference/openapi.json GET /api/v3.1/triggers_types/list/enum","href":"/reference/api-reference/triggers/getTriggersTypesListEnum"},{"title":"Create or update a trigger","openapi":"api-reference/openapi.json POST /api/v3.1/trigger_instances/{slug}/upsert","href":"/reference/api-reference/triggers/postTriggerInstancesBySlugUpsert"},{"title":"Update a trigger","openapi":"api-reference/openapi.json PATCH /api/v3.1/trigger_instances/manage/{triggerId}","href":"/reference/api-reference/triggers/patchTriggerInstancesManageByTriggerId"},{"title":"Delete a trigger","openapi":"api-reference/openapi.json DELETE /api/v3.1/trigger_instances/manage/{triggerId}","href":"/reference/api-reference/triggers/deleteTriggerInstancesManageByTriggerId"}]},{"group":"Webhook Endpoints","root":{"title":"Webhook Endpoints","href":"/reference/api-reference/webhook-endpoints/index"},"directory":"accordion","pages":[{"title":"List webhook endpoints","openapi":"api-reference/openapi.json GET /api/v3.1/webhook_endpoints","href":"/reference/api-reference/webhook-endpoints/getWebhookEndpoints"},{"title":"Get webhook endpoint","openapi":"api-reference/openapi.json GET /api/v3.1/webhook_endpoints/{nano_id}","href":"/reference/api-reference/webhook-endpoints/getWebhookEndpointsByNanoId"},{"title":"Create webhook endpoint","openapi":"api-reference/openapi.json POST /api/v3.1/webhook_endpoints","href":"/reference/api-reference/webhook-endpoints/postWebhookEndpoints"},{"title":"Put webhook endpoint configuration","openapi":"api-reference/openapi.json POST /api/v3.1/webhook_endpoints/{nano_id}","href":"/reference/api-reference/webhook-endpoints/postWebhookEndpointsByNanoId"},{"title":"Update webhook endpoint configuration","openapi":"api-reference/openapi.json PATCH /api/v3.1/webhook_endpoints/{nano_id}","href":"/reference/api-reference/webhook-endpoints/patchWebhookEndpointsByNanoId"}]},{"group":"Webhook Events","root":{"title":"Webhook Events","href":"/reference/api-reference/webhook-events/index"},"directory":"accordion","pages":[{"title":"Connection activated","openapi":"api-reference/openapi.json webhook composio.connected_account.activated","href":"/reference/api-reference/webhook-events/composio_connected_account_activated"},{"title":"Connection expired","openapi":"api-reference/openapi.json webhook composio.connected_account.expired","href":"/reference/api-reference/webhook-events/composio_connected_account_expired"},{"title":"Trigger disabled","openapi":"api-reference/openapi.json webhook composio.trigger.disabled","href":"/reference/api-reference/webhook-events/composio_trigger_disabled"},{"title":"Trigger message","openapi":"api-reference/openapi.json webhook composio.trigger.message","href":"/reference/api-reference/webhook-events/composio_trigger_message"},{"title":"Trigger message (V1)","openapi":"api-reference/openapi.json webhook composio.trigger.message.v1","deprecated":true,"href":"/reference/api-reference/webhook-events/composio_trigger_message_v1"},{"title":"Trigger message (V2)","openapi":"api-reference/openapi.json webhook composio.trigger.message.v2","deprecated":true,"href":"/reference/api-reference/webhook-events/composio_trigger_message_v2"}]},{"group":"Webhook Subscriptions","root":{"title":"Webhook Subscriptions","href":"/reference/api-reference/webhook-subscriptions/index"},"directory":"accordion","pages":[{"title":"List webhook subscriptions","openapi":"api-reference/openapi.json GET /api/v3.1/webhook_subscriptions","href":"/reference/api-reference/webhook-subscriptions/getWebhookSubscriptions"},{"title":"Get webhook subscription","openapi":"api-reference/openapi.json GET /api/v3.1/webhook_subscriptions/{id}","href":"/reference/api-reference/webhook-subscriptions/getWebhookSubscriptionsById"},{"title":"List available event types","openapi":"api-reference/openapi.json GET /api/v3.1/webhook_subscriptions/event_types","href":"/reference/api-reference/webhook-subscriptions/getWebhookSubscriptionsEventTypes"},{"title":"Create webhook subscription","openapi":"api-reference/openapi.json POST /api/v3.1/webhook_subscriptions","href":"/reference/api-reference/webhook-subscriptions/postWebhookSubscriptions"},{"title":"Rotate webhook secret","openapi":"api-reference/openapi.json POST /api/v3.1/webhook_subscriptions/{id}/rotate_secret","href":"/reference/api-reference/webhook-subscriptions/postWebhookSubscriptionsByIdRotateSecret"},{"title":"Update webhook subscription","openapi":"api-reference/openapi.json PATCH /api/v3.1/webhook_subscriptions/{id}","href":"/reference/api-reference/webhook-subscriptions/patchWebhookSubscriptionsById"},{"title":"Delete webhook subscription","openapi":"api-reference/openapi.json DELETE /api/v3.1/webhook_subscriptions/{id}","href":"/reference/api-reference/webhook-subscriptions/deleteWebhookSubscriptionsById"}]}]}],"groups":[{"group":"Sessions (Prev Tool Router)","pages":[{"title":"List Session configs","deprecated":false,"version":null,"sidebarTitle":"Getsessionconfigs","openapi":"/api-reference/openapi.json get /api/v3.1/session_configs","href":"/reference/api-reference/tool-router/getsessionconfigs"},{"title":"Retrieve a Session config","deprecated":false,"version":null,"sidebarTitle":"Getsessionconfigsbysessionconfigid","openapi":"/api-reference/openapi.json get /api/v3.1/session_configs/{session_config_id}","href":"/reference/api-reference/tool-router/getsessionconfigsbysessionconfigid"},{"title":"Create a new tool router session","deprecated":false,"version":null,"sidebarTitle":"Posttoolroutersession","openapi":"/api-reference/openapi.json post /api/v3.1/tool_router/session","href":"/reference/api-reference/tool-router/posttoolroutersession"},{"title":"Get a tool router session by ID (v3.1)","deprecated":false,"version":null,"sidebarTitle":"Gettoolroutersessionbysessionid","openapi":"/api-reference/openapi.json get /api/v3.1/tool_router/session/{session_id}","href":"/reference/api-reference/tool-router/gettoolroutersessionbysessionid"},{"title":"Delete a tool router session","deprecated":false,"version":null,"sidebarTitle":"Deletetoolroutersessionbysessionid","openapi":"/api-reference/openapi.json delete /api/v3.1/tool_router/session/{session_id}","href":"/reference/api-reference/tool-router/deletetoolroutersessionbysessionid"},{"title":"Patch a tool router session config (v3.1)","deprecated":false,"version":null,"sidebarTitle":"Patchtoolroutersessionbysessionid","openapi":"/api-reference/openapi.json patch /api/v3.1/tool_router/session/{session_id}","href":"/reference/api-reference/tool-router/patchtoolroutersessionbysessionid"},{"title":"Attach to an existing tool router session (v3.1)","deprecated":false,"version":null,"sidebarTitle":"Posttoolroutersessionbysessionidattach","openapi":"/api-reference/openapi.json post /api/v3.1/tool_router/session/{session_id}/attach","href":"/reference/api-reference/tool-router/posttoolroutersessionbysessionidattach"},{"title":"List a tool router session config history","deprecated":false,"version":null,"sidebarTitle":"Gettoolroutersessionbysessionidconfighistory","openapi":"/api-reference/openapi.json get /api/v3.1/tool_router/session/{session_id}/config_history","href":"/reference/api-reference/tool-router/gettoolroutersessionbysessionidconfighistory"},{"title":"Search for tools using a query","deprecated":false,"version":null,"sidebarTitle":"Posttoolroutersessionbysessionidsearch","openapi":"/api-reference/openapi.json post /api/v3.1/tool_router/session/{session_id}/search","href":"/reference/api-reference/tool-router/posttoolroutersessionbysessionidsearch"},{"title":"List tools with schemas for a tool router session (v3.1)","deprecated":false,"version":null,"sidebarTitle":"Gettoolroutersessionbysessionidtools","openapi":"/api-reference/openapi.json get /api/v3.1/tool_router/session/{session_id}/tools","href":"/reference/api-reference/tool-router/gettoolroutersessionbysessionidtools"},{"title":"Execute a tool within a tool router session","deprecated":false,"version":null,"sidebarTitle":"Posttoolroutersessionbysessionidexecute","openapi":"/api-reference/openapi.json post /api/v3.1/tool_router/session/{session_id}/execute","href":"/reference/api-reference/tool-router/posttoolroutersessionbysessionidexecute"},{"title":"Execute a meta tool within a tool router session","deprecated":false,"version":null,"sidebarTitle":"Posttoolroutersessionbysessionidexecutemeta","openapi":"/api-reference/openapi.json post /api/v3.1/tool_router/session/{session_id}/execute_meta","href":"/reference/api-reference/tool-router/posttoolroutersessionbysessionidexecutemeta"},{"title":"Create a link session for a toolkit in a tool router session","deprecated":false,"version":null,"sidebarTitle":"Posttoolroutersessionbysessionidlink","openapi":"/api-reference/openapi.json post /api/v3.1/tool_router/session/{session_id}/link","href":"/reference/api-reference/tool-router/posttoolroutersessionbysessionidlink"},{"title":"Execute proxy request within a tool router session","deprecated":false,"version":null,"sidebarTitle":"Posttoolroutersessionbysessionidproxyexecute","openapi":"/api-reference/openapi.json post /api/v3.1/tool_router/session/{session_id}/proxy_execute","href":"/reference/api-reference/tool-router/posttoolroutersessionbysessionidproxyexecute"},{"title":"Get toolkits for a tool router session","deprecated":false,"version":null,"sidebarTitle":"Gettoolroutersessionbysessionidtoolkits","openapi":"/api-reference/openapi.json get /api/v3.1/tool_router/session/{session_id}/toolkits","href":"/reference/api-reference/tool-router/gettoolroutersessionbysessionidtoolkits"},{"title":"List files in a session mount","deprecated":false,"version":null,"sidebarTitle":"Gettoolroutersessionbysessionidmountsbymountiditems","openapi":"/api-reference/openapi.json get /api/v3.1/tool_router/session/{session_id}/mounts/{mount_id}/items","href":"/reference/api-reference/tool-router/gettoolroutersessionbysessionidmountsbymountiditems"},{"title":"Create a presigned download URL for a mount file","deprecated":false,"version":null,"sidebarTitle":"Posttoolroutersessionbysessionidmountsbymountiddownloadurl","openapi":"/api-reference/openapi.json post /api/v3.1/tool_router/session/{session_id}/mounts/{mount_id}/download_url","href":"/reference/api-reference/tool-router/posttoolroutersessionbysessionidmountsbymountiddownloadurl"},{"title":"Create a presigned upload URL for a mount file","deprecated":false,"version":null,"sidebarTitle":"Posttoolroutersessionbysessionidmountsbymountiduploadurl","openapi":"/api-reference/openapi.json post /api/v3.1/tool_router/session/{session_id}/mounts/{mount_id}/upload_url","href":"/reference/api-reference/tool-router/posttoolroutersessionbysessionidmountsbymountiduploadurl"},{"title":"Delete a file from a session mount","deprecated":false,"version":null,"sidebarTitle":"Posttoolroutersessionbysessionidmountsbymountiddelete","openapi":"/api-reference/openapi.json post /api/v3.1/tool_router/session/{session_id}/mounts/{mount_id}/delete","href":"/reference/api-reference/tool-router/posttoolroutersessionbysessionidmountsbymountiddelete"}]},{"group":"Authentication","pages":[]},{"group":"API Keys","pages":[{"title":"Revoke Composio API keys","deprecated":false,"version":null,"sidebarTitle":"Postapikeyrevocation","openapi":"/api-reference/openapi.json post /api/v3.1/api_key_revocation","href":"/reference/api-reference/api-keys/postapikeyrevocation"}]},{"group":"Logs","pages":[{"title":"Search and retrieve tool execution logs","deprecated":false,"version":null,"sidebarTitle":"Postlogstoolexecution","openapi":"/api-reference/openapi.json post /api/v3.1/logs/tool_execution","href":"/reference/api-reference/logs/postlogstoolexecution"},{"title":"Get log details by ID","deprecated":false,"version":null,"sidebarTitle":"Getlogstoolexecutionbyid","openapi":"/api-reference/openapi.json get /api/v3.1/logs/tool_execution/{id}","href":"/reference/api-reference/logs/getlogstoolexecutionbyid"}]},{"group":"Tools","pages":[{"title":"List available tools","deprecated":false,"version":null,"sidebarTitle":"Gettools","openapi":"/api-reference/openapi.json get /api/v3.1/tools","href":"/reference/api-reference/tools/gettools"},{"title":"Get tool enum list","deprecated":false,"version":null,"sidebarTitle":"Gettoolsenum","openapi":"/api-reference/openapi.json get /api/v3.1/tools/enum","href":"/reference/api-reference/tools/gettoolsenum"},{"title":"Get tool by slug","deprecated":false,"version":null,"sidebarTitle":"Gettoolsbytoolslug","openapi":"/api-reference/openapi.json get /api/v3.1/tools/{tool_slug}","href":"/reference/api-reference/tools/gettoolsbytoolslug"},{"title":"Execute tool","deprecated":false,"version":null,"sidebarTitle":"Posttoolsexecutebytoolslug","openapi":"/api-reference/openapi.json post /api/v3.1/tools/execute/{tool_slug}","href":"/reference/api-reference/tools/posttoolsexecutebytoolslug"},{"title":"Generate tool inputs from natural language (DEPRECATED)","deprecated":true,"version":null,"sidebarTitle":"Posttoolsexecutebytoolsluginput","openapi":"/api-reference/openapi.json post /api/v3.1/tools/execute/{tool_slug}/input","href":"/reference/api-reference/tools/posttoolsexecutebytoolsluginput"},{"title":"Execute proxy request","deprecated":false,"version":null,"sidebarTitle":"Posttoolsexecuteproxy","openapi":"/api-reference/openapi.json post /api/v3.1/tools/execute/proxy","href":"/reference/api-reference/tools/posttoolsexecuteproxy"},{"title":"Get required scopes for tools (DEPRECATED)","deprecated":true,"version":null,"sidebarTitle":"Posttoolsscopesrequired","openapi":"/api-reference/openapi.json post /api/v3.1/tools/scopes/required","href":"/reference/api-reference/tools/posttoolsscopesrequired"}]},{"group":"Connected Accounts","pages":[{"title":"Revoke a connected account at the provider","deprecated":false,"version":null,"sidebarTitle":"Postconnectedaccountsbynanoidrevoke","openapi":"/api-reference/openapi.json post /api/v3.1/connected_accounts/{nanoid}/revoke","href":"/reference/api-reference/connected-accounts/postconnectedaccountsbynanoidrevoke"},{"title":"Complete a deferred OAuth connection after identity verification","deprecated":false,"version":null,"sidebarTitle":"Postconnectedaccountscompleteauth","openapi":"/api-reference/openapi.json post /api/v3.1/connected_accounts/complete_auth","href":"/reference/api-reference/connected-accounts/postconnectedaccountscompleteauth"},{"title":"List connected accounts with optional filters","deprecated":false,"version":null,"sidebarTitle":"Getconnectedaccounts","openapi":"/api-reference/openapi.json get /api/v3.1/connected_accounts","href":"/reference/api-reference/connected-accounts/getconnectedaccounts"},{"title":"Create a new connected account","deprecated":false,"version":null,"sidebarTitle":"Postconnectedaccounts","openapi":"/api-reference/openapi.json post /api/v3.1/connected_accounts","href":"/reference/api-reference/connected-accounts/postconnectedaccounts"},{"title":"Get connected account details by ID","deprecated":false,"version":null,"sidebarTitle":"Getconnectedaccountsbynanoid","openapi":"/api-reference/openapi.json get /api/v3.1/connected_accounts/{nanoid}","href":"/reference/api-reference/connected-accounts/getconnectedaccountsbynanoid"},{"title":"Delete a connected account","deprecated":false,"version":null,"sidebarTitle":"Deleteconnectedaccountsbynanoid","openapi":"/api-reference/openapi.json delete /api/v3.1/connected_accounts/{nanoid}","href":"/reference/api-reference/connected-accounts/deleteconnectedaccountsbynanoid"},{"title":"Update a connected account","deprecated":false,"version":null,"sidebarTitle":"Patchconnectedaccountsbynanoid","openapi":"/api-reference/openapi.json patch /api/v3.1/connected_accounts/{nanoid}","href":"/reference/api-reference/connected-accounts/patchconnectedaccountsbynanoid"},{"title":"Enable or disable a connected account (DEPRECATED)","deprecated":true,"version":null,"sidebarTitle":"Patchconnectedaccountsbynanoidstatus","openapi":"/api-reference/openapi.json patch /api/v3.1/connected_accounts/{nanoId}/status","href":"/reference/api-reference/connected-accounts/patchconnectedaccountsbynanoidstatus"},{"title":"Re-initiate authentication for a connected account (DEPRECATED)","deprecated":true,"version":null,"sidebarTitle":"Postconnectedaccountsbynanoidrefresh","openapi":"/api-reference/openapi.json post /api/v3.1/connected_accounts/{nanoid}/refresh","href":"/reference/api-reference/connected-accounts/postconnectedaccountsbynanoidrefresh"},{"title":"Create a new auth link session","deprecated":false,"version":null,"sidebarTitle":"Postconnectedaccountslink","openapi":"/api-reference/openapi.json post /api/v3.1/connected_accounts/link","href":"/reference/api-reference/connected-accounts/postconnectedaccountslink"}]},{"group":"Toolkits","pages":[{"title":"Create a custom toolkit","deprecated":false,"version":null,"sidebarTitle":"Postcustomtoolkits","openapi":"/api-reference/openapi.json post /api/v3.1/custom/toolkits","href":"/reference/api-reference/toolkits/postcustomtoolkits"},{"title":"Delete a custom toolkit","deprecated":false,"version":null,"sidebarTitle":"Deletecustomtoolkitsbyslug","openapi":"/api-reference/openapi.json delete /api/v3.1/custom/toolkits/{slug}","href":"/reference/api-reference/toolkits/deletecustomtoolkitsbyslug"},{"title":"Update a custom toolkit","deprecated":false,"version":null,"sidebarTitle":"Patchcustomtoolkitsbyslug","openapi":"/api-reference/openapi.json patch /api/v3.1/custom/toolkits/{slug}","href":"/reference/api-reference/toolkits/patchcustomtoolkitsbyslug"},{"title":"Get required scopes","deprecated":false,"version":null,"sidebarTitle":"Recommendtoolkitscopes","openapi":"/api-reference/openapi.json post /api/v3.1/toolkits/{toolkit_slug}/scopes/recommended","href":"/reference/api-reference/toolkits/recommendtoolkitscopes"},{"title":"List grant contexts","deprecated":false,"version":null,"sidebarTitle":"Recommendtoolkitscopesgrantcontext","openapi":"/api-reference/openapi.json get /api/v3.1/toolkits/{toolkit_slug}/scopes/grant_context","href":"/reference/api-reference/toolkits/recommendtoolkitscopesgrantcontext"},{"title":"List available toolkits","deprecated":false,"version":null,"sidebarTitle":"Gettoolkits","openapi":"/api-reference/openapi.json get /api/v3.1/toolkits","href":"/reference/api-reference/toolkits/gettoolkits"},{"title":"List toolkit categories","deprecated":false,"version":null,"sidebarTitle":"Gettoolkitscategories","openapi":"/api-reference/openapi.json get /api/v3.1/toolkits/categories","href":"/reference/api-reference/toolkits/gettoolkitscategories"},{"title":"Upsert a custom toolkit","deprecated":false,"version":null,"sidebarTitle":"Postcustomtoolkitsupsert","openapi":"/api-reference/openapi.json post /api/v3.1/custom/toolkits/upsert","href":"/reference/api-reference/toolkits/postcustomtoolkitsupsert"},{"title":"Sync a custom toolkit","deprecated":false,"version":null,"sidebarTitle":"Postcustomtoolkitssync","openapi":"/api-reference/openapi.json post /api/v3.1/custom/toolkits/sync","href":"/reference/api-reference/toolkits/postcustomtoolkitssync"},{"title":"Get toolkit by slug","deprecated":false,"version":null,"sidebarTitle":"Gettoolkitsbyslug","openapi":"/api-reference/openapi.json get /api/v3.1/toolkits/{slug}","href":"/reference/api-reference/toolkits/gettoolkitsbyslug"},{"title":"Fetch multiple toolkits","deprecated":false,"version":null,"sidebarTitle":"Posttoolkitsmulti","openapi":"/api-reference/openapi.json post /api/v3.1/toolkits/multi","href":"/reference/api-reference/toolkits/posttoolkitsmulti"},{"title":"Get toolkits changelog","deprecated":false,"version":null,"sidebarTitle":"Gettoolkitschangelog","openapi":"/api-reference/openapi.json get /api/v3.1/toolkits/changelog","href":"/reference/api-reference/toolkits/gettoolkitschangelog"}]},{"group":"Organization","pages":[{"title":"Org usage summary","deprecated":false,"version":null,"sidebarTitle":"Postorgusagesummary","openapi":"/api-reference/openapi.json post /api/v3.1/org/usage/summary","href":"/reference/api-reference/organization/postorgusagesummary"},{"title":"Org usage breakdown","deprecated":false,"version":null,"sidebarTitle":"Postorgusagebyentitytype","openapi":"/api-reference/openapi.json post /api/v3.1/org/usage/{entity_type}","href":"/reference/api-reference/organization/postorgusagebyentitytype"}]},{"group":"Projects","pages":[{"title":"Project usage summary","deprecated":false,"version":null,"sidebarTitle":"Postprojectusagesummary","openapi":"/api-reference/openapi.json post /api/v3.1/project/usage/summary","href":"/reference/api-reference/projects/postprojectusagesummary"},{"title":"Project usage breakdown","deprecated":false,"version":null,"sidebarTitle":"Postprojectusagebyentitytype","openapi":"/api-reference/openapi.json post /api/v3.1/project/usage/{entity_type}","href":"/reference/api-reference/projects/postprojectusagebyentitytype"},{"title":"List all projects","deprecated":false,"version":null,"sidebarTitle":"Getorgprojectlist","openapi":"/api-reference/openapi.json get /api/v3.1/org/project/list","href":"/reference/api-reference/projects/getorgprojectlist"},{"title":"Create a new project","deprecated":false,"version":null,"sidebarTitle":"Postorgownerprojectnew","openapi":"/api-reference/openapi.json post /api/v3.1/org/owner/project/new","href":"/reference/api-reference/projects/postorgownerprojectnew"},{"title":"List all projects","deprecated":false,"version":null,"sidebarTitle":"Getorgownerprojectlist","openapi":"/api-reference/openapi.json get /api/v3.1/org/owner/project/list","href":"/reference/api-reference/projects/getorgownerprojectlist"},{"title":"Get project details by ID With Org Api key","deprecated":false,"version":null,"sidebarTitle":"Getorgownerprojectbynanoid","openapi":"/api-reference/openapi.json get /api/v3.1/org/owner/project/{nano_id}","href":"/reference/api-reference/projects/getorgownerprojectbynanoid"},{"title":"Delete a project","deprecated":false,"version":null,"sidebarTitle":"Deleteorgownerprojectbynanoid","openapi":"/api-reference/openapi.json delete /api/v3.1/org/owner/project/{nano_id}","href":"/reference/api-reference/projects/deleteorgownerprojectbynanoid"},{"title":"Delete and generate new API key for project","deprecated":false,"version":null,"sidebarTitle":"Postorgownerprojectbynanoidregenerateapikey","openapi":"/api-reference/openapi.json post /api/v3.1/org/owner/project/{nano_id}/regenerate_api_key","href":"/reference/api-reference/projects/postorgownerprojectbynanoidregenerateapikey"}]},{"group":"Auth Configs","pages":[{"title":"List authentication configurations with optional filters","deprecated":false,"version":null,"sidebarTitle":"Getauthconfigs","openapi":"/api-reference/openapi.json get /api/v3.1/auth_configs","href":"/reference/api-reference/auth-configs/getauthconfigs"},{"title":"Create new authentication configuration","deprecated":false,"version":null,"sidebarTitle":"Postauthconfigs","openapi":"/api-reference/openapi.json post /api/v3.1/auth_configs","href":"/reference/api-reference/auth-configs/postauthconfigs"},{"title":"Get single authentication configuration by ID","deprecated":false,"version":null,"sidebarTitle":"Getauthconfigsbynanoid","openapi":"/api-reference/openapi.json get /api/v3.1/auth_configs/{nanoid}","href":"/reference/api-reference/auth-configs/getauthconfigsbynanoid"},{"title":"Delete an authentication configuration","deprecated":false,"version":null,"sidebarTitle":"Deleteauthconfigsbynanoid","openapi":"/api-reference/openapi.json delete /api/v3.1/auth_configs/{nanoid}","href":"/reference/api-reference/auth-configs/deleteauthconfigsbynanoid"},{"title":"Update an authentication configuration","deprecated":false,"version":null,"sidebarTitle":"Patchauthconfigsbynanoid","openapi":"/api-reference/openapi.json patch /api/v3.1/auth_configs/{nanoid}","href":"/reference/api-reference/auth-configs/patchauthconfigsbynanoid"},{"title":"Enable or disable an authentication configuration (DEPRECATED)","deprecated":true,"version":null,"sidebarTitle":"Patchauthconfigsbynanoidbystatus","openapi":"/api-reference/openapi.json patch /api/v3.1/auth_configs/{nanoid}/{status}","href":"/reference/api-reference/auth-configs/patchauthconfigsbynanoidbystatus"}]},{"group":"Organization Management","pages":[{"title":"List organizations","deprecated":false,"version":null,"sidebarTitle":"Getorglist","openapi":"/api-reference/openapi.json get /api/v3.1/org/list","href":"/reference/api-reference/organization-management/getorglist"}]},{"group":"Webhook Subscriptions","pages":[{"title":"List webhook subscriptions","deprecated":false,"version":null,"sidebarTitle":"Getwebhooksubscriptions","openapi":"/api-reference/openapi.json get /api/v3.1/webhook_subscriptions","href":"/reference/api-reference/webhook-subscriptions/getwebhooksubscriptions"},{"title":"Create webhook subscription","deprecated":false,"version":null,"sidebarTitle":"Postwebhooksubscriptions","openapi":"/api-reference/openapi.json post /api/v3.1/webhook_subscriptions","href":"/reference/api-reference/webhook-subscriptions/postwebhooksubscriptions"},{"title":"Get webhook subscription","deprecated":false,"version":null,"sidebarTitle":"Getwebhooksubscriptionsbyid","openapi":"/api-reference/openapi.json get /api/v3.1/webhook_subscriptions/{id}","href":"/reference/api-reference/webhook-subscriptions/getwebhooksubscriptionsbyid"},{"title":"Delete webhook subscription","deprecated":false,"version":null,"sidebarTitle":"Deletewebhooksubscriptionsbyid","openapi":"/api-reference/openapi.json delete /api/v3.1/webhook_subscriptions/{id}","href":"/reference/api-reference/webhook-subscriptions/deletewebhooksubscriptionsbyid"},{"title":"Update webhook subscription","deprecated":false,"version":null,"sidebarTitle":"Patchwebhooksubscriptionsbyid","openapi":"/api-reference/openapi.json patch /api/v3.1/webhook_subscriptions/{id}","href":"/reference/api-reference/webhook-subscriptions/patchwebhooksubscriptionsbyid"},{"title":"Rotate webhook secret","deprecated":false,"version":null,"sidebarTitle":"Postwebhooksubscriptionsbyidrotatesecret","openapi":"/api-reference/openapi.json post /api/v3.1/webhook_subscriptions/{id}/rotate_secret","href":"/reference/api-reference/webhook-subscriptions/postwebhooksubscriptionsbyidrotatesecret"},{"title":"List available event types","deprecated":false,"version":null,"sidebarTitle":"Getwebhooksubscriptionseventtypes","openapi":"/api-reference/openapi.json get /api/v3.1/webhook_subscriptions/event_types","href":"/reference/api-reference/webhook-subscriptions/getwebhooksubscriptionseventtypes"}]},{"group":"Webhook Endpoints","pages":[{"title":"List webhook endpoints","deprecated":false,"version":null,"sidebarTitle":"Getwebhookendpoints","openapi":"/api-reference/openapi.json get /api/v3.1/webhook_endpoints","href":"/reference/api-reference/webhook-endpoints/getwebhookendpoints"},{"title":"Create webhook endpoint","deprecated":false,"version":null,"sidebarTitle":"Postwebhookendpoints","openapi":"/api-reference/openapi.json post /api/v3.1/webhook_endpoints","href":"/reference/api-reference/webhook-endpoints/postwebhookendpoints"},{"title":"Get webhook endpoint","deprecated":false,"version":null,"sidebarTitle":"Getwebhookendpointsbynanoid","openapi":"/api-reference/openapi.json get /api/v3.1/webhook_endpoints/{nano_id}","href":"/reference/api-reference/webhook-endpoints/getwebhookendpointsbynanoid"},{"title":"Put webhook endpoint configuration","deprecated":false,"version":null,"sidebarTitle":"Postwebhookendpointsbynanoid","openapi":"/api-reference/openapi.json post /api/v3.1/webhook_endpoints/{nano_id}","href":"/reference/api-reference/webhook-endpoints/postwebhookendpointsbynanoid"},{"title":"Update webhook endpoint configuration","deprecated":false,"version":null,"sidebarTitle":"Patchwebhookendpointsbynanoid","openapi":"/api-reference/openapi.json patch /api/v3.1/webhook_endpoints/{nano_id}","href":"/reference/api-reference/webhook-endpoints/patchwebhookendpointsbynanoid"}]},{"group":"Triggers","pages":[{"title":"Create or update a trigger","deprecated":false,"version":null,"sidebarTitle":"Posttriggerinstancesbyslugupsert","openapi":"/api-reference/openapi.json post /api/v3.1/trigger_instances/{slug}/upsert","href":"/reference/api-reference/triggers/posttriggerinstancesbyslugupsert"},{"title":"List active triggers","deprecated":false,"version":null,"sidebarTitle":"Gettriggerinstancesactive","openapi":"/api-reference/openapi.json get /api/v3.1/trigger_instances/active","href":"/reference/api-reference/triggers/gettriggerinstancesactive"},{"title":"Delete a trigger","deprecated":false,"version":null,"sidebarTitle":"Deletetriggerinstancesmanagebytriggerid","openapi":"/api-reference/openapi.json delete /api/v3.1/trigger_instances/manage/{triggerId}","href":"/reference/api-reference/triggers/deletetriggerinstancesmanagebytriggerid"},{"title":"Update a trigger","deprecated":false,"version":null,"sidebarTitle":"Patchtriggerinstancesmanagebytriggerid","openapi":"/api-reference/openapi.json patch /api/v3.1/trigger_instances/manage/{triggerId}","href":"/reference/api-reference/triggers/patchtriggerinstancesmanagebytriggerid"},{"title":"List trigger type enums","deprecated":false,"version":null,"sidebarTitle":"Gettriggerstypeslistenum","openapi":"/api-reference/openapi.json get /api/v3.1/triggers_types/list/enum","href":"/reference/api-reference/triggers/gettriggerstypeslistenum"},{"title":"Get trigger type by slug","deprecated":false,"version":null,"sidebarTitle":"Gettriggerstypesbyslug","openapi":"/api-reference/openapi.json get /api/v3.1/triggers_types/{slug}","href":"/reference/api-reference/triggers/gettriggerstypesbyslug"},{"title":"List trigger types","deprecated":false,"version":null,"sidebarTitle":"Gettriggerstypes","openapi":"/api-reference/openapi.json get /api/v3.1/triggers_types","href":"/reference/api-reference/triggers/gettriggerstypes"}]},{"group":"MCP","pages":[{"title":"List MCP servers with optional filters and pagination","deprecated":true,"version":null,"sidebarTitle":"Getmcpservers","openapi":"/api-reference/openapi.json get /api/v3.1/mcp/servers","href":"/reference/api-reference/mcp/getmcpservers"},{"title":"Create a new MCP server","deprecated":true,"version":null,"sidebarTitle":"Postmcpservers","openapi":"/api-reference/openapi.json post /api/v3.1/mcp/servers","href":"/reference/api-reference/mcp/postmcpservers"},{"title":"Create a new custom MCP server with multiple apps","deprecated":true,"version":null,"sidebarTitle":"Postmcpserverscustom","openapi":"/api-reference/openapi.json post /api/v3.1/mcp/servers/custom","href":"/reference/api-reference/mcp/postmcpserverscustom"},{"title":"Generate MCP URL with custom parameters","deprecated":true,"version":null,"sidebarTitle":"Postmcpserversgenerate","openapi":"/api-reference/openapi.json post /api/v3.1/mcp/servers/generate","href":"/reference/api-reference/mcp/postmcpserversgenerate"},{"title":"Get MCP server details by ID","deprecated":true,"version":null,"sidebarTitle":"Getmcpbyid","openapi":"/api-reference/openapi.json get /api/v3.1/mcp/{id}","href":"/reference/api-reference/mcp/getmcpbyid"},{"title":"Delete an MCP server","deprecated":true,"version":null,"sidebarTitle":"Deletemcpbyid","openapi":"/api-reference/openapi.json delete /api/v3.1/mcp/{id}","href":"/reference/api-reference/mcp/deletemcpbyid"},{"title":"Update MCP server configuration","deprecated":true,"version":null,"sidebarTitle":"Patchmcpbyid","openapi":"/api-reference/openapi.json patch /api/v3.1/mcp/{id}","href":"/reference/api-reference/mcp/patchmcpbyid"},{"title":"List MCP servers for a specific app","deprecated":true,"version":null,"sidebarTitle":"Getmcpappbyappkey","openapi":"/api-reference/openapi.json get /api/v3.1/mcp/app/{appKey}","href":"/reference/api-reference/mcp/getmcpappbyappkey"},{"title":"List all instances for an MCP server","deprecated":true,"version":null,"sidebarTitle":"Getmcpserversbyserveridinstances","openapi":"/api-reference/openapi.json get /api/v3.1/mcp/servers/{serverId}/instances","href":"/reference/api-reference/mcp/getmcpserversbyserveridinstances"},{"title":"Create a new MCP server instance","deprecated":true,"version":null,"sidebarTitle":"Postmcpserversbyserveridinstances","openapi":"/api-reference/openapi.json post /api/v3.1/mcp/servers/{serverId}/instances","href":"/reference/api-reference/mcp/postmcpserversbyserveridinstances"},{"title":"Delete an MCP server instance and associated connected accounts","deprecated":true,"version":null,"sidebarTitle":"Deletemcpserversbyserveridinstancesbyinstanceid","openapi":"/api-reference/openapi.json delete /api/v3.1/mcp/servers/{serverId}/instances/{instanceId}","href":"/reference/api-reference/mcp/deletemcpserversbyserveridinstancesbyinstanceid"}]},{"group":"Files","pages":[{"title":"List files with optional app and action filters (DEPRECATED)","deprecated":true,"version":null,"sidebarTitle":"Getfileslist","openapi":"/api-reference/openapi.json get /api/v3.1/files/list","href":"/reference/api-reference/files/getfileslist"},{"title":"Create presigned URL for request file upload to S3","deprecated":false,"version":null,"sidebarTitle":"Postfilesuploadrequest","openapi":"/api-reference/openapi.json post /api/v3.1/files/upload/request","href":"/reference/api-reference/files/postfilesuploadrequest"}]},{"group":"Webhook Events","pages":[{"title":"Trigger message","openapi":"api-reference/openapi.json webhook composio.trigger.message","href":"/reference/api-reference/webhook-events/composio_trigger_message"},{"title":"Trigger message (V2)","openapi":"api-reference/openapi.json webhook composio.trigger.message.v2","deprecated":true,"href":"/reference/api-reference/webhook-events/composio_trigger_message_v2"},{"title":"Trigger message (V1)","openapi":"api-reference/openapi.json webhook composio.trigger.message.v1","deprecated":true,"href":"/reference/api-reference/webhook-events/composio_trigger_message_v1"},{"title":"Connection expired","openapi":"api-reference/openapi.json webhook composio.connected_account.expired","href":"/reference/api-reference/webhook-events/composio_connected_account_expired"},{"title":"Connection activated","openapi":"api-reference/openapi.json webhook composio.connected_account.activated","href":"/reference/api-reference/webhook-events/composio_connected_account_activated"},{"title":"Trigger disabled","openapi":"api-reference/openapi.json webhook composio.trigger.disabled","href":"/reference/api-reference/webhook-events/composio_trigger_disabled"}]}]},{"version":"v3.0","pages":[{"title":"v3.0","href":"/reference/v3"}]}]}]},"basePath":"","title":"Patch a tool router session config (v3.1) - Composio Docs","buildId":"dpl_5tKr6cUUeuVJdEZ9JAEY3h4soMJ8","deploymentId":"dpl_5tKr6cUUeuVJdEZ9JAEY3h4soMJ8","dynamics":["c2aa737661","b0f84f53ff","a9bb46feb3","2b790eda92"],"chunks":["OpenApiReferenceProvider-DbeN8Wo6.js","utils-CwSb5Doc.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-BmREeM3N.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-AYjWerCj.js","snippetPresets-QD4ULQlp.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","conditional-requirements-CFM0id0Q.js","Page-CqcDm2To.js","ApiExamples-Digj5cjF.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-CiHrzluR.js","shallow-D7h7pFGg.js","getApiPlaygroundDisplay-mlxkpAUf.js","CodeSnippet-D2rH5lZI.js","CodeSnippets-B53ulOaL.js","getPastedJson-DxGeNMih.js","icon-BHbyrebp.js","MethodPill-C7F_KEEJ.js","DuplicateIcon-j3c5-73z.js","createIcon-OvCnyFqD.js","DynamicMarkdown-DpAS3GCb.js","SectionHeading-DMPpdrvW.js","axios-vUo_bRtp.js","Markdown-D7pDRguu.js","clsx-2_c6mSt_.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-Cu7_SikL.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-ydqCcy4b.js"]}