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
Flow Executions
Create a new flow execution
Triggers a new execution of a flow via API. The flow must have an active API trigger configured.
POST
/
flows
/
{flow_id}
/
executions
Copy
curl --request POST \
--url https://app.kapso.ai/api/v1/flows/{flow_id}/executions \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{
"phone_number": "+1234567890",
"variables": {
"user_id": "123",
"name": "John Doe",
"email": "john@example.com"
},
"context": {
"source": "mobile_app",
"version": "1.2.3"
},
"initial_data": {}
}'
Copy
{
"flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tracking_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"message": "Flow execution queued"
}
Authorizations
API key required for all endpoints
Path Parameters
Body
application/json
Response
202
application/json
Flow execution accepted and queued
The response is of type object
.
Copy
curl --request POST \
--url https://app.kapso.ai/api/v1/flows/{flow_id}/executions \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{
"phone_number": "+1234567890",
"variables": {
"user_id": "123",
"name": "John Doe",
"email": "john@example.com"
},
"context": {
"source": "mobile_app",
"version": "1.2.3"
},
"initial_data": {}
}'
Copy
{
"flow_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"tracking_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"message": "Flow execution queued"
}
Assistant
Responses are generated using AI and may contain mistakes.