Invoke Connector Operation

Invoke a connector operation on a connection directly - no agent or task required. The response is the target API’s response.

POST /v1/tools/connectors/{connector_id}/connections/{connection_id}/{operation_id}

Invoke Connector Operation

cURL

curl --request POST \
  --url https://api.xpander.ai/v1/tools/connectors/{connector_id}/connections/{connection_id}/{operation_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "body_params": {
    "url": "https://example.com",
    "formats": [
      "markdown"
    ]
  }
}
'

200

{
  "success": true,
  "data": {
    "markdown": "# Example Domain\n\nThis domain is for use in documentation examples...",
    "metadata": {
      "title": "Example Domain",
      "sourceURL": "https://example.com",
      "statusCode": 200
    }
  }
}

New to connector invocation? Follow the end-to-end walkthrough in Invoke a Connector via API — it shows how to find each of the three IDs this endpoint needs.

You need three path IDs: the connector_id (shown in the connector page URL at chat.xpander.ai/connectors/{connector_id}), the connection_id (your org’s authenticated connection — find it in connections[].id from List Tools), and the operation_id (from List Connector Operations — its id or operationId both work). Pass _ as connector_id to resolve it from the connection.

The body follows the same RequestPayload schema the agent-controller uses: body_params (request body), query_params, path_params (by name), and headers (extra headers for the target API). All four are optional — send only what the operation needs. Use Get Connector Operation Schema to inspect the expected inputs first; its input schema uses exactly these three groups.

The operation runs with its spec-defined HTTP method regardless of this POST, the connection’s stored credentials are applied automatically, and the response is the target API’s response, passed through unchanged. Times out after 300s.

When the target API answers with an error, this endpoint returns the same status code, with the target’s response body in detail.

Authorizations

x-api-key · string · header · required

API Key for authentication

Path Parameters

connector_id · string · required

connection_id · string · required

operation_id · string · required

Body

application/json

body_params · Body Params · object | null

query_params · Query Params · object | null

path_params · Path Params · object | null

headers · Headers · object | null

Response

200

application/json

Successful Response