Skip to main content
GET
​
string
required
Bucket ID.
​
string
required
Stream ID within the bucket.
​
string
Starting offset. Use -1 to read from the beginning, or a numeric offset.
​
string
Opaque cursor token returned by a previous read. Alternative to offset.
​
string
Alias for cursor.
​
string
Live mode: sse for Server-Sent Events, long-poll for long-polling. Omit for catch-up read.
​
number
Maximum bytes to return in a single response (catch-up and long-poll only).

​
Read modes

No live parameter. Returns all available data from the given offset immediately.

​
Response

Response headers include Stream-Next-Offset, Stream-Cursor, ETag, Stream-Up-To-Date, Stream-Closed, and Content-Type.

​
SSE event format

In SSE mode, the server sends:
  • Data events (event: data): stream payload in the data field. For binary streams, data is base64-encoded (controlled by the Stream-Sse-Data-Encoding header).
  • Control events (event: control): JSON metadata including the current offset and stream state.
  • Heartbeat comments: periodic : lines to keep the connection alive through proxies.
See read modes, binary SSE, and offsets for more details.