Skip to main content
POST
/
workflows
/
tasks
/
{task_id}
/
stop
Stop Workflow Task
curl --request POST \
  --url https://{api_base_url}/workflows/tasks/{task_id}/stop \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "user": "user_workflow_123"
}
'
{
  "result": "success"
}

Authorizations

​
Authorization
string
header
required

API Key authentication. For all API requests, include your API Key in the Authorization HTTP Header, prefixed with Bearer. Example: Authorization: Bearer {API_KEY}. Strongly recommend storing your API Key on the server-side, not shared or stored on the client-side, to avoid possible API-Key leakage that can lead to serious consequences.

Path Parameters

​
task_id
string
required

Task ID, can be obtained from the streaming chunk return of the Run Workflow API.

Body

application/json
​
user
string
required

User identifier, must be consistent with the user passed in the Run Workflow request.

Response

Operation successful.

​
result
enum<string>

Operation result.

Available options:
success