SDK Reference
TypeScript SDK Reference
Installation
npm install @composio/coreClasses
| Class | Description |
|---|---|
Composio | This is the core class for Composio. |
AuthConfigs | AuthConfigs class |
ConnectedAccounts | ConnectedAccounts class |
CustomToolkits | composio.experimental.customToolkits — toolkits your project registers |
Keyring | composio.keyring — the organization's customer-managed keyring. |
Logs | composio.logs — tool-execution logs. |
Experimental | Experimental API |
MCP | MCP (Model Control Protocol) class |
RemoteFile | Represents a file stored in a tool router session's file mount. |
Sessions | First-class API for creating and reusing Composio sessions. |
Toolkits | Toolkits class |
Session | A Composio session — the object returned by composio.sessions.create(...) |
Session files | File mount for a Composio session, reached via session.experimental.files |
Tools | This class is used to manage tools in the Composio SDK. |
Triggers | Trigger (Instance) class |
Usage | composio.experimental.usage — metering for the project the API key |
WebhookEndpoints | composio.webhooks.endpoints — inbound webhook endpoints. Each endpoint is |
Webhooks | composio.webhooks namespace. |
WebhookSubscriptions | composio.webhooks.subscriptions — the project's outbound webhook |
Quick Start
import { Composio } from '@composio/core';
const composio = new Composio({
apiKey: process.env.COMPOSIO_API_KEY
});
// Get tools for a user
const tools = await composio.tools.get('user-123', {
toolkits: ['github']
});
// Execute a tool
const result = await composio.tools.execute('GITHUB_GET_REPOS', {
userId: 'user-123',
arguments: { owner: 'composio' }
});