Skip to content

Get a run

Reads a run’s status and how far each persona has got. Ask again every so often to follow a run.

GET/v1/runs/:id

Needs the runs:read scope.

Path

idstringRequired
The run’s id, as Start a run returns it (for example run_8f3k2).

Response

statusstring
queued, running, finished, cancelled or failed.
statestring
Where each persona is: running, stuck or finished.
outcomestring
How each persona did, once it ends: done, slowed or stuck.

When the run finishes, read its report.