Automation Runs

List paginated run history#

Returns runs for the automation ordered by `created_at` descending. Defaults: `page=1`, `limit=20`. Maximum `limit` is 100. If `spaceId` is provided it is validated against the automation's actual space.

Parameter

Antworten

• 200Array of automation runs
• 400spaceId does not match this automation
• 401Not authenticated
• 404Automation not found

curl -X GET "https://xapi.ambertech.cloud/api/v1/automations/{id}/runs" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Get run details with all steps#

Returns the full run record alongside all its execution steps ordered by `step_index`. Each step includes `input`, `output`, `error_message`, and timing fields. If `spaceId` is provided it is validated against the automation's actual space.

Parameter

Antworten

• 200`{ run: IAutomationRun, steps: IAutomationRunStep[] }`
• 400spaceId does not match this automation
• 401Not authenticated
• 404Automation or run not found

curl -X GET "https://xapi.ambertech.cloud/api/v1/automations/{id}/runs/{runId}" \
  -H "Authorization: Bearer $XISUITE_TOKEN"

Cancel an in-progress run#

Stops a `running` or `queued` run. Sets all `pending` and `running` steps to `cancelled` with an error message indicating who cancelled it. Returns 409 if the run is already in a terminal state (`succeeded`, `failed`, `cancelled`). `spaceId` in the body must match the automation's actual space.

Parameter

Request-Bodyapplication/jsonRunActionDto

Antworten

• 200`{ runId }` of the cancelled run
• 400spaceId required or does not match this automation
• 401Not authenticated
• 403Insufficient space permissions
• 404Automation or run not found
• 409Run is already in a terminal state

curl -X POST "https://xapi.ambertech.cloud/api/v1/automations/{id}/runs/{runId}/cancel" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"spaceId":"…"}'

Retry a failed run with the same payload#

Creates a new run using the same `trigger_payload` and `automation_version_id` as the original run. Seeds the first actionable step nodes (non-trigger nodes with no incoming edges) as `pending`. Returns 201 with the new `runId`. `spaceId` in the body must match the automation's actual space.

Parameter

Request-Bodyapplication/jsonRunActionDto

Antworten

• 201`{ runId }` of the newly created retry run
• 400spaceId required or does not match this automation
• 401Not authenticated
• 403Insufficient space permissions
• 404Automation or original run not found
• 500Failed to create retry run

curl -X POST "https://xapi.ambertech.cloud/api/v1/automations/{id}/runs/{runId}/retry" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"spaceId":"…"}'

Continue a paused step (resume from debug breakpoint)#

Resets a `paused` step back to `pending` so the worker executes it on the next cycle. Also re-opens the parent run if it is not already `running`.

Parameter

Request-Bodyapplication/json

Antworten

• 200Step resumed — status set to pending
• 400Step is not paused or spaceId mismatch
• 404Step not found

curl -X POST "https://xapi.ambertech.cloud/api/v1/automations/{id}/runs/{runId}/steps/{stepId}/continue" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"spaceId":"…"}'

Replay a failed step#

Resets a `failed` step back to `pending` so the worker picks it up on the next cycle. Optionally accepts a custom `payload` to replace the step input. Re-opens the parent run if it is in a terminal state.

Parameter

Request-Bodyapplication/json

Antworten

• 200Step reset to pending
• 400Step is not in failed state or spaceId mismatch
• 404Step not found

curl -X POST "https://xapi.ambertech.cloud/api/v1/automations/{id}/runs/{runId}/steps/{stepId}/replay" \
  -H "Authorization: Bearer $XISUITE_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"spaceId":"…"}'

Stream live run status via Server-Sent Events#

Parameter

Antworten

• 200OK

curl -X GET "https://xapi.ambertech.cloud/api/v1/automations/{id}/runs/{runId}/stream" \
  -H "Authorization: Bearer $XISUITE_TOKEN"