@devries-cameron20 / composio-1 / commits / 3407bdf9d
Fork 0

Composio powers 1000+ toolkits, tool search, context management, authentication, and a sandboxed workbench to help you build AI agents that turn intent into action.

docs: update guides for SDK changes (#5072)

## Summary Automated docs update triggered by SDK source changes on `next`. - Claude reviewed the SDK diff and updated guides, FAQs, or examples that reference changed APIs or features. - The docs `@composio/*` dependencies were realigned to their latest published releases so Twoslash snippets and example apps validate against versions users can actually install. ## Review checklist - [ ] Changes accurately reflect the new SDK behavior - [ ] No unrelated docs were modified - [ ] Code examples are correct and complete - [ ] If a documented feature is not published yet, the Twoslash build will fail — wait for the release instead of working around it Generated by Claude Code via GitHub Actions. --------- Co-authored-by: jkomyno <12381818+jkomyno@users.noreply.github.com> Co-authored-by: jkomyno <alberto@composio.dev>

sdkrelease[bot] committed Oct 27, 2026 at 13:25 UTC 3407bdf9d46f70b74f1f3ab40c2d11a906a8e957
5 files changed +30 -14
docs/bun.lock
+4 -4
@@ -48,9 +48,9 @@
48 "@ai-sdk/react": "^4.0.96",
49 "@anthropic-ai/claude-agent-sdk": "^0.3.263",
50 "@anthropic-ai/sdk": "^0.115.0",
51 - "@composio/anthropic": "^0.11.5",
51 + "@composio/anthropic": "^0.11.6",
52 "@composio/claude-agent-sdk": "^0.13.0",
53 - "@composio/core": "^0.26.0",
53 + "@composio/core": "^0.27.0",
54 "@composio/google": "^0.12.0",
55 "@composio/langchain": "^0.11.2",
56 "@composio/llamaindex": "^0.11.2",
@@ -219,13 +219,13 @@
219
220 "@chevrotain/types": ["@chevrotain/types@11.1.2", "", {}, "sha512-U+HFai5+zmJCkK86QsaJtoITlboZHBqrVketcO2ROv865xfCMSFpELQoz1GkX5GzME8pTa+3kbKrZHQtI0gdbw=="],
221
222 - "@composio/anthropic": ["@composio/anthropic@0.11.5", "", { "peerDependencies": { "@anthropic-ai/sdk": "^0.110.0 || ^0.120.0 || ^0.124.0 || ^0.125.0 || ^0.127.0 || ^0.132.0", "@composio/core": ">=0.10.0 <1.0.0 || >=1.0.0-beta.0 <1.0.0", "@mastra/mcp": "^1.13.1" } }, "sha512-XwvwUgPumTMnNocKRcP/Nr/thiQ6XRjmDWqFHQ1A0yQgcS689a8lkWQrUDYThghPpPmAPmhMRs0k9YoOJ5GrAg=="],
222 + "@composio/anthropic": ["@composio/anthropic@0.11.6", "", { "peerDependencies": { "@anthropic-ai/sdk": "^0.110.0 || ^0.120.0 || ^0.124.0 || ^0.125.0 || ^0.127.0 || ^0.132.0 || ^0.133.0", "@composio/core": ">=0.10.0 <1.0.0 || >=1.0.0-beta.0 <1.0.0" } }, "sha512-3DIycP1DbLWm7tiLECo9qARxjkKefj3d85dZVsWrQhTcY0cGT8mxoTJlu7nn2iyFV2PprYFiUZ8zDSZqQPpWwA=="],
223
224 "@composio/claude-agent-sdk": ["@composio/claude-agent-sdk@0.13.0", "", { "dependencies": { "@composio/json-schema-to-zod": "0.4.0", "zod": "^4.5.4" }, "peerDependencies": { "@anthropic-ai/claude-agent-sdk": "^0.3.199", "@composio/core": ">=0.10.0 <1.0.0 || >=1.0.0-beta.0 <1.0.0" } }, "sha512-HYEkahUuRlj7WL1m0WJQO9SVuhdTcu/Zg3DA/B5XijRDgY5luFST/otocg4VQ21xLcuo9fMvTYXVN3jQUugv6Q=="],
225
226 "@composio/client": ["@composio/client@2.0.0-rc.19", "", { "peerDependencies": { "effect": "*" }, "optionalPeers": ["effect"] }, "sha512-EdBq7KXefbLXwK4F4wUtlG/e37pSxBQCAjJLRAgb0tHhiifDVqsmB/9AzLzpDsDfDKL/3UMUtYUiVUYaD87BVA=="],
227
228 - "@composio/core": ["@composio/core@0.26.0", "", { "dependencies": { "@composio/client": "2.0.0-rc.19", "@composio/json-schema-to-zod": "0.4.0", "@types/json-schema": "^7.0.15", "is-fs-case-sensitive": "^2.0.0", "openai": "^7.32.0", "picocolors": "^1.1.1", "pusher-js": "^8.6.0", "semver": "^7.8.5", "undici": "^7.30.0", "zod-to-json-schema": "^3.25.2" }, "peerDependencies": { "zod": ">=3.25.76 <5" } }, "sha512-jkdaLfN3rf7B1rYOnP16LyX3L8255FUJ16bdGBe2hcvr0JOgANPNzAgb2tvRotO0Bl5wGaV/caNhWCJBXQowWw=="],
228 + "@composio/core": ["@composio/core@0.27.0", "", { "dependencies": { "@composio/client": "2.0.0-rc.19", "@composio/json-schema-to-zod": "0.4.0", "@types/json-schema": "^7.0.15", "is-fs-case-sensitive": "^2.0.0", "openai": "^7.32.0", "picocolors": "^1.1.1", "pusher-js": "^8.6.0", "semver": "^7.8.5", "undici": "^7.30.0", "zod-to-json-schema": "^3.25.2" }, "peerDependencies": { "zod": ">=3.25.76 <5" } }, "sha512-tkWThMKQ3NzCoIXpMioMSwVB1Lxd7Gk1h2Z+cIdw1P0d6ARYPcmwKkscJHSVknHy4qxJkBtc3Q3dFtinIoZSaA=="],
229
230 "@composio/google": ["@composio/google@0.12.0", "", { "peerDependencies": { "@composio/core": ">=0.16.0 <1.0.0 || >=1.0.0-beta.0 <1.0.0", "@google/genai": "^1.1.0" } }, "sha512-VYVd7F3Nu0b/bxZgQLMb2mR8A2bPNTSKBx3SqJtMOZsJ7Gayu7JE+ZmZtJq8fFXGUmGRoqpwoopwudNpq7GS+w=="],
231
docs/content/docs/extending-sessions/custom-tools-and-toolkits.mdx
+5
@@ -247,6 +247,8 @@ def send_promo_email(input: PromoEmailInput, ctx):
247 method="POST",
248 body={"raw": raw},
249 )
250 + if res["result_type"] == "blocked":
251 + raise RuntimeError(res["message"])
252 return {"status": res["status"], "to": input.to}
253 ```
254 </Tab>
@@ -274,6 +276,9 @@ const sendPromoEmail = experimental_createTool("SEND_PROMO_EMAIL", {
276 method: "POST",
277 body: { raw },
278 });
279 + if (res.resultType === "blocked") {
280 + throw new Error(res.message);
281 + }
282 return { status: res.status, to: input.to };
283 },
284 });
docs/content/docs/extending-sessions/proxy-execute.mdx
+14 -8
@@ -54,7 +54,7 @@ import { Composio } from '@composio/core';
54 const composio = new Composio({ apiKey: 'your_api_key' });
55 const session = await composio.create('user_123', { toolkits: ['github'] });
56 // ---cut---
57 -const { status, data } = await session.proxyExecute({
57 +const response = await session.proxyExecute({
58 toolkit: 'github',
59 endpoint: '/repos/composiohq/composio/issues/1',
60 method: 'GET',
@@ -63,8 +63,12 @@ const { status, data } = await session.proxyExecute({
63 ],
64 });
65
66 -console.log(status);
67 -console.log(data);
66 +if (response.resultType === 'completed') {
67 + console.log(response.status);
68 + console.log(response.data);
69 +} else {
70 + console.log(response.message);
71 +}
72 ```
73 </Tab>
74 <Tab value="API">
@@ -194,9 +198,11 @@ curl -X POST https://backend.composio.dev/api/v3.1/tool_router/session \
198
199 ## Response shape
200
197 -The call forwards the upstream response's status, headers, and parsed body.
198 -Both SDKs expose the same fields; each spells them the way its language does, so
199 -TypeScript reads them as properties and Python as dictionary keys.
201 +Check `resultType` (`result_type` in Python) before reading HTTP response fields.
202 +A `completed` result forwards the upstream response's status, headers, and parsed body.
203 +Both SDKs expose the same fields; TypeScript uses properties and Python uses dictionary keys.
204 +
205 +A session hook can return `blocked` with a `message` and `blockReason` (`block_reason` in Python) instead of an HTTP response. The block reason's `type` is `request_blocked` if the request was stopped before execution, or `response_blocked` if the request ran but its response was withheld. A blocked result has no `status`, `data`, `headers`, or binary data.
206
207 | TypeScript | Python | Type | Description |
208 |---|---|---|---|
@@ -229,7 +235,7 @@ const response = await session.proxyExecute({
235 method: 'GET',
236 });
237 // ---cut---
232 -if (response.binaryData) {
238 +if (response.resultType === 'completed' && response.binaryData) {
239 console.log(response.binaryData.url);
240 }
241 ```
@@ -252,7 +258,7 @@ Don't set the `Authorization` header yourself through `parameters`. Composio inj
258
259 ## Error handling
260
255 -`status` and `data` reflect exactly what the toolkit API returned, so check `status` and branch on the common failures.
261 +For completed results, `status` and `data` reflect what the toolkit API returned. Check `status` and branch on the common failures.
262
263 If the call needs user input before it can run, the SDK raises `ToolInputRequiredError` in Python or `ComposioToolInputRequiredError` in TypeScript instead of returning an HTTP response. Nothing was executed. See [Handling requests for user input](/docs/how-composio-works#handling-requests-for-user-input) for the error fields and continuation state.
264
docs/content/docs/migration-guide/new-sdk.mdx
+5
@@ -644,6 +644,8 @@ def get_issue_info(input: GetIssueInfoInput, ctx) -> dict:
644 endpoint=f"/repos/composiohq/composio/issues/{input.issue_number}",
645 method="GET",
646 )
647 + if result["result_type"] == "blocked":
648 + raise RuntimeError(result["message"])
649 return {"data": result["data"]}
650
651 session = composio.create(
@@ -672,6 +674,9 @@ const getIssueInfo = experimental_createTool("GET_ISSUE_INFO", {
674 endpoint: `/repos/composiohq/composio/issues/${input.issueNumber}`,
675 method: "GET",
676 });
677 + if (result.resultType === "blocked") {
678 + throw new Error(result.message);
679 + }
680 return { data: result.data };
681 },
682 });
docs/package.json
+2 -2
@@ -89,9 +89,9 @@
89 "@ai-sdk/react": "^4.0.96",
90 "@anthropic-ai/claude-agent-sdk": "^0.3.263",
91 "@anthropic-ai/sdk": "^0.115.0",
92 - "@composio/anthropic": "^0.11.5",
92 + "@composio/anthropic": "^0.11.6",
93 "@composio/claude-agent-sdk": "^0.13.0",
94 - "@composio/core": "^0.26.0",
94 + "@composio/core": "^0.27.0",
95 "@composio/google": "^0.12.0",
96 "@composio/langchain": "^0.11.2",
97 "@composio/llamaindex": "^0.11.2",