Skip to main content
POST
Typescript (SDK)

Authorizations

Authorization
string
header
required

API key in the format: Bearer {api_token}

Headers

Idempotency-Key
string

Makes this write safe to retry: a repeat with the same key replays the first response instead of creating a second resource. Scoped to the account, remembered for 24 hours; reusing a key with a different payload is an error.

Maximum string length: 255

Path Parameters

id
string
required

Unified public connection id, as returned by GET /connections/connected. Opaque — pass it back verbatim.

Body

application/json
tool
string
required

Tool name from GET /connections/{id}/tools

arguments
object

Tool-specific arguments

external_id
string

Target a specific linked account when several exist

Response

Tool executed

object
enum<string>
required
Available options:
connection_execution
connection
string
required

The connection public id

status
enum<string>
required
Available options:
executed
tool
string | null
result

Provider response