Skip to content

realtime_history_get

Read message history of a realtime channel: either a cursor (offset + epoch, replays strictly after the offset; recovered:false on epoch mismatch or aged-out entries) or a window (last_n / last_ms).

Tool

realtime_history_get

Read message history of a realtime channel: either a cursor (offset + epoch, replays strictly after the offset; recovered:false on epoch mismatch or aged-out entries) or a window (last_n / last_ms).

Read message history of a realtime channel: either a cursor (offset + epoch, replays strictly after the offset; recovered:false on epoch mismatch or aged-out entries) or a window (last_n / last_ms). Conceptually requires the `history` capability; in Phase 1 this surface is Identity-authenticated management access.

Behavior

HTTP
GET /realtime/messages/history

Arguments

Name
Type
Required
Description
epoch
string
—
Cursor: stream epoch the offset belongs to
last_n
integer
—
Window: return the last N entries
offset
string
—
Cursor: resume strictly after this offset (requires epoch)
channel
string
•
Channel to read history from
last_ms
integer
—
Window: return entries newer than now minus this many milliseconds

Response

Field
Type
Always
Description
epoch
string
•
Current stream epoch, or null when the channel has no history yet
channel
string
•
Channel the history was read from
entries
array
•
Entries in stream order
recovered
boolean
•
false when the cursor epoch mismatches or entries aged out — client must resync

Try it

Read message history of a realtime channel: either a cursor (offset + epoch, replays strictly after the offset; recovered:false on epoch mismatch or aged-out entries) or a window (last_n / last_ms).

When to use

Read message history of a realtime channel: either a cursor (offset + epoch, replays strictly after the offset; recovered:false on epoch mismatch or aged-out entries) or a window (last_n / last_ms). Conceptually requires the `history` capability; in Phase 1 this surface is Identity-authenticated management access.

Example

Ask your agent something like this:

Read message history of a realtime channel: either a cursor (offset + epoch, replays strictly after the offset; recovered:false on epoch mismatch or aged-out entries) or a window (last_n / last_ms).

The agent will invoke realtime_history_get with these arguments:

{
  "channel": "<channel>"
}

Esc

Start typing to search the docs.

↑↓navigate↵select