@devries-cameron20 / composio Mirror · read-only / commits / 0f0ca14a8
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.

Mirrored from https://github.com/Camo67/composio.git

Synced Nov 21, 19:45 UTC

docs: refresh OpenAPI reference (#3699)

## Summary - Refresh the checked-in v3.1 and v3 OpenAPI snapshots from the live backend specs using `bun run scripts/fetch-openapi.mjs`. - Regenerate API reference index pages with `bun run generate:api-index`. - Surfaces `DELETE /api/v3.1/tool_router/session/{session_id}` in the Tool Router API reference. - Includes the other upstream generated spec changes from the same auto-fetch, including generated API Keys and Organization Management section indexes. ## Verification - `bun run scripts/fetch-openapi.mjs` - `bun run generate:api-index` - `git diff --check` - `bun run build` ## Notes before merge - This is intentionally the full auto-generated OpenAPI refresh, not the surgical two-file patch. - The generated backend OpenAPI still contains some `internal` wording in descriptions; left as-is to preserve the auto-generated output. - Confirm the newly generated API Keys / Organization Management sections are intended to publish with this refresh. --------- Co-authored-by: jkomyno <alberto@composio.dev>

Abhishek Patil committed Jun 30, 2026 at 10:38 UTC 0f0ca14a8ffa7b740cd21a9981524631b97f8622
23 files changed +1190 -2082
docs/api-overviews/connected-accounts.mdx
+2 -2
@@ -2,7 +2,7 @@ A connected account is a single user's authorized connection to a toolkit. It st
2
3 Composio creates a connected account when a user completes the flow defined by an [auth config](/reference/api-reference/auth-configs). From there you manage its full lifecycle:
4
5 -- **Create or link**: start a new connection, or generate an auth link session for the user to authorize. See [manually authenticating users](/docs/authenticating-users/manually-authenticating).
5 +- **Create or link**: start a new connection, or generate an auth link session for the user to authorize. See [manually authenticating users](/docs/manually-authenticating).
6 - **Refresh**: renew authentication for an account whose tokens have expired.
7 - **Enable, disable, or update**: change an account's status or metadata without removing it.
8 - **Revoke or delete**: revoke the grant at the provider, or remove the account from Composio.
@@ -13,7 +13,7 @@ Each account is addressed by its `nanoid`. List endpoints accept filters so you
13
14 A Composio Connect Link is a hosted, secure sign-in page. You create one with the create auth link session endpoint, redirect the user to the returned URL, and Composio handles the rest: the user signs in, Composio creates the connected account, and Composio stores and refreshes its tokens. Credentials never pass through your app. This works for all Composio managed connections, with no OAuth credentials to set up.
15
16 -By default a connected account is `PRIVATE` and usable only by its owning user. Mark one `SHARED` to let other users reach it through a per-connection access control list. See [shared connections](/docs/authenticating-users/shared-connections).
16 +By default a connected account is `PRIVATE` and usable only by its owning user. Mark one `SHARED` to let other users reach it through a per-connection access control list. See [shared connections](/docs/shared-connections).
17
18 These endpoints use your project API key in the `x-api-key` header.
19
docs/api-overviews/files.mdx
+1 -1
@@ -11,6 +11,6 @@ This keeps large payloads out of request bodies. Tools receive a file reference
11 File uploads are a two-step flow. Call the upload-request endpoint to mint a presigned URL, then upload the file contents directly to that URL. The API never receives the raw bytes.
12 </Callout>
13
14 -If your agent works with files inside a session, prefer the session file mount, where the sandbox exposes uploaded files to running code. See the [sandbox](/docs/sandbox) for the sandbox helpers (`upload_local_file`, `smart_file_extract`) that build on this storage.
14 +If your agent works with files inside a session, prefer the session file mount, where the sandbox exposes uploaded files to running code. See the [remote sandbox](/docs/sandbox/remote) for the sandbox helpers (`upload_local_file`, `smart_file_extract`) that build on this storage.
15
16 These endpoints use your project API key in the `x-api-key` header.
docs/api-overviews/projects.mdx
+2 -12
@@ -50,16 +50,6 @@ The list endpoint supports pagination with `limit` and `cursor`; getting a proje
50
51 ## Project settings
52
53 -Each project has settings that control security, logging, and display behavior. These endpoints use your **project API key** (`x-api-key`), not the org key.
53 +Each project has settings that control security, logging, and display behavior. The project detail endpoints return current configuration for inspection. Use **Settings > Project Settings** in the [dashboard](https://dashboard.composio.dev/~/project/settings/general) to update project settings.
54
55 -```bash
56 -curl -X PATCH https://backend.composio.dev/api/v3.1/org/project/config \
57 - -H "x-api-key: YOUR_API_KEY" \
58 - -H "Content-Type: application/json" \
59 - -d '{
60 - "mask_secret_keys_in_connected_account": false,
61 - "log_visibility_setting": "show_all"
62 - }'
63 -```
64 -
65 -Notable security setting: `require_mcp_api_key`, when `true`, requires MCP server requests to include a valid `x-api-key` header. This defaults to `true` for organizations created on or after March 5, 2026. You can also view and update project settings from **Settings > Project Settings** in the [dashboard](https://dashboard.composio.dev/~/project/settings/general).
55 +Notable security setting: `require_mcp_api_key`, when `true`, requires MCP server requests to include a valid `x-api-key` header. This defaults to `true` for organizations created on or after March 5, 2026.
docs/api-overviews/webhook-endpoints.mdx
+1 -1
@@ -4,4 +4,4 @@ Reach for these endpoints when an OAuth app you have configured needs to deliver
4
5 Each endpoint is addressed by its `nano_id`. The `POST` to `/webhook_endpoints/{nano_id}` replaces the full configuration, while `PATCH` updates it in place.
6
7 -This is distinct from [webhook subscriptions](/reference/api-reference/webhook-subscriptions), which control where Composio delivers outbound trigger events. To verify the signature on payloads Composio sends you, see [Webhook verification](/docs/webhook-verification). To set up the trigger events those payloads carry, see [Triggers](/docs/triggers).
7 +This is distinct from [webhook subscriptions](/reference/api-reference/webhook-subscriptions), which control where Composio delivers outbound trigger events. To verify the signature on payloads Composio sends you, see [Verifying signatures](/docs/setting-up-triggers/subscribing-to-events#verifying-signatures). To set up the trigger events those payloads carry, see [Triggers](/docs/triggers).
docs/api-overviews/webhook-subscriptions.mdx
+3 -3
@@ -4,7 +4,7 @@ Reach for these endpoints to register where Composio should send events, to filt
4
5 Each subscription is addressed by its `id`. You can update its URL and filters with `PATCH`, delete it, and rotate its signing secret with `/webhook_subscriptions/{id}/rotate_secret` if the secret leaks.
6
7 -Every webhook request Composio sends includes `webhook-id`, `webhook-timestamp`, and `webhook-signature` headers. Store the secret as `COMPOSIO_WEBHOOK_SECRET` and verify each payload before trusting it. See [Webhook verification](/docs/webhook-verification) for the SDK and manual verification flows.
7 +Every webhook request Composio sends includes `webhook-id`, `webhook-timestamp`, and `webhook-signature` headers. Store the secret as `COMPOSIO_WEBHOOK_SECRET` and verify each payload before trusting it. See [Verifying signatures](/docs/setting-up-triggers/subscribing-to-events#verifying-signatures) for the SDK and manual verification flows.
8
9 ## Event types
10
@@ -22,7 +22,7 @@ Composio automatically refreshes OAuth tokens before they expire. But when a ref
22 Subscribe to the `composio.connected_account.expired` event to detect this proactively, instead of waiting for a tool execution to fail.
23
24 <Callout>
25 -This event is only available with [V3 webhook payloads](/docs/webhook-verification#webhook-payload-versions). New organizations use V3 by default.
25 +This event is only available with [V3 webhook payloads](/docs/setting-up-triggers/subscribing-to-events#webhook-payload-versions). New organizations use V3 by default.
26 </Callout>
27
28 Add `composio.connected_account.expired` to the subscription's `enabled_events`:
@@ -128,5 +128,5 @@ export default async function webhookHandler(req: NextApiRequest, res: NextApiRe
128 </Tabs>
129
130 <Callout>
131 -Always [verify webhook signatures](/docs/webhook-verification) before processing events in production.
131 +Always [verify webhook signatures](/docs/setting-up-triggers/subscribing-to-events#verifying-signatures) before processing events in production.
132 </Callout>
docs/content/reference/api-reference/api-keys/index.mdx new
+12
@@ -0,0 +1,12 @@
1 +---
2 +title: API Keys
3 +description: "API key management"
4 +---
5 +
6 +{/* Auto-generated from OpenAPI spec. Do not edit directly. */}
7 +
8 +API key management
9 +
10 +## Endpoints
11 +
12 +<ApiEndpointsTable endpoints={[{"method":"POST","pathV31":"/api/v3.1/api_key_revocation","pathV3":"/api/v3/api_key_revocation","summary":"Publicly revoke leaked Composio API keys","href":"/reference/api-reference/api-keys/postApiKeyRevocation"}]} />
docs/content/reference/api-reference/files/index.mdx
+2 -2
@@ -18,10 +18,10 @@ This keeps large payloads out of request bodies. Tools receive a file reference
18 File uploads are a two-step flow. Call the upload-request endpoint to mint a presigned URL, then upload the file contents directly to that URL. The API never receives the raw bytes.
19 </Callout>
20
21 -If your agent works with files inside a session, prefer the session file mount, where the sandbox exposes uploaded files to running code. See the [sandbox](/docs/sandbox/remote) for the sandbox helpers (`upload_local_file`, `smart_file_extract`) that build on this storage.
21 +If your agent works with files inside a session, prefer the session file mount, where the sandbox exposes uploaded files to running code. See the [remote sandbox](/docs/sandbox/remote) for the sandbox helpers (`upload_local_file`, `smart_file_extract`) that build on this storage.
22
23 These endpoints use your project API key in the `x-api-key` header.
24
25 ## Endpoints
26
27 -<ApiEndpointsTable endpoints={[{"method":"GET","pathV31":"/api/v3.1/files/list","pathV3":"/api/v3/files/list","summary":"List files with optional app and action filters","href":"/reference/api-reference/files/getFilesList"},{"method":"POST","pathV31":"/api/v3.1/files/upload/request","pathV3":"/api/v3/files/upload/request","summary":"Create presigned URL for request file upload to S3","href":"/reference/api-reference/files/postFilesUploadRequest"}]} />
27 +<ApiEndpointsTable endpoints={[{"method":"GET","pathV31":"/api/v3.1/files/list","pathV3":"/api/v3/files/list","summary":"List files with optional app and action filters (DEPRECATED)","href":"/reference/api-reference/files/getFilesList"},{"method":"POST","pathV31":"/api/v3.1/files/upload/request","pathV3":"/api/v3/files/upload/request","summary":"Create presigned URL for request file upload to S3","href":"/reference/api-reference/files/postFilesUploadRequest"}]} />
docs/content/reference/api-reference/migration/index.mdx deleted
-20
@@ -1,20 +0,0 @@
1 ----
2 -title: Migration
3 -description: "Endpoints to help with migration from v1 to v3"
4 ----
5 -
6 -{/* Auto-generated from OpenAPI spec. Edit the overview at api-overviews/migration.mdx, not this file. */}
7 -
8 -These endpoints help you migrate from Composio v1 to v3 by translating identifiers between the two systems.
9 -
10 -Reach for this endpoint when you have a v1 UUID and need the corresponding v3 NanoId so existing references continue to resolve against the v3 API. Pass the UUID and get the NanoId back.
11 -
12 -These endpoints authenticate with your project API key in the `x-api-key` header.
13 -
14 -<Callout type="info">
15 -This is a low-level translation helper for migrating identifiers. For migrating SDK code, sessions, and toolkit versioning, see the [migration guides](/docs/migration-guide).
16 -</Callout>
17 -
18 -## Endpoints
19 -
20 -<ApiEndpointsTable endpoints={[{"method":"GET","pathV31":"/api/v3.1/migration/get-nanoid","pathV3":"/api/v3/migration/get-nanoid","summary":"Get NanoId from UUID","href":"/reference/api-reference/migration/getMigrationGetNanoid"}]} />
docs/content/reference/api-reference/organization-management/index.mdx new
+12
@@ -0,0 +1,12 @@
1 +---
2 +title: Organization Management
3 +description: "Organization Management API endpoints"
4 +---
5 +
6 +{/* Auto-generated from OpenAPI spec. Do not edit directly. */}
7 +
8 +Organization Management API endpoints
9 +
10 +## Endpoints
11 +
12 +<ApiEndpointsTable endpoints={[{"method":"GET","pathV31":"/api/v3.1/org/list","pathV3":"/api/v3/org/list","summary":"List organizations","href":"/reference/api-reference/organization-management/getOrgList"}]} />
docs/content/reference/api-reference/projects/index.mdx
+3 -13
@@ -57,20 +57,10 @@ The list endpoint supports pagination with `limit` and `cursor`; getting a proje
57
58 ## Project settings
59
60 -Each project has settings that control security, logging, and display behavior. These endpoints use your **project API key** (`x-api-key`), not the org key.
60 +Each project has settings that control security, logging, and display behavior. The project detail endpoints return current configuration for inspection. Use **Settings > Project Settings** in the [dashboard](https://dashboard.composio.dev/~/project/settings/general) to update project settings.
61
62 -```bash
63 -curl -X PATCH https://backend.composio.dev/api/v3.1/org/project/config \
64 - -H "x-api-key: YOUR_API_KEY" \
65 - -H "Content-Type: application/json" \
66 - -d '{
67 - "mask_secret_keys_in_connected_account": false,
68 - "log_visibility_setting": "show_all"
69 - }'
70 -```
71 -
72 -Notable security setting: `require_mcp_api_key`, when `true`, requires MCP server requests to include a valid `x-api-key` header. This defaults to `true` for organizations created on or after March 5, 2026. You can also view and update project settings from **Settings > Project Settings** in the [dashboard](https://dashboard.composio.dev/~/project/settings/general).
62 +Notable security setting: `require_mcp_api_key`, when `true`, requires MCP server requests to include a valid `x-api-key` header. This defaults to `true` for organizations created on or after March 5, 2026.
63
64 ## Endpoints
65
76 -<ApiEndpointsTable endpoints={[{"method":"POST","pathV31":"/api/v3.1/project/usage/summary","pathV3":"/api/v3/project/usage/summary","summary":"Project usage summary","href":"/reference/api-reference/projects/postProjectUsageSummary"},{"method":"POST","pathV31":"/api/v3.1/project/usage/{entity_type}","pathV3":"/api/v3/project/usage/{entity_type}","summary":"Project usage breakdown","href":"/reference/api-reference/projects/postProjectUsageByEntityType"},{"method":"GET","pathV31":"/api/v3.1/org/project/config","pathV3":"/api/v3/org/project/config","summary":"Get project configuration","href":"/reference/api-reference/projects/getOrgProjectConfig"},{"method":"PATCH","pathV31":"/api/v3.1/org/project/config","pathV3":"/api/v3/org/project/config","summary":"Update project configuration","href":"/reference/api-reference/projects/patchOrgProjectConfig"},{"method":"POST","pathV31":"/api/v3.1/org/owner/project/new","pathV3":"/api/v3/org/owner/project/new","summary":"Create a new project","href":"/reference/api-reference/projects/postOrgOwnerProjectNew"},{"method":"GET","pathV31":"/api/v3.1/org/owner/project/list","pathV3":"/api/v3/org/owner/project/list","summary":"List all projects","href":"/reference/api-reference/projects/getOrgOwnerProjectList"},{"method":"GET","pathV31":"/api/v3.1/org/owner/project/{nano_id}","pathV3":"/api/v3/org/owner/project/{nano_id}","summary":"Get project details by ID With Org Api key","href":"/reference/api-reference/projects/getOrgOwnerProjectByNanoId"},{"method":"DELETE","pathV31":"/api/v3.1/org/owner/project/{nano_id}","pathV3":"/api/v3/org/owner/project/{nano_id}","summary":"Delete a project","href":"/reference/api-reference/projects/deleteOrgOwnerProjectByNanoId"},{"method":"POST","pathV31":"/api/v3.1/org/owner/project/{nano_id}/regenerate_api_key","pathV3":"/api/v3/org/owner/project/{nano_id}/regenerate_api_key","summary":"Delete and generate new API key for project","href":"/reference/api-reference/projects/postOrgOwnerProjectByNanoIdRegenerateApiKey"}]} />
66 +<ApiEndpointsTable endpoints={[{"method":"POST","pathV31":"/api/v3.1/project/usage/summary","pathV3":"/api/v3/project/usage/summary","summary":"Project usage summary","href":"/reference/api-reference/projects/postProjectUsageSummary"},{"method":"POST","pathV31":"/api/v3.1/project/usage/{entity_type}","pathV3":"/api/v3/project/usage/{entity_type}","summary":"Project usage breakdown","href":"/reference/api-reference/projects/postProjectUsageByEntityType"},{"method":"GET","pathV31":"/api/v3.1/org/project/list","pathV3":"/api/v3/org/project/list","summary":"List all projects","href":"/reference/api-reference/projects/getOrgProjectList"},{"method":"POST","pathV31":"/api/v3.1/org/owner/project/new","pathV3":"/api/v3/org/owner/project/new","summary":"Create a new project","href":"/reference/api-reference/projects/postOrgOwnerProjectNew"},{"method":"GET","pathV31":"/api/v3.1/org/owner/project/list","pathV3":"/api/v3/org/owner/project/list","summary":"List all projects","href":"/reference/api-reference/projects/getOrgOwnerProjectList"},{"method":"GET","pathV31":"/api/v3.1/org/owner/project/{nano_id}","pathV3":"/api/v3/org/owner/project/{nano_id}","summary":"Get project details by ID With Org Api key","href":"/reference/api-reference/projects/getOrgOwnerProjectByNanoId"},{"method":"DELETE","pathV31":"/api/v3.1/org/owner/project/{nano_id}","pathV3":"/api/v3/org/owner/project/{nano_id}","summary":"Delete a project","href":"/reference/api-reference/projects/deleteOrgOwnerProjectByNanoId"},{"method":"POST","pathV31":"/api/v3.1/org/owner/project/{nano_id}/regenerate_api_key","pathV3":"/api/v3/org/owner/project/{nano_id}/regenerate_api_key","summary":"Delete and generate new API key for project","href":"/reference/api-reference/projects/postOrgOwnerProjectByNanoIdRegenerateApiKey"}]} />
docs/content/reference/api-reference/tool-router/index.mdx
+1 -1
@@ -19,4 +19,4 @@ See [Configuring sessions](/docs/configuring-sessions) for toolkits, auth config
19
20 ## Endpoints
21
22 -<ApiEndpointsTable endpoints={[{"method":"POST","pathV31":"/api/v3.1/tool_router/session","pathV3":"/api/v3/tool_router/session","summary":"Create a new tool router session","href":"/reference/api-reference/tool-router/postToolRouterSession"},{"method":"GET","pathV31":"/api/v3.1/tool_router/session/{session_id}","pathV3":"/api/v3/tool_router/session/{session_id}","summary":"Get a tool router session by ID (v3.1)","href":"/reference/api-reference/tool-router/getToolRouterSessionBySessionId"},{"method":"PATCH","pathV31":"/api/v3.1/tool_router/session/{session_id}","pathV3":"/api/v3/tool_router/session/{session_id}","summary":"Patch a tool router session config (v3.1)","href":"/reference/api-reference/tool-router/patchToolRouterSessionBySessionId"},{"method":"POST","pathV31":"/api/v3.1/tool_router/session/{session_id}/attach","pathV3":"/api/v3/tool_router/session/{session_id}/attach","summary":"Attach to an existing tool router session (v3.1)","href":"/reference/api-reference/tool-router/postToolRouterSessionBySessionIdAttach"},{"method":"GET","pathV31":"/api/v3.1/tool_router/session/{session_id}/config_history","pathV3":"/api/v3/tool_router/session/{session_id}/config_history","summary":"List a tool router session config history","href":"/reference/api-reference/tool-router/getToolRouterSessionBySessionIdConfigHistory"},{"method":"POST","pathV31":"/api/v3.1/tool_router/session/{session_id}/search","pathV3":"/api/v3/tool_router/session/{session_id}/search","summary":"Search for tools using a query","href":"/reference/api-reference/tool-router/postToolRouterSessionBySessionIdSearch"},{"method":"GET","pathV31":"/api/v3.1/tool_router/session/{session_id}/tools","pathV3":"/api/v3/tool_router/session/{session_id}/tools","summary":"List tools with schemas for a tool router session (v3.1)","href":"/reference/api-reference/tool-router/getToolRouterSessionBySessionIdTools"},{"method":"POST","pathV31":"/api/v3.1/tool_router/session/{session_id}/execute","pathV3":"/api/v3/tool_router/session/{session_id}/execute","summary":"Execute a tool within a tool router session","href":"/reference/api-reference/tool-router/postToolRouterSessionBySessionIdExecute"},{"method":"POST","pathV31":"/api/v3.1/tool_router/session/{session_id}/execute_meta","pathV3":"/api/v3/tool_router/session/{session_id}/execute_meta","summary":"Execute a meta tool within a tool router session","href":"/reference/api-reference/tool-router/postToolRouterSessionBySessionIdExecuteMeta"},{"method":"POST","pathV31":"/api/v3.1/tool_router/session/{session_id}/link","pathV3":"/api/v3/tool_router/session/{session_id}/link","summary":"Create a link session for a toolkit in a tool router session","href":"/reference/api-reference/tool-router/postToolRouterSessionBySessionIdLink"},{"method":"POST","pathV31":"/api/v3.1/tool_router/session/{session_id}/proxy_execute","pathV3":"/api/v3/tool_router/session/{session_id}/proxy_execute","summary":"Execute proxy request within a tool router session","href":"/reference/api-reference/tool-router/postToolRouterSessionBySessionIdProxyExecute"},{"method":"GET","pathV31":"/api/v3.1/tool_router/session/{session_id}/toolkits","pathV3":"/api/v3/tool_router/session/{session_id}/toolkits","summary":"Get toolkits for a tool router session","href":"/reference/api-reference/tool-router/getToolRouterSessionBySessionIdToolkits"},{"method":"GET","pathV31":"/api/v3.1/tool_router/session/{session_id}/mounts/{mount_id}/items","pathV3":"/api/v3/tool_router/session/{session_id}/mounts/{mount_id}/items","summary":"List files in a session mount","href":"/reference/api-reference/tool-router/getToolRouterSessionBySessionIdMountsByMountIdItems"},{"method":"POST","pathV31":"/api/v3.1/tool_router/session/{session_id}/mounts/{mount_id}/download_url","pathV3":"/api/v3/tool_router/session/{session_id}/mounts/{mount_id}/download_url","summary":"Create a presigned download URL for a mount file","href":"/reference/api-reference/tool-router/postToolRouterSessionBySessionIdMountsByMountIdDownloadUrl"},{"method":"POST","pathV31":"/api/v3.1/tool_router/session/{session_id}/mounts/{mount_id}/upload_url","pathV3":"/api/v3/tool_router/session/{session_id}/mounts/{mount_id}/upload_url","summary":"Create a presigned upload URL for a mount file","href":"/reference/api-reference/tool-router/postToolRouterSessionBySessionIdMountsByMountIdUploadUrl"},{"method":"POST","pathV31":"/api/v3.1/tool_router/session/{session_id}/mounts/{mount_id}/delete","pathV3":"/api/v3/tool_router/session/{session_id}/mounts/{mount_id}/delete","summary":"Delete a file from a session mount","href":"/reference/api-reference/tool-router/postToolRouterSessionBySessionIdMountsByMountIdDelete"}]} />
22 +<ApiEndpointsTable endpoints={[{"method":"POST","pathV31":"/api/v3.1/tool_router/session","pathV3":"/api/v3/tool_router/session","summary":"Create a new tool router session","href":"/reference/api-reference/tool-router/postToolRouterSession"},{"method":"GET","pathV31":"/api/v3.1/tool_router/session/{session_id}","pathV3":"/api/v3/tool_router/session/{session_id}","summary":"Get a tool router session by ID (v3.1)","href":"/reference/api-reference/tool-router/getToolRouterSessionBySessionId"},{"method":"PATCH","pathV31":"/api/v3.1/tool_router/session/{session_id}","pathV3":"/api/v3/tool_router/session/{session_id}","summary":"Patch a tool router session config (v3.1)","href":"/reference/api-reference/tool-router/patchToolRouterSessionBySessionId"},{"method":"DELETE","pathV31":"/api/v3.1/tool_router/session/{session_id}","pathV3":"/api/v3/tool_router/session/{session_id}","summary":"Delete a tool router session","href":"/reference/api-reference/tool-router/deleteToolRouterSessionBySessionId"},{"method":"POST","pathV31":"/api/v3.1/tool_router/session/{session_id}/attach","pathV3":"/api/v3/tool_router/session/{session_id}/attach","summary":"Attach to an existing tool router session (v3.1)","href":"/reference/api-reference/tool-router/postToolRouterSessionBySessionIdAttach"},{"method":"GET","pathV31":"/api/v3.1/tool_router/session/{session_id}/config_history","pathV3":"/api/v3/tool_router/session/{session_id}/config_history","summary":"List a tool router session config history","href":"/reference/api-reference/tool-router/getToolRouterSessionBySessionIdConfigHistory"},{"method":"POST","pathV31":"/api/v3.1/tool_router/session/{session_id}/search","pathV3":"/api/v3/tool_router/session/{session_id}/search","summary":"Search for tools using a query","href":"/reference/api-reference/tool-router/postToolRouterSessionBySessionIdSearch"},{"method":"GET","pathV31":"/api/v3.1/tool_router/session/{session_id}/tools","pathV3":"/api/v3/tool_router/session/{session_id}/tools","summary":"List tools with schemas for a tool router session (v3.1)","href":"/reference/api-reference/tool-router/getToolRouterSessionBySessionIdTools"},{"method":"POST","pathV31":"/api/v3.1/tool_router/session/{session_id}/execute","pathV3":"/api/v3/tool_router/session/{session_id}/execute","summary":"Execute a tool within a tool router session","href":"/reference/api-reference/tool-router/postToolRouterSessionBySessionIdExecute"},{"method":"POST","pathV31":"/api/v3.1/tool_router/session/{session_id}/execute_meta","pathV3":"/api/v3/tool_router/session/{session_id}/execute_meta","summary":"Execute a meta tool within a tool router session","href":"/reference/api-reference/tool-router/postToolRouterSessionBySessionIdExecuteMeta"},{"method":"POST","pathV31":"/api/v3.1/tool_router/session/{session_id}/link","pathV3":"/api/v3/tool_router/session/{session_id}/link","summary":"Create a link session for a toolkit in a tool router session","href":"/reference/api-reference/tool-router/postToolRouterSessionBySessionIdLink"},{"method":"POST","pathV31":"/api/v3.1/tool_router/session/{session_id}/proxy_execute","pathV3":"/api/v3/tool_router/session/{session_id}/proxy_execute","summary":"Execute proxy request within a tool router session","href":"/reference/api-reference/tool-router/postToolRouterSessionBySessionIdProxyExecute"},{"method":"GET","pathV31":"/api/v3.1/tool_router/session/{session_id}/toolkits","pathV3":"/api/v3/tool_router/session/{session_id}/toolkits","summary":"Get toolkits for a tool router session","href":"/reference/api-reference/tool-router/getToolRouterSessionBySessionIdToolkits"},{"method":"GET","pathV31":"/api/v3.1/tool_router/session/{session_id}/mounts/{mount_id}/items","pathV3":"/api/v3/tool_router/session/{session_id}/mounts/{mount_id}/items","summary":"List files in a session mount","href":"/reference/api-reference/tool-router/getToolRouterSessionBySessionIdMountsByMountIdItems"},{"method":"POST","pathV31":"/api/v3.1/tool_router/session/{session_id}/mounts/{mount_id}/download_url","pathV3":"/api/v3/tool_router/session/{session_id}/mounts/{mount_id}/download_url","summary":"Create a presigned download URL for a mount file","href":"/reference/api-reference/tool-router/postToolRouterSessionBySessionIdMountsByMountIdDownloadUrl"},{"method":"POST","pathV31":"/api/v3.1/tool_router/session/{session_id}/mounts/{mount_id}/upload_url","pathV3":"/api/v3/tool_router/session/{session_id}/mounts/{mount_id}/upload_url","summary":"Create a presigned upload URL for a mount file","href":"/reference/api-reference/tool-router/postToolRouterSessionBySessionIdMountsByMountIdUploadUrl"},{"method":"POST","pathV31":"/api/v3.1/tool_router/session/{session_id}/mounts/{mount_id}/delete","pathV3":"/api/v3/tool_router/session/{session_id}/mounts/{mount_id}/delete","summary":"Delete a file from a session mount","href":"/reference/api-reference/tool-router/postToolRouterSessionBySessionIdMountsByMountIdDelete"}]} />
docs/content/reference/api-reference/webhook-endpoints/index.mdx
+1 -1
@@ -11,7 +11,7 @@ Reach for these endpoints when an OAuth app you have configured needs to deliver
11
12 Each endpoint is addressed by its `nano_id`. The `POST` to `/webhook_endpoints/{nano_id}` replaces the full configuration, while `PATCH` updates it in place.
13
14 -This is distinct from [webhook subscriptions](/reference/api-reference/webhook-subscriptions), which control where Composio delivers outbound trigger events. To verify the signature on payloads Composio sends you, see [Webhook verification](/docs/setting-up-triggers/subscribing-to-events#verifying-signatures). To set up the trigger events those payloads carry, see [Triggers](/docs/triggers).
14 +This is distinct from [webhook subscriptions](/reference/api-reference/webhook-subscriptions), which control where Composio delivers outbound trigger events. To verify the signature on payloads Composio sends you, see [Verifying signatures](/docs/setting-up-triggers/subscribing-to-events#verifying-signatures). To set up the trigger events those payloads carry, see [Triggers](/docs/triggers).
15
16 ## Endpoints
17
docs/content/reference/api-reference/webhook-subscriptions/index.mdx
+1 -1
@@ -11,7 +11,7 @@ Reach for these endpoints to register where Composio should send events, to filt
11
12 Each subscription is addressed by its `id`. You can update its URL and filters with `PATCH`, delete it, and rotate its signing secret with `/webhook_subscriptions/{id}/rotate_secret` if the secret leaks.
13
14 -Every webhook request Composio sends includes `webhook-id`, `webhook-timestamp`, and `webhook-signature` headers. Store the secret as `COMPOSIO_WEBHOOK_SECRET` and verify each payload before trusting it. See [Webhook verification](/docs/setting-up-triggers/subscribing-to-events#verifying-signatures) for the SDK and manual verification flows.
14 +Every webhook request Composio sends includes `webhook-id`, `webhook-timestamp`, and `webhook-signature` headers. Store the secret as `COMPOSIO_WEBHOOK_SECRET` and verify each payload before trusting it. See [Verifying signatures](/docs/setting-up-triggers/subscribing-to-events#verifying-signatures) for the SDK and manual verification flows.
15
16 ## Event types
17
docs/content/reference/v3/api-reference/files/index.mdx
+2 -2
@@ -18,10 +18,10 @@ This keeps large payloads out of request bodies. Tools receive a file reference
18 File uploads are a two-step flow. Call the upload-request endpoint to mint a presigned URL, then upload the file contents directly to that URL. The API never receives the raw bytes.
19 </Callout>
20
21 -If your agent works with files inside a session, prefer the session file mount, where the sandbox exposes uploaded files to running code. See the [sandbox](/docs/sandbox/remote) for the sandbox helpers (`upload_local_file`, `smart_file_extract`) that build on this storage.
21 +If your agent works with files inside a session, prefer the session file mount, where the sandbox exposes uploaded files to running code. See the [remote sandbox](/docs/sandbox/remote) for the sandbox helpers (`upload_local_file`, `smart_file_extract`) that build on this storage.
22
23 These endpoints use your project API key in the `x-api-key` header.
24
25 ## Endpoints
26
27 -<ApiEndpointsTable endpoints={[{"method":"GET","pathV31":"/api/v3.1/files/list","pathV3":"/api/v3/files/list","summary":"List files with optional app and action filters","href":"/reference/v3/api-reference/files/getFilesList"},{"method":"POST","pathV31":"/api/v3.1/files/upload/request","pathV3":"/api/v3/files/upload/request","summary":"Create presigned URL for request file upload to S3","href":"/reference/v3/api-reference/files/postFilesUploadRequest"}]} />
27 +<ApiEndpointsTable endpoints={[{"method":"GET","pathV31":"/api/v3.1/files/list","pathV3":"/api/v3/files/list","summary":"List files with optional app and action filters (DEPRECATED)","href":"/reference/v3/api-reference/files/getFilesList"},{"method":"POST","pathV31":"/api/v3.1/files/upload/request","pathV3":"/api/v3/files/upload/request","summary":"Create presigned URL for request file upload to S3","href":"/reference/v3/api-reference/files/postFilesUploadRequest"}]} />
docs/content/reference/v3/api-reference/migration/index.mdx deleted
-20
@@ -1,20 +0,0 @@
1 ----
2 -title: Migration
3 -description: "Endpoints to help with migration from v1 to v3"
4 ----
5 -
6 -{/* Auto-generated from OpenAPI spec. Edit the overview at api-overviews/migration.mdx, not this file. */}
7 -
8 -These endpoints help you migrate from Composio v1 to v3 by translating identifiers between the two systems.
9 -
10 -Reach for this endpoint when you have a v1 UUID and need the corresponding v3 NanoId so existing references continue to resolve against the v3 API. Pass the UUID and get the NanoId back.
11 -
12 -These endpoints authenticate with your project API key in the `x-api-key` header.
13 -
14 -<Callout type="info">
15 -This is a low-level translation helper for migrating identifiers. For migrating SDK code, sessions, and toolkit versioning, see the [migration guides](/docs/migration-guide).
16 -</Callout>
17 -
18 -## Endpoints
19 -
20 -<ApiEndpointsTable endpoints={[{"method":"GET","pathV31":"/api/v3.1/migration/get-nanoid","pathV3":"/api/v3/migration/get-nanoid","summary":"Get NanoId from UUID","href":"/reference/v3/api-reference/migration/getMigrationGetNanoid"}]} />
docs/content/reference/v3/api-reference/organization-management/index.mdx new
+12
@@ -0,0 +1,12 @@
1 +---
2 +title: Organization Management
3 +description: "Organization Management API endpoints"
4 +---
5 +
6 +{/* Auto-generated from OpenAPI spec. Do not edit directly. */}
7 +
8 +Organization Management API endpoints
9 +
10 +## Endpoints
11 +
12 +<ApiEndpointsTable endpoints={[{"method":"GET","pathV31":"/api/v3.1/org/list","pathV3":"/api/v3/org/list","summary":"List organizations","href":"/reference/v3/api-reference/organization-management/getOrgList"}]} />
docs/content/reference/v3/api-reference/organization/index.mdx deleted
-12
@@ -1,12 +0,0 @@
1 ----
2 -title: Organization
3 -description: "Organization management"
4 ----
5 -
6 -{/* Auto-generated from OpenAPI spec. Do not edit directly. */}
7 -
8 -Organization management
9 -
10 -## Endpoints
11 -
12 -<ApiEndpointsTable endpoints={[{"method":"GET","pathV31":"/api/v3.1/org/usage/summary","pathV3":"/api/v3/org/usage/summary","summary":"Org usage summary","href":"/reference/v3/api-reference/organization/getOrgUsageSummary"}]} />
docs/content/reference/v3/api-reference/projects/index.mdx
+3 -13
@@ -57,20 +57,10 @@ The list endpoint supports pagination with `limit` and `cursor`; getting a proje
57
58 ## Project settings
59
60 -Each project has settings that control security, logging, and display behavior. These endpoints use your **project API key** (`x-api-key`), not the org key.
60 +Each project has settings that control security, logging, and display behavior. The project detail endpoints return current configuration for inspection. Use **Settings > Project Settings** in the [dashboard](https://dashboard.composio.dev/~/project/settings/general) to update project settings.
61
62 -```bash
63 -curl -X PATCH https://backend.composio.dev/api/v3.1/org/project/config \
64 - -H "x-api-key: YOUR_API_KEY" \
65 - -H "Content-Type: application/json" \
66 - -d '{
67 - "mask_secret_keys_in_connected_account": false,
68 - "log_visibility_setting": "show_all"
69 - }'
70 -```
71 -
72 -Notable security setting: `require_mcp_api_key`, when `true`, requires MCP server requests to include a valid `x-api-key` header. This defaults to `true` for organizations created on or after March 5, 2026. You can also view and update project settings from **Settings > Project Settings** in the [dashboard](https://dashboard.composio.dev/~/project/settings/general).
62 +Notable security setting: `require_mcp_api_key`, when `true`, requires MCP server requests to include a valid `x-api-key` header. This defaults to `true` for organizations created on or after March 5, 2026.
63
64 ## Endpoints
65
76 -<ApiEndpointsTable endpoints={[{"method":"GET","pathV31":"/api/v3.1/org/project/config","pathV3":"/api/v3/org/project/config","summary":"Get project configuration","href":"/reference/v3/api-reference/projects/getOrgProjectConfig"},{"method":"PATCH","pathV31":"/api/v3.1/org/project/config","pathV3":"/api/v3/org/project/config","summary":"Update project configuration","href":"/reference/v3/api-reference/projects/patchOrgProjectConfig"},{"method":"POST","pathV31":"/api/v3.1/org/owner/project/new","pathV3":"/api/v3/org/owner/project/new","summary":"Create a new project","href":"/reference/v3/api-reference/projects/postOrgOwnerProjectNew"},{"method":"GET","pathV31":"/api/v3.1/org/owner/project/list","pathV3":"/api/v3/org/owner/project/list","summary":"List all projects","href":"/reference/v3/api-reference/projects/getOrgOwnerProjectList"},{"method":"GET","pathV31":"/api/v3.1/org/owner/project/{nano_id}","pathV3":"/api/v3/org/owner/project/{nano_id}","summary":"Get project details by ID With Org Api key","href":"/reference/v3/api-reference/projects/getOrgOwnerProjectByNanoId"},{"method":"DELETE","pathV31":"/api/v3.1/org/owner/project/{nano_id}","pathV3":"/api/v3/org/owner/project/{nano_id}","summary":"Delete a project","href":"/reference/v3/api-reference/projects/deleteOrgOwnerProjectByNanoId"},{"method":"POST","pathV31":"/api/v3.1/org/owner/project/{nano_id}/regenerate_api_key","pathV3":"/api/v3/org/owner/project/{nano_id}/regenerate_api_key","summary":"Delete and generate new API key for project","href":"/reference/v3/api-reference/projects/postOrgOwnerProjectByNanoIdRegenerateApiKey"}]} />
66 +<ApiEndpointsTable endpoints={[{"method":"GET","pathV31":"/api/v3.1/org/project/list","pathV3":"/api/v3/org/project/list","summary":"List all projects","href":"/reference/v3/api-reference/projects/getOrgProjectList"},{"method":"POST","pathV31":"/api/v3.1/org/owner/project/new","pathV3":"/api/v3/org/owner/project/new","summary":"Create a new project","href":"/reference/v3/api-reference/projects/postOrgOwnerProjectNew"},{"method":"GET","pathV31":"/api/v3.1/org/owner/project/list","pathV3":"/api/v3/org/owner/project/list","summary":"List all projects","href":"/reference/v3/api-reference/projects/getOrgOwnerProjectList"},{"method":"GET","pathV31":"/api/v3.1/org/owner/project/{nano_id}","pathV3":"/api/v3/org/owner/project/{nano_id}","summary":"Get project details by ID With Org Api key","href":"/reference/v3/api-reference/projects/getOrgOwnerProjectByNanoId"},{"method":"DELETE","pathV31":"/api/v3.1/org/owner/project/{nano_id}","pathV3":"/api/v3/org/owner/project/{nano_id}","summary":"Delete a project","href":"/reference/v3/api-reference/projects/deleteOrgOwnerProjectByNanoId"},{"method":"POST","pathV31":"/api/v3.1/org/owner/project/{nano_id}/regenerate_api_key","pathV3":"/api/v3/org/owner/project/{nano_id}/regenerate_api_key","summary":"Delete and generate new API key for project","href":"/reference/v3/api-reference/projects/postOrgOwnerProjectByNanoIdRegenerateApiKey"}]} />
docs/content/reference/v3/api-reference/webhook-endpoints/index.mdx
+1 -1
@@ -11,7 +11,7 @@ Reach for these endpoints when an OAuth app you have configured needs to deliver
11
12 Each endpoint is addressed by its `nano_id`. The `POST` to `/webhook_endpoints/{nano_id}` replaces the full configuration, while `PATCH` updates it in place.
13
14 -This is distinct from [webhook subscriptions](/reference/api-reference/webhook-subscriptions), which control where Composio delivers outbound trigger events. To verify the signature on payloads Composio sends you, see [Webhook verification](/docs/setting-up-triggers/subscribing-to-events#verifying-signatures). To set up the trigger events those payloads carry, see [Triggers](/docs/triggers).
14 +This is distinct from [webhook subscriptions](/reference/api-reference/webhook-subscriptions), which control where Composio delivers outbound trigger events. To verify the signature on payloads Composio sends you, see [Verifying signatures](/docs/setting-up-triggers/subscribing-to-events#verifying-signatures). To set up the trigger events those payloads carry, see [Triggers](/docs/triggers).
15
16 ## Endpoints
17
docs/content/reference/v3/api-reference/webhook-subscriptions/index.mdx
+1 -1
@@ -11,7 +11,7 @@ Reach for these endpoints to register where Composio should send events, to filt
11
12 Each subscription is addressed by its `id`. You can update its URL and filters with `PATCH`, delete it, and rotate its signing secret with `/webhook_subscriptions/{id}/rotate_secret` if the secret leaks.
13
14 -Every webhook request Composio sends includes `webhook-id`, `webhook-timestamp`, and `webhook-signature` headers. Store the secret as `COMPOSIO_WEBHOOK_SECRET` and verify each payload before trusting it. See [Webhook verification](/docs/setting-up-triggers/subscribing-to-events#verifying-signatures) for the SDK and manual verification flows.
14 +Every webhook request Composio sends includes `webhook-id`, `webhook-timestamp`, and `webhook-signature` headers. Store the secret as `COMPOSIO_WEBHOOK_SECRET` and verify each payload before trusting it. See [Verifying signatures](/docs/setting-up-triggers/subscribing-to-events#verifying-signatures) for the SDK and manual verification flows.
15
16 ## Event types
17
docs/public/openapi-v3.json
+451 -549
@@ -73,10 +73,6 @@
73 "name": "Tools",
74 "description": "Tool execution endpoints"
75 },
76 - {
77 - "name": "Recipes",
78 - "description": "Recipe management and execution. Recipes are reusable code modules that combine multiple tools."
79 - },
76 {
77 "name": "Triggers",
78 "description": "Trigger management and execution"
@@ -85,6 +81,10 @@
81 "name": "Payments",
82 "description": "Payment and subscription management"
83 },
84 + {
85 + "name": "Billing",
86 + "description": "Dashboard billing state — usage, subscription, contract (cookie-auth only)"
87 + },
88 {
89 "name": "Files",
90 "description": "File management"
@@ -93,17 +93,13 @@
93 "name": "MCP",
94 "description": "MCP server management"
95 },
96 - {
97 - "name": "Migration",
98 - "description": "Endpoints to help with migration from v1 to v3"
99 - },
96 {
97 "name": "MCP Partner",
98 "description": "MCP partner management"
99 },
100 {
105 - "name": "Recipe",
106 - "description": "Recipe endpoints"
101 + "name": "Stripe Projects",
102 + "description": "Stripe Projects provisioning"
103 },
104 {
105 "name": "Tool Router",
@@ -203,111 +199,43 @@
199 "val": {
200 "type": "object",
201 "properties": {
206 - "subdomain": {
207 - "type": "string",
208 - "nullable": true
209 - },
210 - "your-domain": {
211 - "type": "string",
212 - "nullable": true
213 - },
214 - "region": {
215 - "type": "string",
216 - "nullable": true
217 - },
218 - "shop": {
219 - "type": "string",
220 - "nullable": true
221 - },
222 - "account_url": {
223 - "type": "string",
224 - "nullable": true
225 - },
226 - "COMPANYDOMAIN": {
227 - "type": "string",
228 - "nullable": true
229 - },
230 - "extension": {
231 - "type": "string",
232 - "nullable": true
233 - },
234 - "form_api_base_url": {
235 - "type": "string",
236 - "nullable": true
237 - },
238 - "instanceEndpoint": {
239 - "type": "string",
240 - "nullable": true
241 - },
242 - "api_url": {
243 - "type": "string",
244 - "nullable": true
245 - },
246 - "borneo_dashboard_url": {
247 - "type": "string",
248 - "nullable": true
249 - },
250 - "proxy_username": {
251 - "type": "string",
252 - "nullable": true
253 - },
254 - "proxy_password": {
255 - "type": "string",
256 - "nullable": true
257 - },
258 - "domain": {
259 - "type": "string",
260 - "nullable": true
261 - },
262 - "version": {
263 - "type": "string",
264 - "nullable": true
265 - },
266 - "dc": {
267 - "type": "string",
268 - "nullable": true
269 - },
270 - "site_name": {
271 - "type": "string",
272 - "nullable": true
273 - },
274 - "instanceName": {
202 + "token": {
203 "type": "string",
204 "nullable": true
205 },
278 - "account_id": {
206 + "generic_api_key": {
207 "type": "string",
208 "nullable": true
209 },
282 - "your_server": {
210 + "api_key": {
211 "type": "string",
212 "nullable": true
213 },
286 - "server_location": {
214 + "bearer_token": {
215 "type": "string",
216 "nullable": true
217 },
290 - "base_url": {
218 + "basic_encoded": {
219 "type": "string",
220 "nullable": true
221 },
294 - "token": {
222 + "generic_token": {
223 "type": "string",
224 "nullable": true
225 },
298 - "generic_api_key": {
226 + "api_key_prefix": {
227 "type": "string",
228 "nullable": true
229 },
302 - "api_key": {
230 + "generic_secret": {
231 "type": "string",
232 "nullable": true
233 },
306 - "bearer_token": {
234 + "generic_id": {
235 "type": "string",
236 "nullable": true
237 },
310 - "basic_encoded": {
238 + "user_agent": {
239 "type": "string",
240 "nullable": true
241 },
@@ -336,7 +264,7 @@
264 "nullable": true
265 }
266 },
339 - "additionalProperties": {},
267 + "additionalProperties": false,
268 "description": "Credential fields to update. Only provided fields are changed — omitted fields are preserved. Set a field to null to remove it."
269 }
270 },
@@ -841,9 +769,6 @@
769 ],
770 "operationId": "getAuthSessionInfo",
771 "security": [
844 - {
845 - "ApiKeyAuth": []
846 - },
772 {
773 "UserApiKeyAuth": []
774 }
@@ -1096,10 +1021,6 @@
1021 "metadata": {
1022 "type": "object",
1023 "properties": {
1099 - "createdInBetterAuth": {
1100 - "type": "boolean",
1101 - "description": "Whether the user was created via Better Auth (dashboard signup)."
1102 - },
1024 "prefers_old_dashboard": {
1025 "type": "boolean",
1026 "description": "If true, the user will be redirected to the legacy dashboard at platform.composio.dev."
@@ -1291,7 +1212,8 @@
1212 "type": "string"
1213 }
1214 }
1294 - ]
1215 + ],
1216 + "description": "OAuth scopes requested for the managed auth config."
1217 },
1218 "user_scopes": {
1219 "anyOf": [
@@ -1304,7 +1226,8 @@
1226 "type": "string"
1227 }
1228 }
1307 - ]
1229 + ],
1230 + "description": "OAuth user-token scopes requested for the managed auth config. This is primarily used by Slack OAuth v2."
1231 }
1232 },
1233 "default": {}
@@ -1392,7 +1315,8 @@
1315 "type": "string"
1316 }
1317 }
1395 - ]
1318 + ],
1319 + "description": "OAuth scopes requested for the custom auth config."
1320 },
1321 "user_scopes": {
1322 "anyOf": [
@@ -1405,7 +1329,8 @@
1329 "type": "string"
1330 }
1331 }
1408 - ]
1332 + ],
1333 + "description": "OAuth user-token scopes requested for the custom auth config. This is primarily used by Slack OAuth v2."
1334 }
1335 },
1336 "default": {}
@@ -1709,7 +1634,8 @@
1634 },
1635 "uuid": {
1636 "type": "string",
1712 - "description": "The UUID of the authentication configuration (for backward compatibility)"
1637 + "description": "The UUID of the authentication configuration (for backward compatibility)",
1638 + "deprecated": true
1639 },
1640 "type": {
1641 "type": "string",
@@ -2025,7 +1951,8 @@
1951 },
1952 "uuid": {
1953 "type": "string",
2028 - "description": "The UUID of the authentication configuration (for backward compatibility)"
1954 + "description": "The UUID of the authentication configuration (for backward compatibility)",
1955 + "deprecated": true
1956 },
1957 "type": {
1958 "type": "string",
@@ -2335,7 +2262,8 @@
2262 "type": "string"
2263 }
2264 }
2338 - ]
2265 + ],
2266 + "description": "OAuth scopes requested for the auth config."
2267 },
2268 "user_scopes": {
2269 "anyOf": [
@@ -2348,7 +2276,8 @@
2276 "type": "string"
2277 }
2278 }
2351 - ]
2279 + ],
2280 + "description": "OAuth user-token scopes requested for the auth config. This is primarily used by Slack OAuth v2."
2281 }
2282 }
2283 },
@@ -2400,7 +2329,7 @@
2329 "shared_credentials": {
2330 "type": "object",
2331 "additionalProperties": {},
2403 - "description": "Shared credentials that will be inherited by connected accounts. For eg: this can be used to share the API key for a tool with all connected accounts using this auth config."
2332 + "description": "Shared credentials inherited by all connected accounts using this auth config. Secret values are redacted in responses, so provide the real values when updating; omit this field to leave them unchanged."
2333 },
2334 "is_enabled_for_tool_router": {
2335 "type": "boolean",
@@ -2436,7 +2365,8 @@
2365 "type": "string"
2366 }
2367 }
2439 - ]
2368 + ],
2369 + "description": "OAuth scopes requested for the auth config."
2370 },
2371 "user_scopes": {
2372 "anyOf": [
@@ -2449,7 +2379,8 @@
2379 "type": "string"
2380 }
2381 }
2452 - ]
2382 + ],
2383 + "description": "OAuth user-token scopes requested for the auth config. This is primarily used by Slack OAuth v2."
2384 },
2385 "restrict_to_following_tools": {
2386 "type": "array",
@@ -2481,7 +2412,7 @@
2412 "shared_credentials": {
2413 "type": "object",
2414 "additionalProperties": {},
2484 - "description": "Shared credentials that will be inherited by connected accounts. For eg: this can be used to share the API key for a tool with all connected accounts using this auth config."
2415 + "description": "Shared credentials inherited by all connected accounts using this auth config. Secret values are redacted in responses, so provide the real values when updating; omit this field to leave them unchanged."
2416 },
2417 "is_enabled_for_tool_router": {
2418 "type": "boolean",
@@ -2571,7 +2502,7 @@
2502 },
2503 "delete": {
2504 "summary": "Delete an authentication configuration",
2574 - "description": "Soft-deletes an authentication configuration by marking it as deleted in the database. This operation cannot be undone.",
2505 + "description": "Soft-deletes an authentication configuration by marking it as deleted in the database. This operation cannot be undone. Pass `?revoke_on_delete=true` to also revoke the upstream credentials of every connection using this auth config via a background job.",
2506 "tags": [
2507 "Auth Configs"
2508 ],
@@ -2595,6 +2526,18 @@
2526 "description": "The unique identifier of the authentication configuration to delete",
2527 "name": "nanoid",
2528 "in": "path"
2529 + },
2530 + {
2531 + "schema": {
2532 + "type": "boolean",
2533 + "nullable": true,
2534 + "default": false,
2535 + "description": "When `true`, the delete also starts a background job that revokes the upstream credentials of every connected account in scope, and the response carries a `revoke_job_id`. Defaults to `false`. Revocation is irreversible — recovering a deleted entity does not restore working credentials."
2536 + },
2537 + "required": false,
2538 + "description": "When `true`, the delete also starts a background job that revokes the upstream credentials of every connected account in scope, and the response carries a `revoke_job_id`. Defaults to `false`. Revocation is irreversible — recovering a deleted entity does not restore working credentials.",
2539 + "name": "revoke_on_delete",
2540 + "in": "query"
2541 }
2542 ],
2543 "responses": {
@@ -2604,7 +2547,13 @@
2547 "application/json": {
2548 "schema": {
2549 "type": "object",
2607 - "properties": {}
2550 + "properties": {
2551 + "revoke_job_id": {
2552 + "type": "string",
2553 + "description": "Identifier of the background revoke job started for this delete. Present only when `revoke_on_delete=true`. Track the job and its per-connection results from the Composio dashboard — a programmatic endpoint to poll this job is not yet generally available.",
2554 + "example": "pj_1a2b3c4d5e6f"
2555 + }
2556 + }
2557 }
2558 }
2559 }
@@ -2665,9 +2614,6 @@
2614 "security": [
2615 {
2616 "ApiKeyAuth": []
2668 - },
2669 - {
2670 - "UserApiKeyAuth": []
2617 }
2618 ],
2619 "parameters": [
@@ -3386,9 +3332,6 @@
3332 "security": [
3333 {
3334 "ApiKeyAuth": []
3389 - },
3390 - {
3391 - "UserApiKeyAuth": []
3335 }
3336 ],
3337 "requestBody": {
@@ -3919,8 +3862,7 @@
3862 "connectionData",
3863 "status",
3864 "redirect_url",
3922 - "redirect_uri",
3923 - "deprecated"
3865 + "redirect_uri"
3866 ]
3867 }
3868 }
@@ -4370,6 +4312,20 @@
4312 "additionalProperties": {},
4313 "description": "The initialization data of the connection, including configuration parameters",
4314 "deprecated": true
4315 + },
4316 + "requested_scopes": {
4317 + "type": "array",
4318 + "items": {
4319 + "type": "string"
4320 + },
4321 + "description": "OAuth scopes requested when this connection was most recently initiated (create or refresh). Absent for connections created before scope snapshots were captured and for non-OAuth auth schemes."
4322 + },
4323 + "requested_user_scopes": {
4324 + "type": "array",
4325 + "items": {
4326 + "type": "string"
4327 + },
4328 + "description": "OAuth user-token scopes requested at the most recent initiation. Only meaningful for Slackbot auth configs (user-token scopes); absent otherwise."
4329 }
4330 },
4331 "required": [
@@ -4457,7 +4413,7 @@
4413 },
4414 "delete": {
4415 "summary": "Delete a connected account",
4460 - "description": "Soft-deletes a connected account by marking it as deleted in the database. This prevents the account from being used for API calls but preserves the record for audit purposes.",
4416 + "description": "Soft-deletes a connected account by marking it as deleted in the database. This prevents the account from being used for API calls but preserves the record for audit purposes. Pass `?revoke_on_delete=true` to also revoke the account's upstream credentials via a background job.",
4417 "tags": [
4418 "Connected Accounts"
4419 ],
@@ -4481,6 +4437,18 @@
4437 "example": "ca_1a2b3c4d5e6f",
4438 "name": "nanoid",
4439 "in": "path"
4440 + },
4441 + {
4442 + "schema": {
4443 + "type": "boolean",
4444 + "nullable": true,
4445 + "default": false,
4446 + "description": "When `true`, the delete also starts a background job that revokes the upstream credentials of every connected account in scope, and the response carries a `revoke_job_id`. Defaults to `false`. Revocation is irreversible — recovering a deleted entity does not restore working credentials."
4447 + },
4448 + "required": false,
4449 + "description": "When `true`, the delete also starts a background job that revokes the upstream credentials of every connected account in scope, and the response carries a `revoke_job_id`. Defaults to `false`. Revocation is irreversible — recovering a deleted entity does not restore working credentials.",
4450 + "name": "revoke_on_delete",
4451 + "in": "query"
4452 }
4453 ],
4454 "responses": {
@@ -4494,6 +4462,11 @@
4462 "success": {
4463 "type": "boolean",
4464 "description": "Indicates whether the connected account was successfully deleted"
4465 + },
4466 + "revoke_job_id": {
4467 + "type": "string",
4468 + "description": "Identifier of the background revoke job started for this delete. Present only when `revoke_on_delete=true`. Track the job and its per-connection results from the Composio dashboard — a programmatic endpoint to poll this job is not yet generally available.",
4469 + "example": "pj_1a2b3c4d5e6f"
4470 }
4471 },
4472 "required": [
@@ -4571,9 +4544,6 @@
4544 "security": [
4545 {
4546 "ApiKeyAuth": []
4574 - },
4575 - {
4576 - "UserApiKeyAuth": []
4547 }
4548 ],
4549 "parameters": [
@@ -4720,9 +4690,6 @@
4690 "security": [
4691 {
4692 "ApiKeyAuth": []
4723 - },
4724 - {
4725 - "UserApiKeyAuth": []
4693 }
4694 ],
4695 "parameters": [
@@ -4849,9 +4816,6 @@
4816 "security": [
4817 {
4818 "ApiKeyAuth": []
4852 - },
4853 - {
4854 - "UserApiKeyAuth": []
4819 }
4820 ],
4821 "parameters": [
@@ -5505,73 +5469,109 @@
5469 "x-api-version": "3.0"
5470 }
5471 },
5508 - "/api/v3/org/project/config": {
5472 + "/api/v3/org/list": {
5473 "get": {
5510 - "summary": "Get project configuration",
5511 - "description": "Retrieves the current project configuration including 2FA settings.",
5474 + "summary": "List organizations",
5475 + "description": "Retrieves a list of organizations that the authenticated user has access to. This includes organizations where the user is a member with any role.",
5476 "tags": [
5513 - "Projects"
5477 + "Organization Management"
5478 ],
5515 - "operationId": "getOrgProjectConfig",
5479 + "operationId": "getOrgList",
5480 "security": [
5481 {
5518 - "ApiKeyAuth": []
5482 + "UserApiKeyAuth": []
5483 + }
5484 + ],
5485 + "parameters": [
5486 + {
5487 + "schema": {
5488 + "type": "integer",
5489 + "minimum": 1,
5490 + "maximum": 50
5491 + },
5492 + "required": false,
5493 + "description": "Number of items per page, max allowed is 50",
5494 + "name": "limit",
5495 + "in": "query"
5496 },
5497 {
5521 - "UserApiKeyAuth": []
5498 + "schema": {
5499 + "type": "string"
5500 + },
5501 + "required": false,
5502 + "description": "Cursor for pagination. The cursor is a base64 encoded string of the page and limit. The page is the page number and the limit is the number of items per page. The cursor is used to paginate through the items. The cursor is not required for the first page.",
5503 + "name": "cursor",
5504 + "in": "query"
5505 }
5506 ],
5507 "responses": {
5508 "200": {
5526 - "description": "Project configuration retrieved successfully.",
5509 + "description": "Successfully retrieved list of organizations with pagination.",
5510 "content": {
5511 "application/json": {
5512 "schema": {
5513 "type": "object",
5514 "properties": {
5532 - "is_2FA_enabled": {
5533 - "type": "boolean"
5534 - },
5535 - "logo_url": {
5536 - "type": "string"
5537 - },
5538 - "display_name": {
5539 - "type": "string"
5540 - },
5541 - "mask_secret_keys_in_connected_account": {
5542 - "type": "boolean"
5515 + "organizations": {
5516 + "type": "array",
5517 + "items": {
5518 + "type": "object",
5519 + "properties": {
5520 + "id": {
5521 + "type": "string",
5522 + "format": "orgId",
5523 + "description": "Unique identifier for the organization"
5524 + },
5525 + "name": {
5526 + "type": "string",
5527 + "minLength": 3,
5528 + "maxLength": 32,
5529 + "pattern": "^[a-zA-Z][a-zA-Z0-9_]*[a-zA-Z0-9]$",
5530 + "description": "Name of the organization"
5531 + },
5532 + "created_at": {
5533 + "type": "string",
5534 + "description": "When the organization was created"
5535 + },
5536 + "updated_at": {
5537 + "type": "string",
5538 + "description": "When the organization was last updated"
5539 + }
5540 + },
5541 + "required": [
5542 + "id",
5543 + "name",
5544 + "created_at",
5545 + "updated_at"
5546 + ]
5547 + }
5548 },
5544 - "log_visibility_setting": {
5549 + "next_cursor": {
5550 "type": "string",
5546 - "enum": [
5547 - "show_all",
5548 - "dont_store_data"
5549 - ]
5551 + "nullable": true
5552 },
5551 - "require_mcp_api_key": {
5552 - "type": "boolean"
5553 + "total_pages": {
5554 + "type": "number"
5555 },
5554 - "is_composio_link_enabled_for_managed_auth": {
5555 - "type": "boolean",
5556 - "description": "Whether to enable composio link for managed authentication. This key will be deprecated in the future. Please don't use this key."
5556 + "current_page": {
5557 + "type": "number"
5558 },
5558 - "signed_url_file_expiry_in_seconds": {
5559 - "type": "number",
5560 - "minimum": 1,
5561 - "maximum": 86400
5559 + "total_items": {
5560 + "type": "number"
5561 }
5562 },
5563 "required": [
5565 - "is_2FA_enabled",
5566 - "mask_secret_keys_in_connected_account",
5567 - "log_visibility_setting"
5564 + "organizations",
5565 + "total_pages",
5566 + "current_page",
5567 + "total_items"
5568 ]
5569 }
5570 }
5571 }
5572 },
5573 "400": {
5574 - "description": "Bad request. The project configuration data may be invalid.",
5574 + "description": "Bad request. This may occur if there are invalid query parameters or the request is malformed.",
5575 "content": {
5576 "application/json": {
5577 "schema": {
@@ -5591,7 +5591,7 @@
5591 }
5592 },
5593 "404": {
5594 - "description": "Project not found. The specified project does not exist or has been deleted.",
5594 + "description": "Not found. The user or organization was not found.",
5595 "content": {
5596 "application/json": {
5597 "schema": {
@@ -5612,127 +5612,198 @@
5612 }
5613 },
5614 "x-api-version": "3.0"
5615 - },
5616 - "patch": {
5617 - "summary": "Update project configuration",
5618 - "description": "Updates the project configuration settings.",
5615 + }
5616 + },
5617 + "/api/v3/org/project/list": {
5618 + "get": {
5619 + "summary": "List all projects",
5620 + "description": "Retrieves projects belonging to the authenticated organization by default, or all organizations the authenticated user belongs to when list_all_org_projects is true. Projects are returned in descending order of creation date (newest first). This endpoint is useful for displaying project selection in dashboards or for integrations that need to list all available projects.",
5621 "tags": [
5622 "Projects"
5623 ],
5622 - "operationId": "patchOrgProjectConfig",
5624 + "operationId": "getOrgProjectList",
5625 "security": [
5624 - {
5625 - "ApiKeyAuth": []
5626 - },
5626 {
5627 "UserApiKeyAuth": []
5628 }
5629 ],
5631 - "requestBody": {
5632 - "content": {
5633 - "application/json": {
5634 - "schema": {
5635 - "type": "object",
5636 - "properties": {
5637 - "is_2FA_enabled": {
5638 - "type": "boolean"
5639 - },
5640 - "logo_url": {
5641 - "type": "string"
5642 - },
5643 - "display_name": {
5644 - "type": "string"
5645 - },
5646 - "mask_secret_keys_in_connected_account": {
5647 - "type": "boolean"
5648 - },
5649 - "log_visibility_setting": {
5650 - "type": "string",
5651 - "enum": [
5652 - "show_all",
5653 - "dont_store_data"
5654 - ]
5655 - },
5656 - "require_mcp_api_key": {
5657 - "type": "boolean"
5658 - },
5659 - "is_composio_link_enabled_for_managed_auth": {
5660 - "type": "boolean",
5661 - "description": "Whether to enable composio link for managed authentication. This key will be deprecated in the future. Please don't use this key."
5662 - },
5663 - "signed_url_file_expiry_in_seconds": {
5664 - "type": "number",
5665 - "minimum": 1,
5666 - "maximum": 86400
5667 - }
5668 - }
5669 - },
5670 - "examples": {
5671 - "Enable 2FA": {
5672 - "value": {
5673 - "is_2FA_enabled": true
5674 - }
5675 - },
5676 - "Disable 2FA": {
5677 - "value": {
5678 - "is_2FA_enabled": false
5679 - }
5680 - }
5681 - }
5682 - }
5630 + "parameters": [
5631 + {
5632 + "schema": {
5633 + "type": "boolean",
5634 + "nullable": true,
5635 + "default": false,
5636 + "description": "List projects from all organizations the authenticated user belongs to"
5637 + },
5638 + "required": false,
5639 + "description": "List projects from all organizations the authenticated user belongs to",
5640 + "name": "list_all_org_projects",
5641 + "in": "query"
5642 + },
5643 + {
5644 + "schema": {
5645 + "type": "integer",
5646 + "minimum": 1,
5647 + "maximum": 50
5648 + },
5649 + "required": false,
5650 + "description": "Number of items per page, max allowed is 50",
5651 + "name": "limit",
5652 + "in": "query"
5653 + },
5654 + {
5655 + "schema": {
5656 + "type": "string"
5657 + },
5658 + "required": false,
5659 + "description": "Cursor for pagination. The cursor is a base64 encoded string of the page and limit. The page is the page number and the limit is the number of items per page. The cursor is used to paginate through the items. The cursor is not required for the first page.",
5660 + "name": "cursor",
5661 + "in": "query"
5662 }
5684 - },
5663 + ],
5664 "responses": {
5665 "200": {
5687 - "description": "Project configuration updated successfully.",
5666 + "description": "Projects retrieved successfully with pagination. Returns an array of project objects with their complete details and pagination info.",
5667 "content": {
5668 "application/json": {
5669 "schema": {
5670 "type": "object",
5671 "properties": {
5693 - "is_2FA_enabled": {
5694 - "type": "boolean"
5695 - },
5696 - "logo_url": {
5697 - "type": "string"
5698 - },
5699 - "display_name": {
5700 - "type": "string"
5701 - },
5702 - "mask_secret_keys_in_connected_account": {
5703 - "type": "boolean"
5672 + "data": {
5673 + "type": "array",
5674 + "items": {
5675 + "type": "object",
5676 + "properties": {
5677 + "id": {
5678 + "type": "string",
5679 + "format": "projectId",
5680 + "description": "Unique identifier for the project",
5681 + "example": "pr_1a2b3c4d5e6f"
5682 + },
5683 + "org_id": {
5684 + "type": "string",
5685 + "format": "orgId",
5686 + "description": "Identifier of the organization that owns this project",
5687 + "example": "ok_1a2b3c4d5e6f"
5688 + },
5689 + "name": {
5690 + "type": "string",
5691 + "description": "Name of the project",
5692 + "example": "My Awesome Project"
5693 + },
5694 + "email": {
5695 + "type": "string",
5696 + "description": "Email address associated with the project",
5697 + "example": "project-123@composio.dev"
5698 + },
5699 + "created_at": {
5700 + "type": "string",
5701 + "description": "ISO timestamp when the project was created",
5702 + "example": "2023-05-16T14:30:00.000Z"
5703 + },
5704 + "updated_at": {
5705 + "type": "string",
5706 + "description": "ISO timestamp when the project was last updated",
5707 + "example": "2023-05-18T09:15:30.000Z"
5708 + },
5709 + "webhook_url": {
5710 + "type": "string",
5711 + "nullable": true,
5712 + "format": "uri",
5713 + "description": "DEPRECATED: Use GET /api/v3/webhook_subscriptions instead. Legacy project-level webhook URL.",
5714 + "example": "https://example.com/webhook",
5715 + "deprecated": true
5716 + },
5717 + "event_webhook_url": {
5718 + "type": "string",
5719 + "nullable": true,
5720 + "format": "uri",
5721 + "description": "DEPRECATED: No longer used.",
5722 + "example": "https://example.com/events",
5723 + "deprecated": true
5724 + },
5725 + "webhook_secret": {
5726 + "type": "string",
5727 + "nullable": true,
5728 + "description": "DEPRECATED: Use GET /api/v3/webhook_subscriptions instead. Legacy project-level webhook secret.",
5729 + "example": "whsec_abcdef123456789",
5730 + "deprecated": true
5731 + },
5732 + "triggers_enabled": {
5733 + "type": "boolean",
5734 + "description": "Whether triggers are enabled for this project",
5735 + "example": true
5736 + },
5737 + "last_subscribed_at": {
5738 + "type": "string",
5739 + "nullable": true,
5740 + "format": "date-time",
5741 + "description": "ISO timestamp when the project last subscribed to updates",
5742 + "example": "2023-05-17T10:00:00.000Z"
5743 + },
5744 + "is_new_webhook": {
5745 + "type": "boolean",
5746 + "description": "Deprecated: Please refer to webhook_version instead. True indicates if the webhook configuration is using the previous new format (V2). False indicates the oldest format (V1)",
5747 + "example": true,
5748 + "deprecated": true
5749 + },
5750 + "webhook_version": {
5751 + "type": "string",
5752 + "enum": [
5753 + "V1",
5754 + "V2",
5755 + "V3"
5756 + ],
5757 + "description": "Payload format version for Pusher real-time events only. For webhook configuration, use GET /api/v3/webhook_subscriptions.",
5758 + "example": "V2"
5759 + },
5760 + "deleted": {
5761 + "type": "boolean",
5762 + "description": "Whether this project has been soft-deleted",
5763 + "example": false
5764 + }
5765 + },
5766 + "required": [
5767 + "id",
5768 + "org_id",
5769 + "name",
5770 + "email",
5771 + "created_at",
5772 + "updated_at",
5773 + "webhook_url",
5774 + "event_webhook_url",
5775 + "webhook_secret",
5776 + "webhook_version",
5777 + "deleted"
5778 + ]
5779 + }
5780 },
5705 - "log_visibility_setting": {
5781 + "next_cursor": {
5782 "type": "string",
5707 - "enum": [
5708 - "show_all",
5709 - "dont_store_data"
5710 - ]
5783 + "nullable": true
5784 },
5712 - "require_mcp_api_key": {
5713 - "type": "boolean"
5785 + "total_pages": {
5786 + "type": "number"
5787 },
5715 - "is_composio_link_enabled_for_managed_auth": {
5716 - "type": "boolean",
5717 - "description": "Whether to enable composio link for managed authentication. This key will be deprecated in the future. Please don't use this key."
5788 + "current_page": {
5789 + "type": "number"
5790 },
5719 - "signed_url_file_expiry_in_seconds": {
5720 - "type": "number",
5721 - "minimum": 1,
5722 - "maximum": 86400
5791 + "total_items": {
5792 + "type": "number"
5793 }
5794 },
5795 "required": [
5726 - "is_2FA_enabled",
5727 - "mask_secret_keys_in_connected_account",
5728 - "log_visibility_setting"
5796 + "data",
5797 + "total_pages",
5798 + "current_page",
5799 + "total_items"
5800 ]
5801 }
5802 }
5803 }
5804 },
5805 "400": {
5735 - "description": "Bad request. The configuration data may be invalid or missing.",
5806 + "description": "Bad request. This may occur if there are invalid query parameters or the request is malformed.",
5807 "content": {
5808 "application/json": {
5809 "schema": {
@@ -5751,16 +5822,6 @@
5822 }
5823 }
5824 },
5754 - "404": {
5755 - "description": "Project not found. The specified project does not exist or has been deleted.",
5756 - "content": {
5757 - "application/json": {
5758 - "schema": {
5759 - "$ref": "#/components/schemas/Error"
5760 - }
5761 - }
5762 - }
5763 - },
5825 "500": {
5826 "description": "Internal server error. An unexpected error occurred while processing the request.",
5827 "content": {
@@ -6282,8 +6343,8 @@
6343 },
6344 "key": {
6345 "type": "string",
6285 - "description": "The actual API key value used for authentication",
6286 - "example": "ak_a1b2c3d4e5f6g7h8i9j0"
6346 + "description": "Masked API key value",
6347 + "example": "ak_**6j0z"
6348 },
6349 "created_at": {
6350 "type": "string",
@@ -6365,7 +6426,7 @@
6426 },
6427 "delete": {
6428 "summary": "Delete a project",
6368 - "description": "Soft-deletes a project within the organization by its unique identifier. When a project is deleted, it is marked as deleted but not immediately removed from the database. This operation affects all resources associated with the project including API keys, webhook configurations, and connected services. This action cannot be undone through the API.",
6429 + "description": "Soft-deletes a project within the organization by its unique identifier. When a project is deleted, it is marked as deleted but not immediately removed from the database. This operation affects all resources associated with the project including API keys, webhook configurations, and connected services. This action cannot be undone through the API. Pass `?revoke_on_delete=true` to also revoke the upstream credentials of every connection in the project via a background job.",
6430 "tags": [
6431 "Projects"
6432 ],
@@ -6387,6 +6448,18 @@
6448 "description": "Unique identifier (Nano ID) of the project to delete",
6449 "name": "nano_id",
6450 "in": "path"
6451 + },
6452 + {
6453 + "schema": {
6454 + "type": "boolean",
6455 + "nullable": true,
6456 + "default": false,
6457 + "description": "When `true`, the delete also starts a background job that revokes the upstream credentials of every connected account in scope, and the response carries a `revoke_job_id`. Defaults to `false`. Revocation is irreversible — recovering a deleted entity does not restore working credentials."
6458 + },
6459 + "required": false,
6460 + "description": "When `true`, the delete also starts a background job that revokes the upstream credentials of every connected account in scope, and the response carries a `revoke_job_id`. Defaults to `false`. Revocation is irreversible — recovering a deleted entity does not restore working credentials.",
6461 + "name": "revoke_on_delete",
6462 + "in": "query"
6463 }
6464 ],
6465 "responses": {
@@ -6404,6 +6477,11 @@
6477 ],
6478 "description": "Status indicating successful deletion",
6479 "example": "success"
6480 + },
6481 + "revoke_job_id": {
6482 + "type": "string",
6483 + "description": "Identifier of the background revoke job started for this delete. Present only when `revoke_on_delete=true`. Track the job and its per-connection results from the Composio dashboard — a programmatic endpoint to poll this job is not yet generally available.",
6484 + "example": "oj_1a2b3c4d5e6f"
6485 }
6486 },
6487 "required": [
@@ -6569,6 +6647,16 @@
6647 }
6648 }
6649 },
6650 + "403": {
6651 + "description": "Forbidden. API key regeneration is not enabled for this organization.",
6652 + "content": {
6653 + "application/json": {
6654 + "schema": {
6655 + "$ref": "#/components/schemas/Error"
6656 + }
6657 + }
6658 + }
6659 + },
6660 "404": {
6661 "description": "Not found. The specified project does not exist or you do not have access to it.",
6662 "content": {
@@ -6604,9 +6692,6 @@
6692 "security": [
6693 {
6694 "ApiKeyAuth": []
6607 - },
6608 - {
6609 - "UserApiKeyAuth": []
6695 }
6696 ],
6697 "requestBody": {
@@ -6760,9 +6845,6 @@
6845 "security": [
6846 {
6847 "ApiKeyAuth": []
6763 - },
6764 - {
6765 - "UserApiKeyAuth": []
6848 }
6849 ],
6850 "parameters": [
@@ -6917,9 +6999,6 @@
6999 "security": [
7000 {
7001 "ApiKeyAuth": []
6920 - },
6921 - {
6922 - "UserApiKeyAuth": []
7002 }
7003 ],
7004 "parameters": [
@@ -7037,9 +7116,6 @@
7116 "security": [
7117 {
7118 "ApiKeyAuth": []
7040 - },
7041 - {
7042 - "UserApiKeyAuth": []
7119 }
7120 ],
7121 "parameters": [
@@ -7201,9 +7277,6 @@
7277 "security": [
7278 {
7279 "ApiKeyAuth": []
7204 - },
7205 - {
7206 - "UserApiKeyAuth": []
7280 }
7281 ],
7282 "parameters": [
@@ -7283,9 +7356,6 @@
7356 "security": [
7357 {
7358 "ApiKeyAuth": []
7286 - },
7287 - {
7288 - "UserApiKeyAuth": []
7359 }
7360 ],
7361 "parameters": [
@@ -7372,9 +7442,6 @@
7442 "security": [
7443 {
7444 "ApiKeyAuth": []
7375 - },
7376 - {
7377 - "UserApiKeyAuth": []
7445 }
7446 ],
7447 "responses": {
@@ -7461,9 +7528,6 @@
7528 "security": [
7529 {
7530 "ApiKeyAuth": []
7464 - },
7465 - {
7466 - "UserApiKeyAuth": []
7531 }
7532 ],
7533 "requestBody": {
@@ -7643,9 +7707,6 @@
7707 "security": [
7708 {
7709 "ApiKeyAuth": []
7646 - },
7647 - {
7648 - "UserApiKeyAuth": []
7710 }
7711 ],
7712 "parameters": [
@@ -7737,9 +7798,6 @@
7798 "security": [
7799 {
7800 "ApiKeyAuth": []
7740 - },
7741 - {
7742 - "UserApiKeyAuth": []
7801 }
7802 ],
7803 "parameters": [
@@ -7857,9 +7915,6 @@
7915 "security": [
7916 {
7917 "ApiKeyAuth": []
7860 - },
7861 - {
7862 - "UserApiKeyAuth": []
7918 }
7919 ],
7920 "parameters": [
@@ -7997,10 +8052,7 @@
8052 "operationId": "patchWebhookEndpointsByNanoId",
8053 "security": [
8054 {
8000 - "ApiKeyAuth": []
8001 - },
8002 - {
8003 - "UserApiKeyAuth": []
8055 + "ApiKeyAuth": []
8056 }
8057 ],
8058 "parameters": [
@@ -8475,9 +8527,6 @@
8527 "security": [
8528 {
8529 "ApiKeyAuth": []
8478 - },
8479 - {
8480 - "UserApiKeyAuth": []
8530 }
8531 ],
8532 "responses": {
@@ -8653,6 +8702,68 @@
8702 "oauth2"
8703 ]
8704 },
8705 + "composio_managed_auth": {
8706 + "type": "array",
8707 + "items": {
8708 + "type": "object",
8709 + "properties": {
8710 + "mode": {
8711 + "type": "string",
8712 + "description": "Authentication mode for the Composio-managed auth config",
8713 + "example": "OAUTH2"
8714 + },
8715 + "scopes": {
8716 + "type": "object",
8717 + "properties": {
8718 + "available": {
8719 + "type": "array",
8720 + "items": {
8721 + "type": "string"
8722 + },
8723 + "description": "Available OAuth scopes"
8724 + }
8725 + },
8726 + "required": [
8727 + "available"
8728 + ],
8729 + "description": "OAuth scopes available in the Composio-managed auth config for this auth mode.",
8730 + "example": {
8731 + "available": [
8732 + "read",
8733 + "write"
8734 + ]
8735 + }
8736 + },
8737 + "user_scopes": {
8738 + "type": "object",
8739 + "properties": {
8740 + "available": {
8741 + "type": "array",
8742 + "items": {
8743 + "type": "string"
8744 + },
8745 + "description": "Available OAuth user scopes"
8746 + }
8747 + },
8748 + "required": [
8749 + "available"
8750 + ],
8751 + "description": "OAuth user scopes available in the Composio-managed auth config for this auth mode. Only present for Slack toolkits.",
8752 + "example": {
8753 + "available": [
8754 + "search:read",
8755 + "users:read"
8756 + ]
8757 + }
8758 + }
8759 + },
8760 + "required": [
8761 + "mode",
8762 + "scopes"
8763 + ]
8764 + },
8765 + "description": "Managed-auth-only metadata, including the supported OAuth scope ceiling."
8766 + },
8767 "is_local_toolkit": {
8768 "type": "boolean",
8769 "description": "DEPRECATED: This field is no longer meaningful and will always return false. It was previously used to indicate if a toolkit is specific to the current project.",
@@ -9068,6 +9179,7 @@
9179 "slug",
9180 "name",
9181 "enabled",
9182 + "composio_managed_auth",
9183 "is_local_toolkit",
9184 "meta",
9185 "deprecated"
@@ -9599,9 +9711,6 @@
9711 "security": [
9712 {
9713 "ApiKeyAuth": []
9602 - },
9603 - {
9604 - "UserApiKeyAuth": []
9714 }
9715 ],
9716 "requestBody": {
@@ -10339,7 +10448,7 @@
10448 "log_id": {
10449 "type": "string",
10450 "description": "Unique identifier for the execution log (useful for debugging and support)",
10342 - "example": "log_abc123def456"
10451 + "example": "log_1a2b3c4d5e6f"
10452 }
10453 },
10454 "required": [
@@ -10496,9 +10605,6 @@
10605 "security": [
10606 {
10607 "ApiKeyAuth": []
10499 - },
10500 - {
10501 - "UserApiKeyAuth": []
10608 }
10609 ],
10610 "parameters": [
@@ -10644,7 +10750,7 @@
10750 "/api/v3/tools/execute/proxy": {
10751 "post": {
10752 "summary": "Execute proxy request",
10647 - "description": "Proxy an HTTP request to a third-party API using connected account credentials. This endpoint allows making authenticated API calls to external services while abstracting away authentication details.",
10753 + "description": "Proxy an HTTP request to a third-party API using connected account credentials. This endpoint allows making authenticated API calls to external services while abstracting away authentication details. The v3 endpoint is retired except for orgs explicitly allowlisted in LaunchDarkly during migration.",
10754 "tags": [
10755 "Tools"
10756 ],
@@ -10652,9 +10758,6 @@
10758 "security": [
10759 {
10760 "ApiKeyAuth": []
10655 - },
10656 - {
10657 - "UserApiKeyAuth": []
10761 }
10762 ],
10763 "requestBody": {
@@ -11260,6 +11363,10 @@
11363 "format": "connectedAccountId",
11364 "description": "Connected account nanoid"
11365 },
11366 + "user_id": {
11367 + "type": "string",
11368 + "description": "The user id (entity id) that owns the connected account. When the project has 2FA enabled, this is validated against the owner of connected_account_id."
11369 + },
11370 "trigger_config": {
11371 "type": "object",
11372 "additionalProperties": {},
@@ -11321,8 +11428,7 @@
11428 }
11429 },
11430 "required": [
11324 - "trigger_id",
11325 - "deprecated"
11431 + "trigger_id"
11432 ]
11433 }
11434 }
@@ -11353,8 +11459,7 @@
11459 }
11460 },
11461 "required": [
11356 - "trigger_id",
11357 - "deprecated"
11462 + "trigger_id"
11463 ]
11464 }
11465 }
@@ -11391,6 +11496,16 @@
11496 }
11497 }
11498 },
11499 + "403": {
11500 + "description": "Forbidden",
11501 + "content": {
11502 + "application/json": {
11503 + "schema": {
11504 + "$ref": "#/components/schemas/Error"
11505 + }
11506 + }
11507 + }
11508 + },
11509 "404": {
11510 "description": "Trigger instance not found",
11511 "content": {
@@ -12228,7 +12343,7 @@
12343 "schema": {
12344 "type": "string",
12345 "description": "The unique slug identifier for the trigger type. Case-insensitive (internally normalized to uppercase).",
12231 - "example": "SLACK_RECEIVE_MESSAGE"
12346 + "example": "SLACK_CHANNEL_MESSAGE_RECEIVED"
12347 },
12348 "required": true,
12349 "description": "The unique slug identifier for the trigger type. Case-insensitive (internally normalized to uppercase).",
@@ -12284,7 +12399,7 @@
12399 "slug": {
12400 "type": "string",
12401 "description": "Unique identifier for the trigger type",
12287 - "example": "SLACK_RECEIVE_MESSAGE"
12402 + "example": "SLACK_CHANNEL_MESSAGE_RECEIVED"
12403 },
12404 "name": {
12405 "type": "string",
@@ -12553,7 +12668,7 @@
12668 "slug": {
12669 "type": "string",
12670 "description": "Unique identifier for the trigger type",
12556 - "example": "SLACK_RECEIVE_MESSAGE"
12671 + "example": "SLACK_CHANNEL_MESSAGE_RECEIVED"
12672 },
12673 "name": {
12674 "type": "string",
@@ -12747,9 +12862,6 @@
12862 "security": [
12863 {
12864 "ApiKeyAuth": []
12750 - },
12751 - {
12752 - "UserApiKeyAuth": []
12865 }
12866 ],
12867 "parameters": [
@@ -13094,9 +13206,6 @@
13206 "security": [
13207 {
13208 "ApiKeyAuth": []
13097 - },
13098 - {
13099 - "UserApiKeyAuth": []
13209 }
13210 ],
13211 "requestBody": {
@@ -13399,9 +13508,6 @@
13508 "security": [
13509 {
13510 "ApiKeyAuth": []
13402 - },
13403 - {
13404 - "UserApiKeyAuth": []
13511 }
13512 ],
13513 "requestBody": {
@@ -13642,9 +13748,6 @@
13748 "security": [
13749 {
13750 "ApiKeyAuth": []
13645 - },
13646 - {
13647 - "UserApiKeyAuth": []
13751 }
13752 ],
13753 "requestBody": {
@@ -13744,8 +13847,8 @@
13847 },
13848 "description": "List of URLs generated for each connected account ID",
13849 "example": [
13747 - "https://mcp.composio.dev/composio/server/550e8400-e29b-41d4-a716-446655440000?include_composio_helper_actions=true&connected_account_ids=ca_1a2b3c4d5e6f&user_id=user_123456,user_789012",
13748 - "https://mcp.composio.dev/composio/server/550e8400-e29b-41d4-a716-446655440000?include_composio_helper_actions=true&connected_account_ids=ca_7g8h9i0j1k2l&user_id=user_123456,user_789012"
13850 + "https://mcp.composio.dev/composio/server/550e8400-e29b-41d4-a716-446655440000?include_composio_helper_actions=true&connected_account_id=ca_1a2b3c4d5e6f",
13851 + "https://mcp.composio.dev/composio/server/550e8400-e29b-41d4-a716-446655440000?include_composio_helper_actions=true&connected_account_id=ca_7g8h9i0j1k2l"
13852 ]
13853 },
13854 "user_ids_url": {
@@ -13755,8 +13858,8 @@
13858 },
13859 "description": "List of URLs generated for each user ID",
13860 "example": [
13758 - "https://mcp.composio.dev/composio/server/550e8400-e29b-41d4-a716-446655440000?include_composio_helper_actions=true&connected_account_ids=ca_1a2b3c4d5e6f,ca_7g8h9i0j1k2l&user_id=user_123456",
13759 - "https://mcp.composio.dev/composio/server/550e8400-e29b-41d4-a716-446655440000?include_composio_helper_actions=true&connected_account_ids=ca_1a2b3c4d5e6f,ca_7g8h9i0j1k2l&user_id=user_789012"
13861 + "https://mcp.composio.dev/composio/server/550e8400-e29b-41d4-a716-446655440000?include_composio_helper_actions=true&user_id=user_123456",
13862 + "https://mcp.composio.dev/composio/server/550e8400-e29b-41d4-a716-446655440000?include_composio_helper_actions=true&user_id=user_789012"
13863 ]
13864 }
13865 },
@@ -13835,9 +13938,6 @@
13938 "security": [
13939 {
13940 "ApiKeyAuth": []
13838 - },
13839 - {
13840 - "UserApiKeyAuth": []
13941 }
13942 ],
13943 "parameters": [
@@ -14062,9 +14162,6 @@
14162 "security": [
14163 {
14164 "ApiKeyAuth": []
14065 - },
14066 - {
14067 - "UserApiKeyAuth": []
14165 }
14166 ],
14167 "parameters": [
@@ -14404,9 +14501,6 @@
14501 "security": [
14502 {
14503 "ApiKeyAuth": []
14407 - },
14408 - {
14409 - "UserApiKeyAuth": []
14504 }
14505 ],
14506 "parameters": [
@@ -14516,9 +14610,6 @@
14610 "security": [
14611 {
14612 "ApiKeyAuth": []
14519 - },
14520 - {
14521 - "UserApiKeyAuth": []
14613 }
14614 ],
14615 "parameters": [
@@ -14886,9 +14977,6 @@
14977 "security": [
14978 {
14979 "ApiKeyAuth": []
14889 - },
14890 - {
14891 - "UserApiKeyAuth": []
14980 }
14981 ],
14982 "parameters": [
@@ -15118,9 +15206,6 @@
15206 "security": [
15207 {
15208 "ApiKeyAuth": []
15121 - },
15122 - {
15123 - "UserApiKeyAuth": []
15209 }
15210 ],
15211 "parameters": [
@@ -15285,9 +15370,6 @@
15370 "security": [
15371 {
15372 "ApiKeyAuth": []
15288 - },
15289 - {
15290 - "UserApiKeyAuth": []
15373 }
15374 ],
15375 "parameters": [
@@ -15383,8 +15465,9 @@
15465 },
15466 "/api/v3/files/list": {
15467 "get": {
15386 - "summary": "List files with optional app and action filters",
15387 - "description": "Retrieves a list of files associated with the authenticated project. Results can be filtered by toolkit and tool slugs.",
15468 + "summary": "List files with optional app and action filters (DEPRECATED)",
15469 + "description": "DEPRECATED: This endpoint is deprecated and will be removed in a future release. Retrieves a list of files associated with the authenticated project. Results can be filtered by toolkit and tool slugs. Responses carry a `Deprecation` header (RFC 9745) for client-side detection.",
15470 + "deprecated": true,
15471 "tags": [
15472 "Files"
15473 ],
@@ -15392,9 +15475,6 @@
15475 "security": [
15476 {
15477 "ApiKeyAuth": []
15395 - },
15396 - {
15397 - "UserApiKeyAuth": []
15478 }
15479 ],
15480 "parameters": [
@@ -15560,9 +15640,6 @@
15640 "security": [
15641 {
15642 "ApiKeyAuth": []
15563 - },
15564 - {
15565 - "UserApiKeyAuth": []
15643 }
15644 ],
15645 "requestBody": {
@@ -15796,137 +15873,6 @@
15873 "x-api-version": "3.0"
15874 }
15875 },
15799 - "/api/v3/migration/get-nanoid": {
15800 - "get": {
15801 - "summary": "Get NanoId from UUID",
15802 - "description": "Convert a legacy UUID to its corresponding NanoId for migration purposes. This endpoint facilitates the transition from UUID-based identifiers to the more compact NanoId format used in the v3 API.",
15803 - "tags": [
15804 - "Migration"
15805 - ],
15806 - "operationId": "getMigrationGetNanoid",
15807 - "security": [
15808 - {
15809 - "ApiKeyAuth": []
15810 - },
15811 - {
15812 - "UserApiKeyAuth": []
15813 - }
15814 - ],
15815 - "parameters": [
15816 - {
15817 - "schema": {
15818 - "type": "string",
15819 - "format": "uuid",
15820 - "example": "123e4567-e89b-12d3-a456-426614174000"
15821 - },
15822 - "required": true,
15823 - "description": "The legacy UUID that needs to be converted to a NanoId",
15824 - "name": "uuid",
15825 - "in": "query"
15826 - },
15827 - {
15828 - "schema": {
15829 - "type": "string",
15830 - "enum": [
15831 - "CONNECTED_ACCOUNT",
15832 - "AUTH_CONFIG",
15833 - "TRIGGER_INSTANCE"
15834 - ],
15835 - "example": "CONNECTED_ACCOUNT"
15836 - },
15837 - "required": true,
15838 - "description": "The type of resource that the UUID belongs to",
15839 - "name": "type",
15840 - "in": "query"
15841 - },
15842 - {
15843 - "schema": {
15844 - "type": "string",
15845 - "description": "Your Composio API key used for authentication",
15846 - "example": "sk_123456789abcdef"
15847 - },
15848 - "required": true,
15849 - "name": "x-api-key",
15850 - "in": "header"
15851 - }
15852 - ],
15853 - "responses": {
15854 - "200": {
15855 - "description": "Successfully retrieved NanoId for the given UUID",
15856 - "content": {
15857 - "application/json": {
15858 - "schema": {
15859 - "type": "object",
15860 - "properties": {
15861 - "nanoid": {
15862 - "type": "string",
15863 - "minLength": 10,
15864 - "maxLength": 10,
15865 - "description": "The NanoId corresponding to the provided UUID. This is the new identifier that should be used in place of the legacy UUID.",
15866 - "example": "XqXrPalt3v"
15867 - }
15868 - },
15869 - "required": [
15870 - "nanoid"
15871 - ]
15872 - }
15873 - }
15874 - }
15875 - },
15876 - "400": {
15877 - "description": "Bad Request - Invalid UUID or resource not found",
15878 - "content": {
15879 - "application/json": {
15880 - "schema": {
15881 - "$ref": "#/components/schemas/Error"
15882 - }
15883 - }
15884 - }
15885 - },
15886 - "401": {
15887 - "description": "Unauthorized - Invalid or missing API key",
15888 - "content": {
15889 - "application/json": {
15890 - "schema": {
15891 - "$ref": "#/components/schemas/Error"
15892 - }
15893 - }
15894 - }
15895 - },
15896 - "404": {
15897 - "description": "Not Found - The UUID does not correspond to any resource of the specified type",
15898 - "content": {
15899 - "application/json": {
15900 - "schema": {
15901 - "$ref": "#/components/schemas/Error"
15902 - }
15903 - }
15904 - }
15905 - },
15906 - "410": {
15907 - "description": "Gone - The UUID does not correspond to any resource of the specified type",
15908 - "content": {
15909 - "application/json": {
15910 - "schema": {
15911 - "$ref": "#/components/schemas/Error"
15912 - }
15913 - }
15914 - }
15915 - },
15916 - "500": {
15917 - "description": "Internal server error - An unexpected error occurred during processing",
15918 - "content": {
15919 - "application/json": {
15920 - "schema": {
15921 - "$ref": "#/components/schemas/Error"
15922 - }
15923 - }
15924 - }
15925 - }
15926 - },
15927 - "x-api-version": "3.0"
15928 - }
15929 - },
15876 "/api/v3/tool_router/session": {
15877 "post": {
15878 "summary": "Create a new tool router session",
@@ -17323,9 +17269,6 @@
17269 {
17270 "ApiKeyAuth": []
17271 },
17326 - {
17327 - "UserApiKeyAuth": []
17328 - },
17272 {
17273 "workbench_access_key": []
17274 }
@@ -17520,9 +17463,6 @@
17463 "security": [
17464 {
17465 "ApiKeyAuth": []
17523 - },
17524 - {
17525 - "UserApiKeyAuth": []
17466 }
17467 ],
17468 "parameters": [
@@ -17554,9 +17494,7 @@
17494 "COMPOSIO_WAIT_FOR_CONNECTIONS",
17495 "COMPOSIO_REMOTE_WORKBENCH",
17496 "COMPOSIO_REMOTE_BASH_TOOL",
17557 - "COMPOSIO_GET_TOOL_SCHEMAS",
17558 - "COMPOSIO_UPSERT_RECIPE",
17559 - "COMPOSIO_GET_RECIPE"
17497 + "COMPOSIO_GET_TOOL_SCHEMAS"
17498 ],
17499 "description": "The unique slug identifier of the meta tool to execute",
17500 "example": "COMPOSIO_MANAGE_CONNECTIONS"
@@ -17713,9 +17651,6 @@
17651 "security": [
17652 {
17653 "ApiKeyAuth": []
17716 - },
17717 - {
17718 - "UserApiKeyAuth": []
17654 }
17655 ],
17656 "parameters": [
@@ -18287,9 +18222,6 @@
18222 "security": [
18223 {
18224 "ApiKeyAuth": []
18290 - },
18291 - {
18292 - "UserApiKeyAuth": []
18225 }
18226 ],
18227 "parameters": [
@@ -19304,9 +19236,6 @@
19236 "security": [
19237 {
19238 "ApiKeyAuth": []
19307 - },
19308 - {
19309 - "UserApiKeyAuth": []
19239 }
19240 ],
19241 "parameters": [
@@ -19549,9 +19478,6 @@
19478 },
19479 {
19480 "UserApiKeyAuth": []
19552 - },
19553 - {
19554 - "workbench_access_key": []
19481 }
19482 ],
19483 "parameters": [
@@ -20109,9 +20035,6 @@
20035 "security": [
20036 {
20037 "ApiKeyAuth": []
20112 - },
20113 - {
20114 - "UserApiKeyAuth": []
20038 }
20039 ],
20040 "parameters": [
@@ -20262,9 +20185,6 @@
20185 "security": [
20186 {
20187 "ApiKeyAuth": []
20265 - },
20266 - {
20267 - "UserApiKeyAuth": []
20188 }
20189 ],
20190 "parameters": [
@@ -20408,9 +20328,6 @@
20328 "security": [
20329 {
20330 "ApiKeyAuth": []
20411 - },
20412 - {
20413 - "UserApiKeyAuth": []
20331 }
20332 ],
20333 "parameters": [
@@ -20945,9 +20862,6 @@
20862 "security": [
20863 {
20864 "ApiKeyAuth": []
20948 - },
20949 - {
20950 - "UserApiKeyAuth": []
20865 }
20866 ],
20867 "parameters": [
@@ -21117,9 +21031,6 @@
21031 "security": [
21032 {
21033 "ApiKeyAuth": []
21120 - },
21121 - {
21122 - "UserApiKeyAuth": []
21034 }
21035 ],
21036 "parameters": [
@@ -21258,9 +21169,6 @@
21169 "security": [
21170 {
21171 "ApiKeyAuth": []
21261 - },
21262 - {
21263 - "UserApiKeyAuth": []
21172 }
21173 ],
21174 "parameters": [
@@ -21405,9 +21313,6 @@
21313 "security": [
21314 {
21315 "ApiKeyAuth": []
21408 - },
21409 - {
21410 - "UserApiKeyAuth": []
21316 }
21317 ],
21318 "parameters": [
@@ -21536,9 +21441,6 @@
21441 "security": [
21442 {
21443 "ApiKeyAuth": []
21539 - },
21540 - {
21541 - "UserApiKeyAuth": []
21444 }
21445 ],
21446 "responses": {
docs/public/openapi.json
+643 -1426
@@ -73,10 +73,6 @@
73 "name": "Tools",
74 "description": "Tool execution endpoints"
75 },
76 - {
77 - "name": "Recipes",
78 - "description": "Recipe management and execution. Recipes are reusable code modules that combine multiple tools."
79 - },
76 {
77 "name": "Triggers",
78 "description": "Trigger management and execution"
@@ -85,6 +81,10 @@
81 "name": "Payments",
82 "description": "Payment and subscription management"
83 },
84 + {
85 + "name": "Billing",
86 + "description": "Dashboard billing state — usage, subscription, contract (cookie-auth only)"
87 + },
88 {
89 "name": "Files",
90 "description": "File management"
@@ -93,17 +93,13 @@
93 "name": "MCP",
94 "description": "MCP server management"
95 },
96 - {
97 - "name": "Migration",
98 - "description": "Endpoints to help with migration from v1 to v3"
99 - },
96 {
97 "name": "MCP Partner",
98 "description": "MCP partner management"
99 },
100 {
105 - "name": "Recipe",
106 - "description": "Recipe endpoints"
101 + "name": "Stripe Projects",
102 + "description": "Stripe Projects provisioning"
103 },
104 {
105 "name": "Tool Router",
@@ -844,111 +840,43 @@
840 "val": {
841 "type": "object",
842 "properties": {
847 - "subdomain": {
848 - "type": "string",
849 - "nullable": true
850 - },
851 - "your-domain": {
852 - "type": "string",
853 - "nullable": true
854 - },
855 - "region": {
856 - "type": "string",
857 - "nullable": true
858 - },
859 - "shop": {
860 - "type": "string",
861 - "nullable": true
862 - },
863 - "account_url": {
864 - "type": "string",
865 - "nullable": true
866 - },
867 - "COMPANYDOMAIN": {
868 - "type": "string",
869 - "nullable": true
870 - },
871 - "extension": {
872 - "type": "string",
873 - "nullable": true
874 - },
875 - "form_api_base_url": {
876 - "type": "string",
877 - "nullable": true
878 - },
879 - "instanceEndpoint": {
880 - "type": "string",
881 - "nullable": true
882 - },
883 - "api_url": {
884 - "type": "string",
885 - "nullable": true
886 - },
887 - "borneo_dashboard_url": {
888 - "type": "string",
889 - "nullable": true
890 - },
891 - "proxy_username": {
892 - "type": "string",
893 - "nullable": true
894 - },
895 - "proxy_password": {
896 - "type": "string",
897 - "nullable": true
898 - },
899 - "domain": {
900 - "type": "string",
901 - "nullable": true
902 - },
903 - "version": {
904 - "type": "string",
905 - "nullable": true
906 - },
907 - "dc": {
908 - "type": "string",
909 - "nullable": true
910 - },
911 - "site_name": {
912 - "type": "string",
913 - "nullable": true
914 - },
915 - "instanceName": {
843 + "token": {
844 "type": "string",
845 "nullable": true
846 },
919 - "account_id": {
847 + "generic_api_key": {
848 "type": "string",
849 "nullable": true
850 },
923 - "your_server": {
851 + "api_key": {
852 "type": "string",
853 "nullable": true
854 },
927 - "server_location": {
855 + "bearer_token": {
856 "type": "string",
857 "nullable": true
858 },
931 - "base_url": {
859 + "basic_encoded": {
860 "type": "string",
861 "nullable": true
862 },
935 - "token": {
863 + "generic_token": {
864 "type": "string",
865 "nullable": true
866 },
939 - "generic_api_key": {
867 + "api_key_prefix": {
868 "type": "string",
869 "nullable": true
870 },
943 - "api_key": {
871 + "generic_secret": {
872 "type": "string",
873 "nullable": true
874 },
947 - "bearer_token": {
875 + "generic_id": {
876 "type": "string",
877 "nullable": true
878 },
951 - "basic_encoded": {
879 + "user_agent": {
880 "type": "string",
881 "nullable": true
882 },
@@ -977,7 +905,7 @@
905 "nullable": true
906 }
907 },
980 - "additionalProperties": {},
908 + "additionalProperties": false,
909 "description": "Credential fields to update. Only provided fields are changed — omitted fields are preserved. Set a field to null to remove it."
910 }
911 },
@@ -1103,782 +1031,103 @@
1031 "properties": {
1032 "id": {
1033 "type": "string",
1106 - "format": "connectedAccountId",
1107 - "description": "Connected account identifier"
1108 - },
1109 - "user_id": {
1110 - "type": "string",
1111 - "description": "User identifier"
1112 - },
1113 - "status": {
1114 - "type": "string",
1115 - "description": "Connection status"
1116 - },
1117 - "created_at": {
1118 - "type": "string",
1119 - "format": "date-time",
1120 - "description": "Creation timestamp"
1121 - },
1122 - "auth_config": {
1123 - "type": "object",
1124 - "properties": {
1125 - "id": {
1126 - "type": "string",
1127 - "description": "Auth config identifier"
1128 - },
1129 - "auth_scheme": {
1130 - "type": "string",
1131 - "description": "Authentication scheme type"
1132 - },
1133 - "is_composio_managed": {
1134 - "type": "boolean",
1135 - "description": "Whether this is a Composio-managed auth config"
1136 - }
1137 - },
1138 - "required": [
1139 - "id",
1140 - "auth_scheme",
1141 - "is_composio_managed"
1142 - ],
1143 - "description": "Auth config details"
1144 - }
1145 - },
1146 - "required": [
1147 - "id",
1148 - "user_id",
1149 - "status",
1150 - "created_at",
1151 - "auth_config"
1152 - ],
1153 - "description": "Connected account if available"
1154 - }
1155 - },
1156 - "required": [
1157 - "name",
1158 - "slug",
1159 - "enabled",
1160 - "is_no_auth",
1161 - "composio_managed_auth_schemes",
1162 - "meta",
1163 - "connected_account"
1164 - ]
1165 - }
1166 - },
1167 - "next_cursor": {
1168 - "type": "string",
1169 - "nullable": true
1170 - },
1171 - "total_pages": {
1172 - "type": "number"
1173 - },
1174 - "current_page": {
1175 - "type": "number"
1176 - },
1177 - "total_items": {
1178 - "type": "number"
1179 - }
1180 - },
1181 - "required": [
1182 - "items",
1183 - "total_pages",
1184 - "current_page",
1185 - "total_items"
1186 - ]
1187 - }
1188 - },
1189 - "parameters": {}
1190 - },
1191 - "paths": {
1192 - "/api/v3.1/consumer/connected_accounts/{nanoid}/permissions": {
1193 - "get": {
1194 - "summary": "Get consumer tool permissions for a connected account",
1195 - "description": "Returns durable Enhanced Control per-tool permission rows for a connected account.",
1196 - "tags": [
1197 - "Consumer"
1198 - ],
1199 - "operationId": "getConsumerConnectedAccountsByNanoidPermissions",
1200 - "security": [
1201 - {
1202 - "ApiKeyAuth": []
1203 - },
1204 - {
1205 - "UserApiKeyAuth": []
1206 - }
1207 - ],
1208 - "parameters": [
1209 - {
1210 - "schema": {
1211 - "type": "string",
1212 - "format": "connectedAccountId"
1213 - },
1214 - "required": true,
1215 - "description": "Connected account nano ID.",
1216 - "example": "ca_1a2b3c4d5e6f",
1217 - "name": "nanoid",
1218 - "in": "path"
1219 - }
1220 - ],
1221 - "responses": {
1222 - "200": {
1223 - "description": "Connected account tool permissions retrieved successfully.",
1224 - "content": {
1225 - "application/json": {
1226 - "schema": {
1227 - "type": "object",
1228 - "properties": {
1229 - "permissions": {
1230 - "type": "array",
1231 - "items": {
1232 - "type": "object",
1233 - "properties": {
1234 - "id": {
1235 - "type": "string"
1236 - },
1237 - "connected_account_id": {
1238 - "type": "string"
1239 - },
1240 - "tool_slug": {
1241 - "type": "string"
1242 - },
1243 - "toolkit_slug": {
1244 - "type": "string",
1245 - "description": "Normalized toolkit slug that owns this tool permission. Use this to group permissions by app/toolkit, for example `gmail` or `slack`."
1246 - },
1247 - "risk_group": {
1248 - "type": "string",
1249 - "enum": [
1250 - "read",
1251 - "write",
1252 - "destructive"
1253 - ]
1254 - },
1255 - "state": {
1256 - "type": "string",
1257 - "enum": [
1258 - "always_allow",
1259 - "always_deny",
1260 - "ask_once",
1261 - "ask_always"
1262 - ]
1263 - },
1264 - "source": {
1265 - "type": "string",
1266 - "enum": [
1267 - "initial_connect",
1268 - "settings",
1269 - "elicitation",
1270 - "migration"
1271 - ]
1272 - },
1273 - "permission_config_version": {
1274 - "type": "string",
1275 - "nullable": true
1276 - },
1277 - "created_at": {
1278 - "type": "string",
1279 - "format": "date-time"
1280 - },
1281 - "updated_at": {
1282 - "type": "string",
1283 - "format": "date-time"
1284 - }
1285 - },
1286 - "required": [
1287 - "id",
1288 - "connected_account_id",
1289 - "tool_slug",
1290 - "toolkit_slug",
1291 - "risk_group",
1292 - "state",
1293 - "source",
1294 - "permission_config_version",
1295 - "created_at",
1296 - "updated_at"
1297 - ]
1298 - }
1299 - }
1300 - },
1301 - "required": [
1302 - "permissions"
1303 - ]
1304 - }
1305 - }
1306 - }
1307 - },
1308 - "400": {
1309 - "description": "Bad request.",
1310 - "content": {
1311 - "application/json": {
1312 - "schema": {
1313 - "$ref": "#/components/schemas/Error"
1314 - }
1315 - }
1316 - }
1317 - },
1318 - "401": {
1319 - "description": "Unauthorized.",
1320 - "content": {
1321 - "application/json": {
1322 - "schema": {
1323 - "$ref": "#/components/schemas/Error"
1324 - }
1325 - }
1326 - }
1327 - },
1328 - "403": {
1329 - "description": "Forbidden.",
1330 - "content": {
1331 - "application/json": {
1332 - "schema": {
1333 - "$ref": "#/components/schemas/Error"
1334 - }
1335 - }
1336 - }
1337 - },
1338 - "404": {
1339 - "description": "Connected account not found.",
1340 - "content": {
1341 - "application/json": {
1342 - "schema": {
1343 - "$ref": "#/components/schemas/Error"
1344 - }
1345 - }
1346 - }
1347 - },
1348 - "500": {
1349 - "description": "Internal server error.",
1350 - "content": {
1351 - "application/json": {
1352 - "schema": {
1353 - "$ref": "#/components/schemas/Error"
1354 - }
1355 - }
1356 - }
1357 - }
1358 - },
1359 - "x-api-version": "3.1"
1360 - },
1361 - "patch": {
1362 - "summary": "Upsert consumer tool permissions for a connected account",
1363 - "description": "Upserts durable Enhanced Control per-tool permission rows for a connected account. This is a scaffolded write path for initial connect/settings flows.",
1364 - "tags": [
1365 - "Consumer"
1366 - ],
1367 - "operationId": "patchConsumerConnectedAccountsByNanoidPermissions",
1368 - "security": [
1369 - {
1370 - "ApiKeyAuth": []
1371 - },
1372 - {
1373 - "UserApiKeyAuth": []
1374 - }
1375 - ],
1376 - "parameters": [
1377 - {
1378 - "schema": {
1379 - "type": "string",
1380 - "format": "connectedAccountId"
1381 - },
1382 - "required": true,
1383 - "description": "Connected account nano ID.",
1384 - "example": "ca_1a2b3c4d5e6f",
1385 - "name": "nanoid",
1386 - "in": "path"
1387 - }
1388 - ],
1389 - "requestBody": {
1390 - "content": {
1391 - "application/json": {
1392 - "schema": {
1393 - "type": "object",
1394 - "properties": {
1395 - "permissions": {
1396 - "type": "array",
1397 - "items": {
1398 - "type": "object",
1399 - "properties": {
1400 - "tool_slug": {
1401 - "type": "string",
1402 - "minLength": 1
1403 - },
1404 - "toolkit_slug": {
1405 - "type": "string",
1406 - "minLength": 1,
1407 - "description": "Toolkit slug that owns this tool permission. Use this to group and query connected-account permissions by app/toolkit, for example `gmail` or `slack`."
1408 - },
1409 - "risk_group": {
1410 - "type": "string",
1411 - "enum": [
1412 - "read",
1413 - "write",
1414 - "destructive"
1415 - ]
1416 - },
1417 - "state": {
1418 - "type": "string",
1419 - "enum": [
1420 - "always_allow",
1421 - "always_deny",
1422 - "ask_once",
1423 - "ask_always"
1424 - ]
1425 - },
1426 - "source": {
1427 - "type": "string",
1428 - "enum": [
1429 - "initial_connect",
1430 - "settings",
1431 - "elicitation",
1432 - "migration"
1433 - ],
1434 - "default": "settings"
1435 - },
1436 - "permission_config_version": {
1437 - "type": "string",
1438 - "minLength": 1
1439 - }
1440 - },
1441 - "required": [
1442 - "tool_slug",
1443 - "toolkit_slug",
1444 - "risk_group",
1445 - "state"
1446 - ]
1447 - },
1448 - "minItems": 1,
1449 - "description": "Tool permission rows to upsert for this connected account."
1450 - }
1451 - },
1452 - "required": [
1453 - "permissions"
1454 - ]
1455 - }
1456 - }
1457 - }
1458 - },
1459 - "responses": {
1460 - "200": {
1461 - "description": "Connected account tool permissions updated successfully.",
1462 - "content": {
1463 - "application/json": {
1464 - "schema": {
1465 - "type": "object",
1466 - "properties": {
1467 - "permissions": {
1468 - "type": "array",
1469 - "items": {
1470 - "type": "object",
1471 - "properties": {
1472 - "id": {
1473 - "type": "string"
1474 - },
1475 - "connected_account_id": {
1476 - "type": "string"
1477 - },
1478 - "tool_slug": {
1479 - "type": "string"
1480 - },
1481 - "toolkit_slug": {
1482 - "type": "string",
1483 - "description": "Normalized toolkit slug that owns this tool permission. Use this to group permissions by app/toolkit, for example `gmail` or `slack`."
1484 - },
1485 - "risk_group": {
1486 - "type": "string",
1487 - "enum": [
1488 - "read",
1489 - "write",
1490 - "destructive"
1491 - ]
1492 - },
1493 - "state": {
1494 - "type": "string",
1495 - "enum": [
1496 - "always_allow",
1497 - "always_deny",
1498 - "ask_once",
1499 - "ask_always"
1500 - ]
1501 - },
1502 - "source": {
1503 - "type": "string",
1504 - "enum": [
1505 - "initial_connect",
1506 - "settings",
1507 - "elicitation",
1508 - "migration"
1509 - ]
1510 - },
1511 - "permission_config_version": {
1512 - "type": "string",
1513 - "nullable": true
1514 - },
1515 - "created_at": {
1516 - "type": "string",
1517 - "format": "date-time"
1518 - },
1519 - "updated_at": {
1520 - "type": "string",
1521 - "format": "date-time"
1522 - }
1523 - },
1524 - "required": [
1525 - "id",
1526 - "connected_account_id",
1527 - "tool_slug",
1528 - "toolkit_slug",
1529 - "risk_group",
1530 - "state",
1531 - "source",
1532 - "permission_config_version",
1533 - "created_at",
1534 - "updated_at"
1535 - ]
1536 - }
1537 - }
1538 - },
1539 - "required": [
1540 - "permissions"
1541 - ]
1542 - }
1543 - }
1544 - }
1545 - },
1546 - "400": {
1547 - "description": "Bad request.",
1548 - "content": {
1549 - "application/json": {
1550 - "schema": {
1551 - "$ref": "#/components/schemas/Error"
1552 - }
1553 - }
1554 - }
1555 - },
1556 - "401": {
1557 - "description": "Unauthorized.",
1558 - "content": {
1559 - "application/json": {
1560 - "schema": {
1561 - "$ref": "#/components/schemas/Error"
1562 - }
1563 - }
1564 - }
1565 - },
1566 - "403": {
1567 - "description": "Forbidden.",
1568 - "content": {
1569 - "application/json": {
1570 - "schema": {
1571 - "$ref": "#/components/schemas/Error"
1572 - }
1573 - }
1574 - }
1575 - },
1576 - "404": {
1577 - "description": "Connected account not found.",
1578 - "content": {
1579 - "application/json": {
1580 - "schema": {
1581 - "$ref": "#/components/schemas/Error"
1582 - }
1583 - }
1584 - }
1585 - },
1586 - "500": {
1587 - "description": "Internal server error.",
1588 - "content": {
1589 - "application/json": {
1590 - "schema": {
1591 - "$ref": "#/components/schemas/Error"
1592 - }
1593 - }
1594 - }
1595 - }
1596 - },
1597 - "x-api-version": "3.1"
1598 - }
1599 - },
1600 - "/api/v3.1/consumer/connected_accounts/{nanoid}/permissions/tools/{tool_slug}": {
1601 - "patch": {
1602 - "summary": "Upsert one consumer tool permission for a connected account",
1603 - "description": "Upserts a single durable Enhanced Control permission row for a connected account/tool pair.",
1604 - "tags": [
1605 - "Consumer"
1606 - ],
1607 - "operationId": "patchConsumerConnectedAccountsByNanoidPermissionsToolsByToolSlug",
1608 - "security": [
1609 - {
1610 - "ApiKeyAuth": []
1611 - },
1612 - {
1613 - "UserApiKeyAuth": []
1614 - }
1615 - ],
1616 - "parameters": [
1617 - {
1618 - "schema": {
1619 - "type": "string",
1620 - "format": "connectedAccountId"
1621 - },
1622 - "required": true,
1623 - "description": "Connected account nano ID.",
1624 - "example": "ca_1a2b3c4d5e6f",
1625 - "name": "nanoid",
1626 - "in": "path"
1627 - },
1628 - {
1629 - "schema": {
1630 - "type": "string",
1631 - "minLength": 1
1632 - },
1633 - "required": true,
1634 - "description": "Tool slug to update.",
1635 - "example": "GMAIL_SEND_EMAIL",
1636 - "name": "tool_slug",
1637 - "in": "path"
1638 - }
1639 - ],
1640 - "requestBody": {
1641 - "content": {
1642 - "application/json": {
1643 - "schema": {
1644 - "type": "object",
1645 - "properties": {
1646 - "toolkit_slug": {
1647 - "type": "string",
1648 - "minLength": 1,
1649 - "description": "Toolkit slug that owns this tool permission. Use this to group and query connected-account permissions by app/toolkit, for example `gmail` or `slack`."
1650 - },
1651 - "risk_group": {
1652 - "type": "string",
1653 - "enum": [
1654 - "read",
1655 - "write",
1656 - "destructive"
1657 - ]
1658 - },
1659 - "state": {
1660 - "type": "string",
1661 - "enum": [
1662 - "always_allow",
1663 - "always_deny",
1664 - "ask_once",
1665 - "ask_always"
1666 - ]
1667 - },
1668 - "source": {
1669 - "type": "string",
1670 - "enum": [
1671 - "initial_connect",
1672 - "settings",
1673 - "elicitation",
1674 - "migration"
1675 - ],
1676 - "default": "settings"
1677 - },
1678 - "permission_config_version": {
1679 - "type": "string",
1680 - "minLength": 1
1681 - }
1682 - },
1683 - "required": [
1684 - "toolkit_slug",
1685 - "risk_group",
1686 - "state"
1687 - ]
1688 - }
1689 - }
1690 - }
1691 - },
1692 - "responses": {
1693 - "200": {
1694 - "description": "Connected account tool permission updated successfully.",
1695 - "content": {
1696 - "application/json": {
1697 - "schema": {
1698 - "type": "object",
1699 - "properties": {
1700 - "permission": {
1701 - "type": "object",
1702 - "properties": {
1703 - "id": {
1704 - "type": "string"
1705 - },
1706 - "connected_account_id": {
1707 - "type": "string"
1708 - },
1709 - "tool_slug": {
1710 - "type": "string"
1711 - },
1712 - "toolkit_slug": {
1713 - "type": "string",
1714 - "description": "Normalized toolkit slug that owns this tool permission. Use this to group permissions by app/toolkit, for example `gmail` or `slack`."
1715 - },
1716 - "risk_group": {
1717 - "type": "string",
1718 - "enum": [
1719 - "read",
1720 - "write",
1721 - "destructive"
1722 - ]
1723 - },
1724 - "state": {
1725 - "type": "string",
1726 - "enum": [
1727 - "always_allow",
1728 - "always_deny",
1729 - "ask_once",
1730 - "ask_always"
1731 - ]
1732 - },
1733 - "source": {
1734 - "type": "string",
1735 - "enum": [
1736 - "initial_connect",
1737 - "settings",
1738 - "elicitation",
1739 - "migration"
1740 - ]
1741 - },
1742 - "permission_config_version": {
1034 + "format": "connectedAccountId",
1035 + "description": "Connected account identifier"
1036 + },
1037 + "user_id": {
1038 + "type": "string",
1039 + "description": "User identifier"
1040 + },
1041 + "status": {
1042 + "type": "string",
1043 + "description": "Connection status"
1044 + },
1045 + "created_at": {
1046 + "type": "string",
1047 + "format": "date-time",
1048 + "description": "Creation timestamp"
1049 + },
1050 + "auth_config": {
1051 + "type": "object",
1052 + "properties": {
1053 + "id": {
1054 "type": "string",
1744 - "nullable": true
1055 + "description": "Auth config identifier"
1056 },
1746 - "created_at": {
1057 + "auth_scheme": {
1058 "type": "string",
1748 - "format": "date-time"
1059 + "description": "Authentication scheme type"
1060 },
1750 - "updated_at": {
1751 - "type": "string",
1752 - "format": "date-time"
1061 + "is_composio_managed": {
1062 + "type": "boolean",
1063 + "description": "Whether this is a Composio-managed auth config"
1064 }
1065 },
1066 "required": [
1067 "id",
1757 - "connected_account_id",
1758 - "tool_slug",
1759 - "toolkit_slug",
1760 - "risk_group",
1761 - "state",
1762 - "source",
1763 - "permission_config_version",
1764 - "created_at",
1765 - "updated_at"
1766 - ]
1068 + "auth_scheme",
1069 + "is_composio_managed"
1070 + ],
1071 + "description": "Auth config details"
1072 }
1073 },
1074 "required": [
1770 - "permission"
1771 - ]
1772 - }
1773 - }
1774 - }
1775 - },
1776 - "400": {
1777 - "description": "Bad request.",
1778 - "content": {
1779 - "application/json": {
1780 - "schema": {
1781 - "$ref": "#/components/schemas/Error"
1075 + "id",
1076 + "user_id",
1077 + "status",
1078 + "created_at",
1079 + "auth_config"
1080 + ],
1081 + "description": "Connected account if available"
1082 }
1783 - }
1083 + },
1084 + "required": [
1085 + "name",
1086 + "slug",
1087 + "enabled",
1088 + "is_no_auth",
1089 + "composio_managed_auth_schemes",
1090 + "meta",
1091 + "connected_account"
1092 + ]
1093 }
1094 },
1786 - "401": {
1787 - "description": "Unauthorized.",
1788 - "content": {
1789 - "application/json": {
1790 - "schema": {
1791 - "$ref": "#/components/schemas/Error"
1792 - }
1793 - }
1794 - }
1095 + "next_cursor": {
1096 + "type": "string",
1097 + "nullable": true
1098 },
1796 - "403": {
1797 - "description": "Forbidden.",
1798 - "content": {
1799 - "application/json": {
1800 - "schema": {
1801 - "$ref": "#/components/schemas/Error"
1802 - }
1803 - }
1804 - }
1099 + "total_pages": {
1100 + "type": "number"
1101 },
1806 - "404": {
1807 - "description": "Connected account not found.",
1808 - "content": {
1809 - "application/json": {
1810 - "schema": {
1811 - "$ref": "#/components/schemas/Error"
1812 - }
1813 - }
1814 - }
1102 + "current_page": {
1103 + "type": "number"
1104 },
1816 - "500": {
1817 - "description": "Internal server error.",
1818 - "content": {
1819 - "application/json": {
1820 - "schema": {
1821 - "$ref": "#/components/schemas/Error"
1822 - }
1823 - }
1824 - }
1105 + "total_items": {
1106 + "type": "number"
1107 }
1108 },
1827 - "x-api-version": "3.1"
1109 + "required": [
1110 + "items",
1111 + "total_pages",
1112 + "current_page",
1113 + "total_items"
1114 + ]
1115 }
1116 },
1830 - "/api/v3.1/consumer/permissions/resolve": {
1117 + "parameters": {}
1118 + },
1119 + "paths": {
1120 + "/api/v3.1/api_key_revocation": {
1121 "post": {
1832 - "summary": "Resolve consumer tool-router permissions",
1833 - "description": "Resolves durable connected-account tool permissions into the landed tool-router experimental.permissions config so consumer flows can pass it directly when creating a tool-router session. In addition to existing auth methods, server-side callers may use admin auth with org_member_id/project_id/org_id query params to derive the project user context.",
1122 + "summary": "Publicly revoke leaked Composio API keys",
1123 + "description": "Public endpoint for reporting and revoking Composio API keys that have been leaked (e.g. via the GitHub Secret Scanning Partner Program, third-party scanners, or self-reported leaks). Accepts project (ak_*), user (uak_*), and org (oak_*) keys in a single batch. Matched keys are revoked or soft-deleted. The response shape is constant regardless of whether any submitted key matched, so callers cannot use this endpoint to probe key existence. IP-rate-limited via the shared `ipRateLimitMiddleware` (same Redis-backed pattern used by the public install endpoint): per-IP and global tiers, fail-closed on Redis errors, returns 429 on hit.",
1124 "tags": [
1835 - "Consumer"
1125 + "API Keys"
1126 ],
1837 - "operationId": "postConsumerPermissionsResolve",
1127 + "operationId": "postApiKeyRevocation",
1128 "security": [
1129 {
1840 - "ApiKeyAuth": []
1841 - },
1842 - {
1843 - "UserApiKeyAuth": []
1844 - },
1845 - {
1846 - "admin": []
1847 - }
1848 - ],
1849 - "parameters": [
1850 - {
1851 - "schema": {
1852 - "type": "string",
1853 - "format": "uuid",
1854 - "description": "Org member/user UUID used with admin auth."
1855 - },
1856 - "required": false,
1857 - "description": "Org member/user UUID used with admin auth.",
1858 - "name": "org_member_id",
1859 - "in": "query"
1860 - },
1861 - {
1862 - "schema": {
1863 - "type": "string",
1864 - "format": "projectId",
1865 - "description": "Project nano ID used with admin auth."
1866 - },
1867 - "required": false,
1868 - "description": "Project nano ID used with admin auth.",
1869 - "name": "project_id",
1870 - "in": "query"
1871 - },
1872 - {
1873 - "schema": {
1874 - "type": "string",
1875 - "format": "orgId",
1876 - "description": "Org nano ID used with admin auth."
1877 - },
1878 - "required": false,
1879 - "description": "Org nano ID used with admin auth.",
1880 - "name": "org_id",
1881 - "in": "query"
1130 + "no_auth": []
1131 }
1132 ],
1133 "requestBody": {
@@ -1887,127 +1136,47 @@
1136 "schema": {
1137 "type": "object",
1138 "properties": {
1890 - "connected_account_ids": {
1139 + "api_keys": {
1140 "type": "array",
1141 "items": {
1142 "type": "string",
1894 - "format": "connectedAccountId"
1895 - },
1896 - "description": "Connected account nano IDs to include in resolution."
1897 - },
1898 - "connected_accounts": {
1899 - "type": "object",
1900 - "additionalProperties": {
1901 - "type": "array",
1902 - "items": {
1903 - "type": "string",
1904 - "format": "connectedAccountId"
1905 - },
1906 - "minItems": 1
1143 + "minLength": 4,
1144 + "maxLength": 256
1145 },
1908 - "description": "Optional toolkit_slug -> connected account nano ID array map. Values are flattened and merged with connected_account_ids."
1909 - },
1910 - "default": {
1911 - "type": "string",
1912 - "enum": [
1913 - "allow_all",
1914 - "ask_every_call",
1915 - "ask_once_per_session"
1916 - ],
1917 - "description": "Optional default mode to include in the resolved tool-router permissions config.",
1918 - "x-experimental": true
1146 + "minItems": 1,
1147 + "maxItems": 100,
1148 + "description": "Composio API keys to revoke. Accepts project (ak_*), user (uak_*), and org (oak_*) keys. Each batch is capped at 100 entries."
1149 }
1920 - }
1150 + },
1151 + "required": [
1152 + "api_keys"
1153 + ]
1154 }
1155 }
1156 }
1157 },
1158 "responses": {
1159 "200": {
1927 - "description": "Consumer permissions resolved successfully.",
1160 + "description": "Revocation request received",
1161 "content": {
1162 "application/json": {
1163 "schema": {
1164 "type": "object",
1165 "properties": {
1933 - "experimental": {
1934 - "type": "object",
1935 - "properties": {
1936 - "permissions": {
1937 - "type": "object",
1938 - "properties": {
1939 - "default": {
1940 - "type": "string",
1941 - "enum": [
1942 - "allow_all",
1943 - "ask_every_call",
1944 - "ask_once_per_session"
1945 - ],
1946 - "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."
1947 - },
1948 - "overrides": {
1949 - "type": "object",
1950 - "additionalProperties": {
1951 - "type": "string",
1952 - "enum": [
1953 - "always_allow",
1954 - "always_deny",
1955 - "ask_once",
1956 - "ask_always"
1957 - ]
1958 - },
1959 - "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`."
1960 - }
1961 - },
1962 - "required": [
1963 - "default"
1964 - ]
1965 - }
1966 - },
1967 - "required": [
1968 - "permissions"
1969 - ]
1166 + "received": {
1167 + "type": "boolean",
1168 + "description": "Always true when the request body is valid. The response intentionally does not reveal whether any submitted key matched a record."
1169 }
1170 },
1171 "required": [
1973 - "experimental"
1172 + "received"
1173 ]
1174 }
1175 }
1176 }
1177 },
1178 "400": {
1980 - "description": "Bad request.",
1981 - "content": {
1982 - "application/json": {
1983 - "schema": {
1984 - "$ref": "#/components/schemas/Error"
1985 - }
1986 - }
1987 - }
1988 - },
1989 - "401": {
1990 - "description": "Unauthorized.",
1991 - "content": {
1992 - "application/json": {
1993 - "schema": {
1994 - "$ref": "#/components/schemas/Error"
1995 - }
1996 - }
1997 - }
1998 - },
1999 - "403": {
2000 - "description": "Forbidden.",
2001 - "content": {
2002 - "application/json": {
2003 - "schema": {
2004 - "$ref": "#/components/schemas/Error"
2005 - }
2006 - }
2007 - }
2008 - },
2009 - "404": {
2010 - "description": "Connected account not found.",
1179 + "description": "Malformed payload",
1180 "content": {
1181 "application/json": {
1182 "schema": {
@@ -2016,8 +1185,8 @@
1185 }
1186 }
1187 },
2019 - "500": {
2020 - "description": "Internal server error.",
1188 + "429": {
1189 + "description": "Too many requests",
1190 "content": {
1191 "application/json": {
1192 "schema": {
@@ -2041,9 +1210,6 @@
1210 "security": [
1211 {
1212 "ApiKeyAuth": []
2044 - },
2045 - {
2046 - "UserApiKeyAuth": []
1213 }
1214 ],
1215 "requestBody": {
@@ -2263,9 +1429,6 @@
1429 "security": [
1430 {
1431 "ApiKeyAuth": []
2266 - },
2267 - {
2268 - "UserApiKeyAuth": []
1432 }
1433 ],
1434 "parameters": [
@@ -3369,7 +2532,7 @@
2532 "log_id": {
2533 "type": "string",
2534 "description": "Unique identifier for the execution log (useful for debugging and support)",
3372 - "example": "log_abc123def456"
2535 + "example": "log_1a2b3c4d5e6f"
2536 }
2537 },
2538 "required": [
@@ -3526,9 +2689,6 @@
2689 "security": [
2690 {
2691 "ApiKeyAuth": []
3529 - },
3530 - {
3531 - "UserApiKeyAuth": []
2692 }
2693 ],
2694 "parameters": [
@@ -3674,7 +2834,7 @@
2834 "/api/v3.1/tools/execute/proxy": {
2835 "post": {
2836 "summary": "Execute proxy request",
3677 - "description": "Proxy an HTTP request to a third-party API using connected account credentials. This endpoint allows making authenticated API calls to external services while abstracting away authentication details.",
2837 + "description": "Proxy an HTTP request to a third-party API using connected account credentials. This endpoint allows making authenticated API calls to external services while abstracting away authentication details. v3.1 requires a proxy_execute scoped project API key; default project API keys are rejected.",
2838 "tags": [
2839 "Tools"
2840 ],
@@ -3682,9 +2842,6 @@
2842 "security": [
2843 {
2844 "ApiKeyAuth": []
3685 - },
3686 - {
3687 - "UserApiKeyAuth": []
2845 }
2846 ],
2847 "requestBody": {
@@ -4250,9 +3407,6 @@
3407 "security": [
3408 {
3409 "ApiKeyAuth": []
4253 - },
4254 - {
4255 - "UserApiKeyAuth": []
3410 }
3411 ],
3412 "requestBody": {
@@ -4544,9 +3698,6 @@
3698 "security": [
3699 {
3700 "ApiKeyAuth": []
4547 - },
4548 - {
4549 - "UserApiKeyAuth": []
3701 }
3702 ],
3703 "parameters": [
@@ -4576,7 +3727,8 @@
3727 "type": "string",
3728 "enum": [
3729 "access_token",
4579 - "refresh_token"
3730 + "refresh_token",
3731 + "credential"
3732 ]
3733 },
3734 "description": "Tokens revoked at the provider on this call. Empty array means the connection was already revoked (no upstream dispatch)."
@@ -4702,9 +3854,6 @@
3854 "security": [
3855 {
3856 "ApiKeyAuth": []
4705 - },
4706 - {
4707 - "UserApiKeyAuth": []
3857 }
3858 ],
3859 "requestBody": {
@@ -6141,9 +5290,6 @@
5290 "security": [
5291 {
5292 "ApiKeyAuth": []
6144 - },
6145 - {
6146 - "UserApiKeyAuth": []
5293 }
5294 ],
5295 "parameters": [
@@ -6738,10 +5884,7 @@
5884 "operationId": "patchToolRouterSessionBySessionId",
5885 "security": [
5886 {
6741 - "ApiKeyAuth": []
6742 - },
6743 - {
6744 - "UserApiKeyAuth": []
5887 + "ApiKeyAuth": []
5888 }
5889 ],
5890 "parameters": [
@@ -7793,6 +6936,106 @@
6936 }
6937 },
6938 "x-api-version": "3.1"
6939 + },
6940 + "delete": {
6941 + "summary": "Delete a tool router session",
6942 + "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. The record is retained internally for audit purposes. Deleting an already-deleted session returns 404.",
6943 + "tags": [
6944 + "Tool Router"
6945 + ],
6946 + "operationId": "deleteToolRouterSessionBySessionId",
6947 + "security": [
6948 + {
6949 + "ApiKeyAuth": []
6950 + }
6951 + ],
6952 + "parameters": [
6953 + {
6954 + "schema": {
6955 + "type": "string",
6956 + "format": "toolRouterSessionId",
6957 + "description": "The unique identifier of the tool router session",
6958 + "example": "trs_1a2b3c4d5e6f"
6959 + },
6960 + "required": true,
6961 + "description": "The unique identifier of the tool router session",
6962 + "name": "session_id",
6963 + "in": "path"
6964 + }
6965 + ],
6966 + "responses": {
6967 + "200": {
6968 + "description": "Session successfully deleted.",
6969 + "content": {
6970 + "application/json": {
6971 + "schema": {
6972 + "type": "object",
6973 + "properties": {
6974 + "session_id": {
6975 + "type": "string",
6976 + "format": "toolRouterSessionId",
6977 + "description": "The unique identifier of the deleted tool router session",
6978 + "example": "trs_1a2b3c4d5e6f"
6979 + },
6980 + "deleted": {
6981 + "type": "boolean",
6982 + "enum": [
6983 + true
6984 + ],
6985 + "description": "Always true — present to make the outcome explicit",
6986 + "example": true
6987 + }
6988 + },
6989 + "required": [
6990 + "session_id",
6991 + "deleted"
6992 + ]
6993 + }
6994 + }
6995 + }
6996 + },
6997 + "400": {
6998 + "description": "Bad request. This may occur if the session_id format is invalid, please pass this in trs_ prefix format",
6999 + "content": {
7000 + "application/json": {
7001 + "schema": {
7002 + "$ref": "#/components/schemas/Error"
7003 + }
7004 + }
7005 + }
7006 + },
7007 + "401": {
7008 + "description": "Unauthorized. Authentication is required or the provided credentials are invalid.",
7009 + "content": {
7010 + "application/json": {
7011 + "schema": {
7012 + "$ref": "#/components/schemas/Error"
7013 + }
7014 + }
7015 + }
7016 + },
7017 + "404": {
7018 + "description": "Not found. The session with the provided ID does not exist or has already been deleted.",
7019 + "content": {
7020 + "application/json": {
7021 + "schema": {
7022 + "$ref": "#/components/schemas/Error"
7023 + }
7024 + }
7025 + }
7026 + },
7027 + "500": {
7028 + "description": "Internal server error.",
7029 + "content": {
7030 + "application/json": {
7031 + "schema": {
7032 + "$ref": "#/components/schemas/Error"
7033 + }
7034 + }
7035 + }
7036 + }
7037 + },
7038 + "x-api-version": "3.1"
7039 }
7040 },
7041 "/api/v3.1/tool_router/session/{session_id}/attach": {
@@ -7806,9 +7049,6 @@
7049 "security": [
7050 {
7051 "ApiKeyAuth": []
7809 - },
7810 - {
7811 - "UserApiKeyAuth": []
7052 }
7053 ],
7054 "parameters": [
@@ -8604,9 +7844,6 @@
7844 "security": [
7845 {
7846 "ApiKeyAuth": []
8607 - },
8608 - {
8609 - "UserApiKeyAuth": []
7847 }
7848 ],
7849 "parameters": [
@@ -8709,9 +7946,6 @@
7946 "security": [
7947 {
7948 "ApiKeyAuth": []
8712 - },
8713 - {
8714 - "UserApiKeyAuth": []
7949 }
7950 ],
7951 "parameters": [
@@ -9422,9 +8656,6 @@
8656 "security": [
8657 {
8658 "ApiKeyAuth": []
9425 - },
9426 - {
9427 - "UserApiKeyAuth": []
8659 }
8660 ],
8661 "parameters": [
@@ -9527,9 +8758,6 @@
8758 {
8759 "ApiKeyAuth": []
8760 },
9530 - {
9531 - "UserApiKeyAuth": []
9532 - },
8761 {
8762 "workbench_access_key": []
8763 }
@@ -9900,9 +9128,6 @@
9128 "security": [
9129 {
9130 "ApiKeyAuth": []
9903 - },
9904 - {
9905 - "UserApiKeyAuth": []
9131 }
9132 ],
9133 "parameters": [
@@ -9934,9 +9159,7 @@
9159 "COMPOSIO_WAIT_FOR_CONNECTIONS",
9160 "COMPOSIO_REMOTE_WORKBENCH",
9161 "COMPOSIO_REMOTE_BASH_TOOL",
9937 - "COMPOSIO_GET_TOOL_SCHEMAS",
9938 - "COMPOSIO_UPSERT_RECIPE",
9939 - "COMPOSIO_GET_RECIPE"
9162 + "COMPOSIO_GET_TOOL_SCHEMAS"
9163 ],
9164 "description": "The unique slug identifier of the meta tool to execute",
9165 "example": "COMPOSIO_MANAGE_CONNECTIONS"
@@ -10646,9 +9869,6 @@
9869 "security": [
9870 {
9871 "ApiKeyAuth": []
10649 - },
10650 - {
10651 - "UserApiKeyAuth": []
9872 }
9873 ],
9874 "requestBody": {
@@ -10804,9 +10024,6 @@
10024 "security": [
10025 {
10026 "ApiKeyAuth": []
10807 - },
10808 - {
10809 - "UserApiKeyAuth": []
10027 }
10028 ],
10029 "parameters": [
@@ -11009,9 +10226,6 @@
10226 ],
10227 "operationId": "getAuthSessionInfo",
10228 "security": [
11012 - {
11013 - "ApiKeyAuth": []
11014 - },
10229 {
10230 "UserApiKeyAuth": []
10231 }
@@ -11264,10 +10478,6 @@
10478 "metadata": {
10479 "type": "object",
10480 "properties": {
11267 - "createdInBetterAuth": {
11268 - "type": "boolean",
11269 - "description": "Whether the user was created via Better Auth (dashboard signup)."
11270 - },
10481 "prefers_old_dashboard": {
10482 "type": "boolean",
10483 "description": "If true, the user will be redirected to the legacy dashboard at platform.composio.dev."
@@ -11459,7 +10669,8 @@
10669 "type": "string"
10670 }
10671 }
11462 - ]
10672 + ],
10673 + "description": "OAuth scopes requested for the managed auth config."
10674 },
10675 "user_scopes": {
10676 "anyOf": [
@@ -11472,7 +10683,8 @@
10683 "type": "string"
10684 }
10685 }
11475 - ]
10686 + ],
10687 + "description": "OAuth user-token scopes requested for the managed auth config. This is primarily used by Slack OAuth v2."
10688 }
10689 },
10690 "default": {}
@@ -11560,7 +10772,8 @@
10772 "type": "string"
10773 }
10774 }
11563 - ]
10775 + ],
10776 + "description": "OAuth scopes requested for the custom auth config."
10777 },
10778 "user_scopes": {
10779 "anyOf": [
@@ -11573,7 +10786,8 @@
10786 "type": "string"
10787 }
10788 }
11576 - ]
10789 + ],
10790 + "description": "OAuth user-token scopes requested for the custom auth config. This is primarily used by Slack OAuth v2."
10791 }
10792 },
10793 "default": {}
@@ -11877,7 +11091,8 @@
11091 },
11092 "uuid": {
11093 "type": "string",
11880 - "description": "The UUID of the authentication configuration (for backward compatibility)"
11094 + "description": "The UUID of the authentication configuration (for backward compatibility)",
11095 + "deprecated": true
11096 },
11097 "type": {
11098 "type": "string",
@@ -12193,7 +11408,8 @@
11408 },
11409 "uuid": {
11410 "type": "string",
12196 - "description": "The UUID of the authentication configuration (for backward compatibility)"
11411 + "description": "The UUID of the authentication configuration (for backward compatibility)",
11412 + "deprecated": true
11413 },
11414 "type": {
11415 "type": "string",
@@ -12503,7 +11719,8 @@
11719 "type": "string"
11720 }
11721 }
12506 - ]
11722 + ],
11723 + "description": "OAuth scopes requested for the auth config."
11724 },
11725 "user_scopes": {
11726 "anyOf": [
@@ -12516,7 +11733,8 @@
11733 "type": "string"
11734 }
11735 }
12519 - ]
11736 + ],
11737 + "description": "OAuth user-token scopes requested for the auth config. This is primarily used by Slack OAuth v2."
11738 }
11739 }
11740 },
@@ -12568,7 +11786,7 @@
11786 "shared_credentials": {
11787 "type": "object",
11788 "additionalProperties": {},
12571 - "description": "Shared credentials that will be inherited by connected accounts. For eg: this can be used to share the API key for a tool with all connected accounts using this auth config."
11789 + "description": "Shared credentials inherited by all connected accounts using this auth config. Secret values are redacted in responses, so provide the real values when updating; omit this field to leave them unchanged."
11790 },
11791 "is_enabled_for_tool_router": {
11792 "type": "boolean",
@@ -12604,7 +11822,8 @@
11822 "type": "string"
11823 }
11824 }
12607 - ]
11825 + ],
11826 + "description": "OAuth scopes requested for the auth config."
11827 },
11828 "user_scopes": {
11829 "anyOf": [
@@ -12617,7 +11836,8 @@
11836 "type": "string"
11837 }
11838 }
12620 - ]
11839 + ],
11840 + "description": "OAuth user-token scopes requested for the auth config. This is primarily used by Slack OAuth v2."
11841 },
11842 "restrict_to_following_tools": {
11843 "type": "array",
@@ -12649,7 +11869,7 @@
11869 "shared_credentials": {
11870 "type": "object",
11871 "additionalProperties": {},
12652 - "description": "Shared credentials that will be inherited by connected accounts. For eg: this can be used to share the API key for a tool with all connected accounts using this auth config."
11872 + "description": "Shared credentials inherited by all connected accounts using this auth config. Secret values are redacted in responses, so provide the real values when updating; omit this field to leave them unchanged."
11873 },
11874 "is_enabled_for_tool_router": {
11875 "type": "boolean",
@@ -12739,7 +11959,7 @@
11959 },
11960 "delete": {
11961 "summary": "Delete an authentication configuration",
12742 - "description": "Soft-deletes an authentication configuration by marking it as deleted in the database. This operation cannot be undone.",
11962 + "description": "Soft-deletes an authentication configuration by marking it as deleted in the database. This operation cannot be undone. Pass `?revoke_on_delete=true` to also revoke the upstream credentials of every connection using this auth config via a background job.",
11963 "tags": [
11964 "Auth Configs"
11965 ],
@@ -12763,6 +11983,18 @@
11983 "description": "The unique identifier of the authentication configuration to delete",
11984 "name": "nanoid",
11985 "in": "path"
11986 + },
11987 + {
11988 + "schema": {
11989 + "type": "boolean",
11990 + "nullable": true,
11991 + "default": false,
11992 + "description": "When `true`, the delete also starts a background job that revokes the upstream credentials of every connected account in scope, and the response carries a `revoke_job_id`. Defaults to `false`. Revocation is irreversible — recovering a deleted entity does not restore working credentials."
11993 + },
11994 + "required": false,
11995 + "description": "When `true`, the delete also starts a background job that revokes the upstream credentials of every connected account in scope, and the response carries a `revoke_job_id`. Defaults to `false`. Revocation is irreversible — recovering a deleted entity does not restore working credentials.",
11996 + "name": "revoke_on_delete",
11997 + "in": "query"
11998 }
11999 ],
12000 "responses": {
@@ -12772,7 +12004,13 @@
12004 "application/json": {
12005 "schema": {
12006 "type": "object",
12775 - "properties": {}
12007 + "properties": {
12008 + "revoke_job_id": {
12009 + "type": "string",
12010 + "description": "Identifier of the background revoke job started for this delete. Present only when `revoke_on_delete=true`. Track the job and its per-connection results from the Composio dashboard — a programmatic endpoint to poll this job is not yet generally available.",
12011 + "example": "pj_1a2b3c4d5e6f"
12012 + }
12013 + }
12014 }
12015 }
12016 }
@@ -12833,9 +12071,6 @@
12071 "security": [
12072 {
12073 "ApiKeyAuth": []
12836 - },
12837 - {
12838 - "UserApiKeyAuth": []
12074 }
12075 ],
12076 "parameters": [
@@ -13554,9 +12789,6 @@
12789 "security": [
12790 {
12791 "ApiKeyAuth": []
13557 - },
13558 - {
13559 - "UserApiKeyAuth": []
12792 }
12793 ],
12794 "requestBody": {
@@ -14087,8 +13319,7 @@
13319 "connectionData",
13320 "status",
13321 "redirect_url",
14090 - "redirect_uri",
14091 - "deprecated"
13322 + "redirect_uri"
13323 ]
13324 }
13325 }
@@ -14538,6 +13769,20 @@
13769 "additionalProperties": {},
13770 "description": "The initialization data of the connection, including configuration parameters",
13771 "deprecated": true
13772 + },
13773 + "requested_scopes": {
13774 + "type": "array",
13775 + "items": {
13776 + "type": "string"
13777 + },
13778 + "description": "OAuth scopes requested when this connection was most recently initiated (create or refresh). Absent for connections created before scope snapshots were captured and for non-OAuth auth schemes."
13779 + },
13780 + "requested_user_scopes": {
13781 + "type": "array",
13782 + "items": {
13783 + "type": "string"
13784 + },
13785 + "description": "OAuth user-token scopes requested at the most recent initiation. Only meaningful for Slackbot auth configs (user-token scopes); absent otherwise."
13786 }
13787 },
13788 "required": [
@@ -14625,7 +13870,7 @@
13870 },
13871 "delete": {
13872 "summary": "Delete a connected account",
14628 - "description": "Soft-deletes a connected account by marking it as deleted in the database. This prevents the account from being used for API calls but preserves the record for audit purposes.",
13873 + "description": "Soft-deletes a connected account by marking it as deleted in the database. This prevents the account from being used for API calls but preserves the record for audit purposes. Pass `?revoke_on_delete=true` to also revoke the account's upstream credentials via a background job.",
13874 "tags": [
13875 "Connected Accounts"
13876 ],
@@ -14649,6 +13894,18 @@
13894 "example": "ca_1a2b3c4d5e6f",
13895 "name": "nanoid",
13896 "in": "path"
13897 + },
13898 + {
13899 + "schema": {
13900 + "type": "boolean",
13901 + "nullable": true,
13902 + "default": false,
13903 + "description": "When `true`, the delete also starts a background job that revokes the upstream credentials of every connected account in scope, and the response carries a `revoke_job_id`. Defaults to `false`. Revocation is irreversible — recovering a deleted entity does not restore working credentials."
13904 + },
13905 + "required": false,
13906 + "description": "When `true`, the delete also starts a background job that revokes the upstream credentials of every connected account in scope, and the response carries a `revoke_job_id`. Defaults to `false`. Revocation is irreversible — recovering a deleted entity does not restore working credentials.",
13907 + "name": "revoke_on_delete",
13908 + "in": "query"
13909 }
13910 ],
13911 "responses": {
@@ -14662,6 +13919,11 @@
13919 "success": {
13920 "type": "boolean",
13921 "description": "Indicates whether the connected account was successfully deleted"
13922 + },
13923 + "revoke_job_id": {
13924 + "type": "string",
13925 + "description": "Identifier of the background revoke job started for this delete. Present only when `revoke_on_delete=true`. Track the job and its per-connection results from the Composio dashboard — a programmatic endpoint to poll this job is not yet generally available.",
13926 + "example": "pj_1a2b3c4d5e6f"
13927 }
13928 },
13929 "required": [
@@ -14739,9 +14001,6 @@
14001 "security": [
14002 {
14003 "ApiKeyAuth": []
14742 - },
14743 - {
14744 - "UserApiKeyAuth": []
14004 }
14005 ],
14006 "parameters": [
@@ -14888,9 +14147,6 @@
14147 "security": [
14148 {
14149 "ApiKeyAuth": []
14891 - },
14892 - {
14893 - "UserApiKeyAuth": []
14150 }
14151 ],
14152 "parameters": [
@@ -15017,9 +14273,6 @@
14273 "security": [
14274 {
14275 "ApiKeyAuth": []
15020 - },
15021 - {
15022 - "UserApiKeyAuth": []
14276 }
14277 ],
14278 "parameters": [
@@ -15673,73 +14926,109 @@
14926 "x-api-version": "3.1"
14927 }
14928 },
15676 - "/api/v3.1/org/project/config": {
14929 + "/api/v3.1/org/list": {
14930 "get": {
15678 - "summary": "Get project configuration",
15679 - "description": "Retrieves the current project configuration including 2FA settings.",
14931 + "summary": "List organizations",
14932 + "description": "Retrieves a list of organizations that the authenticated user has access to. This includes organizations where the user is a member with any role.",
14933 "tags": [
15681 - "Projects"
14934 + "Organization Management"
14935 ],
15683 - "operationId": "getOrgProjectConfig",
14936 + "operationId": "getOrgList",
14937 "security": [
14938 {
15686 - "ApiKeyAuth": []
14939 + "UserApiKeyAuth": []
14940 + }
14941 + ],
14942 + "parameters": [
14943 + {
14944 + "schema": {
14945 + "type": "integer",
14946 + "minimum": 1,
14947 + "maximum": 50
14948 + },
14949 + "required": false,
14950 + "description": "Number of items per page, max allowed is 50",
14951 + "name": "limit",
14952 + "in": "query"
14953 },
14954 {
15689 - "UserApiKeyAuth": []
14955 + "schema": {
14956 + "type": "string"
14957 + },
14958 + "required": false,
14959 + "description": "Cursor for pagination. The cursor is a base64 encoded string of the page and limit. The page is the page number and the limit is the number of items per page. The cursor is used to paginate through the items. The cursor is not required for the first page.",
14960 + "name": "cursor",
14961 + "in": "query"
14962 }
14963 ],
14964 "responses": {
14965 "200": {
15694 - "description": "Project configuration retrieved successfully.",
14966 + "description": "Successfully retrieved list of organizations with pagination.",
14967 "content": {
14968 "application/json": {
14969 "schema": {
14970 "type": "object",
14971 "properties": {
15700 - "is_2FA_enabled": {
15701 - "type": "boolean"
15702 - },
15703 - "logo_url": {
15704 - "type": "string"
15705 - },
15706 - "display_name": {
15707 - "type": "string"
15708 - },
15709 - "mask_secret_keys_in_connected_account": {
15710 - "type": "boolean"
14972 + "organizations": {
14973 + "type": "array",
14974 + "items": {
14975 + "type": "object",
14976 + "properties": {
14977 + "id": {
14978 + "type": "string",
14979 + "format": "orgId",
14980 + "description": "Unique identifier for the organization"
14981 + },
14982 + "name": {
14983 + "type": "string",
14984 + "minLength": 3,
14985 + "maxLength": 32,
14986 + "pattern": "^[a-zA-Z][a-zA-Z0-9_]*[a-zA-Z0-9]$",
14987 + "description": "Name of the organization"
14988 + },
14989 + "created_at": {
14990 + "type": "string",
14991 + "description": "When the organization was created"
14992 + },
14993 + "updated_at": {
14994 + "type": "string",
14995 + "description": "When the organization was last updated"
14996 + }
14997 + },
14998 + "required": [
14999 + "id",
15000 + "name",
15001 + "created_at",
15002 + "updated_at"
15003 + ]
15004 + }
15005 },
15712 - "log_visibility_setting": {
15006 + "next_cursor": {
15007 "type": "string",
15714 - "enum": [
15715 - "show_all",
15716 - "dont_store_data"
15717 - ]
15008 + "nullable": true
15009 },
15719 - "require_mcp_api_key": {
15720 - "type": "boolean"
15010 + "total_pages": {
15011 + "type": "number"
15012 },
15722 - "is_composio_link_enabled_for_managed_auth": {
15723 - "type": "boolean",
15724 - "description": "Whether to enable composio link for managed authentication. This key will be deprecated in the future. Please don't use this key."
15013 + "current_page": {
15014 + "type": "number"
15015 },
15726 - "signed_url_file_expiry_in_seconds": {
15727 - "type": "number",
15728 - "minimum": 1,
15729 - "maximum": 86400
15016 + "total_items": {
15017 + "type": "number"
15018 }
15019 },
15020 "required": [
15733 - "is_2FA_enabled",
15734 - "mask_secret_keys_in_connected_account",
15735 - "log_visibility_setting"
15021 + "organizations",
15022 + "total_pages",
15023 + "current_page",
15024 + "total_items"
15025 ]
15026 }
15027 }
15028 }
15029 },
15030 "400": {
15742 - "description": "Bad request. The project configuration data may be invalid.",
15031 + "description": "Bad request. This may occur if there are invalid query parameters or the request is malformed.",
15032 "content": {
15033 "application/json": {
15034 "schema": {
@@ -15759,7 +15048,7 @@
15048 }
15049 },
15050 "404": {
15762 - "description": "Project not found. The specified project does not exist or has been deleted.",
15051 + "description": "Not found. The user or organization was not found.",
15052 "content": {
15053 "application/json": {
15054 "schema": {
@@ -15780,127 +15069,198 @@
15069 }
15070 },
15071 "x-api-version": "3.1"
15783 - },
15784 - "patch": {
15785 - "summary": "Update project configuration",
15786 - "description": "Updates the project configuration settings.",
15072 + }
15073 + },
15074 + "/api/v3.1/org/project/list": {
15075 + "get": {
15076 + "summary": "List all projects",
15077 + "description": "Retrieves projects belonging to the authenticated organization by default, or all organizations the authenticated user belongs to when list_all_org_projects is true. Projects are returned in descending order of creation date (newest first). This endpoint is useful for displaying project selection in dashboards or for integrations that need to list all available projects.",
15078 "tags": [
15079 "Projects"
15080 ],
15790 - "operationId": "patchOrgProjectConfig",
15081 + "operationId": "getOrgProjectList",
15082 "security": [
15792 - {
15793 - "ApiKeyAuth": []
15794 - },
15083 {
15084 "UserApiKeyAuth": []
15085 }
15086 ],
15799 - "requestBody": {
15800 - "content": {
15801 - "application/json": {
15802 - "schema": {
15803 - "type": "object",
15804 - "properties": {
15805 - "is_2FA_enabled": {
15806 - "type": "boolean"
15807 - },
15808 - "logo_url": {
15809 - "type": "string"
15810 - },
15811 - "display_name": {
15812 - "type": "string"
15813 - },
15814 - "mask_secret_keys_in_connected_account": {
15815 - "type": "boolean"
15816 - },
15817 - "log_visibility_setting": {
15818 - "type": "string",
15819 - "enum": [
15820 - "show_all",
15821 - "dont_store_data"
15822 - ]
15823 - },
15824 - "require_mcp_api_key": {
15825 - "type": "boolean"
15826 - },
15827 - "is_composio_link_enabled_for_managed_auth": {
15828 - "type": "boolean",
15829 - "description": "Whether to enable composio link for managed authentication. This key will be deprecated in the future. Please don't use this key."
15830 - },
15831 - "signed_url_file_expiry_in_seconds": {
15832 - "type": "number",
15833 - "minimum": 1,
15834 - "maximum": 86400
15835 - }
15836 - }
15837 - },
15838 - "examples": {
15839 - "Enable 2FA": {
15840 - "value": {
15841 - "is_2FA_enabled": true
15842 - }
15843 - },
15844 - "Disable 2FA": {
15845 - "value": {
15846 - "is_2FA_enabled": false
15847 - }
15848 - }
15849 - }
15850 - }
15087 + "parameters": [
15088 + {
15089 + "schema": {
15090 + "type": "boolean",
15091 + "nullable": true,
15092 + "default": false,
15093 + "description": "List projects from all organizations the authenticated user belongs to"
15094 + },
15095 + "required": false,
15096 + "description": "List projects from all organizations the authenticated user belongs to",
15097 + "name": "list_all_org_projects",
15098 + "in": "query"
15099 + },
15100 + {
15101 + "schema": {
15102 + "type": "integer",
15103 + "minimum": 1,
15104 + "maximum": 50
15105 + },
15106 + "required": false,
15107 + "description": "Number of items per page, max allowed is 50",
15108 + "name": "limit",
15109 + "in": "query"
15110 + },
15111 + {
15112 + "schema": {
15113 + "type": "string"
15114 + },
15115 + "required": false,
15116 + "description": "Cursor for pagination. The cursor is a base64 encoded string of the page and limit. The page is the page number and the limit is the number of items per page. The cursor is used to paginate through the items. The cursor is not required for the first page.",
15117 + "name": "cursor",
15118 + "in": "query"
15119 }
15852 - },
15120 + ],
15121 "responses": {
15122 "200": {
15855 - "description": "Project configuration updated successfully.",
15123 + "description": "Projects retrieved successfully with pagination. Returns an array of project objects with their complete details and pagination info.",
15124 "content": {
15125 "application/json": {
15126 "schema": {
15127 "type": "object",
15128 "properties": {
15861 - "is_2FA_enabled": {
15862 - "type": "boolean"
15863 - },
15864 - "logo_url": {
15865 - "type": "string"
15866 - },
15867 - "display_name": {
15868 - "type": "string"
15869 - },
15870 - "mask_secret_keys_in_connected_account": {
15871 - "type": "boolean"
15129 + "data": {
15130 + "type": "array",
15131 + "items": {
15132 + "type": "object",
15133 + "properties": {
15134 + "id": {
15135 + "type": "string",
15136 + "format": "projectId",
15137 + "description": "Unique identifier for the project",
15138 + "example": "pr_1a2b3c4d5e6f"
15139 + },
15140 + "org_id": {
15141 + "type": "string",
15142 + "format": "orgId",
15143 + "description": "Identifier of the organization that owns this project",
15144 + "example": "ok_1a2b3c4d5e6f"
15145 + },
15146 + "name": {
15147 + "type": "string",
15148 + "description": "Name of the project",
15149 + "example": "My Awesome Project"
15150 + },
15151 + "email": {
15152 + "type": "string",
15153 + "description": "Email address associated with the project",
15154 + "example": "project-123@composio.dev"
15155 + },
15156 + "created_at": {
15157 + "type": "string",
15158 + "description": "ISO timestamp when the project was created",
15159 + "example": "2023-05-16T14:30:00.000Z"
15160 + },
15161 + "updated_at": {
15162 + "type": "string",
15163 + "description": "ISO timestamp when the project was last updated",
15164 + "example": "2023-05-18T09:15:30.000Z"
15165 + },
15166 + "webhook_url": {
15167 + "type": "string",
15168 + "nullable": true,
15169 + "format": "uri",
15170 + "description": "DEPRECATED: Use GET /api/v3/webhook_subscriptions instead. Legacy project-level webhook URL.",
15171 + "example": "https://example.com/webhook",
15172 + "deprecated": true
15173 + },
15174 + "event_webhook_url": {
15175 + "type": "string",
15176 + "nullable": true,
15177 + "format": "uri",
15178 + "description": "DEPRECATED: No longer used.",
15179 + "example": "https://example.com/events",
15180 + "deprecated": true
15181 + },
15182 + "webhook_secret": {
15183 + "type": "string",
15184 + "nullable": true,
15185 + "description": "DEPRECATED: Use GET /api/v3/webhook_subscriptions instead. Legacy project-level webhook secret.",
15186 + "example": "whsec_abcdef123456789",
15187 + "deprecated": true
15188 + },
15189 + "triggers_enabled": {
15190 + "type": "boolean",
15191 + "description": "Whether triggers are enabled for this project",
15192 + "example": true
15193 + },
15194 + "last_subscribed_at": {
15195 + "type": "string",
15196 + "nullable": true,
15197 + "format": "date-time",
15198 + "description": "ISO timestamp when the project last subscribed to updates",
15199 + "example": "2023-05-17T10:00:00.000Z"
15200 + },
15201 + "is_new_webhook": {
15202 + "type": "boolean",
15203 + "description": "Deprecated: Please refer to webhook_version instead. True indicates if the webhook configuration is using the previous new format (V2). False indicates the oldest format (V1)",
15204 + "example": true,
15205 + "deprecated": true
15206 + },
15207 + "webhook_version": {
15208 + "type": "string",
15209 + "enum": [
15210 + "V1",
15211 + "V2",
15212 + "V3"
15213 + ],
15214 + "description": "Payload format version for Pusher real-time events only. For webhook configuration, use GET /api/v3/webhook_subscriptions.",
15215 + "example": "V2"
15216 + },
15217 + "deleted": {
15218 + "type": "boolean",
15219 + "description": "Whether this project has been soft-deleted",
15220 + "example": false
15221 + }
15222 + },
15223 + "required": [
15224 + "id",
15225 + "org_id",
15226 + "name",
15227 + "email",
15228 + "created_at",
15229 + "updated_at",
15230 + "webhook_url",
15231 + "event_webhook_url",
15232 + "webhook_secret",
15233 + "webhook_version",
15234 + "deleted"
15235 + ]
15236 + }
15237 },
15873 - "log_visibility_setting": {
15238 + "next_cursor": {
15239 "type": "string",
15875 - "enum": [
15876 - "show_all",
15877 - "dont_store_data"
15878 - ]
15240 + "nullable": true
15241 },
15880 - "require_mcp_api_key": {
15881 - "type": "boolean"
15242 + "total_pages": {
15243 + "type": "number"
15244 },
15883 - "is_composio_link_enabled_for_managed_auth": {
15884 - "type": "boolean",
15885 - "description": "Whether to enable composio link for managed authentication. This key will be deprecated in the future. Please don't use this key."
15245 + "current_page": {
15246 + "type": "number"
15247 },
15887 - "signed_url_file_expiry_in_seconds": {
15888 - "type": "number",
15889 - "minimum": 1,
15890 - "maximum": 86400
15248 + "total_items": {
15249 + "type": "number"
15250 }
15251 },
15252 "required": [
15894 - "is_2FA_enabled",
15895 - "mask_secret_keys_in_connected_account",
15896 - "log_visibility_setting"
15253 + "data",
15254 + "total_pages",
15255 + "current_page",
15256 + "total_items"
15257 ]
15258 }
15259 }
15260 }
15261 },
15262 "400": {
15903 - "description": "Bad request. The configuration data may be invalid or missing.",
15263 + "description": "Bad request. This may occur if there are invalid query parameters or the request is malformed.",
15264 "content": {
15265 "application/json": {
15266 "schema": {
@@ -15919,16 +15279,6 @@
15279 }
15280 }
15281 },
15922 - "404": {
15923 - "description": "Project not found. The specified project does not exist or has been deleted.",
15924 - "content": {
15925 - "application/json": {
15926 - "schema": {
15927 - "$ref": "#/components/schemas/Error"
15928 - }
15929 - }
15930 - }
15931 - },
15282 "500": {
15283 "description": "Internal server error. An unexpected error occurred while processing the request.",
15284 "content": {
@@ -16450,8 +15800,8 @@
15800 },
15801 "key": {
15802 "type": "string",
16453 - "description": "The actual API key value used for authentication",
16454 - "example": "ak_a1b2c3d4e5f6g7h8i9j0"
15803 + "description": "Masked API key value",
15804 + "example": "ak_**6j0z"
15805 },
15806 "created_at": {
15807 "type": "string",
@@ -16533,7 +15883,7 @@
15883 },
15884 "delete": {
15885 "summary": "Delete a project",
16536 - "description": "Soft-deletes a project within the organization by its unique identifier. When a project is deleted, it is marked as deleted but not immediately removed from the database. This operation affects all resources associated with the project including API keys, webhook configurations, and connected services. This action cannot be undone through the API.",
15886 + "description": "Soft-deletes a project within the organization by its unique identifier. When a project is deleted, it is marked as deleted but not immediately removed from the database. This operation affects all resources associated with the project including API keys, webhook configurations, and connected services. This action cannot be undone through the API. Pass `?revoke_on_delete=true` to also revoke the upstream credentials of every connection in the project via a background job.",
15887 "tags": [
15888 "Projects"
15889 ],
@@ -16555,6 +15905,18 @@
15905 "description": "Unique identifier (Nano ID) of the project to delete",
15906 "name": "nano_id",
15907 "in": "path"
15908 + },
15909 + {
15910 + "schema": {
15911 + "type": "boolean",
15912 + "nullable": true,
15913 + "default": false,
15914 + "description": "When `true`, the delete also starts a background job that revokes the upstream credentials of every connected account in scope, and the response carries a `revoke_job_id`. Defaults to `false`. Revocation is irreversible — recovering a deleted entity does not restore working credentials."
15915 + },
15916 + "required": false,
15917 + "description": "When `true`, the delete also starts a background job that revokes the upstream credentials of every connected account in scope, and the response carries a `revoke_job_id`. Defaults to `false`. Revocation is irreversible — recovering a deleted entity does not restore working credentials.",
15918 + "name": "revoke_on_delete",
15919 + "in": "query"
15920 }
15921 ],
15922 "responses": {
@@ -16572,6 +15934,11 @@
15934 ],
15935 "description": "Status indicating successful deletion",
15936 "example": "success"
15937 + },
15938 + "revoke_job_id": {
15939 + "type": "string",
15940 + "description": "Identifier of the background revoke job started for this delete. Present only when `revoke_on_delete=true`. Track the job and its per-connection results from the Composio dashboard — a programmatic endpoint to poll this job is not yet generally available.",
15941 + "example": "oj_1a2b3c4d5e6f"
15942 }
15943 },
15944 "required": [
@@ -16737,6 +16104,16 @@
16104 }
16105 }
16106 },
16107 + "403": {
16108 + "description": "Forbidden. API key regeneration is not enabled for this organization.",
16109 + "content": {
16110 + "application/json": {
16111 + "schema": {
16112 + "$ref": "#/components/schemas/Error"
16113 + }
16114 + }
16115 + }
16116 + },
16117 "404": {
16118 "description": "Not found. The specified project does not exist or you do not have access to it.",
16119 "content": {
@@ -16772,9 +16149,6 @@
16149 "security": [
16150 {
16151 "ApiKeyAuth": []
16775 - },
16776 - {
16777 - "UserApiKeyAuth": []
16152 }
16153 ],
16154 "requestBody": {
@@ -16928,9 +16302,6 @@
16302 "security": [
16303 {
16304 "ApiKeyAuth": []
16931 - },
16932 - {
16933 - "UserApiKeyAuth": []
16305 }
16306 ],
16307 "parameters": [
@@ -17085,9 +16456,6 @@
16456 "security": [
16457 {
16458 "ApiKeyAuth": []
17088 - },
17089 - {
17090 - "UserApiKeyAuth": []
16459 }
16460 ],
16461 "parameters": [
@@ -17204,10 +16572,7 @@
16572 "operationId": "patchWebhookSubscriptionsById",
16573 "security": [
16574 {
17207 - "ApiKeyAuth": []
17208 - },
17209 - {
17210 - "UserApiKeyAuth": []
16575 + "ApiKeyAuth": []
16576 }
16577 ],
16578 "parameters": [
@@ -17369,9 +16734,6 @@
16734 "security": [
16735 {
16736 "ApiKeyAuth": []
17372 - },
17373 - {
17374 - "UserApiKeyAuth": []
16737 }
16738 ],
16739 "parameters": [
@@ -17451,9 +16813,6 @@
16813 "security": [
16814 {
16815 "ApiKeyAuth": []
17454 - },
17455 - {
17456 - "UserApiKeyAuth": []
16816 }
16817 ],
16818 "parameters": [
@@ -17540,9 +16899,6 @@
16899 "security": [
16900 {
16901 "ApiKeyAuth": []
17543 - },
17544 - {
17545 - "UserApiKeyAuth": []
16902 }
16903 ],
16904 "responses": {
@@ -17629,9 +16985,6 @@
16985 "security": [
16986 {
16987 "ApiKeyAuth": []
17632 - },
17633 - {
17634 - "UserApiKeyAuth": []
16988 }
16989 ],
16990 "requestBody": {
@@ -17811,9 +17164,6 @@
17164 "security": [
17165 {
17166 "ApiKeyAuth": []
17814 - },
17815 - {
17816 - "UserApiKeyAuth": []
17167 }
17168 ],
17169 "parameters": [
@@ -17905,9 +17255,6 @@
17255 "security": [
17256 {
17257 "ApiKeyAuth": []
17908 - },
17909 - {
17910 - "UserApiKeyAuth": []
17258 }
17259 ],
17260 "parameters": [
@@ -18025,9 +17372,6 @@
17372 "security": [
17373 {
17374 "ApiKeyAuth": []
18028 - },
18029 - {
18030 - "UserApiKeyAuth": []
17375 }
17376 ],
17377 "parameters": [
@@ -18166,9 +17510,6 @@
17510 "security": [
17511 {
17512 "ApiKeyAuth": []
18169 - },
18170 - {
18171 - "UserApiKeyAuth": []
17513 }
17514 ],
17515 "parameters": [
@@ -18643,9 +17984,6 @@
17984 "security": [
17985 {
17986 "ApiKeyAuth": []
18646 - },
18647 - {
18648 - "UserApiKeyAuth": []
17987 }
17988 ],
17989 "responses": {
@@ -18821,6 +18159,68 @@
18159 "oauth2"
18160 ]
18161 },
18162 + "composio_managed_auth": {
18163 + "type": "array",
18164 + "items": {
18165 + "type": "object",
18166 + "properties": {
18167 + "mode": {
18168 + "type": "string",
18169 + "description": "Authentication mode for the Composio-managed auth config",
18170 + "example": "OAUTH2"
18171 + },
18172 + "scopes": {
18173 + "type": "object",
18174 + "properties": {
18175 + "available": {
18176 + "type": "array",
18177 + "items": {
18178 + "type": "string"
18179 + },
18180 + "description": "Available OAuth scopes"
18181 + }
18182 + },
18183 + "required": [
18184 + "available"
18185 + ],
18186 + "description": "OAuth scopes available in the Composio-managed auth config for this auth mode.",
18187 + "example": {
18188 + "available": [
18189 + "read",
18190 + "write"
18191 + ]
18192 + }
18193 + },
18194 + "user_scopes": {
18195 + "type": "object",
18196 + "properties": {
18197 + "available": {
18198 + "type": "array",
18199 + "items": {
18200 + "type": "string"
18201 + },
18202 + "description": "Available OAuth user scopes"
18203 + }
18204 + },
18205 + "required": [
18206 + "available"
18207 + ],
18208 + "description": "OAuth user scopes available in the Composio-managed auth config for this auth mode. Only present for Slack toolkits.",
18209 + "example": {
18210 + "available": [
18211 + "search:read",
18212 + "users:read"
18213 + ]
18214 + }
18215 + }
18216 + },
18217 + "required": [
18218 + "mode",
18219 + "scopes"
18220 + ]
18221 + },
18222 + "description": "Managed-auth-only metadata, including the supported OAuth scope ceiling."
18223 + },
18224 "is_local_toolkit": {
18225 "type": "boolean",
18226 "description": "DEPRECATED: This field is no longer meaningful and will always return false. It was previously used to indicate if a toolkit is specific to the current project.",
@@ -19236,6 +18636,7 @@
18636 "slug",
18637 "name",
18638 "enabled",
18639 + "composio_managed_auth",
18640 "is_local_toolkit",
18641 "meta",
18642 "deprecated"
@@ -19300,9 +18701,6 @@
18701 "security": [
18702 {
18703 "ApiKeyAuth": []
19303 - },
19304 - {
19305 - "UserApiKeyAuth": []
18704 }
18705 ],
18706 "requestBody": {
@@ -19642,6 +19040,10 @@
19040 "format": "connectedAccountId",
19041 "description": "Connected account nanoid"
19042 },
19043 + "user_id": {
19044 + "type": "string",
19045 + "description": "The user id (entity id) that owns the connected account. When the project has 2FA enabled, this is validated against the owner of connected_account_id."
19046 + },
19047 "trigger_config": {
19048 "type": "object",
19049 "additionalProperties": {},
@@ -19703,8 +19105,7 @@
19105 }
19106 },
19107 "required": [
19706 - "trigger_id",
19707 - "deprecated"
19108 + "trigger_id"
19109 ]
19110 }
19111 }
@@ -19735,8 +19136,7 @@
19136 }
19137 },
19138 "required": [
19738 - "trigger_id",
19739 - "deprecated"
19139 + "trigger_id"
19140 ]
19141 }
19142 }
@@ -19773,6 +19173,16 @@
19173 }
19174 }
19175 },
19176 + "403": {
19177 + "description": "Forbidden",
19178 + "content": {
19179 + "application/json": {
19180 + "schema": {
19181 + "$ref": "#/components/schemas/Error"
19182 + }
19183 + }
19184 + }
19185 + },
19186 "404": {
19187 "description": "Trigger instance not found",
19188 "content": {
@@ -20610,7 +20020,7 @@
20020 "schema": {
20021 "type": "string",
20022 "description": "The unique slug identifier for the trigger type. Case-insensitive (internally normalized to uppercase).",
20613 - "example": "SLACK_RECEIVE_MESSAGE"
20023 + "example": "SLACK_CHANNEL_MESSAGE_RECEIVED"
20024 },
20025 "required": true,
20026 "description": "The unique slug identifier for the trigger type. Case-insensitive (internally normalized to uppercase).",
@@ -20666,7 +20076,7 @@
20076 "slug": {
20077 "type": "string",
20078 "description": "Unique identifier for the trigger type",
20669 - "example": "SLACK_RECEIVE_MESSAGE"
20079 + "example": "SLACK_CHANNEL_MESSAGE_RECEIVED"
20080 },
20081 "name": {
20082 "type": "string",
@@ -20935,7 +20345,7 @@
20345 "slug": {
20346 "type": "string",
20347 "description": "Unique identifier for the trigger type",
20938 - "example": "SLACK_RECEIVE_MESSAGE"
20348 + "example": "SLACK_CHANNEL_MESSAGE_RECEIVED"
20349 },
20350 "name": {
20351 "type": "string",
@@ -21129,9 +20539,6 @@
20539 "security": [
20540 {
20541 "ApiKeyAuth": []
21132 - },
21133 - {
21134 - "UserApiKeyAuth": []
20542 }
20543 ],
20544 "parameters": [
@@ -21476,9 +20883,6 @@
20883 "security": [
20884 {
20885 "ApiKeyAuth": []
21479 - },
21480 - {
21481 - "UserApiKeyAuth": []
20886 }
20887 ],
20888 "requestBody": {
@@ -21781,9 +21185,6 @@
21185 "security": [
21186 {
21187 "ApiKeyAuth": []
21784 - },
21785 - {
21786 - "UserApiKeyAuth": []
21188 }
21189 ],
21190 "requestBody": {
@@ -22024,9 +21425,6 @@
21425 "security": [
21426 {
21427 "ApiKeyAuth": []
22027 - },
22028 - {
22029 - "UserApiKeyAuth": []
21428 }
21429 ],
21430 "requestBody": {
@@ -22126,8 +21524,8 @@
21524 },
21525 "description": "List of URLs generated for each connected account ID",
21526 "example": [
22129 - "https://mcp.composio.dev/composio/server/550e8400-e29b-41d4-a716-446655440000?include_composio_helper_actions=true&connected_account_ids=ca_1a2b3c4d5e6f&user_id=user_123456,user_789012",
22130 - "https://mcp.composio.dev/composio/server/550e8400-e29b-41d4-a716-446655440000?include_composio_helper_actions=true&connected_account_ids=ca_7g8h9i0j1k2l&user_id=user_123456,user_789012"
21527 + "https://mcp.composio.dev/composio/server/550e8400-e29b-41d4-a716-446655440000?include_composio_helper_actions=true&connected_account_id=ca_1a2b3c4d5e6f",
21528 + "https://mcp.composio.dev/composio/server/550e8400-e29b-41d4-a716-446655440000?include_composio_helper_actions=true&connected_account_id=ca_7g8h9i0j1k2l"
21529 ]
21530 },
21531 "user_ids_url": {
@@ -22137,8 +21535,8 @@
21535 },
21536 "description": "List of URLs generated for each user ID",
21537 "example": [
22140 - "https://mcp.composio.dev/composio/server/550e8400-e29b-41d4-a716-446655440000?include_composio_helper_actions=true&connected_account_ids=ca_1a2b3c4d5e6f,ca_7g8h9i0j1k2l&user_id=user_123456",
22141 - "https://mcp.composio.dev/composio/server/550e8400-e29b-41d4-a716-446655440000?include_composio_helper_actions=true&connected_account_ids=ca_1a2b3c4d5e6f,ca_7g8h9i0j1k2l&user_id=user_789012"
21538 + "https://mcp.composio.dev/composio/server/550e8400-e29b-41d4-a716-446655440000?include_composio_helper_actions=true&user_id=user_123456",
21539 + "https://mcp.composio.dev/composio/server/550e8400-e29b-41d4-a716-446655440000?include_composio_helper_actions=true&user_id=user_789012"
21540 ]
21541 }
21542 },
@@ -22217,9 +21615,6 @@
21615 "security": [
21616 {
21617 "ApiKeyAuth": []
22220 - },
22221 - {
22222 - "UserApiKeyAuth": []
21618 }
21619 ],
21620 "parameters": [
@@ -22444,9 +21839,6 @@
21839 "security": [
21840 {
21841 "ApiKeyAuth": []
22447 - },
22448 - {
22449 - "UserApiKeyAuth": []
21842 }
21843 ],
21844 "parameters": [
@@ -22786,9 +22178,6 @@
22178 "security": [
22179 {
22180 "ApiKeyAuth": []
22789 - },
22790 - {
22791 - "UserApiKeyAuth": []
22181 }
22182 ],
22183 "parameters": [
@@ -22898,9 +22287,6 @@
22287 "security": [
22288 {
22289 "ApiKeyAuth": []
22901 - },
22902 - {
22903 - "UserApiKeyAuth": []
22290 }
22291 ],
22292 "parameters": [
@@ -23268,9 +22654,6 @@
22654 "security": [
22655 {
22656 "ApiKeyAuth": []
23271 - },
23272 - {
23273 - "UserApiKeyAuth": []
22657 }
22658 ],
22659 "parameters": [
@@ -23500,9 +22883,6 @@
22883 "security": [
22884 {
22885 "ApiKeyAuth": []
23503 - },
23504 - {
23505 - "UserApiKeyAuth": []
22886 }
22887 ],
22888 "parameters": [
@@ -23667,9 +23047,6 @@
23047 "security": [
23048 {
23049 "ApiKeyAuth": []
23670 - },
23671 - {
23672 - "UserApiKeyAuth": []
23050 }
23051 ],
23052 "parameters": [
@@ -23765,8 +23142,9 @@
23142 },
23143 "/api/v3.1/files/list": {
23144 "get": {
23768 - "summary": "List files with optional app and action filters",
23769 - "description": "Retrieves a list of files associated with the authenticated project. Results can be filtered by toolkit and tool slugs.",
23145 + "summary": "List files with optional app and action filters (DEPRECATED)",
23146 + "description": "DEPRECATED: This endpoint is deprecated and will be removed in a future release. Retrieves a list of files associated with the authenticated project. Results can be filtered by toolkit and tool slugs. Responses carry a `Deprecation` header (RFC 9745) for client-side detection.",
23147 + "deprecated": true,
23148 "tags": [
23149 "Files"
23150 ],
@@ -23774,9 +23152,6 @@
23152 "security": [
23153 {
23154 "ApiKeyAuth": []
23777 - },
23778 - {
23779 - "UserApiKeyAuth": []
23155 }
23156 ],
23157 "parameters": [
@@ -23942,9 +23317,6 @@
23317 "security": [
23318 {
23319 "ApiKeyAuth": []
23945 - },
23946 - {
23947 - "UserApiKeyAuth": []
23320 }
23321 ],
23322 "requestBody": {
@@ -24178,137 +23550,6 @@
23550 "x-api-version": "3.1"
23551 }
23552 },
24181 - "/api/v3.1/migration/get-nanoid": {
24182 - "get": {
24183 - "summary": "Get NanoId from UUID",
24184 - "description": "Convert a legacy UUID to its corresponding NanoId for migration purposes. This endpoint facilitates the transition from UUID-based identifiers to the more compact NanoId format used in the v3 API.",
24185 - "tags": [
24186 - "Migration"
24187 - ],
24188 - "operationId": "getMigrationGetNanoid",
24189 - "security": [
24190 - {
24191 - "ApiKeyAuth": []
24192 - },
24193 - {
24194 - "UserApiKeyAuth": []
24195 - }
24196 - ],
24197 - "parameters": [
24198 - {
24199 - "schema": {
24200 - "type": "string",
24201 - "format": "uuid",
24202 - "example": "123e4567-e89b-12d3-a456-426614174000"
24203 - },
24204 - "required": true,
24205 - "description": "The legacy UUID that needs to be converted to a NanoId",
24206 - "name": "uuid",
24207 - "in": "query"
24208 - },
24209 - {
24210 - "schema": {
24211 - "type": "string",
24212 - "enum": [
24213 - "CONNECTED_ACCOUNT",
24214 - "AUTH_CONFIG",
24215 - "TRIGGER_INSTANCE"
24216 - ],
24217 - "example": "CONNECTED_ACCOUNT"
24218 - },
24219 - "required": true,
24220 - "description": "The type of resource that the UUID belongs to",
24221 - "name": "type",
24222 - "in": "query"
24223 - },
24224 - {
24225 - "schema": {
24226 - "type": "string",
24227 - "description": "Your Composio API key used for authentication",
24228 - "example": "sk_123456789abcdef"
24229 - },
24230 - "required": true,
24231 - "name": "x-api-key",
24232 - "in": "header"
24233 - }
24234 - ],
24235 - "responses": {
24236 - "200": {
24237 - "description": "Successfully retrieved NanoId for the given UUID",
24238 - "content": {
24239 - "application/json": {
24240 - "schema": {
24241 - "type": "object",
24242 - "properties": {
24243 - "nanoid": {
24244 - "type": "string",
24245 - "minLength": 10,
24246 - "maxLength": 10,
24247 - "description": "The NanoId corresponding to the provided UUID. This is the new identifier that should be used in place of the legacy UUID.",
24248 - "example": "XqXrPalt3v"
24249 - }
24250 - },
24251 - "required": [
24252 - "nanoid"
24253 - ]
24254 - }
24255 - }
24256 - }
24257 - },
24258 - "400": {
24259 - "description": "Bad Request - Invalid UUID or resource not found",
24260 - "content": {
24261 - "application/json": {
24262 - "schema": {
24263 - "$ref": "#/components/schemas/Error"
24264 - }
24265 - }
24266 - }
24267 - },
24268 - "401": {
24269 - "description": "Unauthorized - Invalid or missing API key",
24270 - "content": {
24271 - "application/json": {
24272 - "schema": {
24273 - "$ref": "#/components/schemas/Error"
24274 - }
24275 - }
24276 - }
24277 - },
24278 - "404": {
24279 - "description": "Not Found - The UUID does not correspond to any resource of the specified type",
24280 - "content": {
24281 - "application/json": {
24282 - "schema": {
24283 - "$ref": "#/components/schemas/Error"
24284 - }
24285 - }
24286 - }
24287 - },
24288 - "410": {
24289 - "description": "Gone - The UUID does not correspond to any resource of the specified type",
24290 - "content": {
24291 - "application/json": {
24292 - "schema": {
24293 - "$ref": "#/components/schemas/Error"
24294 - }
24295 - }
24296 - }
24297 - },
24298 - "500": {
24299 - "description": "Internal server error - An unexpected error occurred during processing",
24300 - "content": {
24301 - "application/json": {
24302 - "schema": {
24303 - "$ref": "#/components/schemas/Error"
24304 - }
24305 - }
24306 - }
24307 - }
24308 - },
24309 - "x-api-version": "3.1"
24310 - }
24311 - },
23553 "/api/v3.1/tool_router/session/{session_id}/link": {
23554 "post": {
23555 "summary": "Create a link session for a toolkit in a tool router session",
@@ -24320,9 +23561,6 @@
23561 "security": [
23562 {
23563 "ApiKeyAuth": []
24323 - },
24324 - {
24325 - "UserApiKeyAuth": []
23564 }
23565 ],
23566 "parameters": [
@@ -24565,9 +23803,6 @@
23803 },
23804 {
23805 "UserApiKeyAuth": []
24568 - },
24569 - {
24570 - "workbench_access_key": []
23806 }
23807 ],
23808 "parameters": [
@@ -25125,9 +24360,6 @@
24360 "security": [
24361 {
24362 "ApiKeyAuth": []
25128 - },
25129 - {
25130 - "UserApiKeyAuth": []
24363 }
24364 ],
24365 "parameters": [
@@ -25278,9 +24510,6 @@
24510 "security": [
24511 {
24512 "ApiKeyAuth": []
25281 - },
25282 - {
25283 - "UserApiKeyAuth": []
24513 }
24514 ],
24515 "parameters": [
@@ -25450,9 +24679,6 @@
24679 "security": [
24680 {
24681 "ApiKeyAuth": []
25453 - },
25454 - {
25455 - "UserApiKeyAuth": []
24682 }
24683 ],
24684 "parameters": [
@@ -25591,9 +24817,6 @@
24817 "security": [
24818 {
24819 "ApiKeyAuth": []
25594 - },
25595 - {
25596 - "UserApiKeyAuth": []
24820 }
24821 ],
24822 "parameters": [
@@ -25738,9 +24961,6 @@
24961 "security": [
24962 {
24963 "ApiKeyAuth": []
25741 - },
25742 - {
25743 - "UserApiKeyAuth": []
24964 }
24965 ],
24966 "parameters": [
@@ -25869,9 +25089,6 @@
25089 "security": [
25090 {
25091 "ApiKeyAuth": []
25872 - },
25873 - {
25874 - "UserApiKeyAuth": []
25092 }
25093 ],
25094 "responses": {
docs/scripts/generate-api-index.ts
+36 -1
@@ -6,7 +6,7 @@
6 * Run: bun scripts/generate-api-index.ts
7 */
8
9 -import { readFileSync, writeFileSync, mkdirSync, existsSync, rmSync } from 'fs';
9 +import { readFileSync, writeFileSync, mkdirSync, existsSync, rmSync, readdirSync } from 'fs';
10 import { join } from 'path';
11 import { HIDDEN_API_TAGS } from '../lib/filter-api-version';
12
@@ -94,6 +94,35 @@ function getOperationsByTag(spec: OpenAPISpec): Record<string, OperationEntry[]>
94 return tagOps;
95 }
96
97 +function activeTagSlugs(opsByTag: Record<string, OperationEntry[]>): Set<string> {
98 + const active = new Set<string>();
99 + for (const [tagName, ops] of Object.entries(opsByTag)) {
100 + const tagSlug = slugify(tagName);
101 + if (ops.length > 0 && !HIDDEN_TAGS.has(tagSlug)) {
102 + active.add(tagSlug);
103 + }
104 + }
105 + return active;
106 +}
107 +
108 +function removeStaleTagIndexes(baseDir: string, activeSlugs: Set<string>) {
109 + if (!existsSync(baseDir)) return;
110 +
111 + for (const entry of readdirSync(baseDir, { withFileTypes: true })) {
112 + if (!entry.isDirectory()) continue;
113 +
114 + const tagSlug = entry.name;
115 + if (activeSlugs.has(tagSlug)) continue;
116 +
117 + const tagDir = join(baseDir, tagSlug);
118 + const indexPath = join(tagDir, 'index.mdx');
119 + if (existsSync(indexPath)) {
120 + rmSync(tagDir, { recursive: true, force: true });
121 + console.log(`Removed stale tag: ${tagDir}`);
122 + }
123 + }
124 +}
125 +
126 function generateIndexPages() {
127 const specV31Path = join(process.cwd(), 'public/openapi.json');
128 const specV3Path = join(process.cwd(), 'public/openapi-v3.json');
@@ -115,6 +144,12 @@ function generateIndexPages() {
144
145 const outputDir = join(process.cwd(), 'content/reference/api-reference');
146
147 + removeStaleTagIndexes(outputDir, activeTagSlugs(v31Ops));
148 + removeStaleTagIndexes(
149 + join(process.cwd(), 'content/reference/v3/api-reference'),
150 + activeTagSlugs(v3Ops),
151 + );
152 +
153 // Get all unique tag names
154 const allTags = new Set([...Object.keys(v31Ops), ...Object.keys(v3Ops)]);
155