Create a new debug chat session
Start a new debug chat session to interactively test an agent variant outside of production traffic. Served from api..poly.ai.
Documentation Index
Fetch the complete documentation index at: https://docs.poly.ai/llms.txt
Use this file to discover all available pages before exploring further.
Authorizations
Contact your PolyAI representative.
Path Parameters
Agent ID.
Body
Starting parameters for a debug chat session: which agent variant, which language codes, and which environment to run in.
Client environment (sandbox, pre-release, live).
sandbox, pre-release, live ASR language code (e.g. en-US). Defaults to server config.
TTS language code (e.g. en-US). Defaults to server config.
Custom conversation ID. Auto-generated if omitted.
Variant ID to use.
Channel type (e.g. chat.polyai).
Custom attributes accessible via conv.integration_attributes in project functions.
Response
Debug chat session created.
A chat turn's result: the agent's reply text, the conversation's updated state, and whether the conversation has ended.
ID of the debug chat session.
User input that produced this response.
Agent's reply text.
Metadata returned with each chat response.
Whether the conversation has ended after this turn.
Whether the agent's response was delayed (e.g. awaiting a long-running tool).

