Skip to main content
GET
Read History

Authorizations

Authorization
string
header
required

API key authentication. Obtain your API key from the Replicas dashboard under Organization → Settings → API Keys. User-session JWTs are not accepted by /v1/replica endpoints.

Path Parameters

id
string<uuid>
required

The unique identifier of the replica

Query Parameters

chat_id
string

Filter history to a specific chat

limit
integer

Maximum number of events to return, taken from the end of the history. Omit to return the full history.

Required range: x >= 1
beforeEvent
integer

Exclusive 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.

Required range: x >= 0
beforeTurn
integer

Exclusive upper bound for Codex transcript turns, paged with turnsStartIndex the same way beforeEvent pages events.

Required range: x >= 0

Response

Successful response

Response containing paginated conversation history

thread_id
string | null
required

Thread/session ID

events
object[]
required

History events (paginated from the end)

total
integer
required

Total number of events in the full history, not just this page

has_more
boolean
required

Whether earlier events exist before this page

eventsStartIndex
integer

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.

turnsStartIndex
integer

Index of the first returned Codex transcript turn, used with beforeTurn. Present only when the response includes codexAspTranscript.

coding_agent
enum<string> | null

Currently active coding agent

Available options:
claude,
codex,
cursor,
opencode,
pi,
null
waking
boolean | null

Whether the workspace was just woken from a sleeping or archived state. Retry in 30-90 seconds.

codexAspTranscript
object | null

Native Codex ASP transcript when available

senders
object[]

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".