Get paginated workflow execution history for a specific run
Changed onget/workflow/{id}/runs/{rid}/history
Request
- Base URLhttp://localhost:3001
- Authnone required
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Path parameters
idstring required
The workflow execution ID
ridstring uuid required
The specific run id to target
Query parameters
pageSizeinteger
Number of events per page
pageTokenstring
Base64 pagination token from previous response
includePayloadsboolean
Include decoded input/output payloads in events
longPollTimeoutMsinteger
When set, long-poll for a new event once caught up to the end of history instead of returning immediately, bounding the block by this many milliseconds. Clamped to the server's configured maximum — a caller can shorten the wait but never exceed it. Omit for an immediate response; on timeout returns the same page's cursor unchanged with an empty events array so the caller can retry. Lets a poller keep the block roughly aligned with its own tick interval.
Response
Paginated history events
Changes
- info
added the new optional
queryrequest parameterlongPollTimeoutMs
- info
- info
endpoint added
- info