Skip to main content

Documentation Index

Fetch the complete documentation index at: https://s2.dev/docs/llms.txt

Use this file to discover all available pages before exploring further.

S2 streams allow you to append records at the tail, and read starting from any position in the stream.
seq_num: 42
timestamp: 1713812735000

headers:
Ā Ā role: agent
Ā Ā response-type: tool-call
Ā Ā format: json

body:
Ā Ā 

Anatomy of a record

Sequence number
Strictly increasing position within the stream.Always assigned by S2.
Timestamp
Arrival timestamp in milliseconds, when assigned by S2 (default).It can also be client-specified.
Headers
Name-value pairs, similar to HTTP headers.Both the name and value can be arbitrary bytes.
Body
The core payload of a record.Arbitrary bytes.

Size

A single record can be up to 1 MiB in metered bytes.

See also

Appends

Understand append acknowledgements, batching, and durability.

Reads

Scan from sequence numbers, timestamps, and tail offsets.

Data plane API

Compare the append, read, and check-tail endpoints.