@devries-cameron20 / composio-1 / commits / 856d49267
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: add changelog entry for API v3.1 tool version defaults

Explains the key difference between v3 and v3.1: tool-related endpoints now default to the latest toolkit version instead of 00000000_00. Includes migration guide and affected endpoint table. Co-Authored-By: Claude Opus 4.6 <noreply@anthropic.com> Co-authored-by: Zen Agent <zen@composio.dev>

rahul.lingala committed Apr 8, 2026 at 12:49 UTC 856d49267f952b034f7a66f20c3280d3e26af888
1 file changed +55
docs/content/changelog/04-08-26-v31-api.mdx new
+55
@@ -0,0 +1,55 @@
1 +---
2 +title: "Introducing API v3.1 - Latest Tool Versions by Default"
3 +description: "API v3.1 endpoints now default to the latest toolkit version for tool-related endpoints instead of the legacy pinned version."
4 +date: "2026-04-08"
5 +---
6 +
7 +We're rolling out API v3.1 endpoints that change how tool versions are resolved. The key difference: **tool-related endpoints now default to the latest toolkit version** instead of the legacy pinned version (`00000000_00`).
8 +
9 +### What Changed
10 +
11 +In API v3 (`/api/v3/tools/*`), tool-related endpoints default the `version` parameter to `00000000_00` (the initial pinned version). This means callers must explicitly pass `version: "latest"` or a specific version string to get the most recent tool definitions.
12 +
13 +In API v3.1 (`/api/v3.1/tools/*`), the default is flipped: **tool-related endpoints default to the latest toolkit version**. If you're already passing `version: "latest"` in your requests, switching to v3.1 changes nothing for you. If you were relying on the `00000000_00` default, you'll now get the latest version unless you explicitly pin.
14 +
15 +**Affected tool endpoints:**
16 +
17 +| Endpoint | v3 Default Version | v3.1 Default Version |
18 +|----------|-------------------|---------------------|
19 +| `GET /tools` | `00000000_00` | `latest` |
20 +| `GET /tools/enum` | `00000000_00` | `latest` |
21 +| `GET /tools/{tool_slug}` | `00000000_00` | `latest` |
22 +| `POST /tools/execute/{tool_slug}` | `00000000_00` | `latest` |
23 +| `POST /tools/execute/{tool_slug}/input` | `00000000_00` | `latest` |
24 +| `POST /tools/execute/proxy` | `00000000_00` | `latest` |
25 +| `POST /tools/scopes/required` | `00000000_00` | `latest` |
26 +
27 +### All Other Endpoints Are Unchanged
28 +
29 +Every non-tool endpoint (`/auth_configs`, `/connected_accounts`, `/triggers`, `/toolkits`, etc.) behaves identically between v3 and v3.1. They are served at both `/api/v3/` and `/api/v3.1/` paths with the same request and response contracts.
30 +
31 +### Migration Guide
32 +
33 +**If you're using the Composio SDK:** No action needed. The SDK will adopt v3.1 endpoints in an upcoming release.
34 +
35 +**If you're calling the API directly:**
36 +
37 +1. Replace `/api/v3/` with `/api/v3.1/` in your tool endpoint URLs
38 +2. If you depend on a specific pinned version, pass `version: "00000000_00"` explicitly
39 +3. If you were already passing `version: "latest"`, you can drop the parameter entirely on v3.1
40 +
41 +**Before (v3):**
42 +```bash
43 +curl https://backend.composio.dev/api/v3/tools?toolkit_slug=gmail&toolkit_versions=latest \
44 + -H "x-api-key: YOUR_KEY"
45 +```
46 +
47 +**After (v3.1):**
48 +```bash
49 +curl https://backend.composio.dev/api/v3.1/tools?toolkit_slug=gmail \
50 + -H "x-api-key: YOUR_KEY"
51 +```
52 +
53 +### v3 Is Not Going Away
54 +
55 +API v3 endpoints continue to work exactly as before. There is no deprecation timeline. You can migrate to v3.1 at your own pace.