API ReferenceTools

Execute proxy requestv3.1

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.

Authorization

ApiKeyAuth
x-api-key<token>

Project API key authentication

In: header

Request Body

application/json

connected_account_idstring

The ID of the connected account to use for authentication (if not provided, will use the default account for the project)

Format: connectedAccountId
endpointstringRequired

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

methodenumRequired

The HTTP method to use for the request

Possible values:
GETPOSTPUTDELETEPATCHHEAD
bodynullable object

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

binary_bodyobject | object

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

parametersarray of object

Additional HTTP headers or query parameters to include in the request

custom_connection_dataobjectDeprecated

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/api/v3.1/tools/execute/proxy" \  -H "Content-Type: application/json" \  -d '{    "endpoint": "/api/v1/resources",    "method": "GET"  }'
{  "data": {    "id": "123",    "name": "Resource Name",    "created_at": "2023-01-01T00:00:00Z"  },  "binary_data": {    "url": "string",    "content_type": "string",    "size": 0,    "expires_at": "string"  },  "status": 200,  "headers": {    "content-type": "application/json",    "cache-control": "no-cache",    "host": "api.example.com"  }}
Edit this page on GitHub