Skip to main content
POST
Execute proxy request within a tool router session

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.

Path Parameters

session_id
string<toolRouterSessionId>
required

Tool router session ID (required for public API, optional for internal - injected by middleware) The unique identifier of the tool router session. Required for public API endpoints, optional for internal endpoints where it is injected by middleware.

Example:

"trs_LX9uJKBinWWr"

Body

application/json
toolkit_slug
string
required

The slug of the toolkit to use for the request

Example:

"gmail"

endpoint
string
required

The API endpoint to call (absolute URL or path relative to base URL of the connected account)

Example:

"/api/v1/resources"

method
enum<string>
required

The HTTP method to use for the request

Available options:
GET,
POST,
PUT,
DELETE,
PATCH,
HEAD
Example:

"GET"

body
object | null

The request body (for POST, PUT, and PATCH requests)

Example:
binary_body
object

Binary body to send. For binary upload via URL: use {url: "https://...", content_type?: "..."}. For binary upload via base64: use {base64: "...", content_type?: "..."}.

parameters
object[]

Additional HTTP headers or query parameters to include in the request

Example:
custom_connection_data
object
deprecated

Response

Successfully executed proxy request and received response

result_type
enum<string>
required

The request was sent and the proxied API responded

Available options:
completed
status
number
required

The HTTP status code returned from the proxied API

Example:

200

data
object | null

The response data returned from the proxied API

Example:
binary_data
object

Binary body response data. Present when the response is a binary file.

headers
object

The HTTP headers returned from the proxied API

Example:
hook_results
object[]

Every session hook that applied to this request. Omitted when none applied.