API

Every composio.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Connections

create

connections.create Create a connected-account auth link Risk: write

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

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

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`	No	—
`total_pages`	`number`	Yes	—
`current_page`	`number`	Yes	—
`total_items`	`number`	Yes	—

items full type

{
  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

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.

arguments full type

{
  toolkit?: string,
  connected_account_id?: string
}

Output

Name	Type	Required	Description
`data`	`object`	Yes	JSON object mapping string keys to JSON values
`error`	`string`	No	—
`successful`	`boolean`	Yes	—
`log_id`	`string`	No	—

data full type

Record<string, JsonValue>

checkActiveConnections

meta.checkActiveConnections COMPOSIO_CHECK_ACTIVE_CONNECTIONS: check many connections Risk: read

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.

arguments full type

{
  requests: {
    toolkit?: string,
    connected_account_id?: string
  }[]
}

Output

Name	Type	Required	Description
`data`	`object`	Yes	JSON object mapping string keys to JSON values
`error`	`string`	No	—
`successful`	`boolean`	Yes	—
`log_id`	`string`	No	—

data full type

Record<string, JsonValue>

createPlan

meta.createPlan COMPOSIO_CREATE_PLAN: plan a multi-step workflow Risk: read

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.

arguments full type

{
  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`	`object`	Yes	JSON object mapping string keys to JSON values
`error`	`string`	No	—
`successful`	`boolean`	Yes	—
`log_id`	`string`	No	—

data full type

Record<string, JsonValue>

enableTrigger

meta.enableTrigger COMPOSIO_ENABLE_TRIGGER: enable a trigger on an account Risk: write

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.

arguments full type

{
  connected_account_id: string,
  toolkit_slug: string,
  trigger_name: string,
  config_params?: Record<string, JsonValue>,
  user_id?: string
}

Output

Name	Type	Required	Description
`data`	`object`	Yes	JSON object mapping string keys to JSON values
`error`	`string`	No	—
`successful`	`boolean`	Yes	—
`log_id`	`string`	No	—

data full type

Record<string, JsonValue>

executeTool

meta.executeTool COMPOSIO_EXECUTE_TOOL: run one tool Risk: write

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.

arguments full type

{
  tool_slug: string,
  arguments: Record<string, JsonValue>,
  connected_account_id?: string,
  allow_destructive?: boolean
}

Output

Name	Type	Required	Description
`data`	`object`	Yes	JSON object mapping string keys to JSON values
`error`	`string`	No	—
`successful`	`boolean`	Yes	—
`log_id`	`string`	No	—

data full type

Record<string, JsonValue>

getDependencyGraph

meta.getDependencyGraph COMPOSIO_GET_DEPENDENCY_GRAPH: tools a tool depends on Risk: read

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.

arguments full type

{
  tool_name: string
}

Output

Name	Type	Required	Description
`data`	`object`	Yes	JSON object mapping string keys to JSON values
`error`	`string`	No	—
`successful`	`boolean`	Yes	—
`log_id`	`string`	No	—

data full type

Record<string, JsonValue>

getRequiredParameters

meta.getRequiredParameters COMPOSIO_GET_REQUIRED_PARAMETERS: auth fields of a toolkit Risk: read

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.

arguments full type

{
  toolkit: string
}

Output

Name	Type	Required	Description
`data`	`object`	Yes	JSON object mapping string keys to JSON values
`error`	`string`	No	—
`successful`	`boolean`	Yes	—
`log_id`	`string`	No	—

data full type

Record<string, JsonValue>

getResponseSchema

meta.getResponseSchema COMPOSIO_GET_RESPONSE_SCHEMA: output schema of a tool Risk: read

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.

arguments full type

{
  tool: string
}

Output

Name	Type	Required	Description
`data`	`object`	Yes	JSON object mapping string keys to JSON values
`error`	`string`	No	—
`successful`	`boolean`	Yes	—
`log_id`	`string`	No	—

data full type

Record<string, JsonValue>

getToolSchemas

meta.getToolSchemas COMPOSIO_GET_TOOL_SCHEMAS: input schemas by slug Risk: read

await corsair.composio.api.meta.getToolSchemas({});

Input

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

arguments full type

{
  tool_slugs: string[],
  include?: input_schema | output_schema[],
  session_id?: string
}

Output: object

Output full type

{
  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

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.

arguments full type

{
  toolkit: string,
  parameters?: Record<string, string>
}

Output

Name	Type	Required	Description
`data`	`object`	Yes	JSON object mapping string keys to JSON values
`error`	`string`	No	—
`successful`	`boolean`	Yes	—
`log_id`	`string`	No	—

data full type

Record<string, JsonValue>

listToolkits

meta.listToolkits COMPOSIO_LIST_TOOLKITS: list toolkits Risk: read

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.

arguments full type

{
  category?: string,
  name_filter?: string,
  min_tools?: number,
  no_auth_only?: boolean,
  size?: number
}

Output

Name	Type	Required	Description
`data`	`object`	Yes	JSON object mapping string keys to JSON values
`error`	`string`	No	—
`successful`	`boolean`	Yes	—
`log_id`	`string`	No	—

data full type

Record<string, JsonValue>

listTriggers

meta.listTriggers COMPOSIO_LIST_TRIGGERS: list trigger types Risk: read

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.

arguments full type

{
  toolkit_names?: string[]
}

Output

Name	Type	Required	Description
`data`	`object`	Yes	JSON object mapping string keys to JSON values
`error`	`string`	No	—
`successful`	`boolean`	Yes	—
`log_id`	`string`	No	—

data full type

Record<string, JsonValue>

manageConnections

meta.manageConnections COMPOSIO_MANAGE_CONNECTIONS: check or connect toolkits Risk: write

await corsair.composio.api.meta.manageConnections({});

Input

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

arguments full type

{
  toolkits: string[],
  reinitiate_all?: boolean,
  session_id?: string
}

Output: object

Output full type

{
  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

await corsair.composio.api.meta.multiExecuteTool({});

Input

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

arguments full type

{
  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

Output full type

{
  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

await corsair.composio.api.meta.remoteBashTool({});

Input

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

arguments full type

{
  command: string,
  session_id?: string
}

Output: object

Output full type

{
  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

await corsair.composio.api.meta.remoteWorkbench({});

Input

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

arguments full type

{
  code_to_execute: string,
  thought?: string,
  current_step?: string,
  current_step_metric?: string,
  session_id?: string
}

Output: object

Output full type

{
  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

await corsair.composio.api.meta.searchTools({});

Input

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

arguments full type

{
  queries: {
    use_case: string,
    known_fields?: string
  }[],
  session?: {
    generate_id: true
  } | {
    id: string
  },
  model?: string,
  search_strategy?: auto | tool_search
}

Output: object

Output full type

{
  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

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.

arguments full type

{
  toolkits: string[],
  mode?: 'any' | 'all',
  timeout_seconds?: number
}

Output

Name	Type	Required	Description
`data`	`object`	Yes	JSON object mapping string keys to JSON values
`error`	`string`	No	—
`successful`	`boolean`	Yes	—
`log_id`	`string`	No	—

data full type

Record<string, JsonValue>

waitForConnections

meta.waitForConnections COMPOSIO_WAIT_FOR_CONNECTIONS: wait inside a session Risk: read

await corsair.composio.api.meta.waitForConnections({});

Input

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

arguments full type

{
  toolkits: string[],
  mode?: 'any' | 'all',
  session_id?: string
}

Output: object

Output full type

{
  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

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

toolkits full type

{
  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	—

mcp full type

{
  type: http,
  url: string
}

config full type

{
  user_id?: string
}

Toolkits

list

toolkits.list List toolkits Risk: read

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`	No	—
`total_pages`	`number`	Yes	—
`current_page`	`number`	Yes	—
`total_items`	`number`	Yes	—

items full type

{
  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

await corsair.composio.api.tools.execute({});

Input

Name	Type	Required	Description
`tool_slug`	`string`	Yes	—
`arguments`	`object`	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.

arguments full type

Record<string, JsonValue>

Output

Name	Type	Required	Description
`data`	`object`	Yes	JSON object mapping string keys to JSON values
`error`	`string`	No	—
`successful`	`boolean`	Yes	—
`log_id`	`string`	No	—

data full type

Record<string, JsonValue>

get

tools.get Get a tool by slug Risk: read

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`	`object`	Yes	JSON object mapping string keys to JSON values
`output_parameters`	`object`	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	—

toolkit full type

{
  slug: string,
  name: string,
  logo?: string
}

input_parameters full type

Record<string, JsonValue>

output_parameters full type

Record<string, JsonValue>

list

tools.list List Composio tools Risk: read

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`	No	—
`total_pages`	`number`	Yes	—
`current_page`	`number`	Yes	—
`total_items`	`number`	Yes	—

items full type

{
  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
}[]

Overview

Plugins

Connections

create

delete

list

Meta

checkActiveConnection

checkActiveConnections

createPlan

enableTrigger

executeTool

getDependencyGraph

getRequiredParameters

getResponseSchema

getToolSchemas

initiateConnection

listToolkits

listTriggers

manageConnections

multiExecuteTool

remoteBashTool

remoteWorkbench

searchTools

waitForConnection

waitForConnections

Sessions

create

Toolkits

list

Tools

execute

get

list

​Connections

​create

​delete

​list

​Meta

​checkActiveConnection

​checkActiveConnections

​createPlan

​enableTrigger

​executeTool

​getDependencyGraph

​getRequiredParameters

​getResponseSchema

​getToolSchemas

​initiateConnection

​listToolkits

​listTriggers

​manageConnections

​multiExecuteTool

​remoteBashTool

​remoteWorkbench

​searchTools

​waitForConnection

​waitForConnections

​Sessions

​create

​Toolkits

​list

​Tools

​execute

​get

​list

Connections

create

delete

list

Meta

checkActiveConnection

checkActiveConnections

createPlan

enableTrigger

executeTool

getDependencyGraph

getRequiredParameters

getResponseSchema

getToolSchemas

initiateConnection

listToolkits

listTriggers

manageConnections

multiExecuteTool

remoteBashTool

remoteWorkbench

searchTools

waitForConnection

waitForConnections

Sessions

create

Toolkits

list

Tools

execute

get

list