Skip to main content

Installation

Classes

Quick Start

Composio

This is the core class for Composio. It is used to initialize the Composio SDK and provide a global configuration.

AuthConfigs

AuthConfigs class This class is used to manage authentication configurations in the Composio SDK. Auth configs are used to configure authentication providers and settings.

ConnectedAccounts

ConnectedAccounts class This class is used to manage connected accounts in the Composio SDK. Connected accounts are used to authenticate with third-party services.

CustomToolkits

`composio.experimental.customToolkits` — toolkits your project registers from its own app or MCP server, with their own auth configs and connected accounts. **Experimental — custom toolkits are in pilot; shape may change.** These live on the Composio platform. They are unrelated to the in-process toolkits built with `experimental_createToolkit()`, which run inside your application.

Keyring

`composio.keyring` — the organization's customer-managed keyring.

Logs

`composio.logs` — tool-execution logs.

SessionConfigs

`composio.sessionConfigs` — saved, reusable Session configs. A Session config is a named access policy (`sc_…`) built in the Composio Dashboard under Sessions → Configs. Pass its id as `experimental.sessionConfigId` to `composio.sessions.create()` or `session.update()` to apply it. These endpoints require Session configs to be enabled for the project; otherwise the backend returns 403.

Experimental

Experimental class reference

MCP

MCP (Model Control Protocol) class Handles MCP server operations. When `config.experimental.mcp` is enabled, this class augments the features of `composio.mcp`.

RemoteFile

Represents a file stored in a tool router session's file mount. Provides methods to fetch, save, and work with the file content.

Sessions

First-class API for creating and reusing Composio sessions. `composio.sessions.create(...)` is the canonical session creation entrypoint. The top-level `composio.create(...)` method remains as a backwards-compatible alias for `composio.sessions.create(...)`.

Toolkits

Toolkits class Toolkits are a collection of tools that can be used to perform various tasks. This is similar/replacement of `apps` in the Composio API.

Session

A Composio session — the object returned by `composio.sessions.create(...)` and `composio.sessions.use(...)` (also reachable via the top-level `composio.create(...)` / `composio.use(...)` aliases). This is the canonical session surface. Use it to fetch session-scoped tools, authorize toolkits, search, and execute tools. The public return type is `Session` (with `mcp` surfaced, returned when `{ mcp: true }` is passed) or `SessionWithoutMcp` (the default, with `mcp` omitted from the type); this class is the concrete runtime form behind both.

Session files

File mount for a Composio session, reached via `session.experimental.files` on a session created with `composio.sessions.create(...)`. Upload, list, download, and delete files scoped to a single session.

Tools

This class is used to manage tools in the Composio SDK. It provides methods to list, get, and execute tools.

Triggers

Trigger (Instance) class

Usage

`composio.experimental.usage` — metering for the project the API key belongs to. **Experimental — shape may change in future releases.**

WebhookEndpoints

`composio.webhooks.endpoints` — inbound webhook endpoints. Each endpoint is the ingress URL Composio exposes for one toolkit + OAuth app pair, which you register with the third-party provider so it can push events to Composio.

Webhooks

`composio.webhooks` namespace. - `subscriptions`: the project's outbound webhook subscription (where Composio delivers trigger and lifecycle events). - `endpoints`: inbound ingress URLs for third-party providers, one per toolkit + OAuth app pair.

WebhookSubscriptions

`composio.webhooks.subscriptions` — the project's outbound webhook subscription. The API allows one subscription per project; every response includes the signing `secret` used to verify deliveries with `composio.triggers.verifyWebhook()` / `composio.triggers.parse()`.