Create a new debug chat session

POST

/v1/agents/:agentId/debug-chat

POST

/v1/agents/:agentId/debug-chat

curl -X POST https://api.us.poly.ai/v1/agents/agentId/debug-chat \
     -H "X-API-KEY: <apiKey>" \
     -H "Content-Type: application/json" \
     -d '{
  "clientEnv": "sandbox"
}'

{
  "conversationId": "conv_9f8b7c6d5e4a3b2c1d0e",
  "userInput": "Hello, can you help me with my account?",
  "response": "Of course! What issue are you experiencing with your account?",
  "metadata": {
    "state": {},
    "currentNode": "greeting_node",
    "nodeTrace": [
      "start_node",
      "greeting_node"
    ],
    "metrics": {},
    "functionEvents": [
      null
    ],
    "handoffDestination": "human_agent",
    "retrievedTopics": [
      "account_management"
    ],
    "retrievedSources": [
      "faq_account_issues"
    ],
    "citedTopic": "account_management",
    "inFlow": "account_help_flow",
    "inStep": "initial_greeting",
    "llmRequests": [
      {}
    ],
    "asrLangCode": "en-US",
    "ttsLangCode": "en-US"
  },
  "conversationEnded": false,
  "delayedResponse": false
}

Authentication

X-API-KEYstring

PolyAI API key. Send it in the X-API-KEY header.

Path parameters

agentIdstringRequired

Request

This endpoint expects an object.

clientEnvenumRequired

Client environment (sandbox, pre-release, live).

Allowed values:

asrLangCodestringOptional

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

ttsLangCodestringOptional

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

conversationIdstringOptional

Custom conversation ID. Auto-generated if omitted.

variantIdstringOptional

Variant ID to use

channelstringOptional

Channel type (e.g. chat.polyai)

integrationAttributesmap from strings to anyOptional

Custom attributes accessible via conv.integration_attributes in project functions.

Response

Successful response

conversationIdstring

userInputstring

responsestring

metadataobject

Metadata returned with each chat response.

conversationEndedboolean

delayedResponseboolean

Errors

400

Bad Request Error

401

Unauthorized Error

403

Forbidden Error