Assistant

Stop Assistant Turn

Stop the running turn (RO-319): its message becomes `cancelled`. A planning turn stops at once (the model call in flight is dropped); a confirmed plan stops before its next step and reports what it did. 409 when nothing is running.

API key access

Not available to API keys or connected apps: only a signed-in person can call this route.
POST/api/v1/assistant/threads/{thread_id}/stop
AuthorizationBearer <token>

Access token from /api/v1/auth/login, or an API key (ro_pat_..., RO-176) from /api/v1/workspaces/current/api-keys: the key implies its workspace and needs the route's scope. MCP connectors (/api/v1/mcp only) may use an OAuth access token (ro_oat_..., RO-284).

In: header

Path Parameters

thread_idstring
Formatuuid

Header Parameters

X-Workspace-Id?string | null

Id of the workspace to act on (must be a member).

Response Body

curl -X POST "http://localhost:8000/api/v1/assistant/threads/497f6eca-6276-4993-bfeb-53cbbbba6f08/stop" \  -H "X-Workspace-Id: string"
{
  "message_id": "d7d9d9fd-478f-40e6-b651-49b7f19878a2",
  "status": "string"
}
Empty
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}