Composio

App · 20 actions

Composio v3.1 tools, toolkits, connections, auth configs and trigger instances.

Actions

ActionWhat it does
Create auth configCreate auth config.
Create connected accountCreate connected account.
Delete auth configDelete auth config.
Delete connected accountDelete connected account.
Delete triggerDelete trigger.
Execute toolExecute tool.
Get auth configGet auth config.
Get connected accountGet connected account.
Get toolGet tool.
Get toolkitGet toolkit.
Get trigger typeGet trigger type.
List active triggersList active triggers.
List auth configsList auth configs.
List connected accountsList connected accounts.
List toolkitsList toolkits.
List toolsList tools.
List trigger typesList trigger types.
Refresh connected accountRefresh connected account.
Update auth configUpdate auth config.
Upsert triggerUpsert trigger.

Create auth config

Create auth config.

Inputs

ToolkittoolkitobjectRequired
Toolkit.
Auth configauth_configobject
Auth config.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "auth_config": {
      "auth_scheme": "example",
      "id": "example",
      "is_composio_managed": false,
      "managed_app_id": "example",
      "restrict_to_following_tools": []
    },
    "toolkit": {
      "slug": "example"
    }
  }
}

Create connected account

Create connected account.

Inputs

Auth configauth_configobjectRequired
Auth config.
ConnectionconnectionobjectRequired
Connection.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "connectionData": {
      "authScheme": "OAUTH1",
      "val": {
        "COMPANYDOMAIN": "example",
        "account_id": "example",
        "account_url": "example",
        "api_url": "example",
        "base_url": "example",
        "borneo_dashboard_url": "example",
        "dc": "example",
        "displayName": "example",
        "domain": "example",
        "extension": "example",
        "form_api_base_url": "example",
        "instanceEndpoint": "example",
        "instanceName": "example",
        "proxy_password": "example",
        "proxy_username": "example",
        "region": "example",
        "server_location": "example",
        "shop": "example",
        "site_name": "example",
        "status": "INITIALIZING",
        "subdomain": "example",
        "version": "example",
        "your-domain": "example",
        "your_server": "example"
      }
    },
    "experimental": {
      "account_type": "PRIVATE",
      "acl_config_for_shared": {
        "allow_all_users": false,
        "allowed_user_ids": [],
        "not_allowed_user_ids": []
      }
    },
    "id": "example",
    "redirect_uri": "example",
    "redirect_url": "example",
    "status": "INITIALIZING"
  }
}

Delete auth config

Delete auth config.

Inputs

NanoidnanoidtextRequired
The unique identifier of the authentication configuration to delete
Revoke on deleterevoke_on_deletetrue/false
When `true`, the delete also starts a background job that revokes the upstream credentials of every connected account in scope, and the response carries a `revoke_job_id`. Defaults to `false`. Revocation is irreversible , recovering a deleted entity does not restore working credentials.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "message": "example",
    "revoke_job_id": "example",
    "success": false
  }
}

Delete connected account

Delete connected account.

Inputs

NanoidnanoidtextRequired
The unique identifier (nanoid) of the connected account
Revoke on deleterevoke_on_deletetrue/false
When `true`, the delete also starts a background job that revokes the upstream credentials of every connected account in scope, and the response carries a `revoke_job_id`. Defaults to `false`. Revocation is irreversible , recovering a deleted entity does not restore working credentials.

Outputs

dataobject
Response returned after successfully deleting a connected account
Example output
{
  "data": {
    "revoke_job_id": "example",
    "success": false
  }
}

Delete trigger

Delete trigger.

Inputs

Trigger IdtriggerIdtextRequired
The ID of the trigger instance to delete

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "trigger_id": "example"
  }
}

Execute tool

Execute tool.

Inputs

Tool slugtool_slugtextRequired
The tool slug to execute
Connected account idconnected_account_idtext
Unique identifier for the connected account to use for authentication. Pass `instant_account` to run the tool on the Composio instant account for its toolkit, even when the user has connected the toolkit themselves; the request fails rather than falling back to another credential.One of: instant_account (Instant account).
Entity identity_idtext
Deprecated: please use user_id instead. Entity identifier for multi-entity connected accounts (e.g. multiple repositories, organizations)
User idexternal_user_idtext
User id for multi-user connected accounts (e.g. multiple users, organizations)
Versionversiontext
Tool version to execute. Defaults to the latest published version ("latest") when omitted.
Custom auth paramscustom_auth_paramsobject
Custom authentication parameters for tools that support parameterized authentication
Custom connection datacustom_connection_dataobject
Custom connection data for tools that support custom connection data
Argumentsargumentsobject
Key-value pairs of arguments required by the tool (mutually exclusive with text)
Texttexttext
Natural language description of the task to perform (mutually exclusive with arguments)
Allow tracingallow_tracingtrue/false
Deprecated. Enable debug tracing for tool execution (useful for debugging)

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "data": {},
    "error": "example",
    "log_id": "example",
    "session_info": "example",
    "successful": false
  }
}

Get auth config

Get auth config.

Inputs

NanoidnanoidtextRequired
The unique identifier of the authentication configuration to retrieve

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "auth_scheme": "OAUTH2",
    "created_at": "example",
    "created_by": "example",
    "credentials": {},
    "expected_input_fields": [],
    "id": "example",
    "is_composio_managed": false,
    "is_enabled_for_tool_router": false,
    "keyring_routed": false,
    "last_updated_at": "example",
    "managed_app_id": "example",
    "name": "example",
    "no_of_connections": 1.0,
    "proxy_config": {
      "proxy_auth_key": "example",
      "proxy_url": "example"
    },
    "restrict_to_following_tools": [],
    "shared_connection_fields": {},
    "shared_credentials": {},
    "status": "ENABLED",
    "tool_access_config": {
      "tools_available_for_execution": [],
      "tools_for_connected_account_creation": []
    },
    "toolkit": {
      "auth_guide_url": "example",
      "auth_hint_url": "example",
      "logo": "example",
      "slug": "example"
    },
    "type": "default",
    "uuid": "example"
  }
}

Get connected account

Get connected account.

Inputs

NanoidnanoidtextRequired
The unique identifier (nanoid) of the connected account

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "alias": "example",
    "authScheme": "OAUTH2",
    "auth_config": {
      "auth_scheme": "OAUTH2",
      "id": "example",
      "is_composio_managed": false,
      "is_disabled": false
    },
    "created_at": "example",
    "data": {},
    "experimental": {
      "account_type": "PRIVATE",
      "acl_config_for_shared": {
        "allow_all_users": false,
        "allowed_user_ids": [],
        "not_allowed_user_ids": []
      }
    },
    "id": "example",
    "is_disabled": false,
    "params": {},
    "requested_scopes": [],
    "requested_user_scopes": [],
    "state": {
      "authScheme": "OAUTH1",
      "val": {
        "COMPANYDOMAIN": "example",
        "account_id": "example",
        "account_url": "example",
        "api_url": "example",
        "base_url": "example",
        "borneo_dashboard_url": "example",
        "dc": "example",
        "displayName": "example",
        "domain": "example",
        "extension": "example",
        "form_api_base_url": "example",
        "instanceEndpoint": "example",
        "instanceName": "example",
        "proxy_password": "example",
        "proxy_username": "example",
        "region": "example",
        "server_location": "example",
        "shop": "example",
        "site_name": "example",
        "status": "INITIALIZING",
        "subdomain": "example",
        "version": "example",
        "your-domain": "example",
        "your_server": "example"
      }
    },
    "status": "INITIALIZING",
    "status_reason": "example",
    "test_request_endpoint": "example",
    "toolkit": {
      "slug": "example"
    },
    "updated_at": "example",
    "user_id": "example",
    "word_id": "example"
  }
}

Get tool

Get tool.

Inputs

Tool slugtool_slugtextRequired
The unique slug identifier of the tool
Include pricinginclude_pricingtrue/false
Whether to include published pricing within instant, when available. Defaults to false.
Versionversiontext
Optional version of the tool to retrieve. Takes precedence over toolkit_versions; when both are omitted the tool resolves to the latest published version ("latest").
Toolkit versionstoolkit_versionsobject
Toolkit version specification. Use "latest" for latest versions or bracket notation for specific versions per toolkit. Read only when version is omitted; when neither is supplied the tool resolves to the latest published version ("latest").

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "available_versions": [],
    "deprecated": {
      "available_versions": [],
      "displayName": "example",
      "is_deprecated": false,
      "toolkit": {
        "logo": "example"
      },
      "version": "example"
    },
    "description": "example",
    "human_description": "example",
    "input_parameters": {},
    "instant": {
      "price": {
        "description": "example",
        "discount": "example"
      },
      "supported": true
    },
    "is_deprecated": false,
    "name": "example",
    "no_auth": false,
    "output_parameters": {},
    "scope_requirements": {
      "all_of": [],
      "source": []
    },
    "scopes": [],
    "slug": "example",
    "tags": [],
    "toolkit": {
      "logo": "example",
      "name": "example",
      "slug": "example"
    },
    "version": "example"
  }
}

Get toolkit

Get toolkit.

Inputs

SlugslugtextRequired
The unique slug identifier of the toolkit to retrieve
Versionversiontext
Version of the toolkit

Outputs

dataobject
Detailed information about a single toolkit
Example output
{
  "data": {
    "access": "all",
    "auth_config_details": [],
    "auth_guide_url": "example",
    "base_url": "example",
    "composio_managed_auth": [],
    "composio_managed_auth_schemes": [],
    "deprecated": {
      "getCurrentUserEndpoint": "example",
      "rawProxyInfoByAuthSchemes": [],
      "toolkitId": "example"
    },
    "enabled": false,
    "get_current_user_endpoint": "example",
    "get_current_user_endpoint_method": "example",
    "is_local_toolkit": false,
    "meta": {
      "app_url": "example",
      "available_versions": [],
      "categories": [],
      "created_at": "example",
      "description": "example",
      "logo": "example",
      "tools_count": 1.0,
      "triggers_count": 1.0,
      "updated_at": "example",
      "version": "example"
    },
    "name": "example",
    "slug": "example",
    "type": "native"
  }
}

Get trigger type

Get trigger type.

Inputs

SlugslugtextRequired
The unique slug identifier for the trigger type. Case-insensitive (internally normalized to uppercase).
Toolkit versionstoolkit_versionsobject
Toolkit version specification. Use "latest" for latest versions or bracket notation for specific versions per toolkit.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "config": {},
    "description": "example",
    "instructions": "example",
    "name": "example",
    "payload": {},
    "requires_webhook_endpoint_setup": false,
    "slug": "example",
    "toolkit": {
      "logo": "example",
      "name": "example",
      "slug": "example"
    },
    "type": "webhook",
    "types": [],
    "version": "example"
  }
}

List active triggers

List active triggers.

Inputs

User idsuser_idslist
Array of user IDs to filter triggers by
Connected account idsconnected_account_idslist
Array of connected account IDs to filter triggers by
Auth config idsauth_config_idslist
Array of auth config IDs to filter triggers by
Trigger idstrigger_idslist
Array of trigger IDs to filter triggers by
Trigger namestrigger_nameslist
Array of trigger names to filter triggers by. Case-insensitive (internally normalized to uppercase).
Connected Account IdsconnectedAccountIdslist
DEPRECATED: This parameter will be removed in a future version. Please use connected_account_ids instead.
Auth Config IdsauthConfigIdslist
DEPRECATED: This parameter will be removed in a future version. Please use auth_config_ids instead.
Trigger IdstriggerIdslist
DEPRECATED: This parameter will be removed in a future version. Please use trigger_ids instead.
Show disabledshow_disabledtrue/false
When set to true, includes disabled triggers in the response.
Trigger NamestriggerNameslist
DEPRECATED: This parameter will be removed in a future version. Please use trigger_names instead.
Show DisabledshowDisabledtrue/false
DEPRECATED: Use show_disabled instead
Deprecated Connected Account UuidsdeprecatedConnectedAccountUuidslist
Array of connected account UUIDs to filter triggers by
Deprecated Auth Config UuidsdeprecatedAuthConfigUuidslist
Array of auth config UUIDs to filter triggers by
Limitlimitnumber
Number of items per page, max allowed is 50
Cursorcursortext
Cursor for pagination. The cursor is a base64 encoded string of the page and limit. The page is the page number and the limit is the number of items per page. The cursor is used to paginate through the items. The cursor is not required for the first page.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "current_page": 1.0,
    "items": [],
    "next_cursor": "example",
    "total_items": 1.0,
    "total_pages": 1.0
  }
}

List auth configs

List auth configs.

Inputs

Is composio managedis_composio_managedtext
Whether to filter by composio managed auth configs
Toolkit slugtoolkit_slugtext
Comma-separated list of toolkit slugs to filter auth configs by
Deprecated app iddeprecated_app_idtext
DEPRECATED: This parameter will be removed in a future version. Please use toolkit_slug instead.
Deprecated statusdeprecated_statustext
DEPRECATED: This parameter will be removed in a future version.
Show disabledshow_disabledtrue/false
Show disabled auth configs
Searchsearchtext
Search auth configs by name or id
Limitlimitnumber
Number of items per page, max allowed is 200
Cursorcursortext
Cursor for pagination. The cursor is a base64 encoded string of the page and limit. The page is the page number and the limit is the number of items per page. The cursor is used to paginate through the items. The cursor is not required for the first page.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "current_page": 1.0,
    "items": [],
    "next_cursor": "example",
    "total_items": 1.0,
    "total_pages": 1.0
  }
}

List connected accounts

List connected accounts.

Inputs

Toolkit slugstoolkit_slugslist
The toolkit slugs of the connected accounts
Statusesstatuseslist
The status of the connected accountOne or more of: INITIALIZING, INITIATED, ACTIVE, FAILED, EXPIRED, INACTIVE, REVOKED.
Cursorcursortext
The cursor to paginate through the connected accounts
Limitlimitnumber
The limit of the connected accounts to return
User idsuser_idslist
The user ids of the connected accounts
Auth config idsauth_config_idslist
The auth config ids of the connected accounts
Connected account idsconnected_account_idslist
The connected account ids to filter by
Order byorder_bytext
The order by of the connected accountsOne of: created_at (Created at), updated_at (Updated at).
Order directionorder_directiontext
The order direction of the connected accountsOne of: asc, desc.
Account typeaccount_typetext
[Experimental] Filter by sharing model. Default (omitted) returns PRIVATE only , shared accounts must be requested explicitly. Pass SHARED for only shared accounts, or ALL for PRIVATE + SHARED.One of: PRIVATE, SHARED, ALL.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "current_page": 1.0,
    "items": [],
    "next_cursor": "example",
    "total_items": 1.0,
    "total_pages": 1.0
  }
}

List toolkits

List toolkits.

Inputs

Categorycategorytext
Category ID or name to filter toolkits by
Managed bymanaged_bytext
Deprecated: Entity responsible for managing the toolkitsOne of: composio, all, project.
Typetypetext
Filter by toolkit provenance: "native" (Composio-managed), "custom" (project-registered custom toolkits), or "all". Takes precedence over managed_by when both are supplied.One of: native, custom, all.
Sort bysort_bytext
Determines how toolkits should be sorted in the responseOne of: usage, alphabetically.
Include deprecatedinclude_deprecatedtrue/false
Include deprecated toolkits in the response
Searchsearchtext
Search query to filter toolkits by name, slug, or description (minimum 1 character)
User idexternal_user_idtext
List the custom toolkits this user can use. Without it, only custom toolkits with access "all" are listed.
Limitlimitnumber
Number of items per page, max allowed is 1000
Cursorcursortext
Cursor for pagination. The cursor is a base64 encoded string of the page and limit. The page is the page number and the limit is the number of items per page. The cursor is used to paginate through the items. The cursor is not required for the first page.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "current_page": 1.0,
    "items": [],
    "next_cursor": "example",
    "total_items": 1.0,
    "total_pages": 1.0
  }
}

List tools

List tools.

Inputs

Toolkit slugtoolkit_slugtext
The slug of the toolkit to filter by
Tool slugstool_slugstext
Comma-separated list of specific tool slugs to retrieve (overrides other filters)
Auth config idsauth_config_idstext
DEPRECATED: This parameter will be removed in a future version. Filter directly instead with tool_slugs and toolkit_slug, which accepts a comma-separated list of toolkits.
Importantimportanttext
Filter to only show important/featured tools (set to "true" to enable)One of: true, false.
Tagstagslist
Filter tools by one or more tags (can be specified multiple times)
Scopesscopeslist
Filter tools by one or more scopes (can be specified multiple times)
Queryquerytext
Full-text search query to filter tools by name, slug, or description. Applied as a soft filter on top of other filters.
Searchsearchtext
Deprecated: use "query" instead. Free-text search query to find tools by name, description, or functionality.
Include deprecatedinclude_deprecatedtrue/false
Include deprecated tools in the response
Include pricinginclude_pricingtrue/false
Whether to include published pricing within instant, when available. Defaults to false.
Toolkit versionstoolkit_versionsobject
Toolkit version specification. Use "latest" for latest versions or bracket notation for specific versions per toolkit. Defaults to the latest published version ("latest") when omitted.
Limitlimitnumber
Number of items per page, max allowed is 1000
Cursorcursortext
Cursor for pagination. The cursor is a base64 encoded string of the page and limit. The page is the page number and the limit is the number of items per page. The cursor is used to paginate through the items. The cursor is not required for the first page.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "current_page": 1.0,
    "items": [],
    "next_cursor": "example",
    "total_items": 1.0,
    "total_pages": 1.0
  }
}

List trigger types

List trigger types.

Inputs

Toolkit slugstoolkit_slugslist
Array of toolkit slugs to filter triggers by
Toolkit versionstoolkit_versionsobject
Toolkit version specification. Use "latest" for latest versions or bracket notation for specific versions per toolkit.
Limitlimitnumber
Number of items per page, max allowed is 50
Cursorcursortext
Cursor for pagination. The cursor is a base64 encoded string of the page and limit. The page is the page number and the limit is the number of items per page. The cursor is used to paginate through the items. The cursor is not required for the first page.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "current_page": 1.0,
    "items": [],
    "next_cursor": "example",
    "total_items": 1.0,
    "total_pages": 1.0
  }
}

Refresh connected account

Refresh connected account.

Inputs

NanoidnanoidtextRequired
The unique identifier of the connected account
Redirect urlredirect_urltext
Redirect url.
Body Redirect urlbody_redirect_urltext
Redirect url.

Outputs

dataobject
Response schema for a refreshed connected account authentication
Example output
{
  "data": {
    "id": "example",
    "redirect_url": "example",
    "status": "INITIALIZING"
  }
}

Update auth config

Update auth config.

Inputs

NanoidnanoidtextRequired
The unique identifier of the authentication configuration to update
TypetypetextRequired
Default for Composio-managed authentication, or Custom for your own OAuth credentials.One of: custom, default.
Namenametext
The display name of the authentication configuration
Credentialscredentialsobject
Credentials.
Sealed credentialssealed_credentialsobject
[EXPERIMENTAL] Client-sealed secret fields to redeem through the organization keyring instance (GET /api/v3.1/keyring/transfer_keys). The plaintext must not also appear in credentials. Rotates the stored client_secret without Composio ever holding it.
Proxy configproxy_configobject
Proxy config.
Restrict to following toolsrestrict_to_following_toolslist
List of tool slugs this auth config is restricted to use with. DEPRECATED: use [Get required scopes](https://docs.composio.dev/reference/api-reference/toolkits/recommendToolkitScopes) to resolve the scopes for the tools you need, then pass those scopes in `credentials.scopes`.
Tool access configtool_access_configobject
DEPRECATED: use [Get required scopes](https://docs.composio.dev/reference/api-reference/toolkits/recommendToolkitScopes) to resolve the scopes for the tools you need, then pass those scopes in `credentials.scopes`.
Shared credentialsshared_credentialsobject
Shared credentials inherited by all connected accounts using this auth config. Secret values are redacted in responses, so provide the real values when updating; omit this field to leave them unchanged. DEPRECATED: use `shared_connection_fields` instead. It takes the same value and behaves the same way.
Shared connection fieldsshared_connection_fieldsobject
Connection field values inherited by every connected account created under this auth config. Secret values are redacted in responses, so provide the real values when updating; omit this field to leave them unchanged.
Is enabled for tool routeris_enabled_for_tool_routertrue/false
Whether this auth config is enabled for tool router
Scopesscopestext
Comma-separated scopes, for a default auth configuration.
User scopesuser_scopestext
Comma-separated user scopes, for a default auth configuration.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "message": "example",
    "success": false
  }
}

Upsert trigger

Upsert trigger.

Inputs

SlugslugtextRequired
The slug of the trigger instance. Case-insensitive (internally normalized to uppercase).
Connected Auth IdconnectedAuthIdtext
DEPRECATED: This parameter will be removed in a future version. Please use connected_account_id instead.
Trigger ConfigtriggerConfigobject
DEPRECATED: This parameter will be removed in a future version. Please use trigger_config instead.
Connected account idconnected_account_idtext
Connected account nanoid. Optional when user_id is provided , the first active connection for that user and the trigger's toolkit is auto-resolved.
User idexternal_user_idtext
The user id (entity id) that owns the connection. When connected_account_id is omitted, the first active connection for this user and the trigger's toolkit is auto-resolved (same as tool execution). When connected_account_id is also provided, user_id is checked against that connection: always against a SHARED connection's ACL (user_id is then required), and against a PRIVATE connection's owner when the project has 2FA enabled.
Egress urlegress_urltext
Overrides the delivery URL for this trigger instance only: its events are sent to this HTTPS URL instead of the project webhook URL. Your project webhook subscription is still required and still controls signing (the webhook secret), the payload version and which events are enabled; only the destination changes for this instance. Omit to leave the current value unchanged; pass null to remove the override and deliver to the project webhook URL again.
Trigger configtrigger_configobject
Trigger configuration
Typetypetext
Whether this instance receives events by webhook or by polling, for a trigger that supports both. Omit it to let Composio choose the best one.One of: poll, webhook.
Polling intervalpolling_intervalnumber
Minutes between polls, for an instance that polls for its events. It is checked whenever the instance could poll, even when Composio tries a webhook first, so an interval outside the toolkit's allowed range fails the request.From 1 to 10080.
Versionversiontext
DEPRECATED: This parameter will be removed in a future version. Please use toolkit_versions instead.
Toolkit versionstoolkit_versionsobject
Toolkit version specification. Supports "latest" string or a record mapping toolkit slugs to specific versions.

Outputs

dataobject
Api result.
Example output
{
  "data": {
    "fallback_reason": "example",
    "polling_interval": 1,
    "trigger_id": "example",
    "type": "webhook"
  }
}

On this page