Skip to main content
POST
Test one of a connected integration’s tools

Authorizations

Authorization
string
header
required

Use JWT token for authentication

Path Parameters

id
string
required

Integration id

toolName
string
required

Tool slug, e.g. GMAIL_GET_PROFILE

Body

application/json
parameters
object

Arguments passed to the tool, as the app expects them. Omit for a tool that takes none.

Example:

Response

Success

success
boolean
required

Whether the app accepted and ran the call

executionTimeMs
number
required

Round trip to the app, in milliseconds

app
string
required

App the tool belongs to

Example:

"gmail"

tool
string
required

Tool slug that ran

Example:

"GMAIL_GET_PROFILE"

data
object

What the tool returned, exactly as the agent would receive it

error
string

Why it failed, in the app’s own words

requiresUserAction
boolean

True when the failure is the connection itself (expired or revoked account), not the arguments