Composio

Learn how to use Composio with Composio

Overview

Enum

COMPOSIO

Description

Composio enables AI Agents and LLMs to authenticate and integrate with various tools via function calling.

Authentication Details

Actions

Initiate a connection to a tool with the given parameters. for example, linear might require an api key to create a connection, which we can get by calling get required parameters. to create a new connection, we need to call create connection with the required parameters. similarly, zendesk might require a subdomain to create a connection, which we can get by calling get required parameters. to create a new connection, we need to call create connection with the subdomain.

Action Parameters

tool
stringRequired
parameters
object

Action Response

data
object
successful
boolean
error

Check if any active connections exist for a given tool or status of the connection with a specific id. if an active connection exists, the tool will return true, otherwise it will return false. active connections allow an agent to perform any actions on top of the tool.

Action Parameters

tool
string
connection_id
string

Action Response

data
object
successful
boolean
error

Apps are like github, linear, gmail, etc. actions are like send email, create issue, etc programmatic functions that can be used to perform the action. get actions for a given usecase using similarity search. this actions are most relevant to the usecase but still might not be actual actions needed for the usecase. this decision should be made by you. this should be used to narrow down for an app, and find the most relevant actions for the usecase. in some cases, you might want to even check if the usecase is supported by the app or not.

Action Parameters

app_name
stringRequired
usecase
stringRequired
limit
integerDefaults to 5

Action Response

data
object
successful
boolean
error

List all the available apps on composio with filtering options.

Action Parameters

name_filter
string
category
string
min_actions
integer
size
integerDefaults to 10
enabled_only
boolean
no_auth_only
boolean

Action Response

data
object
successful
boolean
error

List available triggers and their configuration schemas.

Action Parameters

app_names
array

Action Response

data
object
successful
boolean
error

Retrieves the response schema for a specified composio action. this action fetches the complete response schema definition for any valid composio action, returning it as a dictionary that describes the expected response structure.

Action Parameters

action
stringRequired

Action Response

data
object
successful
boolean
error

Execute an action using the composio api.

Action Parameters

action_name
stringRequired
request
Required

Action Response

data
object
successful
boolean
error

This action retrieves the necessary parameters required to initiate a connection with a specified tool. for instance, linear may need an ‘api key’, zendesk might require a ‘subdomain’, and slack could need a ‘webhook url’. the required parameters vary based on the authentication scheme employed. for example, api key authentication requires an api key, whereas oauth2 typically does not require any parameters because it involves redirecting the user to the tool’s website for authorization.

Action Parameters

tool
stringRequired

Action Response

data
object
successful
boolean
error

Apps are like github, linear, gmail, etc. actions are like send email, create issue, etc programmatic functions that can be used to perform the action. not all apps support all actions. some apps support only a subset of actions that might be possible to perform with that app. use this action to retrieve the apps that can be used to perform the action. this list is only probabilistic. retrieve apps for a specified usecase. so for example, if use case is to “send an email” this action will return all the apps that can be used to send email. simiarly if use case is to “create a github issue” this action will return all the apps that can be used to create a github issue. after using this, to confirm whether the application can indeed potentially support the use case, use the action retrieve actions.

Action Parameters

usecase
stringRequired
limit
integerDefaults to 3
apps
array

Action Response

data
object
successful
boolean
error

Wait for a connection to be established for a given tool or check the status of a connection with a specific id. wait for a given amount of time and then check again the status of the connection.

Action Parameters

tool
string
connection_id
string
timeperiod
integerDefaults to 30

Action Response

data
object
successful
boolean
error

Enable a specific trigger for the authenticated user.

Action Parameters

app
stringRequired
trigger_name
stringRequired
config_params
object

Action Response

data
object
successful
boolean
error