Skip to content
LogoLogo

Request an exact stop for a queued or running response

Request an exact stop for a queued or running response

POST/api/v1/workspaces/{workspace_id}/discuss/messages/{message_id}/cancel

Queued work becomes cancelled immediately. Running work first reports cancel_requested; its terminal message and run state are reconciled after execution has stopped. A completed action and its receipt are never described as rolled back.

Path Parameters

workspace_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001
message_idRequired
string <uuid>
Example0198ac5e-f9b7-7000-8000-000000000001

Header Parameters

X-CSRF-TokenRequired
string·min 43·max 43

Session-bound CSRF token. It must exactly match the __Host-assign_csrf cookie sent with the request.

Responses