workflows

GET /api/v1/workflows/runs/{runId}/stream

Changed on

Request

  • Base URL
    /api/v1 (relative, and the document was published on a file host, not at the API’s origin)
  • URL
    /api/v1/api/v1/workflows/runs/{runId}/stream
  • Auth
    none declared

Path parameters

runIdstring required

Query parameters

temporalRunIdstring
cursorstring
terminalCursorstring
logCursorstring date-time

Response

Server-sent events stream for workflow run updates

Changes

    • breaking

      added the pattern ^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d(?::[0-5]\d(?:\.\d+)?)?(?:Z))$ to the query request parameter logCursor

    • info

      for the query request parameter logCursor, the type was generalized from integer to string, and format from no format to date-time

    • info

      added the new optional query request parameter logCursor