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 Executions
Start a new agent execution
Triggers a new execution of the specified agent
POST
/
agents
/
{agent_id}
/
executions
Copy
curl --request POST \
--url https://app.kapso.ai/api/v1/agents/{agent_id}/executions \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{
"message": "I need help with my order",
"phone_number": "+1234567890"
}'
Copy
{
"data": {
"id": "execution-789ghi",
"agent_id": "agent-123abc",
"thread_id": "thread-101jkl",
"status": "running",
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"duration": 123
}
}
Authorizations
API key required for all endpoints
Path Parameters
Body
application/json
Response
202
application/json
Execution accepted
The response is of type object
.
Copy
curl --request POST \
--url https://app.kapso.ai/api/v1/agents/{agent_id}/executions \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{
"message": "I need help with my order",
"phone_number": "+1234567890"
}'
Copy
{
"data": {
"id": "execution-789ghi",
"agent_id": "agent-123abc",
"thread_id": "thread-101jkl",
"status": "running",
"started_at": "2023-11-07T05:31:56Z",
"ended_at": "2023-11-07T05:31:56Z",
"duration": 123
}
}
Assistant
Responses are generated using AI and may contain mistakes.