Read History
Reads conversation history from the end. Omit limit for the full history. For earlier pages, pass the previous response’s opaque beforeCursor, which keeps events and Codex turns aligned. Continue until beforeCursor is null. Legacy index-based clients can pass eventsStartIndex as beforeEvent and turnsStartIndex as beforeTurn. Sleeping and archived workspaces return retained history without waking when available.
Authorizations
API key authentication. Obtain your API key from the Replicas dashboard under Organization → Settings → API Keys.
Path Parameters
The unique identifier of the replica
Query Parameters
Filter history to a specific chat
Maximum number of events to return, taken from the end of the history. Omit to return the full history.
x >= 1Exclusive upper bound: return only events with an index below this value. Pass the previous response's eventsStartIndex to fetch the page before it. Indexes are stable as new events append to the end.
x >= 0Exclusive upper bound for Codex transcript turns, paged with turnsStartIndex the same way beforeEvent pages events.
x >= 0Opaque cursor from the previous response's beforeCursor. Advances events and Codex turns together.
Response
Successful response
Response containing paginated conversation history
Thread/session ID
History events (paginated from the end)
Total number of events when known; otherwise the number of events in this page
Whether earlier events exist before this page
Index of the first returned event within the full history. Pass it back as beforeEvent to fetch the preceding page. Absent when the full history was returned.
Index of the first returned Codex transcript turn, used with beforeTurn. Present only when the response includes codexAspTranscript.
Opaque cursor for the next earlier page of events and Codex turns. Null when no earlier page exists.
Currently active coding agent
claude, codex, cursor, deepseek, fx, kimi, opencode, pi, null Whether the workspace was just woken from a sleeping or archived state. Retry in 30-90 seconds.
Native Codex ASP transcript when available
Sender attribution records for user messages in this chat. In team workspaces, each sendMessage call records the authenticated user; clients can use this to label messages with the actual sender's name instead of "You".