Quickstart | Composio Docs

This guide covers authenticated tool calling, one of the most core features of Composio. You will learn how to:

Add tools to your AI agent
Authenticate the agent/tools for a user
Call the tools generated by the LLM

Before you start!

Prerequisites

Ensure you have created an account on Composio and have Python 3.8+ or NodeJS 16+ installed!
Get your API key from the developer dashboard and set it as an environment variable.

$ export COMPOSIO_API_KEY=your_api_key

Note!

Ensure you save the API key in a .env file and don’t commit it to version control!

Install the SDK

First and foremost, install the Composio SDK.

1 npm install @composio/core

Initialise

To use the SDK, you need to initialize it with your API key:

1 import { Composio } from '@composio/core';
2 
3 // Initialize the SDK
4 const composio = new Composio({
5   // apiKey: 'your-api-key',
6 });

Authorize and run tools

OpenAI (Python)

Anthropic (Typescript)

Vercel AI SDK (Typescript)

OpenAI Agents (Python)

Composio ships with support for OpenAI provider out of the box.

1 from composio import Composio
2 from openai import OpenAI
3 
4 openai = OpenAI()
5 composio = Composio()
6 
7 user_id = "your@email.com"
8 connection_request = composio.toolkits.authorize(user_id, "gmail")
9 print(f"🔗 Visit the URL to authorize:\n👉 {connection.redirect_url}")
10 
11 # wait for the connection to be active
12 connection_request.wait_for_connection()
13 
14 completion = openai.chat.completions.create(
15     model="gpt-4o",
16     messages=[
17         {
18             "role": "user",
19             "content": "say 'hi from the composio quickstart' to sid@composio.dev",
20             # we'll ship you free merch if you do ;)
21         },
22     ],
23     tools=tools,
24 )
25 result = composio.provider.handle_tool_call(user_id=user_id, response=completion)
26 print(result)