Stream a run's log lines as SSE

GET

/api/tasks/{taskName}/runs/{runId}/log/stream

const url = 'http://localhost:9477/api/tasks/example/runs/example/log/stream';
const options = {method: 'GET'};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}

curl --request GET \
  --url http://localhost:9477/api/tasks/example/runs/example/log/stream

Server-Sent Events stream of absolute-line-numbered log entries. Replays history starting at from (or Last-Event-ID + 1), then follows live output until the run terminates.

Parameters

Path Parameters

taskName

required

Task name

string

>= 1 characters <= 100 characters /^[a-zA-Z0-9._-]+$/

Task name

runId

required

Run ULID

string

>= 26 characters <= 26 characters /^[0-9A-HJKMNP-TV-Z]{26}$/

Run ULID

Query Parameters

from

Anchor line number; negative values count from end (default -1000)

integer format: int64

Anchor line number; negative values count from end (default -1000)

replay_limit

Cap on backfilled lines (default 5000)

integer format: int64

>= 1 <= 50000

Cap on backfilled lines (default 5000)

Header Parameters

Last-Event-ID

Native SSE resume cursor; takes precedence over the from query

string

Native SSE resume cursor; takes precedence over the from query

Responses

200

text/event-stream

Server Sent Events

Each oneOf object in the array represents one possible Server Sent Events (SSE) message, serialized as UTF-8 text according to the SSE specification.

Array

One of:

Event done

object

data

required

object

final_line

required

Last line number emitted before the run terminated

integer format: int64

status

required

Reason the stream is closing (e.g. ‘ended’)

string

event

required

The event name.

string

Allowed value: done

The event ID.

integer

retry

The retry time in milliseconds.

integer

default

Error

application/problem+json

object

$schema

A URL to the JSON Schema for this object.

string format: uri

detail

A human-readable explanation specific to this occurrence of the problem.

string

errors

Optional list of individual error details

array | null

object

location

Where the error occurred, e.g. ‘body.items[3].tags’ or ‘path.thing-id’

string

message

Error message text

string

value

The value at the given location

instance

A URI reference that identifies the specific occurrence of the problem.

string format: uri

status

HTTP status code

integer format: int64

title

A short, human-readable summary of the problem type. This value should not change between occurrences of the error.

string

type

A URI reference to human-readable documentation for the error.

string format: uri

default: about:blank

Example

{
  "$schema": "http://localhost:9477/schemas/ErrorModel.json",
  "detail": "Property foo is required but is missing.",
  "instance": "https://example.com/error-log/abc123",
  "status": 400,
  "title": "Bad Request",
  "type": "about:blank"
}