List streams

List streams within a bucket with optional prefix filtering and pagination.

bucketpathstringrequired

Bucket ID. Must match [a-z0-9_-]{4,64}.

prefixquerystringdefault: ""

Only return streams whose ID starts with this prefix.

afterquerystring

Cursor for pagination. Return streams after this stream ID.

limitquerynumberdefault: 1000

Maximum number of streams to return. Must be between 1 and 1000.

Response

StatusMeaning
200Streams listed.
400Invalid bucket ID or limit out of range.
404Bucket not found.
bucket_idfieldstringrequired

The bucket identifier.

prefixfieldstringrequired

The prefix filter applied.

stream_countfieldnumberrequired

Number of streams in this page.

streamsfieldobject[]required
properties
stream_idfieldstringrequired

Stream ID (local to the bucket).

statusfieldstringrequired

Stream status: open or closed.

content_typefieldstringrequired

The stream's content type.

tail_offsetfieldnumberrequired

Current tail offset (next writable position).

created_at_msfieldnumberrequired

Creation timestamp in milliseconds since epoch.

last_write_at_msfieldnumberrequired

Last write timestamp in milliseconds since epoch.

next_cursorfieldstring

Cursor for the next page. Pass as after to fetch the next page.

has_morefieldbooleanrequired

Whether more streams exist beyond this page.

curl 'http://127.0.0.1:4437/demo/streams'
curl 'http://127.0.0.1:4437/demo/streams?prefix=session-&limit=100'
{
  "bucket_id": "demo",
  "prefix": "",
  "stream_count": 2,
  "streams": [
    {
      "stream_id": "hello",
      "status": "open",
      "content_type": "application/json",
      "tail_offset": 42,
      "created_at_ms": 1711234567890,
      "last_write_at_ms": 1711234599000
    }
  ],
  "next_cursor": "hello",
  "has_more": false
}