Skip to navigation
API referenceConversations and chat

Read messages

Needs the conversations:read scope. A key without it gets 403 insufficient_scope. Routes not in this reference cannot be called with a key at all (403 not_available_to_api_keys).

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Path parameters

idstringRequired
The conversation id.

Response

OK
idstring
A UUID.
conversationIdstring
A UUID.
roleenum
Allowed values:
contentstring
createdAtdatetime
tokensIninteger or nullOptional
tokensOutinteger or nullOptional
partslist of maps from strings to any or nullOptional

Errors

401
Unauthorized Error
403
Forbidden Error
429
Too Many Requests Error