Skip to content

Read conversation messages

GET
/v1/conversations/{conversationId}/messages
curl --request GET \
--url 'https://example.com/v1/conversations/2489E9AD-2EE2-8E00-8EC9-32D5F69181C0/messages?limit=25' \
--header 'Authorization: Bearer <token>'

Cursor-paginated. Sort is sequence asc (natural conversation reading order) — distinct from most list endpoints, which use createdAt desc.

conversationId
required
string format: uuid

ConversationId — opaque branded string (a UUID).

limit
integer
default: 25 >= 1 <= 100

1..100. Default 25.

cursor
string

Opaque cursor from a prior response. Absent → first page.

Page of messages.

Media typeapplication/json
object
data
required
Array<object>
object
sequence
required

Monotonic index within the conversation. Sort order for the list endpoint.

integer
role
required
string
Allowed values: user agent tool system
content
required

Free-form string OR a structured object (tool results, multi-modal payloads).

toolCall
object
toolId
required
string
invocationId
required
string
actor
string
createdAt
required
string format: date-time
nextCursor

Opaque cursor for the next page. Absent when hasMore: false. Sort is sequence asc.

string
hasMore
required
boolean
Example
{
"data": [
{
"role": "user"
}
]
}

Malformed cursor.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": {},
"requestId": "example"
}
}

Missing / malformed / expired / revoked bearer token.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": {},
"requestId": "example"
}
}

No conversation with that id under this tenant.

Media typeapplication/json
object
error
required
object
code
required

Stable machine-readable discriminant. Values match domain error codes (see docs/API-ROUTE-CONVENTIONS.md §4.3).

string
message
required
string
details

Optional, kind-specific.

object
key
additional properties
any
requestId
required

Server-assigned request id; also echoed via X-Request-Id header.

string
Examplegenerated
{
"error": {
"code": "example",
"message": "example",
"details": {},
"requestId": "example"
}
}