# Toolkits (/reference/sdk-reference/typescript/toolkits) # Usage [#usage] Access this class through the `composio.toolkits` property: ```typescript const composio = new Composio({ apiKey: 'your-api-key' }); const result = await composio.toolkits.list(); ``` # Methods [#methods] ## authorize() [#authorize] Authorizes a user to use a toolkit. This method will create an auth config if one doesn't exist and initiate a connection request. ```typescript async authorize(userId: string, toolkitSlug: string, authConfigId?: string, requestOptions?: ComposioRequestOptions): Promise ``` **Parameters** | Name | Type | Description | | ----------------- | ------------------------ | ------------------------------------ | | `userId` | `string` | The user id of the user to authorize | | `toolkitSlug` | `string` | The slug of the toolkit to authorize | | `authConfigId?` | `string` | | | `requestOptions?` | `ComposioRequestOptions` | | **Returns** `Promise` — The connection request object **Example** ```typescript const connectionRequest = await composio.toolkits.authorize(userId, 'github'); ``` *** ## get() [#get] Retrieves a specific toolkit by its slug identifier. **Overload 1** ```typescript async get(slug: string, requestOptions?: ComposioRequestOptions): Promise ``` **Parameters** | Name | Type | Description | | ----------------- | ------------------------ | ----------------------------------------------------- | | `slug` | `string` | The unique slug identifier of the toolkit to retrieve | | `requestOptions?` | `ComposioRequestOptions` | | **Returns** `Promise` — The toolkit object with detailed information **Overload 2** ```typescript async get(query?: ToolkitListParams, requestOptions?: ComposioRequestOptions): Promise ``` **Parameters** | Name | Type | Description | | ----------------- | ------------------------ | --------------------------------------- | | `query?` | `ToolkitListParams` | The query parameters to filter toolkits | | `requestOptions?` | `ComposioRequestOptions` | | **Returns** `Promise` — A paginated list of toolkits matching the query criteria **Example** ```typescript // Get a specific toolkit const githubToolkit = await composio.toolkits.get('github'); console.log(githubToolkit.name); // GitHub console.log(githubToolkit.authConfigDetails); // Authentication configuration details ``` *** ## getAuthConfigCreationFields() [#getauthconfigcreationfields] Retrieves the fields required for creating an auth config for a toolkit. ```typescript async getAuthConfigCreationFields(toolkitSlug: string, authScheme: AuthSchemeType, options: { requiredOnly?: boolean }): Promise ``` **Parameters** | Name | Type | Description | | ------------- | ------------------------------ | -------------------------------------------------- | | `toolkitSlug` | `string` | The slug of the toolkit to retrieve the fields for | | `authScheme` | `AuthSchemeType` | The auth scheme to retrieve the fields for | | `options` | `\{ requiredOnly?: boolean \}` | | **Returns** `Promise` — The fields required for creating an auth config *** ## getConnectedAccountInitiationFields() [#getconnectedaccountinitiationfields] Retrieves the fields required for initiating a connected account for a toolkit. ```typescript async getConnectedAccountInitiationFields(toolkitSlug: string, authScheme: AuthSchemeType, options: { requiredOnly?: boolean }): Promise ``` **Parameters** | Name | Type | Description | | ------------- | ------------------------------ | -------------------------------------------------- | | `toolkitSlug` | `string` | The slug of the toolkit to retrieve the fields for | | `authScheme` | `AuthSchemeType` | The auth scheme to retrieve the fields for | | `options` | `\{ requiredOnly?: boolean \}` | | **Returns** `Promise` — The fields required for initiating a connected account *** ## listCategories() [#listcategories] Retrieves all toolkit categories available in the Composio SDK. This method fetches the complete list of categories from the Composio API and transforms the response to use camelCase property naming. ```typescript async listCategories(requestOptions?: ComposioRequestOptions): Promise ``` **Parameters** | Name | Type | | ----------------- | ------------------------ | | `requestOptions?` | `ComposioRequestOptions` | **Returns** `Promise` — The list of toolkit categories **Example** ```typescript // Get all toolkit categories const categories = await composio.toolkits.listCategories(); console.log(categories.items); // Array of category objects ``` *** --- 📚 **More documentation:** [View all docs](https://docs.composio.dev/llms.txt) | [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. - 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()`) is a fully supported lower-level interface: your code picks the tool, no runtime discovery. It fits deterministic workflows and scripts; sessions fit agents that decide at runtime. The tradeoffs are documented at https://docs.composio.dev/docs/sessions-vs-direct-execution. Note that direct execution requires a toolkit version (https://docs.composio.dev/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.