Skip to main content
POST
Run Tool
This endpoint can be used to call any Tool on behalf of your user. You can find specific input parameters for a Tool you want to call in the Tools Reference, for example: Each Tool in the Reference is an example call to this endpoint.

Output Modes

outputMode controls whether the provider body is returned on the execution or stored. When a Tool returns a large result (e.g. hundreds of CRM records), you can store the output server-side and receive a compact envelope instead of the full payload. A stored response has output.resultId and output.stored. output.inline is omitted.

Stored Result Envelope

  • output.stored is the envelope written with the stored body.
  • output.resultId (also available as stored.resultId) is an ID beginning with res_ that can be used to retrieve a stored result with Get Result or page through a records result with Get Result Rows.

Authorizations

Authorization
string
header
required

Your Paragon User Token (JWT), which you can generate using your project's signing keys.

Headers

Prefer
string

RFC 7240 wait. Default 25 seconds. wait=0 returns 202 immediately.

Example:

"wait=25"

Idempotency-Key
string

Stored on the row. Not used to replay an earlier execution.

x-paragon-credential
string

Forwarded as the execution credential. Omit to send none.

Path Parameters

projectId
string<uuid>
required

Body

application/json
intentName
string
required
Required string length: 1 - 512
args
object
timeoutMs
integer
default:60000
Required range: 1000 <= x <= 120000
outputMode
enum<string>
default:auto
Available options:
inline,
auto,
reference

Response

The call settled within the Prefer wait.

executionId
string
required
engine
enum<string>
required
Available options:
declarative
status
enum<string>
required
Available options:
running,
completed,
failed,
timeout,
cancelled
startedAt
string<date-time>
required
settledAt
string<date-time> | null
required
durationMs
number | null
required
calls
object[]
required
deadlineMs
number
killed
boolean
cancelledBy
enum<string>
Available options:
operator
output
object