Skip to main content
API reference sections

Schema

RunStreamItem

GET /v1/runs/{run}/stream?after=…, one SSE event each: a history entry with its index, a status change, or the end of the stream.

Type object or object or object

Shape

One of 3 shapes:

  1. kind: "entry"

    FieldTypeDescription
    indexrequiredinteger (uint64, >= 0)
    itemrequiredTimelineItem

    One entry of the history as the wire carries it. Unrecognized is an entry this build could not decode, in its place.

    kindrequired"entry"
  2. kind: "status"

    FieldTypeDescription
    statusrequiredRunStatus

    Where a run is. One canonical authority - the Run document - holds it (§7.1); runs.db never carries a second one.

    kindrequired"status"
  3. kind: "closed"

    The worker stopped streaming - the run ended, or the worker is going away. A client resumes with after set to the last index.

    FieldTypeDescription
    kindrequired"closed"
Example
{
  "index": 0,
  "item": {
    "id": "00000000-0000-4000-8000-000000000000",
    "kind": {
      "step": "run_created"
    },
    "refs": [],
    "at_ms": 0
  },
  "kind": "entry"
}

The contract has no example values, so example bodies are generated from each schema: every field is shown with a placeholder of its type.

Used by

Generated from contract version 1. Last updated .

Privacy choices

Choose which optional tools Koru may use on this site. Your choice is saved in a cookie in this browser for 12 months. Privacy policy

Privacy choices

Keep you signed in, protect forms and remember your language and this choice.

Always on

PostHog and Google Analytics 4 measure page views and actions such as downloads, using cookies or local storage.

PostHog records how pages are used, with form inputs masked and private pages excluded. Needs Analytics.

Ahrefs Web Analytics measures visits and where they come from, and Google Ads measures whether our ads led to a visit or download.