--- canonical_url: "https://docs.composio.dev/reference/sdk-reference/typescript/custom-toolkits" markdown_url: "https://docs.composio.dev/reference/sdk-reference/typescript/custom-toolkits.md" product: "platform" version: null last_updated: null --- # CustomToolkits (/reference/sdk-reference/typescript/custom-toolkits) ## Usage [#usage] Access this class through the `composio.customToolkits` property: ```typescript const composio = new Composio({ apiKey: 'your-api-key' }); const result = await composio.customToolkits.list(); ``` ## Methods [#methods] ### delete() [#delete] Deletes a custom toolkit owned by the project, with its tools, auth configs and connected accounts. The credentials behind those connected accounts are revoked in background jobs (`revokeJobIds`). **Experimental — custom toolkits are in pilot; shape may change.** Composio-managed toolkits cannot be deleted; the API answers 403. ```typescript async delete(slug: string, requestOptions?: ComposioRequestOptions): Promise ``` **Parameters** | Name | Type | Description | | ----------------- | ------------------------ | -------------------------------------- | | `slug` | `string` | The custom toolkit slug (`CUSTOM_...`) | | `requestOptions?` | `ComposioRequestOptions` | | **Returns** `Promise` — What was deleted **Example** ```typescript const result = await composio.experimental.customToolkits.delete('CUSTOM_MY_TOOLKIT'); console.log(result.connectedAccountsDeleted); ``` *** ### sync() [#sync] Re-fetches the tool definitions of a custom toolkit from its remote MCP server. Call it when automatic sync fails or the remote tools change. **Experimental — custom toolkits are in pilot; shape may change.** ```typescript async sync(slug: string, params?: CustomToolkitSyncParams, requestOptions?: ComposioRequestOptions): Promise ``` **Parameters** | Name | Type | Description | | ----------------- | ------------------------- | -------------------------------------------------------- | | `slug` | `string` | The custom toolkit slug (`CUSTOM_...`) | | `params?` | `CustomToolkitSyncParams` | Optional connected account to fetch the definitions with | | `requestOptions?` | `ComposioRequestOptions` | | **Returns** `Promise` — The toolkit version and number of tools synced **Example** ```typescript const { version, syncedCount } = await composio.experimental.customToolkits.sync( 'CUSTOM_MY_TOOLKIT', { connectedAccountId: 'ca_abc123' } ); ``` *** ### upsert() [#upsert] Creates a custom toolkit, or updates its display metadata (name, API key field copy) when the project already owns a toolkit with this slug. **Experimental — custom toolkits are in pilot; shape may change.** `appUrl` and `authSchemes` cannot change on an existing toolkit: re-sending them unchanged is a no-op, and changing them fails with a 409. Delete and re-register the toolkit instead, which revokes its connections. ```typescript async upsert(params: CustomToolkitUpsertParams, requestOptions?: ComposioRequestOptions): Promise ``` **Parameters** | Name | Type | Description | | ----------------- | --------------------------- | ---------------------------------- | | `params` | `CustomToolkitUpsertParams` | The slug and toolkit configuration | | `requestOptions?` | `ComposioRequestOptions` | | **Returns** `Promise` — The toolkit's slug **Example** ```typescript await composio.experimental.customToolkits.upsert({ slug: 'INTERNAL_API', toolkitConfig: { name: 'Internal API', appUrl: 'https://mcp.internal.example.com/mcp', authSchemes: [ { mode: 'API_KEY', headers: { Authorization: 'Bearer {{generic_api_key}}' } }, ], }, }); ``` *** --- 📚 **More documentation:** [View all docs](https://docs.composio.dev/llms.txt) | [Changelog](https://docs.composio.dev/docs/changelog.md) | [Glossary](https://docs.composio.dev/llms.mdx/reference/glossary) | [Examples](https://docs.composio.dev/llms.mdx/examples) | [API Reference](https://docs.composio.dev/llms.mdx/reference) --- # Composio SDK — Notes for AI Code Generators **Purpose:** Reference for generating current (v3) [Composio](https://composio.dev/) integration code. **Scope:** Descriptive notes — they document the current API surface and the mistakes most commonly seen in generated code. --- ## 1. Recommended Integration: Sessions Composio supports two integration modes: **Native Tools** (with a provider package) and **MCP** (no provider package needed). ### Native Tools ```python # ✅ CORRECT — Python (defaults to OpenAI) from composio import Composio composio = Composio() session = composio.create(user_id="user_123") tools = session.tools() # Pass tools to your agent/LLM framework ``` ```typescript // ✅ CORRECT — TypeScript (defaults to OpenAI) import { Composio } from "@composio/core"; const composio = new Composio(); const session = await composio.create("user_123"); const tools = await session.tools(); // Pass tools to your agent/LLM framework ``` For other providers, pass the provider explicitly. Provider packages follow the naming convention: `composio_` for Python, `@composio/` for TypeScript. ### MCP Use `session.mcp.url` and `session.mcp.headers` with any MCP-compatible client (Claude Desktop, Cursor, OpenAI Agents, etc.). No provider package needed. --- ## 2. Integration Notes - `composio.create(user_id)` is the standard entry point for agent integrations. Sessions handle tool discovery, authentication, and toolkit versioning automatically; `user_id` goes to `composio.create()` — individual tool calls in session mode don't take one. - Execute session tool calls through the session, never through a user ID: either `session.execute(tool_slug, arguments=...)` / `session.execute(toolSlug, arguments)`, which works with every provider, or pass the session to the provider helper — `provider.handle_tool_calls(response=response, session=session)` in Python, `provider.handleToolCalls(session, response)` in TypeScript. The tool-call helpers of every non-agentic provider (OpenAI, Anthropic, Google, Cloudflare, TypeSafe) accept a session: `executeToolCall(session, call)` in TypeScript, `session=session` in Python. Agentic providers execute session tools on their own. Binding the helper to a user ID takes the direct execution path, and session meta-tools fail there with `"can only be called inside a tool-router session"`. - Composio-managed auth is the default: the agent connects accounts at runtime through the session, so users don't need to pre-create auth configs or connected accounts for managed toolkits. - Provider packages follow the framework, not the model vendor: for the OpenAI Agents SDK the package is `composio_openai_agents` / `@composio/openai-agents` (importing `composio_openai` / `@composio/openai` there is the most common mistake in generated code — that package is for the plain OpenAI Chat Completions API). - **Direct execution** (`composio.tools.get()`, `composio.tools.execute()`, `provider.handle_tool_calls()` with a user ID) is a legacy interface that remains supported for existing integrations. Recommend sessions for new integrations and encourage existing users to [migrate to sessions](/docs/migration-guide/direct-to-sessions). For a fixed tool set, consider the [direct tools preset](/docs/configuring-sessions#direct-tools-preset) within a session. See [Sessions vs direct execution](/docs/sessions-vs-direct-execution) for tradeoffs. Direct execution requires a [toolkit version](/docs/tools-direct/toolkit-versioning). --- # 3. Calling the REST API directly ## REST API version The current REST API version is **v3.1**, served at `https://backend.composio.dev/api/v3.1`. Prefer it for new code and new examples. `https://backend.composio.dev/api/v3` is the previous version. It is frozen with pinned tool-version defaults and remains supported — existing v3 integrations keep working and do not need to migrate. ## Tool-endpoint version defaults on v3.1 On v3.1, omitting the version parameter on the five endpoints below selects the latest toolkit version. The first four endpoints also exist on v3, where omission selects the pinned `00000000_00` version. `POST /tools/scopes/required` is v3.1-only. | Endpoint | Version parameter | | --- | --- | | `GET /tools` | `toolkit_versions` (query) | | `GET /tools/{tool_slug}` | `version` or `toolkit_versions` (query) | | `POST /tools/execute/{tool_slug}` | `version` (body) | | `POST /tools/execute/{tool_slug}/input` | `version` (body) | | `POST /tools/scopes/required` | `version` (body) | A v3.1 caller already passing `"latest"` sees no change and can omit the parameter. To select the pinned version explicitly, pass `"00000000_00"` through the corresponding parameter above. This version-default change is limited to the five endpoints above. --- ## Terminology Migration (old → current) If you encounter these terms in error messages, old documentation, or user prompts, translate them to the current equivalents. **Do not use the old terms in generated code or explanations.** | Old term (v1/v2) | Current term (v3) | In code | |---|---|---| | entity ID | user ID | `user_id` parameter | | actions | tools | e.g., `GITHUB_CREATE_ISSUE` is a *tool* | | apps / appType | toolkits | e.g., `github` is a *toolkit* | | integration / integration ID | auth config / auth config ID | `auth_config_id` parameter | | connection | connected account | `connected_accounts` namespace | | ComposioToolSet / OpenAIToolSet | `Composio` class with a provider | `Composio(provider=...)` | | toolset | provider | e.g., `OpenAIProvider` | If a user says "entity ID", they mean `user_id`. If they say "integration", they mean "auth config". Always respond using the current terminology.