Search
K
Conversations API

Send a message to a debug chat session

post
https://api.dev.poly.ai/v1/agents/{agentId}/debug-chat/{conversationId}

Path Parameters

agentIdstringrequired
conversationIdstringrequired

Body

application/json

RespondDebugChatBody

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

Response

application/json

Successful response

DebugChatResponse

A 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
post/v1/agents/{agentId}/debug-chat/{conversationId}

Body

{ "clientEnv": "clientEnv" }
 
application/json

AddAnnotationsBody

object

Request body for adding annotations to a conversation.

annotationsarray[object]required

>= 1 items

Example

ChatMetadataResponse

object

Metadata returned with each chat response.

stateobjectrequired
currentNodestringrequired
nodeTracearray[string]required
metricsobjectrequired
functionEventsarrayrequired
handoffDestinationstring
retrievedTopicsarray[string]
retrievedSourcesarray[string]
citedTopicstring
inFlowstring
inStepstring
llmRequestsarray[object]
asrLangCodestring
ttsLangCodestring
Example

ConversationDetailResponse

object

Public-facing conversation detail (includes turns, metrics).

conversationIdstringrequired
accountIdstringrequired
projectIdstringrequired
createdAtstring
startedAtstring
finishedAtstring
channelstring
fromNumberstring
toNumberstring
languagestring
variantIdstring
clientEnvstring
totalDurationinteger
polyaiDurationinteger
durationinteger
inProgressboolean
handoffboolean
handoffDestinationstring
handoffReasonstring
directionstring
tagsarray[string]
polyScorenumber
shortSummarystring
deploymentIdstring
notestring
audioUrlstring
turnsarray[object]
metricsobject
functionEventsobject
Example

ConversationSummaryResponse

object

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

conversationIdstringrequired
accountIdstringrequired
projectIdstringrequired
createdAtstring
startedAtstring
finishedAtstring
channelstring
fromNumberstring
toNumberstring
languagestring
variantIdstring
clientEnvstring
totalDurationinteger
polyaiDurationinteger
durationinteger
inProgressboolean
handoffboolean
handoffDestinationstring
handoffReasonstring
directionstring
tagsarray[string]
polyScorenumber
shortSummarystring
deploymentIdstring
notestring
audioUrlstring
Example