General Documentation
Agents
Agent Executions
Test Suites
Projects
WhatsApp Conversations
Customers
WhatsApp Configs
Agent Test Chats
Conversation Assignments
WhatsApp Templates
WhatsApp Contact Notes
Agent Snapshots
Agent Test Chats
Start a new agent test chat
Initiates a test conversation with the specified agent
POST
/
agents
/
{agent_id}
/
test_chats
Copy
curl --request POST \
--url https://app.kapso.ai/api/v1/agents/{agent_id}/test_chats \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{
"message": "I need help with my order",
"agent_test_chat_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
Copy
{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_snapshot_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "processing",
"conversation": [
{
"role": "user",
"content": "<string>"
}
],
"error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
Authorizations
API key required for all endpoints
Path Parameters
Body
application/json
Response
201
application/json
Test chat initiated
The response is of type object
.
Copy
curl --request POST \
--url https://app.kapso.ai/api/v1/agents/{agent_id}/test_chats \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{
"message": "I need help with my order",
"agent_test_chat_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}'
Copy
{
"data": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"agent_snapshot_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"status": "processing",
"conversation": [
{
"role": "user",
"content": "<string>"
}
],
"error": "<string>",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z"
}
}
Assistant
Responses are generated using AI and may contain mistakes.