Skip to content
Kindgi

Server-Sent Events stream of a run's progress

GET
/v1/runs/{runId}/progress/stream
curl --request GET \
  --url https://example.com/v1/runs/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/progress/stream \
  --header 'Authorization: Bearer <token>'

Each SSE frame is one RunProgressEvent: what happened, on which node, when — no payloads. Accepts an API token, or a public run token that names the run or one of its ancestors. Reconnect via Last-Event-Id; the server ends the stream after the run’s terminal event, or after 5 minutes.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
runId
required
string format: uuid

RunId — opaque branded string (a UUID).

Header Parameters

Section titled “Header Parameters”
Last-Event-Id
string

Resume marker (<runId>:<sequence>). Server replays events with sequence > lastSeen before entering live-poll.

Responses

Section titled “Responses”

200

Section titled “200”

Text/event-stream. Each frame is one RunProgressEvent.

Media typetext/event-stream

A run event without its payload: what happened, on which node, when.

object
eventId
required

Sent as the SSE id: line; echo it back in Last-Event-Id to resume.

string
>= 1 characters
runId
required
string
>= 1 characters
timestamp
required
string format: date-time
kind
required
string
sequence
required
integer
nodeId
string

401

Section titled “401”

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}

404

Section titled “404”

No run with that id that the token may read.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
  "error": {
    "code": "example",
    "message": "example",
    "details": {},
    "requestId": "example"
  }
}