> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# TypeScript SDK Reference

> Complete API reference for the Composio TypeScript SDK (@composio/core).

## Installation

```bash npm theme={null}
npm install @composio/core
```

```bash pnpm theme={null}
pnpm add @composio/core
```

```bash yarn theme={null}
yarn add @composio/core
```

```bash bun theme={null}
bun add @composio/core
```

## Classes

| Class | Description |
| - | - |
| [`Composio`](https://composio-preview.mintlify.site/reference/sdk-reference/typescript/composio) | This is the core class for Composio. |
| [`AuthConfigs`](https://composio-preview.mintlify.site/reference/sdk-reference/typescript/auth-configs) | AuthConfigs class |
| [`ConnectedAccounts`](https://composio-preview.mintlify.site/reference/sdk-reference/typescript/connected-accounts) | ConnectedAccounts class |
| [`CustomToolkits`](https://composio-preview.mintlify.site/reference/sdk-reference/typescript/custom-toolkits) | `composio.experimental.customToolkits` — toolkits your project registers |
| [`Keyring`](https://composio-preview.mintlify.site/reference/sdk-reference/typescript/keyring) | `composio.keyring` — the organization's customer-managed keyring. |
| [`Logs`](https://composio-preview.mintlify.site/reference/sdk-reference/typescript/logs) | `composio.logs` — tool-execution logs. |
| [`SessionConfigs`](https://composio-preview.mintlify.site/reference/sdk-reference/typescript/session-configs) | `composio.sessionConfigs` — saved, reusable Session configs. |
| [`Experimental`](https://composio-preview.mintlify.site/reference/sdk-reference/typescript/experimental) | Experimental API |
| [`MCP`](https://composio-preview.mintlify.site/reference/sdk-reference/typescript/mcp) | MCP (Model Control Protocol) class |
| [`RemoteFile`](https://composio-preview.mintlify.site/reference/sdk-reference/typescript/remote-file) | Represents a file stored in a tool router session's file mount. |
| [`Sessions`](https://composio-preview.mintlify.site/reference/sdk-reference/typescript/sessions) | First-class API for creating and reusing Composio sessions. |
| [`Toolkits`](https://composio-preview.mintlify.site/reference/sdk-reference/typescript/toolkits) | Toolkits class |
| [`Session`](https://composio-preview.mintlify.site/reference/sdk-reference/typescript/session) | A Composio session — the object returned by `composio.sessions.create(...)` |
| [`Session files`](https://composio-preview.mintlify.site/reference/sdk-reference/typescript/session-files) | File mount for a Composio session, reached via `session.experimental.files` |
| [`Tools`](https://composio-preview.mintlify.site/reference/sdk-reference/typescript/tools) | This class is used to manage tools in the Composio SDK. |
| [`Triggers`](https://composio-preview.mintlify.site/reference/sdk-reference/typescript/triggers) | Trigger (Instance) class |
| [`Usage`](https://composio-preview.mintlify.site/reference/sdk-reference/typescript/usage) | `composio.experimental.usage` — metering for the project the API key |
| [`WebhookEndpoints`](https://composio-preview.mintlify.site/reference/sdk-reference/typescript/webhook-endpoints) | `composio.webhooks.endpoints` — inbound webhook endpoints. Each endpoint is |
| [`Webhooks`](https://composio-preview.mintlify.site/reference/sdk-reference/typescript/webhooks) | `composio.webhooks` namespace. |
| [`WebhookSubscriptions`](https://composio-preview.mintlify.site/reference/sdk-reference/typescript/webhook-subscriptions) | `composio.webhooks.subscriptions` — the project's outbound webhook |

## Quick Start

```typescript theme={null}
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' }
});
```
