Skip to content

Mark Agent Session Read

PUT
/agent/sessions/{session_id}/read

Mark messages read up to a COUNT, not a flag.

A count higher than the session actually holds is refused with 409 rather than accepted. That looks strict until you consider what accepting it does: a stale client claiming to have read eleven messages when there are nine would mark the next two read before anyone saw them, and the customer would never be told the agent had replied.

The app answers 204 with no body; this returns the usual envelope so a generated SDK has one response shape across the surface.

Authorizations

Parameters

Path Parameters

session_id
required

Session id (UUID).

string

Session id (UUID).

Header Parameters

X-Target-Org-Id
Any of:
string

Request Body required

Mirror of SessionReadRequest.

object
message_count
required

How many messages the caller has actually seen. NOT a flag: the server refuses a count higher than the session holds with a 409, because a client claiming to have read messages that do not exist yet is a stale client, and silently accepting it would mark a later real message read before anyone saw it.

integer

Responses

200

Successful Response

object
data
required

An open envelope for a hydration or voice answer.

Open because session hydration returns the agent’s STEPS as well as its messages, and a step’s detail is whatever the tool that produced it reported. That set grows with every tool the platform gains, and a pinned mirror would drop the detail of exactly the newest ones - which on a transcript surface reads as the agent having done less than it did.

object
key
additional properties
any
pagination
Any of:
object
has_next
required

Whether there are more pages

boolean
limit
required

Items per page

integer
next_cursor
Any of:
string
notes
Any of:
Array<string>
page
required

Current page number (1-indexed)

integer
total
required

Total number of items

integer
total_available
Any of:
integer
total_is_lower_bound
Any of:
boolean

422

Validation Error

object
detail
Array<object>
object
loc
required
Array
msg
required
string
type
required
string