Menu
Platform
AI
App store purchases
Database
Flags
Jobs and cron
Localization
Monitoring
Notifications
Payments
Queues
Sandboxes
Webhooks
Getting Started
Authentication
KV Store
Deploy & Infrastructure
Reference
On this page
Read history on a run
Reads a page of the Run's immutable history, projected to Sylphx events.
Reads a page of the Run's immutable history, projected to Sylphx events.
- Path
GET https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows/workflow/runs/run:readHistory - Scope
workflows:read - Effect
read— nothing is written. - Collection runs
- Query
page_size,page_token
#Request
| Field | Type | What it is |
|---|---|---|
name | string | The name of the run. Required. |
page_size | int32 | At most this many; default 100, clamped to 1000. |
page_token | string | next_page_token of the previous page. |
#Response
| Field | Type | What it is |
|---|---|---|
events | RunHistoryEvent[] | The page, oldest first. |
next_page_token | string | The token of the next page; empty on the last page. |
#RunHistoryEvent
| Field | Type | What it is |
|---|---|---|
sequence | int64 | Monotonic sequence number within the Run. Output only. |
event_time | timestamp | When the event happened. Output only. |
kind | RunHistoryEventKind | What happened. Output only. One of run_started, invocation, step_completed, sleep_started, signal_received, child_started, cancel_requested, run_closed. |
step | string | The step id, for step events. Output only. |
attempt | int32 | The attempt number, for invocation events. Output only. |
attempt_outcome | AttemptOutcome | The attempt outcome, for invocation events. Output only. One of invoked, protocol_error, rejected, retryable, unreached, unknown, unsigned. |
details | struct | Event details (step output, signal payload, error). Output only. |
#Errors
UNAUTHENTICATED— No valid key or token was presented.PERMISSION_DENIED— The key lacks the method's permission.INVALID_FIELD— A field failed validation.PAGE_TOKEN_MISMATCH— A page token was reused with different parameters.RESOURCE_NOT_FOUND— The named Resource does not exist or is not visible.
Every error arrives in the body Errors describes.
#Examples
curl "https://api.sylphx.com/v1/orgs/acme/projects/shop/envs/production/workflows/workflow/runs/run:readHistory" \
-H "Authorization: Bearer $SYLPHX_API_KEY"