--- canonical_url: "https://docs.composio.dev/examples/sdk-examples" markdown_url: "https://docs.composio.dev/examples/sdk-examples.md" product: "platform" version: null last_updated: null --- # TypeScript and Python SDK examples (/examples/sdk-examples) Use these examples to try a specific Composio feature in your own project. Start with a walkthrough for complete setup instructions, or open a source file alongside its guide. ## Start with a walkthrough [#start-with-a-walkthrough] - [Run an agent on Cloudflare Workers](/examples/cloudflare-workers): Build, test, and deploy an authenticated HTTP endpoint that runs an OpenAI agent with Composio tools. - [Select tools with TypeSafe](/examples/typesafe-tool-selection): Choose a tool, fill its arguments, and handle incomplete decisions before execution. - [Use CrewAI and LangChain with MCP](/examples/python-mcp-agents): Give either Python framework access to a Composio session through its MCP client. - [Analyze a CSV and download a report](/examples/csv-report-agent): Turn the session files API into an agent that produces a downloadable report. - [Use multiple accounts in one agent](/examples/multiple-accounts): Connect work and personal Gmail and require explicit account selection. - [Combine your own tools with Composio](/examples/custom-tools): Run local application tools alongside remote Composio tools. - [Run an agent when an email arrives](/examples/email-triggered-agent): Connect trigger setup, webhook verification, and agent execution. ## Find source code by task [#find-source-code-by-task] These are selected examples from [`ts/examples`](https://github.com/ComposioHQ/composio/tree/next/ts/examples), [`python/examples`](https://github.com/ComposioHQ/composio/tree/next/python/examples), and the Python TypeSafe provider. The directories also contain experiments and older API examples. Use the linked guide for the current setup and API choices. | Task | TypeScript source | Python source | Guide | | ---------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------- | | Run an agent on Cloudflare Workers | [OpenAI Worker](https://github.com/ComposioHQ/composio/blob/next/ts/examples/openai/src/cloudflare.ts), [Mastra Worker](https://github.com/ComposioHQ/composio/blob/next/ts/examples/mastra/src/cloudflare.ts) | Not available | [Worker setup and deployment](/examples/cloudflare-workers) | | Select and shortlist tools with TypeSafe | [TypeSafe examples](https://github.com/ComposioHQ/composio/tree/next/ts/examples/typesafe) | [TypeSafe demo](https://github.com/ComposioHQ/composio/blob/next/python/providers/typesafe/typesafe_demo.py) | [TypeSafe walkthrough](/examples/typesafe-tool-selection) | | Connect an agent over MCP | [Vercel AI SDK](https://github.com/ComposioHQ/composio/blob/next/ts/examples/tool-router/src/mcp.ts) | [CrewAI](https://github.com/ComposioHQ/composio/blob/next/python/examples/tool_router/crewai_agent.py), [LangChain](https://github.com/ComposioHQ/composio/blob/next/python/examples/tool_router/langchain_agent.py) | [Python MCP walkthrough](/examples/python-mcp-agents), [sessions via MCP](/docs/sessions-via-mcp) | | Preload tools in a session | [Preload tools](https://github.com/ComposioHQ/composio/blob/next/ts/examples/tool-router/src/preload.ts) | [Preload tools](https://github.com/ComposioHQ/composio/blob/next/python/examples/tool_router/preload.py) | [Custom tools walkthrough](/examples/custom-tools#preload-selected-tools-while-keeping-discovery) | | Control which tools a session exposes | [Direct tools](https://github.com/ComposioHQ/composio/blob/next/ts/examples/tool-router/src/direct-tools-preset.ts) | [Direct tools](https://github.com/ComposioHQ/composio/blob/next/python/examples/tool_router/direct_tools_preset.py) | [Custom tools walkthrough](/examples/custom-tools), [configure sessions](/docs/configuring-sessions) | | Change a session's configuration | [Update a session](https://github.com/ComposioHQ/composio/blob/next/ts/examples/tool-router/src/session-update.ts) | [Update a session](https://github.com/ComposioHQ/composio/blob/next/python/examples/tool_router/session_update.py) | [Sessions](/docs/how-composio-works) | | Upload and download sandbox files | See guide | [Session files](https://github.com/ComposioHQ/composio/blob/next/python/examples/tool_router/files.py) | [CSV report walkthrough](/examples/csv-report-agent), [remote sandbox](/docs/sandbox/remote) | | Connect an app for a user | [Connected accounts](https://github.com/ComposioHQ/composio/tree/next/ts/examples/connected-accounts) | [Authorize a session](https://github.com/ComposioHQ/composio/blob/next/python/examples/tool_router/authorize.py) | [Authentication](/docs/authentication) | | Use multiple accounts in one agent | [Multi-account agent](https://github.com/ComposioHQ/composio/blob/next/ts/examples/tool-router/src/multi-account.ts) | See walkthrough | [Multiple accounts walkthrough](/examples/multiple-accounts) | | Create triggers and receive events | [Trigger examples](https://github.com/ComposioHQ/composio/tree/next/ts/examples/triggers) | [Triggers](https://github.com/ComposioHQ/composio/blob/next/python/examples/triggers.py) | [Email-triggered agent](/examples/email-triggered-agent), [receive events](/docs/setting-up-triggers/subscribing-to-events) | ## Run a repository example [#run-a-repository-example] Follow the [TypeScript setup](https://github.com/ComposioHQ/composio/blob/next/ts/examples/README.md) or [Python setup](https://github.com/ComposioHQ/composio/blob/next/python/examples/README.md) to install the workspace and configure credentials. Check the selected example for its model provider key and connected-account requirements. Scripts that create connections or triggers make changes in your Composio project. The LangChain MCP script declares its own dependencies. From the repository root, use `uv run --script python/examples/tool_router/langchain_agent.py` as shown in the [walkthrough](/examples/python-mcp-agents). For a standalone project, use a walkthrough above. To choose a framework first, see [SDKs and frameworks](/docs/providers). --- 📚 **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.