Skip to main content
GET
List simulated conversation comments

Authorizations

X-API-Key
string
header
required

API key for authentication.

Headers

X-Coval-Workspace-Id
string

Workspace ID. When omitted, the API resolves the default workspace. Only the default workspace includes legacy comments without workspace attribution.

Path Parameters

conversation_id
string
required

ID of the simulated conversation.

Query Parameters

page_size
integer
default:50

Maximum comments per page.

Required range: 1 <= x <= 100
page_token
string

Opaque next_page_token from the previous response. Keep the same conversation and workspace.

Required string length: 1 - 4096

Response

Comments retrieved. An accessible conversation with no comments returns an empty list.

comments
object[]
required
next_page_token
string | null
required

Token for the next page, or null when the traversal is complete.