Skip to navigation
API referenceConversations and chat

Start a chat

Opens a conversation with an expert. Then post messages and read the reply stream.

Needs the chat:write 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.

Request

This endpoint expects an object.
agentIdstringRequired
A UUID.
meetingIdstringOptional

Ground the chat in a meeting’s transcript.

Response

OK
idstring
A UUID.
orgIdstring
A UUID.
agentIdstring
A UUID.
kindenum
Allowed values:
createdAtdatetime
updatedAtdatetime
userIdstring or nullOptional
meetingIdstring or nullOptional
titlestring or nullOptional
channelenum or nullOptional

Errors

401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
429
Too Many Requests Error