DebugChatResponse
objectA chat turn’s result: the agent’s reply text, the conversation’s
updated state, and whether the conversation has ended.
conversationIdstringrequired
userInputstringrequired
responsestringrequired
metadataobjectrequired
Metadata returned with each chat response.
Show Child Parameters
conversationEndedbooleanrequired
delayedResponsebooleanrequired
Example
GetConversationsResponse
objectA 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
objectMinimal success payload for mutation endpoints.
successboolean
Default:true
Example
RespondDebugChatBody
objectA 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
objectRequest body for upserting a note on a conversation.
notestringrequired
Example