Conversations API

GetConversationsResponse

object

A page of conversations matching the query, plus total count and
limit/offset pagination.

conversationsarray[object]required

Public-facing conversation summary (used in list endpoint).

Show Child Parameters
countintegerrequired
limitintegerrequired
offsetintegerrequired
Example

OperationSuccessResponse

object

Minimal success payload for mutation endpoints.

successboolean

Default:true

Example

RespondDebugChatBody

object

A user turn sent into an existing debug chat session, with the
runtime overrides that apply to this message.

clientEnvstringrequired

Client environment (sandbox, pre-release, live)

asrLangCodestring

ASR language code (e.g. en-US). Defaults to server config.

ttsLangCodestring

TTS language code (e.g. en-US). Defaults to server config.

messagestring

User input message

Default:

metadataobject

User input metadata

Example

UpsertNoteBody

object

Request body for upserting a note on a conversation.

notestringrequired
Example