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.
POST
/
v1
/
agents
/
{agentId}
/
debug-chat
Create a new debug chat session
curl --request POST \
--url https://api.us.poly.ai/v1/agents/{agentId}/debug-chat \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"clientEnv": "<string>",
"asrLangCode": "<string>",
"ttsLangCode": "<string>",
"conversationId": "<string>",
"variantId": "<string>",
"channel": "<string>",
"integrationAttributes": {}
}
'import requests
url = "https://api.us.poly.ai/v1/agents/{agentId}/debug-chat"
payload = {
"clientEnv": "<string>",
"asrLangCode": "<string>",
"ttsLangCode": "<string>",
"conversationId": "<string>",
"variantId": "<string>",
"channel": "<string>",
"integrationAttributes": {}
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
clientEnv: '<string>',
asrLangCode: '<string>',
ttsLangCode: '<string>',
conversationId: '<string>',
variantId: '<string>',
channel: '<string>',
integrationAttributes: {}
})
};
fetch('https://api.us.poly.ai/v1/agents/{agentId}/debug-chat', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.us.poly.ai/v1/agents/{agentId}/debug-chat",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'clientEnv' => '<string>',
'asrLangCode' => '<string>',
'ttsLangCode' => '<string>',
'conversationId' => '<string>',
'variantId' => '<string>',
'channel' => '<string>',
'integrationAttributes' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.us.poly.ai/v1/agents/{agentId}/debug-chat"
payload := strings.NewReader("{\n \"clientEnv\": \"<string>\",\n \"asrLangCode\": \"<string>\",\n \"ttsLangCode\": \"<string>\",\n \"conversationId\": \"<string>\",\n \"variantId\": \"<string>\",\n \"channel\": \"<string>\",\n \"integrationAttributes\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.us.poly.ai/v1/agents/{agentId}/debug-chat")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"clientEnv\": \"<string>\",\n \"asrLangCode\": \"<string>\",\n \"ttsLangCode\": \"<string>\",\n \"conversationId\": \"<string>\",\n \"variantId\": \"<string>\",\n \"channel\": \"<string>\",\n \"integrationAttributes\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.us.poly.ai/v1/agents/{agentId}/debug-chat")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"clientEnv\": \"<string>\",\n \"asrLangCode\": \"<string>\",\n \"ttsLangCode\": \"<string>\",\n \"conversationId\": \"<string>\",\n \"variantId\": \"<string>\",\n \"channel\": \"<string>\",\n \"integrationAttributes\": {}\n}"
response = http.request(request)
puts response.read_body{
"conversationId": "<string>",
"userInput": "<string>",
"response": "<string>",
"metadata": {
"state": {},
"currentNode": "<string>",
"nodeTrace": [
"<string>"
],
"metrics": {},
"functionEvents": [
"<unknown>"
],
"handoffDestination": "<string>",
"retrievedTopics": [
"<string>"
],
"retrievedSources": [
"<string>"
],
"citedTopic": "<string>",
"inFlow": "<string>",
"inStep": "<string>",
"llmRequests": [
{}
],
"asrLangCode": "<string>",
"ttsLangCode": "<string>"
},
"conversationEnded": true,
"delayedResponse": true
}{
"success": false,
"error": "The draft you are attempting to chat with does not exist.",
"error_id": "550e8400-e29b-41d4-a716-446655440000",
"error_code": "CHAT_DRAFT_NOT_EXIST",
"error_message": "The draft you are attempting to chat with does not exist.",
"data": null
}{
"success": false,
"error": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"error_message": "<string>",
"data": "<unknown>"
}{
"success": false,
"error": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"error_message": "<string>",
"data": "<unknown>"
}Authorizations
Path Parameters
Body
application/json
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)
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
Successful response
A chat turn's result: the agent's reply text, the conversation's updated state, and whether the conversation has ended.
Last modified on July 13, 2026
Was this page helpful?
Previous
Send a message to a debug chat sessionSend a user turn into an existing debug chat session and return the agent's response. Served from api.{region}.poly.ai.
Next
⌘I
Create a new debug chat session
curl --request POST \
--url https://api.us.poly.ai/v1/agents/{agentId}/debug-chat \
--header 'Content-Type: application/json' \
--header 'X-API-KEY: <api-key>' \
--data '
{
"clientEnv": "<string>",
"asrLangCode": "<string>",
"ttsLangCode": "<string>",
"conversationId": "<string>",
"variantId": "<string>",
"channel": "<string>",
"integrationAttributes": {}
}
'import requests
url = "https://api.us.poly.ai/v1/agents/{agentId}/debug-chat"
payload = {
"clientEnv": "<string>",
"asrLangCode": "<string>",
"ttsLangCode": "<string>",
"conversationId": "<string>",
"variantId": "<string>",
"channel": "<string>",
"integrationAttributes": {}
}
headers = {
"X-API-KEY": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {'X-API-KEY': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
clientEnv: '<string>',
asrLangCode: '<string>',
ttsLangCode: '<string>',
conversationId: '<string>',
variantId: '<string>',
channel: '<string>',
integrationAttributes: {}
})
};
fetch('https://api.us.poly.ai/v1/agents/{agentId}/debug-chat', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.us.poly.ai/v1/agents/{agentId}/debug-chat",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'clientEnv' => '<string>',
'asrLangCode' => '<string>',
'ttsLangCode' => '<string>',
'conversationId' => '<string>',
'variantId' => '<string>',
'channel' => '<string>',
'integrationAttributes' => [
]
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"X-API-KEY: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.us.poly.ai/v1/agents/{agentId}/debug-chat"
payload := strings.NewReader("{\n \"clientEnv\": \"<string>\",\n \"asrLangCode\": \"<string>\",\n \"ttsLangCode\": \"<string>\",\n \"conversationId\": \"<string>\",\n \"variantId\": \"<string>\",\n \"channel\": \"<string>\",\n \"integrationAttributes\": {}\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("X-API-KEY", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.post("https://api.us.poly.ai/v1/agents/{agentId}/debug-chat")
.header("X-API-KEY", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"clientEnv\": \"<string>\",\n \"asrLangCode\": \"<string>\",\n \"ttsLangCode\": \"<string>\",\n \"conversationId\": \"<string>\",\n \"variantId\": \"<string>\",\n \"channel\": \"<string>\",\n \"integrationAttributes\": {}\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.us.poly.ai/v1/agents/{agentId}/debug-chat")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["X-API-KEY"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"clientEnv\": \"<string>\",\n \"asrLangCode\": \"<string>\",\n \"ttsLangCode\": \"<string>\",\n \"conversationId\": \"<string>\",\n \"variantId\": \"<string>\",\n \"channel\": \"<string>\",\n \"integrationAttributes\": {}\n}"
response = http.request(request)
puts response.read_body{
"conversationId": "<string>",
"userInput": "<string>",
"response": "<string>",
"metadata": {
"state": {},
"currentNode": "<string>",
"nodeTrace": [
"<string>"
],
"metrics": {},
"functionEvents": [
"<unknown>"
],
"handoffDestination": "<string>",
"retrievedTopics": [
"<string>"
],
"retrievedSources": [
"<string>"
],
"citedTopic": "<string>",
"inFlow": "<string>",
"inStep": "<string>",
"llmRequests": [
{}
],
"asrLangCode": "<string>",
"ttsLangCode": "<string>"
},
"conversationEnded": true,
"delayedResponse": true
}{
"success": false,
"error": "The draft you are attempting to chat with does not exist.",
"error_id": "550e8400-e29b-41d4-a716-446655440000",
"error_code": "CHAT_DRAFT_NOT_EXIST",
"error_message": "The draft you are attempting to chat with does not exist.",
"data": null
}{
"success": false,
"error": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"error_message": "<string>",
"data": "<unknown>"
}{
"success": false,
"error": "<string>",
"error_id": "<string>",
"error_code": "<string>",
"error_message": "<string>",
"data": "<unknown>"
}
