← All Toolkits

Proxy Execute

COMPOSIO_PROXY_EXECUTE

Sends a raw HTTP request to a connected app's own API, authenticated with your connected account, for endpoints no Composio tool covers.

When to use it

Use `COMPOSIO_PROXY_EXECUTE` when no tool from `COMPOSIO_SEARCH_TOOLS` covers the endpoint you need. The toolkit needs an active connection first; call `COMPOSIO_MANAGE_CONNECTIONS` if it has none.

Enable it with `proxyExecute: true` in TypeScript or `proxy_execute=True` in Python. Compared with `session.proxyExecute()`, pass `toolkit_slug` instead of `toolkit`, use `type` instead of `in` for each parameter's location, and `method` also accepts `HEAD`. Composio attaches credentials. If the request cannot be sent, the tool returns `successful: false` with an `error`; an upstream non-2xx response returns normally in `data`, with its HTTP `status` and body. Large responses can be offloaded to the sandbox.

Input parameters

toolkit_slugstringRequired

Slug of the toolkit whose connected account authenticates the request, e.g. github.

endpointstringRequired

API path relative to the app's API base URL (e.g. /user/repos), or an absolute URL on the app's own API domain.

methodstringRequired

HTTP method.

Possible values: GETPOSTPUTDELETEPATCHHEAD
bodyany

JSON request body, for POST, PUT and PATCH requests.

parametersarray<object>

Extra HTTP headers or query parameters. Do not include credentials.

Response

dataobject
errorstring

Error if the request could not be sent.

successfulboolean

Whether the request was sent and a response received.