Skip to main content
GET
Wait for an execution's status to change

Authorizations

X-Api-Key
string
header
required

Path Parameters

executionId
string<uuid>
required

Query Parameters

timeoutSeconds
integer<int32>

Seconds to wait for a change before returning 202. Defaults to 25.

Required range: 1 <= x <= 25

Response

The request has succeeded.

executionId
string<uuid>
required
returnReason
enum<string>
required

Why the call returned. After status_change or timed_out, follow the execution with GET /executions/{executionId}/sync. Never repeat an execute call: it starts another execution.

Available options:
ended,
needs_person,
status_change,
timed_out
status
enum<string>
required

The execution's status when the call returned: terminal on 200, the current status on 202

Available options:
queued,
starting,
running,
paused,
awaiting_confirmation,
completed,
cancelled,
failed,
paused_by_agent
awaitingConfirmation
object

Present when status is awaiting_confirmation: the node the execution holds at. Resume the execution to approve it.

executionResult
object

Outcome, reasoning and result data. Present on 200 when the execution recorded a result.