Quickstart

Installation

Get started with Composio by installing the SDK for your preferred language.

TypeScript
Python

npm install @composio/core

pip install composio

Initialize Composio

TypeScript
Python

import { Composio } from '@composio/core';

// Initialize the SDK
const composio = new Composio({
  // apiKey: 'your-api-key',
});

from composio import Composio

composio = Composio(
  # api_key="your-api-key",
)

Build Your First Agent

Create a simple agent that can fetch the latest Hacker News posts using OpenAI Agents.

Install OpenAI Agents Provider

TypeScript
Python

npm install @composio/openai-agents @openai/agents

pip install composio_openai_agents openai-agents

Initialize Composio with Provider

TypeScript
Python

import { Composio } from '@composio/core';
import { OpenAIAgentsProvider } from '@composio/openai-agents';
import { Agent, run } from '@openai/agents';

const composio = new Composio({
  provider: new OpenAIAgentsProvider(),
});

const userId = '[email protected]';

import asyncio
from agents import Agent, Runner
from composio import Composio
from composio_openai_agents import OpenAIAgentsProvider

# Initialize Composio client with OpenAI Agents Provider
composio = Composio(provider=OpenAIAgentsProvider())

user_id = "[email protected]"

Get Tools from a Toolkit

TypeScript
Python

const tools = await composio.tools.get(userId, {
  toolkits: ['HACKERNEWS'],
});

tools = composio.tools.get(user_id=user_id, toolkits=["HACKERNEWS"])

Create and Run Your Agent

TypeScript
Python

const agent = new Agent({
  name: 'Hackernews assistant',
  tools: tools,
});

const result = await run(agent, 'What is the latest hackernews post about?');

console.log(JSON.stringify(result.finalOutput, null, 2));
// will return the response from the agent with data from HACKERNEWS API.

# Create an agent with the tools
agent = Agent(
    name="Hackernews Agent",
    instructions="You are a helpful assistant.",
    tools=tools,
)

# Run the agent
async def main():
    result = await Runner.run(
        starting_agent=agent,
        input="What's the latest Hackernews post about?",
    )
    print(result.final_output)

asyncio.run(main())
# will return the response from the agent with data from HACKERNEWS API.

Complete Example

Here’s the full code to get you started:

TypeScript
Python

import { Composio } from '@composio/core';
import { OpenAIAgentsProvider } from '@composio/openai-agents';
import { Agent, run } from '@openai/agents';

const composio = new Composio({
  provider: new OpenAIAgentsProvider(),
});

const userId = '[email protected]';

const tools = await composio.tools.get(userId, {
  toolkits: ['HACKERNEWS'],
});

const agent = new Agent({
  name: 'Hackernews assistant',
  tools: tools,
});

const result = await run(agent, 'What is the latest hackernews post about?');

console.log(JSON.stringify(result.finalOutput, null, 2));
// will return the response from the agent with data from HACKERNEWS API.

import asyncio
from agents import Agent, Runner
from composio import Composio
from composio_openai_agents import OpenAIAgentsProvider

# Initialize Composio client with OpenAI Agents Provider
composio = Composio(provider=OpenAIAgentsProvider())

user_id = "[email protected]"
tools = composio.tools.get(user_id=user_id, toolkits=["HACKERNEWS"])

# Create an agent with the tools
agent = Agent(
    name="Hackernews Agent",
    instructions="You are a helpful assistant.",
    tools=tools,
)

# Run the agent
async def main():
    result = await Runner.run(
        starting_agent=agent,
        input="What's the latest Hackernews post about?",
    )
    print(result.final_output)

asyncio.run(main())
# will return the response from the agent with data from HACKERNEWS API.

Next Steps

Explore Toolkits

Browse 1000+ available toolkits and integrations

Authentication

Learn how to connect user accounts to external services

AI Providers

Integrate with OpenAI, Anthropic, LangChain, and more

Custom Tools

Create your own custom tools and actions

Get Started

Core Concepts

Installation

Guides

MCP & Rube

Installation

Initialize Composio

Build Your First Agent

Complete Example

Next Steps

Explore Toolkits

Authentication

AI Providers

Custom Tools

Build docs developers (and LLMs) love

Get Started

Core Concepts

Installation

Guides

MCP & Rube

​Installation

​Initialize Composio

​Build Your First Agent

​Complete Example

​Next Steps

Explore Toolkits

Authentication

AI Providers

Custom Tools

Build docs developers (and LLMs) love

Installation

Initialize Composio

Build Your First Agent

Complete Example

Next Steps