--- title: "Execute proxy request" method: POST path: "/api/v3.1/tools/execute/proxy" tags: ["Tools", "Proxy"] --- # Execute proxy request `POST /api/v3.1/tools/execute/proxy` Proxy an HTTP request to a third-party API using connected account credentials. This endpoint allows making authenticated API calls to external services while abstracting away authentication details. v3.1 requires a proxy_execute scoped project API key; default project API keys are rejected. ## Request body - object - `connected_account_id` string, connectedAccountId — The ID of the connected account to use for authentication (if not provided, will use the default account for the project) - `endpoint` string, required — The API endpoint to call (absolute URL or path relative to base URL of the connected account) - `method` 'GET' | 'POST' | 'PUT' | 'DELETE' | 'PATCH' | 'HEAD', required — The HTTP method to use for the request - `body` unknown - `binary_body` union — Binary body to send. For binary upload via URL: use {url: "https://...", content_type?: "..."}. For binary upload via base64: use {base64: "...", content_type?: "..."}. - object - `url` string, uri, required — URL to fetch binary content from - `content_type` string — Content-Type header to use for the request - object - `base64` string, required — Base64-encoded binary data - `content_type` string — Content-Type header to use for the request - `parameters` object[] — Additional HTTP headers or query parameters to include in the request - `name` string, required — Parameter name - `value` string, required — Parameter value - `type` 'header' | 'query', required — Parameter type (header or query) - `custom_connection_data` union - object - `authScheme` 'OAUTH2', required - `toolkitSlug` string, required - `val` object, required - `subdomain` string - `your-domain` string - `region` string - `shop` string - `account_url` string - `COMPANYDOMAIN` string - `extension` string - `form_api_base_url` string - `instanceEndpoint` string - `api_url` string - `borneo_dashboard_url` string - `proxy_username` string - `proxy_password` string - `domain` string - `version` string - `dc` string - `site_name` string - `instanceName` string - `account_id` string - `your_server` string - `server_location` string - `base_url` string - `state_prefix` string — The oauth2 state prefix for the connection - `long_redirect_url` boolean — Whether to return the redirect url without shortening - `access_token` string, required - `id_token` string - `token_type` string - `refresh_token` string, nullable - `expires_in` union - number - string - unknown - `scope` union - string - string[] - unknown - `webhook_signature` string - `authed_user` object — for slack user scopes - `access_token` string - `scope` string - `extra_token_data` object - object - `authScheme` 'DCR_OAUTH', required - `toolkitSlug` string, required - `val` object, required - `subdomain` string - `your-domain` string - `region` string - `shop` string - `account_url` string - `COMPANYDOMAIN` string - `extension` string - `form_api_base_url` string - `instanceEndpoint` string - `api_url` string - `borneo_dashboard_url` string - `proxy_username` string - `proxy_password` string - `domain` string - `version` string - `dc` string - `site_name` string - `instanceName` string - `account_id` string - `your_server` string - `server_location` string - `base_url` string - `state_prefix` string — The oauth2 state prefix for the connection - `long_redirect_url` boolean — Whether to return the redirect url without shortening - `client_id` string, required — Dynamically registered client ID - `client_secret` string — Dynamically registered client secret - `access_token` string, required - `id_token` string - `token_type` string - `refresh_token` string, nullable - `expires_in` union - number - string - unknown - `scope` union - string - string[] - unknown - `client_id_issued_at` number - `client_secret_expires_at` number - object - `authScheme` 'API_KEY', required - `toolkitSlug` string, required - `val` object, required - `subdomain` string - `your-domain` string - `region` string - `shop` string - `account_url` string - `COMPANYDOMAIN` string - `extension` string - `form_api_base_url` string - `instanceEndpoint` string - `api_url` string - `borneo_dashboard_url` string - `proxy_username` string - `proxy_password` string - `domain` string - `version` string - `dc` string - `site_name` string - `instanceName` string - `account_id` string - `your_server` string - `server_location` string - `base_url` string - `generic_api_key` string - `api_key` string - `bearer_token` string - `basic_encoded` string - object - `authScheme` 'BASIC_WITH_JWT', required - `toolkitSlug` string, required - `val` object, required - `subdomain` string - `your-domain` string - `region` string - `shop` string - `account_url` string - `COMPANYDOMAIN` string - `extension` string - `form_api_base_url` string - `instanceEndpoint` string - `api_url` string - `borneo_dashboard_url` string - `proxy_username` string - `proxy_password` string - `domain` string - `version` string - `dc` string - `site_name` string - `instanceName` string - `account_id` string - `your_server` string - `server_location` string - `base_url` string - `username` string, required - `password` string, required - object - `authScheme` 'BASIC', required - `toolkitSlug` string, required - `val` object, required - `subdomain` string - `your-domain` string - `region` string - `shop` string - `account_url` string - `COMPANYDOMAIN` string - `extension` string - `form_api_base_url` string - `instanceEndpoint` string - `api_url` string - `borneo_dashboard_url` string - `proxy_username` string - `proxy_password` string - `domain` string - `version` string - `dc` string - `site_name` string - `instanceName` string - `account_id` string - `your_server` string - `server_location` string - `base_url` string - `username` string, required - `password` string - object - `authScheme` 'BEARER_TOKEN', required - `toolkitSlug` string, required - `val` object, required - `subdomain` string - `your-domain` string - `region` string - `shop` string - `account_url` string - `COMPANYDOMAIN` string - `extension` string - `form_api_base_url` string - `instanceEndpoint` string - `api_url` string - `borneo_dashboard_url` string - `proxy_username` string - `proxy_password` string - `domain` string - `version` string - `dc` string - `site_name` string - `instanceName` string - `account_id` string - `your_server` string - `server_location` string - `base_url` string - `token` string, required - object - `authScheme` 'OAUTH1', required - `toolkitSlug` string, required - `val` object, required - `subdomain` string - `your-domain` string - `region` string - `shop` string - `account_url` string - `COMPANYDOMAIN` string - `extension` string - `form_api_base_url` string - `instanceEndpoint` string - `api_url` string - `borneo_dashboard_url` string - `proxy_username` string - `proxy_password` string - `domain` string - `version` string - `dc` string - `site_name` string - `instanceName` string - `account_id` string - `your_server` string - `server_location` string - `base_url` string - `oauth_token` string, required - `oauth_token_secret` string, required - `oauth_verifier` string - `consumer_key` string - `redirectUrl` string - `callback_url` string - object - `authScheme` 'NO_AUTH', required - `toolkitSlug` string, required - `val` object, required - `subdomain` string - `your-domain` string - `region` string - `shop` string - `account_url` string - `COMPANYDOMAIN` string - `extension` string - `form_api_base_url` string - `instanceEndpoint` string - `api_url` string - `borneo_dashboard_url` string - `proxy_username` string - `proxy_password` string - `domain` string - `version` string - `dc` string - `site_name` string - `instanceName` string - `account_id` string - `your_server` string - `server_location` string - `base_url` string - object - `authScheme` 'SERVICE_ACCOUNT', required - `toolkitSlug` string, required - `val` object, required - `subdomain` string - `your-domain` string - `region` string - `shop` string - `account_url` string - `COMPANYDOMAIN` string - `extension` string - `form_api_base_url` string - `instanceEndpoint` string - `api_url` string - `borneo_dashboard_url` string - `proxy_username` string - `proxy_password` string - `domain` string - `version` string - `dc` string - `site_name` string - `instanceName` string - `account_id` string - `your_server` string - `server_location` string - `base_url` string - `application_id` string, required - `installation_id` string, required - `private_key` string, required - object - `authScheme` 'GOOGLE_SERVICE_ACCOUNT', required - `toolkitSlug` string, required - `val` object, required - `subdomain` string - `your-domain` string - `region` string - `shop` string - `account_url` string - `COMPANYDOMAIN` string - `extension` string - `form_api_base_url` string - `instanceEndpoint` string - `api_url` string - `borneo_dashboard_url` string - `proxy_username` string - `proxy_password` string - `domain` string - `version` string - `dc` string - `site_name` string - `instanceName` string - `account_id` string - `your_server` string - `server_location` string - `base_url` string - `credentials_json` string, required - object - `authScheme` 'S2S_OAUTH2', required - `toolkitSlug` string, required - `val` object, required - `subdomain` string - `your-domain` string - `region` string - `shop` string - `account_url` string - `COMPANYDOMAIN` string - `extension` string - `form_api_base_url` string - `instanceEndpoint` string - `api_url` string - `borneo_dashboard_url` string - `proxy_username` string - `proxy_password` string - `domain` string - `version` string - `dc` string - `site_name` string - `instanceName` string - `account_id` string - `your_server` string - `server_location` string - `base_url` string - `access_token` string, required - `token_type` string - `client_id` string - `client_secret` string - `expires_in` union - number - string - unknown - `expires_at` string - `scope` union - string - string[] - unknown ## Response `200` Successfully executed proxy request and received response - object - `data` unknown - `binary_data` object — Binary body response data. Present when the response is a binary file. - `url` string, required — URL to download binary content - `content_type` string, required — Content-Type of the binary data - `size` number, required — File size in bytes - `expires_at` string — ISO 8601 timestamp when the URL expires - `status` number, required — The HTTP status code returned from the proxied API - `headers` object — The HTTP headers returned from the proxied API ## Other responses - `400` — Bad request - Invalid request parameters or body format - `401` — Unauthorized - Authentication credentials are missing or invalid - `403` — Forbidden - Connected account does not have permission to access the requested resource - `404` — Not found - Resource not found or connected account not found - `422` — Unprocessable entity - Invalid state of the connected account - `429` — Too many requests - Rate limit exceeded on the connected account or proxy service - `500` — Internal server error - Something went wrong on the server - `501` — Not implemented - This operation is not supported for the requested connected account or authentication scheme --- [API](https://skmtc.net/composiohq/apis/composio-platform-api-v3-1.md) · [All operations](https://skmtc.net/composiohq/apis/composio-platform-api-v3-1/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/composiohq/composio-platform-api-v3-1/versions/4239836857f8/schema)