Skip to main content
POST
/
agents
/
{agent_id}
/
executions
Start a new agent execution
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",
  "whatsapp_config_id": "config-123abc"
}
'
{
  "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

​
X-API-Key
string
header
required

API key required for all endpoints

Path Parameters

​
agent_id
string
required

Body

application/json
​
message

Legacy format - Initial message to send to the agent (string)

Example:

"I need help with my order"

​
phone_number
string

WhatsApp phone number to associate with this execution

Example:

"+1234567890"

​
whatsapp_config_id
string<uuid>

Optional specific WhatsApp configuration to use for this execution

Example:

"config-123abc"

Response

Execution accepted

​
data
object