Authorizations
API key required for all endpoints
Body
application/json
Response
Flow created successfully
curl --request POST \
--url https://app.kapso.ai/api/v1/flows \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{
"flow": {
"name": "Customer Onboarding Flow",
"description": "Automated flow for onboarding new customers",
"definition": {
"nodes": [
{
"id": "start_node_1",
"position": {
"x": 100,
"y": 200
},
"data": {
"node_type": "start",
"config": {}
}
}
],
"edges": [
{
"id": "edge_1",
"source": "start_node_1",
"target": "send_text_1",
"label": "next",
"flow_condition_id": "<string>"
}
]
}
}
}'
{
"data": {
"id": "flow-123abc",
"name": "Customer Onboarding Flow",
"description": "Automated flow for onboarding new customers",
"status": "active",
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"last_executed_at": "2023-11-07T05:31:56Z",
"execution_count": 42
}
}
Creates a new flow with basic data and optional definition
curl --request POST \
--url https://app.kapso.ai/api/v1/flows \
--header 'Content-Type: application/json' \
--header 'X-API-Key: <api-key>' \
--data '{
"flow": {
"name": "Customer Onboarding Flow",
"description": "Automated flow for onboarding new customers",
"definition": {
"nodes": [
{
"id": "start_node_1",
"position": {
"x": 100,
"y": 200
},
"data": {
"node_type": "start",
"config": {}
}
}
],
"edges": [
{
"id": "edge_1",
"source": "start_node_1",
"target": "send_text_1",
"label": "next",
"flow_condition_id": "<string>"
}
]
}
}
}'
{
"data": {
"id": "flow-123abc",
"name": "Customer Onboarding Flow",
"description": "Automated flow for onboarding new customers",
"status": "active",
"project_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"created_at": "2023-11-07T05:31:56Z",
"updated_at": "2023-11-07T05:31:56Z",
"created_by": {
"id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
"name": "<string>"
},
"last_executed_at": "2023-11-07T05:31:56Z",
"execution_count": 42
}
}
API key required for all endpoints
Show child attributes
Flow created successfully
Show child attributes
Was this page helpful?