Skip to main content
POST
Stop Workflow Task

Authorizations

Authorization
string
header
required

Every request authenticates with an API key: Authorization: Bearer {API_KEY}. App endpoints take an app API key; knowledge endpoints take a knowledge base API key (Get Started).

Keep keys server-side; never embed them in client code. Requests with a missing or invalid key fail with HTTP 401 (unauthorized).

Path Parameters

task_id
string<uuid>
required

Task ID, from the response or the streaming events of Run Workflow.

Body

application/json
user
string

End-user identifier, defined by your app and unique within it. Accepted for compatibility; the stop is authorized by the API key and task alone. See End User Identity.

Response

The stop was accepted.

result
string

Always success.