# Composio

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

App · 20 actions. Web page: https://docs.lodol.com/docs/integrations/composio

## Actions

### Create auth config

Create auth config.

**Inputs**

- Toolkit (`toolkit`, object, required): Toolkit.
- Auth config (`auth_config`, object): Auth config.

**Outputs**

- `data` (object): Api result.

**Example output**

```json
{
  "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 config (`auth_config`, object, required): Auth config.
- Connection (`connection`, object, required): Connection.

**Outputs**

- `data` (object): Api result.

**Example output**

```json
{
  "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**

- Nanoid (`nanoid`, text, required): The unique identifier of the authentication configuration to delete
- Revoke on delete (`revoke_on_delete`, true/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**

- `data` (object): Api result.

**Example output**

```json
{
  "data": {
    "message": "example",
    "revoke_job_id": "example",
    "success": false
  }
}
```

### Delete connected account

Delete connected account.

**Inputs**

- Nanoid (`nanoid`, text, required): The unique identifier (nanoid) of the connected account
- Revoke on delete (`revoke_on_delete`, true/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**

- `data` (object): Response returned after successfully deleting a connected account

**Example output**

```json
{
  "data": {
    "revoke_job_id": "example",
    "success": false
  }
}
```

### Delete trigger

Delete trigger.

**Inputs**

- Trigger Id (`triggerId`, text, required): The ID of the trigger instance to delete

**Outputs**

- `data` (object): Api result.

**Example output**

```json
{
  "data": {
    "trigger_id": "example"
  }
}
```

### Execute tool

Execute tool.

**Inputs**

- Tool slug (`tool_slug`, text, required): The tool slug to execute
- Connected account id (`connected_account_id`, text): 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 id (`entity_id`, text): Deprecated: please use user_id instead. Entity identifier for multi-entity connected accounts (e.g. multiple repositories, organizations)
- User id (`external_user_id`, text): User id for multi-user connected accounts (e.g. multiple users, organizations)
- Version (`version`, text): Tool version to execute. Defaults to the latest published version ("latest") when omitted.
- Custom auth params (`custom_auth_params`, object): Custom authentication parameters for tools that support parameterized authentication
- Custom connection data (`custom_connection_data`, object): Custom connection data for tools that support custom connection data
- Arguments (`arguments`, object): Key-value pairs of arguments required by the tool (mutually exclusive with text)
- Text (`text`, text): Natural language description of the task to perform (mutually exclusive with arguments)
- Allow tracing (`allow_tracing`, true/false): Deprecated. Enable debug tracing for tool execution (useful for debugging)

**Outputs**

- `data` (object): Api result.

**Example output**

```json
{
  "data": {
    "data": {},
    "error": "example",
    "log_id": "example",
    "session_info": "example",
    "successful": false
  }
}
```

### Get auth config

Get auth config.

**Inputs**

- Nanoid (`nanoid`, text, required): The unique identifier of the authentication configuration to retrieve

**Outputs**

- `data` (object): Api result.

**Example output**

```json
{
  "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**

- Nanoid (`nanoid`, text, required): The unique identifier (nanoid) of the connected account

**Outputs**

- `data` (object): Api result.

**Example output**

```json
{
  "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 slug (`tool_slug`, text, required): The unique slug identifier of the tool
- Include pricing (`include_pricing`, true/false): Whether to include published pricing within instant, when available. Defaults to false.
- Version (`version`, text): 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 versions (`toolkit_versions`, object): 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**

- `data` (object): Api result.

**Example output**

```json
{
  "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**

- Slug (`slug`, text, required): The unique slug identifier of the toolkit to retrieve
- Version (`version`, text): Version of the toolkit

**Outputs**

- `data` (object): Detailed information about a single toolkit

**Example output**

```json
{
  "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**

- Slug (`slug`, text, required): The unique slug identifier for the trigger type. Case-insensitive (internally normalized to uppercase).
- Toolkit versions (`toolkit_versions`, object): Toolkit version specification. Use "latest" for latest versions or bracket notation for specific versions per toolkit.

**Outputs**

- `data` (object): Api result.

**Example output**

```json
{
  "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 ids (`user_ids`, list): Array of user IDs to filter triggers by
- Connected account ids (`connected_account_ids`, list): Array of connected account IDs to filter triggers by
- Auth config ids (`auth_config_ids`, list): Array of auth config IDs to filter triggers by
- Trigger ids (`trigger_ids`, list): Array of trigger IDs to filter triggers by
- Trigger names (`trigger_names`, list): Array of trigger names to filter triggers by. Case-insensitive (internally normalized to uppercase).
- Connected Account Ids (`connectedAccountIds`, list): DEPRECATED: This parameter will be removed in a future version. Please use connected_account_ids instead.
- Auth Config Ids (`authConfigIds`, list): DEPRECATED: This parameter will be removed in a future version. Please use auth_config_ids instead.
- Trigger Ids (`triggerIds`, list): DEPRECATED: This parameter will be removed in a future version. Please use trigger_ids instead.
- Show disabled (`show_disabled`, true/false): When set to true, includes disabled triggers in the response.
- Trigger Names (`triggerNames`, list): DEPRECATED: This parameter will be removed in a future version. Please use trigger_names instead.
- Show Disabled (`showDisabled`, true/false): DEPRECATED: Use show_disabled instead
- Deprecated Connected Account Uuids (`deprecatedConnectedAccountUuids`, list): Array of connected account UUIDs to filter triggers by
- Deprecated Auth Config Uuids (`deprecatedAuthConfigUuids`, list): Array of auth config UUIDs to filter triggers by
- Limit (`limit`, number): Number of items per page, max allowed is 50
- Cursor (`cursor`, text): 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**

- `data` (object): Api result.

**Example output**

```json
{
  "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 managed (`is_composio_managed`, text): Whether to filter by composio managed auth configs
- Toolkit slug (`toolkit_slug`, text): Comma-separated list of toolkit slugs to filter auth configs by
- Deprecated app id (`deprecated_app_id`, text): DEPRECATED: This parameter will be removed in a future version. Please use toolkit_slug instead.
- Deprecated status (`deprecated_status`, text): DEPRECATED: This parameter will be removed in a future version.
- Show disabled (`show_disabled`, true/false): Show disabled auth configs
- Search (`search`, text): Search auth configs by name or id
- Limit (`limit`, number): Number of items per page, max allowed is 200
- Cursor (`cursor`, text): 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**

- `data` (object): Api result.

**Example output**

```json
{
  "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 slugs (`toolkit_slugs`, list): The toolkit slugs of the connected accounts
- Statuses (`statuses`, list): The status of the connected account. One or more of: `INITIALIZING`, `INITIATED`, `ACTIVE`, `FAILED`, `EXPIRED`, `INACTIVE`, `REVOKED`.
- Cursor (`cursor`, text): The cursor to paginate through the connected accounts
- Limit (`limit`, number): The limit of the connected accounts to return
- User ids (`user_ids`, list): The user ids of the connected accounts
- Auth config ids (`auth_config_ids`, list): The auth config ids of the connected accounts
- Connected account ids (`connected_account_ids`, list): The connected account ids to filter by
- Order by (`order_by`, text): The order by of the connected accounts. One of: `created_at` (Created at), `updated_at` (Updated at).
- Order direction (`order_direction`, text): The order direction of the connected accounts. One of: `asc`, `desc`.
- Account type (`account_type`, text): [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**

- `data` (object): Api result.

**Example output**

```json
{
  "data": {
    "current_page": 1.0,
    "items": [],
    "next_cursor": "example",
    "total_items": 1.0,
    "total_pages": 1.0
  }
}
```

### List toolkits

List toolkits.

**Inputs**

- Category (`category`, text): Category ID or name to filter toolkits by
- Managed by (`managed_by`, text): Deprecated: Entity responsible for managing the toolkits. One of: `composio`, `all`, `project`.
- Type (`type`, text): 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 by (`sort_by`, text): Determines how toolkits should be sorted in the response. One of: `usage`, `alphabetically`.
- Include deprecated (`include_deprecated`, true/false): Include deprecated toolkits in the response
- Search (`search`, text): Search query to filter toolkits by name, slug, or description (minimum 1 character)
- User id (`external_user_id`, text): List the custom toolkits this user can use. Without it, only custom toolkits with access "all" are listed.
- Limit (`limit`, number): Number of items per page, max allowed is 1000
- Cursor (`cursor`, text): 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**

- `data` (object): Api result.

**Example output**

```json
{
  "data": {
    "current_page": 1.0,
    "items": [],
    "next_cursor": "example",
    "total_items": 1.0,
    "total_pages": 1.0
  }
}
```

### List tools

List tools.

**Inputs**

- Toolkit slug (`toolkit_slug`, text): The slug of the toolkit to filter by
- Tool slugs (`tool_slugs`, text): Comma-separated list of specific tool slugs to retrieve (overrides other filters)
- Auth config ids (`auth_config_ids`, text): 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.
- Important (`important`, text): Filter to only show important/featured tools (set to "true" to enable). One of: `true`, `false`.
- Tags (`tags`, list): Filter tools by one or more tags (can be specified multiple times)
- Scopes (`scopes`, list): Filter tools by one or more scopes (can be specified multiple times)
- Query (`query`, text): Full-text search query to filter tools by name, slug, or description. Applied as a soft filter on top of other filters.
- Search (`search`, text): Deprecated: use "query" instead. Free-text search query to find tools by name, description, or functionality.
- Include deprecated (`include_deprecated`, true/false): Include deprecated tools in the response
- Include pricing (`include_pricing`, true/false): Whether to include published pricing within instant, when available. Defaults to false.
- Toolkit versions (`toolkit_versions`, object): 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.
- Limit (`limit`, number): Number of items per page, max allowed is 1000
- Cursor (`cursor`, text): 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**

- `data` (object): Api result.

**Example output**

```json
{
  "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 slugs (`toolkit_slugs`, list): Array of toolkit slugs to filter triggers by
- Toolkit versions (`toolkit_versions`, object): Toolkit version specification. Use "latest" for latest versions or bracket notation for specific versions per toolkit.
- Limit (`limit`, number): Number of items per page, max allowed is 50
- Cursor (`cursor`, text): 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**

- `data` (object): Api result.

**Example output**

```json
{
  "data": {
    "current_page": 1.0,
    "items": [],
    "next_cursor": "example",
    "total_items": 1.0,
    "total_pages": 1.0
  }
}
```

### Refresh connected account

Refresh connected account.

**Inputs**

- Nanoid (`nanoid`, text, required): The unique identifier of the connected account
- Redirect url (`redirect_url`, text): Redirect url.
- Body Redirect url (`body_redirect_url`, text): Redirect url.

**Outputs**

- `data` (object): Response schema for a refreshed connected account authentication

**Example output**

```json
{
  "data": {
    "id": "example",
    "redirect_url": "example",
    "status": "INITIALIZING"
  }
}
```

### Update auth config

Update auth config.

**Inputs**

- Nanoid (`nanoid`, text, required): The unique identifier of the authentication configuration to update
- Type (`type`, text, required): Default for Composio-managed authentication, or Custom for your own OAuth credentials. One of: `custom`, `default`.
- Name (`name`, text): The display name of the authentication configuration
- Credentials (`credentials`, object): Credentials.
- Sealed credentials (`sealed_credentials`, object): [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 config (`proxy_config`, object): Proxy config.
- Restrict to following tools (`restrict_to_following_tools`, list): 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 config (`tool_access_config`, object): 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 credentials (`shared_credentials`, object): 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 fields (`shared_connection_fields`, object): 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 router (`is_enabled_for_tool_router`, true/false): Whether this auth config is enabled for tool router
- Scopes (`scopes`, text): Comma-separated scopes, for a default auth configuration.
- User scopes (`user_scopes`, text): Comma-separated user scopes, for a default auth configuration.

**Outputs**

- `data` (object): Api result.

**Example output**

```json
{
  "data": {
    "message": "example",
    "success": false
  }
}
```

### Upsert trigger

Upsert trigger.

**Inputs**

- Slug (`slug`, text, required): The slug of the trigger instance. Case-insensitive (internally normalized to uppercase).
- Connected Auth Id (`connectedAuthId`, text): DEPRECATED: This parameter will be removed in a future version. Please use connected_account_id instead.
- Trigger Config (`triggerConfig`, object): DEPRECATED: This parameter will be removed in a future version. Please use trigger_config instead.
- Connected account id (`connected_account_id`, text): 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 id (`external_user_id`, text): 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 url (`egress_url`, text): 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 config (`trigger_config`, object): Trigger configuration
- Type (`type`, text): 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 interval (`polling_interval`, number): 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.
- Version (`version`, text): DEPRECATED: This parameter will be removed in a future version. Please use toolkit_versions instead.
- Toolkit versions (`toolkit_versions`, object): Toolkit version specification. Supports "latest" string or a record mapping toolkit slugs to specific versions.

**Outputs**

- `data` (object): Api result.

**Example output**

```json
{
  "data": {
    "fallback_reason": "example",
    "polling_interval": 1,
    "trigger_id": "example",
    "type": "webhook"
  }
}
```
