> ## Documentation Index
> Fetch the complete documentation index at: https://docs.corsair.dev/llms.txt
> Use this file to discover all available pages before exploring further.

# Composio API reference

> API reference for the Composio plugin in Corsair: every `composio.api.*` operation with its input and output types, taken from the plugin's Zod schemas.

> [!NOTE]
>
> **New to Corsair?** See [API access](https://docs.corsair.dev/concepts/api.md), [authentication](https://docs.corsair.dev/concepts/auth.md), and [error handling](https://docs.corsair.dev/concepts/error-handling).

## Connections

### create

`connections.create`

Create a connected-account auth link

**Risk:** `write`

```ts theme={null}
await corsair.composio.api.connections.create({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `auth_config_id` | `string` | Yes | — |
| `user_id` | `string` | Yes | — |
| `alias` | `string` | No | — |
| `callback_url` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `link_token` | `string` | Yes | — |
| `redirect_url` | `string` | Yes | — |
| `expires_at` | `string` | Yes | — |
| `connected_account_id` | `string` | Yes | — |

***

### delete

`connections.delete`

Delete a connected account

**Risk:** `destructive` · **Irreversible**

```ts theme={null}
await corsair.composio.api.connections.delete({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `connected_account_id` | `string` | Yes | — |
| `revoke_on_delete` | `boolean` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `success` | `boolean` | Yes | — |
| `revoke_job_id` | `string` | No | — |

***

### list

`connections.list`

List connected accounts

**Risk:** `read`

```ts theme={null}
await corsair.composio.api.connections.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `toolkit_slugs` | `string[]` | No | — |
| `statuses` | `(INITIALIZING \| INITIATED \| ACTIVE \| FAILED \| EXPIRED \| INACTIVE \| REVOKED)[]` | No | — |
| `user_ids` | `string[]` | No | — |
| `auth_config_ids` | `string[]` | No | — |
| `limit` | `number` | No | — |
| `cursor` | `string` | No | — |
| `account_type` | `PRIVATE \| SHARED \| ALL` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `items` | `object[]` | Yes | — |
| `next_cursor` | `string \| null` | No | — |
| `total_pages` | `number` | Yes | — |
| `current_page` | `number` | Yes | — |
| `total_items` | `number` | Yes | — |

> [accordion] items full type
>
> ```ts theme={null}
> {
>   id: string,
>   status: string,
>   user_id: string,
>   alias?: string | null,
>   created_at: string,
>   updated_at: string,
>   is_disabled: boolean,
>   toolkit: {
>     slug: string
>   },
>   auth_config: {
>     id: string,
>     auth_scheme?: string,
>     is_composio_managed?: boolean,
>     is_disabled?: boolean
>   },
>   authScheme?: string,
>   word_id?: string | null,
>   status_reason?: string | null
> }[]
> ```

***

## Meta

### checkActiveConnection

`meta.checkActiveConnection`

COMPOSIO\_CHECK\_ACTIVE\_CONNECTION: check one connection

**Risk:** `read`

```ts theme={null}
await corsair.composio.api.meta.checkActiveConnection({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `arguments` | `object` | Yes | — |
| `user_id` | `string` | No | Composio user the call runs for |
| `version` | `string` | No | Toolkit version. Composio runs the latest when omitted. |

> [accordion] arguments full type
>
> ```ts theme={null}
> {
>   toolkit?: string,
>   connected_account_id?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `Record<string, JsonValue>` | Yes | JSON object mapping string keys to JSON values |
| `error` | `string \| null` | Yes | — |
| `successful` | `boolean` | Yes | — |
| `log_id` | `string` | No | — |

***

### checkActiveConnections

`meta.checkActiveConnections`

COMPOSIO\_CHECK\_ACTIVE\_CONNECTIONS: check many connections

**Risk:** `read`

```ts theme={null}
await corsair.composio.api.meta.checkActiveConnections({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `arguments` | `object` | Yes | — |
| `user_id` | `string` | No | Composio user the call runs for |
| `version` | `string` | No | Toolkit version. Composio runs the latest when omitted. |

> [accordion] arguments full type
>
> ```ts theme={null}
> {
>   requests: {
>     toolkit?: string,
>     connected_account_id?: string
>   }[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `Record<string, JsonValue>` | Yes | JSON object mapping string keys to JSON values |
| `error` | `string \| null` | Yes | — |
| `successful` | `boolean` | Yes | — |
| `log_id` | `string` | No | — |

***

### createPlan

`meta.createPlan`

COMPOSIO\_CREATE\_PLAN: plan a multi-step workflow

**Risk:** `read`

```ts theme={null}
await corsair.composio.api.meta.createPlan({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `arguments` | `object` | Yes | — |
| `user_id` | `string` | No | Composio user the call runs for |
| `version` | `string` | No | Toolkit version. Composio runs the latest when omitted. |

> [accordion] arguments full type
>
> ```ts theme={null}
> {
>   difficulty: medium | hard,
>   known_fields: string,
>   primary_tool_slugs: string[],
>   reasoning: string,
>   use_case: string,
>   related_tool_slugs?: string[],
>   session_id?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `Record<string, JsonValue>` | Yes | JSON object mapping string keys to JSON values |
| `error` | `string \| null` | Yes | — |
| `successful` | `boolean` | Yes | — |
| `log_id` | `string` | No | — |

***

### enableTrigger

`meta.enableTrigger`

COMPOSIO\_ENABLE\_TRIGGER: enable a trigger on an account

**Risk:** `write`

```ts theme={null}
await corsair.composio.api.meta.enableTrigger({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `arguments` | `object` | Yes | — |
| `user_id` | `string` | No | Composio user the call runs for |
| `version` | `string` | No | Toolkit version. Composio runs the latest when omitted. |

> [accordion] arguments full type
>
> ```ts theme={null}
> {
>   connected_account_id: string,
>   toolkit_slug: string,
>   trigger_name: string,
>   config_params?: Record<string, JsonValue>,
>   user_id?: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `Record<string, JsonValue>` | Yes | JSON object mapping string keys to JSON values |
| `error` | `string \| null` | Yes | — |
| `successful` | `boolean` | Yes | — |
| `log_id` | `string` | No | — |

***

### executeTool

`meta.executeTool`

COMPOSIO\_EXECUTE\_TOOL: run one tool

**Risk:** `write`

```ts theme={null}
await corsair.composio.api.meta.executeTool({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `arguments` | `object` | Yes | — |
| `user_id` | `string` | No | Composio user the call runs for |
| `version` | `string` | No | Toolkit version. Composio runs the latest when omitted. |

> [accordion] arguments full type
>
> ```ts theme={null}
> {
>   tool_slug: string,
>   arguments: Record<string, JsonValue>,
>   connected_account_id?: string,
>   allow_destructive?: boolean
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `Record<string, JsonValue>` | Yes | JSON object mapping string keys to JSON values |
| `error` | `string \| null` | Yes | — |
| `successful` | `boolean` | Yes | — |
| `log_id` | `string` | No | — |

***

### getDependencyGraph

`meta.getDependencyGraph`

COMPOSIO\_GET\_DEPENDENCY\_GRAPH: tools a tool depends on

**Risk:** `read`

```ts theme={null}
await corsair.composio.api.meta.getDependencyGraph({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `arguments` | `object` | Yes | — |
| `user_id` | `string` | No | Composio user the call runs for |
| `version` | `string` | No | Toolkit version. Composio runs the latest when omitted. |

> [accordion] arguments full type
>
> ```ts theme={null}
> {
>   tool_name: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `Record<string, JsonValue>` | Yes | JSON object mapping string keys to JSON values |
| `error` | `string \| null` | Yes | — |
| `successful` | `boolean` | Yes | — |
| `log_id` | `string` | No | — |

***

### getRequiredParameters

`meta.getRequiredParameters`

COMPOSIO\_GET\_REQUIRED\_PARAMETERS: auth fields of a toolkit

**Risk:** `read`

```ts theme={null}
await corsair.composio.api.meta.getRequiredParameters({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `arguments` | `object` | Yes | — |
| `user_id` | `string` | No | Composio user the call runs for |
| `version` | `string` | No | Toolkit version. Composio runs the latest when omitted. |

> [accordion] arguments full type
>
> ```ts theme={null}
> {
>   toolkit: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `Record<string, JsonValue>` | Yes | JSON object mapping string keys to JSON values |
| `error` | `string \| null` | Yes | — |
| `successful` | `boolean` | Yes | — |
| `log_id` | `string` | No | — |

***

### getResponseSchema

`meta.getResponseSchema`

COMPOSIO\_GET\_RESPONSE\_SCHEMA: output schema of a tool

**Risk:** `read`

```ts theme={null}
await corsair.composio.api.meta.getResponseSchema({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `arguments` | `object` | Yes | — |
| `user_id` | `string` | No | Composio user the call runs for |
| `version` | `string` | No | Toolkit version. Composio runs the latest when omitted. |

> [accordion] arguments full type
>
> ```ts theme={null}
> {
>   tool: string
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `Record<string, JsonValue>` | Yes | JSON object mapping string keys to JSON values |
| `error` | `string \| null` | Yes | — |
| `successful` | `boolean` | Yes | — |
| `log_id` | `string` | No | — |

***

### getToolSchemas

`meta.getToolSchemas`

COMPOSIO\_GET\_TOOL\_SCHEMAS: input schemas by slug

**Risk:** `read`

```ts theme={null}
await corsair.composio.api.meta.getToolSchemas({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `session_id` | `string` | Yes | Session id from sessions.create |
| `arguments` | `object` | Yes | — |

> [accordion] arguments full type
>
> ```ts theme={null}
> {
>   tool_slugs: string[],
>   include?: (input_schema | output_schema)[],
>   session_id?: string
> }
> ```

**Output:** `object`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   result_type: completed | failed,
>   data: Record<string, JsonValue>,
>   error: string | null,
>   log_id: string
> } | {
>   result_type: input_required,
>   input_requests: Record<string, Record<string, JsonValue>>,
>   request_state?: string
> }
> ```

***

### initiateConnection

`meta.initiateConnection`

COMPOSIO\_INITIATE\_CONNECTION: start connecting a toolkit

**Risk:** `write`

```ts theme={null}
await corsair.composio.api.meta.initiateConnection({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `arguments` | `object` | Yes | — |
| `user_id` | `string` | No | Composio user the call runs for |
| `version` | `string` | No | Toolkit version. Composio runs the latest when omitted. |

> [accordion] arguments full type
>
> ```ts theme={null}
> {
>   toolkit: string,
>   parameters?: Record<string, string>
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `Record<string, JsonValue>` | Yes | JSON object mapping string keys to JSON values |
| `error` | `string \| null` | Yes | — |
| `successful` | `boolean` | Yes | — |
| `log_id` | `string` | No | — |

***

### listToolkits

`meta.listToolkits`

COMPOSIO\_LIST\_TOOLKITS: list toolkits

**Risk:** `read`

```ts theme={null}
await corsair.composio.api.meta.listToolkits({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `arguments` | `object` | Yes | — |
| `user_id` | `string` | No | Composio user the call runs for |
| `version` | `string` | No | Toolkit version. Composio runs the latest when omitted. |

> [accordion] arguments full type
>
> ```ts theme={null}
> {
>   category?: string,
>   name_filter?: string,
>   min_tools?: number,
>   no_auth_only?: boolean,
>   size?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `Record<string, JsonValue>` | Yes | JSON object mapping string keys to JSON values |
| `error` | `string \| null` | Yes | — |
| `successful` | `boolean` | Yes | — |
| `log_id` | `string` | No | — |

***

### listTriggers

`meta.listTriggers`

COMPOSIO\_LIST\_TRIGGERS: list trigger types

**Risk:** `read`

```ts theme={null}
await corsair.composio.api.meta.listTriggers({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `arguments` | `object` | Yes | — |
| `user_id` | `string` | No | Composio user the call runs for |
| `version` | `string` | No | Toolkit version. Composio runs the latest when omitted. |

> [accordion] arguments full type
>
> ```ts theme={null}
> {
>   toolkit_names?: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `Record<string, JsonValue>` | Yes | JSON object mapping string keys to JSON values |
| `error` | `string \| null` | Yes | — |
| `successful` | `boolean` | Yes | — |
| `log_id` | `string` | No | — |

***

### manageConnections

`meta.manageConnections`

COMPOSIO\_MANAGE\_CONNECTIONS: check or connect toolkits

**Risk:** `write`

```ts theme={null}
await corsair.composio.api.meta.manageConnections({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `session_id` | `string` | Yes | Session id from sessions.create |
| `arguments` | `object` | Yes | — |

> [accordion] arguments full type
>
> ```ts theme={null}
> {
>   toolkits: string[],
>   reinitiate_all?: boolean,
>   session_id?: string
> }
> ```

**Output:** `object`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   result_type: completed | failed,
>   data: Record<string, JsonValue>,
>   error: string | null,
>   log_id: string
> } | {
>   result_type: input_required,
>   input_requests: Record<string, Record<string, JsonValue>>,
>   request_state?: string
> }
> ```

***

### multiExecuteTool

`meta.multiExecuteTool`

COMPOSIO\_MULTI\_EXECUTE\_TOOL: run tools in parallel

**Risk:** `write`

```ts theme={null}
await corsair.composio.api.meta.multiExecuteTool({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `session_id` | `string` | Yes | Session id from sessions.create |
| `arguments` | `object` | Yes | — |

> [accordion] arguments full type
>
> ```ts theme={null}
> {
>   tools: {
>     tool_slug: string,
>     arguments: Record<string, JsonValue>
>   }[],
>   sync_response_to_workbench: boolean,
>   memory?: Record<string, string[]>,
>   thought?: string,
>   current_step?: string,
>   current_step_metric?: string,
>   session_id?: string
> }
> ```

**Output:** `object`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   result_type: completed | failed,
>   data: Record<string, JsonValue>,
>   error: string | null,
>   log_id: string
> } | {
>   result_type: input_required,
>   input_requests: Record<string, Record<string, JsonValue>>,
>   request_state?: string
> }
> ```

***

### remoteBashTool

`meta.remoteBashTool`

COMPOSIO\_REMOTE\_BASH\_TOOL: run bash in the sandbox

**Risk:** `write`

```ts theme={null}
await corsair.composio.api.meta.remoteBashTool({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `session_id` | `string` | Yes | Session id from sessions.create |
| `arguments` | `object` | Yes | — |

> [accordion] arguments full type
>
> ```ts theme={null}
> {
>   command: string,
>   session_id?: string
> }
> ```

**Output:** `object`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   result_type: completed | failed,
>   data: Record<string, JsonValue>,
>   error: string | null,
>   log_id: string
> } | {
>   result_type: input_required,
>   input_requests: Record<string, Record<string, JsonValue>>,
>   request_state?: string
> }
> ```

***

### remoteWorkbench

`meta.remoteWorkbench`

COMPOSIO\_REMOTE\_WORKBENCH: run Python in the sandbox

**Risk:** `write`

```ts theme={null}
await corsair.composio.api.meta.remoteWorkbench({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `session_id` | `string` | Yes | Session id from sessions.create |
| `arguments` | `object` | Yes | — |

> [accordion] arguments full type
>
> ```ts theme={null}
> {
>   code_to_execute: string,
>   thought?: string,
>   current_step?: string,
>   current_step_metric?: string,
>   session_id?: string
> }
> ```

**Output:** `object`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   result_type: completed | failed,
>   data: Record<string, JsonValue>,
>   error: string | null,
>   log_id: string
> } | {
>   result_type: input_required,
>   input_requests: Record<string, Record<string, JsonValue>>,
>   request_state?: string
> }
> ```

***

### searchTools

`meta.searchTools`

COMPOSIO\_SEARCH\_TOOLS: find tools for a use case

**Risk:** `read`

```ts theme={null}
await corsair.composio.api.meta.searchTools({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `session_id` | `string` | Yes | Session id from sessions.create |
| `arguments` | `object` | Yes | — |

> [accordion] arguments full type
>
> ```ts theme={null}
> {
>   queries: {
>     use_case: string,
>     known_fields?: string
>   }[],
>   session?: {
>     generate_id: true
>   } | {
>     id: string
>   },
>   model?: string,
>   search_strategy?: auto | tool_search
> }
> ```

**Output:** `object`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   result_type: completed | failed,
>   data: Record<string, JsonValue>,
>   error: string | null,
>   log_id: string
> } | {
>   result_type: input_required,
>   input_requests: Record<string, Record<string, JsonValue>>,
>   request_state?: string
> }
> ```

***

### waitForConnection

`meta.waitForConnection`

COMPOSIO\_WAIT\_FOR\_CONNECTION: wait until toolkits connect

**Risk:** `read`

```ts theme={null}
await corsair.composio.api.meta.waitForConnection({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `arguments` | `object` | Yes | — |
| `user_id` | `string` | No | Composio user the call runs for |
| `version` | `string` | No | Toolkit version. Composio runs the latest when omitted. |

> [accordion] arguments full type
>
> ```ts theme={null}
> {
>   toolkits: string[],
>   mode?: any | all,
>   timeout_seconds?: number
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `Record<string, JsonValue>` | Yes | JSON object mapping string keys to JSON values |
| `error` | `string \| null` | Yes | — |
| `successful` | `boolean` | Yes | — |
| `log_id` | `string` | No | — |

***

### waitForConnections

`meta.waitForConnections`

COMPOSIO\_WAIT\_FOR\_CONNECTIONS: wait inside a session

**Risk:** `read`

```ts theme={null}
await corsair.composio.api.meta.waitForConnections({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `session_id` | `string` | Yes | Session id from sessions.create |
| `arguments` | `object` | Yes | — |

> [accordion] arguments full type
>
> ```ts theme={null}
> {
>   toolkits: string[],
>   mode?: any | all,
>   session_id?: string
> }
> ```

**Output:** `object`

> [accordion] Output full type
>
> ```ts theme={null}
> {
>   result_type: completed | failed,
>   data: Record<string, JsonValue>,
>   error: string | null,
>   log_id: string
> } | {
>   result_type: input_required,
>   input_requests: Record<string, Record<string, JsonValue>>,
>   request_state?: string
> }
> ```

***

## Sessions

### create

`sessions.create`

Create a tool router session for a user

**Risk:** `write`

```ts theme={null}
await corsair.composio.api.sessions.create({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `user_id` | `string` | Yes | — |
| `toolkits` | `object` | No | Allowlist (enable) or denylist (disable) of toolkit slugs |

> [accordion] toolkits full type
>
> ```ts theme={null}
> {
>   enable: string[]
> } | {
>   disable: string[]
> }
> ```

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `session_id` | `string` | Yes | — |
| `mcp` | `object` | Yes | — |
| `tool_router_tools` | `string[]` | Yes | — |
| `config` | `object` | No | — |
| `config_version` | `number` | No | — |

> [accordion] mcp full type
>
> ```ts theme={null}
> {
>   type: http,
>   url: string
> }
> ```

> [accordion] config full type
>
> ```ts theme={null}
> {
>   user_id?: string
> }
> ```

***

## Toolkits

### list

`toolkits.list`

List toolkits

**Risk:** `read`

```ts theme={null}
await corsair.composio.api.toolkits.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `category` | `string` | No | — |
| `managed_by` | `composio \| all \| project` | No | — |
| `type` | `native \| custom \| all` | No | — |
| `sort_by` | `usage \| alphabetically` | No | — |
| `search` | `string` | No | — |
| `include_deprecated` | `boolean` | No | — |
| `limit` | `number` | No | — |
| `cursor` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `items` | `object[]` | Yes | — |
| `next_cursor` | `string \| null` | No | — |
| `total_pages` | `number` | Yes | — |
| `current_page` | `number` | Yes | — |
| `total_items` | `number` | Yes | — |

> [accordion] items full type
>
> ```ts theme={null}
> {
>   slug: string,
>   name: string,
>   type: string,
>   auth_schemes?: string[],
>   no_auth?: boolean,
>   composio_managed_auth_schemes?: string[],
>   is_local_toolkit?: boolean,
>   auth_guide_url?: string | null,
>   meta: {
>     created_at?: string,
>     updated_at?: string,
>     description?: string,
>     logo?: string,
>     app_url?: string | null,
>     categories?: {
>       id: string,
>       name: string
>     }[],
>     triggers_count?: number,
>     tools_count?: number,
>     version?: string
>   }
> }[]
> ```

***

## Tools

### execute

`tools.execute`

Execute a tool by slug

**Risk:** `write`

```ts theme={null}
await corsair.composio.api.tools.execute({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `tool_slug` | `string` | Yes | — |
| `arguments` | `Record<string, JsonValue>` | Yes | Arguments the tool takes |
| `connected_account_id` | `string` | No | — |
| `user_id` | `string` | No | — |
| `version` | `string` | No | Toolkit version. Composio runs the latest when omitted. |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `data` | `Record<string, JsonValue>` | Yes | JSON object mapping string keys to JSON values |
| `error` | `string \| null` | Yes | — |
| `successful` | `boolean` | Yes | — |
| `log_id` | `string` | No | — |

***

### get

`tools.get`

Get a tool by slug

**Risk:** `read`

```ts theme={null}
await corsair.composio.api.tools.get({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `tool_slug` | `string` | Yes | — |
| `version` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `slug` | `string` | Yes | — |
| `name` | `string` | Yes | — |
| `description` | `string` | Yes | — |
| `toolkit` | `object` | Yes | — |
| `input_parameters` | `Record<string, JsonValue>` | Yes | JSON object mapping string keys to JSON values |
| `output_parameters` | `Record<string, JsonValue>` | Yes | JSON object mapping string keys to JSON values |
| `no_auth` | `boolean` | Yes | — |
| `version` | `string` | Yes | — |
| `available_versions` | `string[]` | Yes | — |
| `scopes` | `string[]` | No | — |
| `tags` | `string[]` | Yes | — |
| `human_description` | `string` | No | — |
| `is_deprecated` | `boolean` | Yes | — |

> [accordion] toolkit full type
>
> ```ts theme={null}
> {
>   slug: string,
>   name: string,
>   logo?: string
> }
> ```

***

### list

`tools.list`

List Composio tools

**Risk:** `read`

```ts theme={null}
await corsair.composio.api.tools.list({});
```

**Input**

| Name | Type | Required | Description |
| - | - | - | - |
| `toolkit_slug` | `string` | No | — |
| `tool_slugs` | `string` | No | Comma-separated tool slugs |
| `query` | `string` | No | — |
| `important` | `true \| false` | No | — |
| `include_deprecated` | `boolean` | No | — |
| `toolkit_versions` | `string` | No | — |
| `limit` | `number` | No | — |
| `cursor` | `string` | No | — |

**Output**

| Name | Type | Required | Description |
| - | - | - | - |
| `items` | `object[]` | Yes | — |
| `next_cursor` | `string \| null` | No | — |
| `total_pages` | `number` | Yes | — |
| `current_page` | `number` | Yes | — |
| `total_items` | `number` | Yes | — |

> [accordion] items full type
>
> ```ts theme={null}
> {
>   slug: string,
>   name: string,
>   description: string,
>   toolkit: {
>     slug: string,
>     name: string,
>     logo?: string
>   },
>   input_parameters: Record<string, JsonValue>,
>   output_parameters: Record<string, JsonValue>,
>   no_auth: boolean,
>   version: string,
>   available_versions: string[],
>   scopes?: string[],
>   tags: string[],
>   human_description?: string,
>   is_deprecated: boolean
> }[]
> ```

***


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.