Client.workflow_run¶
Beta: This API may change shape in 0.1.x. It is not a frozen 1.0 contract.
Fetch a workflow run by id (beta).
Server: GET /api/workflow-runs/{id}/.
Signature¶
workflow_run(run_id: str) -> WorkflowRun
Parameters¶
| Name | Type | Required | Default |
|---|---|---|---|
run_id |
str |
yes | - |
HTTP parameters¶
| Name | In | Type | Required | Default |
|---|---|---|---|---|
run_id |
path |
string |
yes | - |
Fields¶
| Field |
|---|
run_id |
Return shape¶
HTTP 200 — OK
Schema: WorkflowRunOut
| Field | Type | Required |
|---|---|---|
actor_snapshot |
object |
no |
automation_principal_id |
string |
no |
created_at |
string |
yes |
depth |
integer |
no |
enabled_by_id |
string |
no |
event_id |
string |
no |
finished_at |
string |
no |
id |
string |
yes |
initiated_by_id |
string |
no |
started_at |
string |
no |
status |
string |
yes |
steps_snapshot |
array<object> |
no |
trigger_id |
string |
no |
trigger_snapshot |
object |
no |
workflow_id |
string |
yes |
Permission¶
Required permission: Any signed-in user
HTTP¶
GET /api/workflow-runs/{run_id}/ (getWorkflowRun)
Usage¶
client.workflow_run(run_id)