Installation and Basic Commands

Composio

Get Started

Guides

Examples

Documentation

Dashboard

Discord

Learn how to install and use the Composio CLI for managing your agent interactions.

Install

💻 Using Composio CLI

Composio equips agents with well-crafted tools empowering them to tackle complex tasks

Overview

Use Composio to connect OpenAI Assistant to GitHub (via OAUTH2) to perform a task using natural language

Quick Start

🚀 Quick Start

Get an API key

Platform's core concepts and functionalities.

Core Concepts

Manage all the connected accounts of your Users & Organizations 🧑‍🤝‍🧑 via entities

Accounts/Entity

🧑‍🤝‍🧑 Accounts/Entity

Allow your users to connect with any Apps.

Integrations

Learn how to perform actions with a connected account.

Actions

🛠️ How to Use Actions

Learn, how to use triggers in Connected Apps

Triggers

🛠️ How to Use Triggers

How to create a Local Tool and add it to your Agent

Local Tools

Creating a Local Tool

Explore the process of creating custom integrations with external Apps

Custom Tools

🔧 Crafting Custom Tools

Learn how to perform local actions with a connected account.

Custom Actions

🛠️ How to Use Custom Local Actions

Integrate Composio with Langchain agents to let them seamlessly interact with external apps

LangChain SDK

🦜🔗 Using Composio With LangChain

Integrate Composio with Autogen agents to let them seamlessly interact with external apps

Autogen SDK

Using Composio With Autogen

Integrate Composio with Crewai agents to let them seamlessly interact with external apps

crewAI SDK

Using Composio With crewAI

Integrate Composio with Lyzr agents to let them seamlessly interact with external apps

Lyzr SDK

Using Composio With Lyzr

Enable OpenAI assistants to seamlessly interact with external apps via Composio for enhanced functionality

OpenAI SDK

Using Composio With OpenAI

Integrate Composio with Julep agents to enhance their interaction with external apps

Julep SDK

Using Composio With Julep

Integrate Composio with Griptape agents to let them seamlessly interact with external apps

Griptape SDK

🧻 Using Composio With Griptape

Integrate Composio with LlamaIndex application to let them seamlessly interact with external apps

LlamaIndex SDK

🦙 Using Composio With LlamaIndex

Integrate Composio with CAMEL agents to let them seamlessly interact with external apps

CAMEL SDK

🐫 Using Composio With CAMEL-AI

Integrate Composio with PraisonAI agents to let them seamlessly interact with external apps

PraisonAI SDK

📖 Using Composio With PraisonAI

Integrate Composio with LangGraph Agentic workflows & enable them to interact seamlessly with external apps, enhancing their functionality and reach.

LangGraph SDK

🦜🕸️ Using Composio With LangGraph

The Composio SDK allows you to integrate your applications with a variety of tools and services.

Using Composio Python SDK

Use Composio JS SDK with OpenAI to create a github issue creation agent

Quickstart

Using Composio JS SDK with OpenAI

Langchain

Using Composio JS SDK with Langchain

Use Composio JS SDK with Cloudflare Worker AI

Cloudflare Worker AI

Using Composio JS SDK with Cloudflare Worker AI

Build Software Engineering agents locally with frameworks and tools of your choice

Introduction

SWE Development Kit

Configure and utilize different workspace environments for running your SWE agents securely and with custom configurations.

Workspace Environments

Learn how to extend the capabilities of your SWE agents by adding custom tools.

Adding Custom Tools

Learn how to run and evaluate your SWE agents using benchmarks

Benchmarks

Build and benchmark Software Engineering agents with Composio's tooling ecosystem using JavaScript

Configure and utilize different workspace environments for running your SWE agents

Learn how to add, check, and manage connections using the CLI.

Connections

🧑🏻‍💻 Manage Connections using CLI

Learn how to enable, disable, list, and manage triggers using the CLI.

🧑🏻‍💻 Manage Triggers using CLI

Learn how to get/update enums for apps/actions using the CLI.

Apps/Actions

🧑🏻‍💻 Managing Apps/Actions using CLI

This section will walk you through the basics of managing multiple users and their authentication using Composio.

Managing Multiple Users

Managing Multiple Users and Their Authentication with Composio

This guide provides step-by-step instructions for enabling a specific trigger for a user in Composio.

Specific Triggers for a User

Enabling a Specific Trigger for a User in Composio

This documentation will guide you through the process of use case-based action finding in Composio.

Use Case based Action

Use Case based Action finding

This section will walk you through discovering and managing the tools

Tool Finding

Tool finding

In Composio, managing and monitoring your connections is essential for maintaining an organized and efficient workflow. This page will help you list and manage the connections associated with your account, allowing you to keep track of the active Connections and their details.

Listing Connected Accounts

Listing Connected Accounts in Composio

In this section, we will guide you through deploying your application to production

Using Composio in Production

The Composio coding cookbook contain in-depth examples and code.  These examples can be used as reference to better understand the core principles and applications of composio.

Coding Guides

This guide provides detailed steps to create an Investment Analyst Agent that leverages CrewAI, Composio  to perform investment research, analyze stocks, and offer recommendations based on user input

Investment Analyst

This guide provides detailed steps to create a research assistant agent that leverages CrewAI, Composio, and ChatGPT to perform web searches and compile research reports. Ensure you have Python 3.8 or higher installed. 

Research Assistant

This guide provides detailed steps to create an agent that leverages  Composio to perform SQL queries and file operations to perform sql queries and  File operations and plot insightful graphs on the data in the db

SQL Agent

This guide will walk you through setting up a system that scrapes competitor websites and automatically adds detailed research notes to your Notion workspace. Let's get started!

Competitor Researcher

This guide provides detailed steps to create an agent that leverages Composio to add content to a RAG tool, perform retrieval-augmented generation queries, and return relevant information based on user input.

RAG Tool Agent

This is a simple guide to demonstrate how to use CODEINTERPRETER tool by composio

Code Execution Agent

This guide provides detailed instructions on how to create an application that retrieves the latest news articles and generates summaries using Langchain and Composio.

News Summary

This guide provides detailed steps to create a Calendar Agent using CrewAI, Composio, and Google Calendar API. You will build a system capable of converting roughly written todo items into Google Calendar events, ensuring your tasks are scheduled efficiently.

Calendar Agent

This guide provides detailed steps to create a Calendar Agent using LangChain, Composio, and Google Calendar tools. You will build a system capable of converting roughly written todo items into Google Calendar events, ensuring your tasks are scheduled efficiently.

This is a simple guide to demonstrate how to use CODEINTERPRETER tool by composio. This example is written in javascript

This guide provides detailed steps to create an Investment Analyst Agent that leverages LangChain and Composio  to perform investment research, analyze stocks, and offer recommendations based on user input

Retrieves a list of all available apps in the Composio platform.

This endpoint allows clients to explore and discover the supported apps. It returns an array of app objects, each containing essential details such as the app's key, name, description, logo, categories, and unique identifier.

Use this endpoint to build a catalog of available apps and provide your users with an overview of the apps they can integrate with.

List All Apps

Retrieves a list of all connected accounts in the Composio platform. 

It supports pagination and filtering based on various parameters such as app ID, integration ID, and connected  ID. The response includes an array of connection objects, each containing details like the connector ID, connection parameters, status, creation/update timestamps, and associated app information.

Use this endpoint to manage and monitor all active connections.  

List All Connected Accounts

Connect an account

This endpoint allows you to connect an external app account with Composio. It requires the integration ID in the request body and returns the connection status, connection ID, and a redirect URL (if applicable) for completing the connection flow.

Use this endpoint to initiate the process of connecting an external app for your end user.

Connect an Account

Retrieves details of a specific account connected to the Composio platform by providing its connected account ID. 
The response includes the integration ID, connection parameters (such as scope, base URL, client ID, token type, access token, etc.), connection ID, status, and creation/update timestamps.

Get a Connected Account

Remove a specific account from the Composio platform by providing its connection ID. Upon successful deletion, the response includes a status indicating the success of the operation.
Use this endpoint to clean up unwanted connections for your end user and manage the connection lifecycle.

Delete a Connected Account

Retrieves details of a specific integration in the Composio platform by providing its unique identifier. The response includes the connector's name, authentication scheme, authentication configuration, creation and update timestamps, enabled status, associated app information, expected input fields, and logo.

Use this endpoint to obtain detailed information about a integration and its configuration. It can be shown to end user for selection. 

You will also get parameters that are required to be captured from end user to connect an account using this connector. 
ex. API Key or subdomain URL. 

If the end-user selects this flow, collect the parameters and connect an account using it. 

Get an Integration

Updates the settings of a specific integration in the Composio platform.

This endpoint allows you to modify the settings of a integration, such as enabling or disabling it, by providing its unique identifier. The request body should include the updated settings, and the response indicates the success of the update operation.

Use this endpoint to manage the configuration and behavior of integrations in the Composio platform.

Update an Integration

Retrieves a list of all integrations in the Composio platform. It supports pagination to handle large numbers of connectors. The response includes an array of connector objects, each containing information such as the connector's ID, name, authentication scheme, creation/update timestamps, enabled status, associated app information, and logo.

This are the integration you can showcase to end user, and let them select which integration they want to connect an account with. 

List All Integrations

This endpoint allows you to add a new integration by providing the necessary details such as the integration name, authentication scheme, associated app ID, and authentication configuration. Upon successful creation, the response includes the newly created connector object.

Create a new integration

Retrieves details of a specific action in the Composio platform.

This endpoint allows you to fetch comprehensive information about a particular action by providing its unique identifier.
The response includes the action's name, display name, description, input parameters, expected response, associated app information, and enabled status.
Use this endpoint to obtain detailed information about an action, including its configuration and usage requirements. 
You can then pass this to function calling or use LLM to fill in the parameters. 

Get a Specific Action

Retrieves a list of all actions in the Composio platform.

This endpoint allows you to fetch a list of all the available actions. It supports pagination to handle large numbers of actions. The response includes an array of action objects, each containing information such as the action's name, display name, description, input parameters, expected response, associated app information, and enabled status.

Use this endpoint to explore and discover the actions supported by the Composio platform and showcase them to end user. 

Get List of Actions

Executes a specific action in the Composio platform.

This endpoint allows you to trigger the execution of an action by providing its name and the necessary input parameters. The request includes the connected account ID to identify the app connection to use for the action, and the input parameters required by the action. The response provides details about the execution status and the response data returned by the action.

Use this endpoint to execute actions available in the Composio platform for your end customer. 

Executed will indicate whether the action was successfully executed. 

Introduction

Python

Javascript

SweKit

SweKit.js

CLI

💻 Using Composio CLI

Installation and Basic Commands

Introduction

Python

Javascript

SweKit

SweKit.js

CLI

​Installation and Basic Commands

Installation and Basic Commands