SDK Reference

TypeScript SDK Reference

Markdown

Installation

npm install @composio/core
pnpm add @composio/core
yarn add @composio/core
bun add @composio/core

Classes

ClassDescription
ComposioThis is the core class for Composio.
AuthConfigsAuthConfigs class
ConnectedAccountsConnectedAccounts class
MCPMCP (Model Control Protocol) class
RemoteFileRepresents a file stored in a tool router session's file mount.
ToolkitsToolkits class
ToolRouterSessionToolRouterSession API
ToolRouterSessionFilesMountToolRouterSessionFilesMount API
ToolsThis class is used to manage tools in the Composio SDK.
TriggersTrigger (Instance) class

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' }
});