Skip to main content
POST
Execute tool

Authorizations

x-api-key
string
header
default:your-project-api-key
required

Your Composio project API key. Create or copy it from the Composio dashboard.

Headers

x-llm-gateway-headers
string

JSON object containing custom headers to pass to LLM providers (OpenAI, Bedrock, etc.)

Example:

"{\"x-custom-header\": \"value\", \"authorization\": \"Bearer token\"}"

Path Parameters

tool_slug
string
required

The tool slug to execute

Body

application/json
connected_account_id

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.

Available options:
instant_account
Example:

"ca_1a2b3c4d5e6f"

entity_id
string
deprecated

Deprecated: please use user_id instead. Entity identifier for multi-entity connected accounts (e.g. multiple repositories, organizations)

Example:

"repo-123"

user_id
string

User id for multi-user connected accounts (e.g. multiple users, organizations)

Example:

"user-123"

version
string

Tool version to execute. Defaults to the latest published version ("latest") when omitted.

Example:

"latest"

custom_auth_params
object

Custom authentication parameters for tools that support parameterized authentication

Example:
custom_connection_data
object

Custom connection data for tools that support custom connection data

Example:
arguments
object

Key-value pairs of arguments required by the tool (mutually exclusive with text)

Example:
text
string

Natural language description of the task to perform (mutually exclusive with arguments)

Example:

"Trigger the main workflow in the octocat/Hello-World repository on the main branch for the production environment"

allow_tracing
boolean | null
deprecated

Deprecated. Enable debug tracing for tool execution (useful for debugging)

Example:

false

Response

Successfully executed action and received response

data
object
required

Tool execution output data that varies based on the specific tool

Example:
error
string | null
required

Error message if the tool execution was not successful (null if successful)

successful
boolean
required

Indicates if the tool execution was successful

Example:

true

session_info
object | null

Optional session information for tools that return session context

Example:
log_id
string

Unique identifier for the execution log (useful for debugging and support)

Example:

"log_1a2b3c4d5e6f"