Workflows
Update workflow execution status
Manually update the status of a workflow execution. This is useful for programmatically controlling workflow lifecycle from external systems.
Allowed status transitions:
- ended - End the execution immediately
- handoff - Transfer execution to human agent
- waiting - Pause execution until resumed
Use cases:
- End workflows based on external events
- Transfer complex queries to human agents
- Implement custom timeout logic
- Coordinate workflows with external systems
Invalid transitions (e.g., transitioning from a terminal state) will return a 422 error with details about why the transition is not allowed.
Response: Returns full execution data including the updated status. Use GET /workflow_executions/{id} to retrieve execution context and event history.
patch/workflow_executions/{execution_id}
Request
- Base URLhttps://api.kapso.ai/platform/v1
- AuthAPI key in header X-API-Key
- TypeScriptA function with typed inputs. Its response is checked against the schema.
Request body
Example request
{
"workflow_execution": {
"status": "ended"
}
}Response
Execution status updated successfully
Changes
No recorded changes to this operation across all 1 revision of this API.