Execute function
POST
Execute function

Authorizations

Authorization
string
header
required

Voiceflow bearer token

Path Parameters

functionID
string
required

Query Parameters

projectID
string
required

The ID of the project to operate on.

environmentAlias
string
required

The alias of the environment to operate on (e.g. main).

Body

inputs
object

A value for each of the function's input variables, keyed by input name. Every declared input needs a value, and a name the function does not declare is refused. List them with get_schema.

Response

200 - application/json

Returns the function's output variables, the exit path it chose, and the traces it emitted, with success, latencyMs, and error fields.

success
boolean
required

Whether the tool ran and reported no error.

latencyMs
number
required

How long the run took, in milliseconds, measured by this API around the call.

error
string
required

Why the run failed when success is false, otherwise null. Secret values read [secret].

truncated
boolean
required

Whether a returned payload was over 64 KB and was cut to its first 64 KB of JSON text, which then arrives as a string.

output
object
required

What the function returned, on failure too. Null only when general-runtime did not answer in time.

Use the up and down arrow keys to select a result, Enter to open it, and Escape to close the search.