Docs
OverviewGuidesZero & MCPAPI referenceChangelog
Assistant

Cancel Assistant Action

Drop a proposed plan (RO-303); nothing is changed.

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}/actions/{action_id}/cancel

Authorization

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
action_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/actions/497f6eca-6276-4993-bfeb-53cbbbba6f08/cancel" \  -H "X-Workspace-Id: string"
{
  "action_id": "52d6fa12-2c88-46da-984a-4cc821c7837a",
  "status": "pending",
  "message": {
    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
    "role": "user",
    "text": "string",
    "components": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "text": "string",
        "chips": [
          "string"
        ],
        "type": "question"
      }
    ],
    "status": "done",
    "created_at": "2019-08-24T14:15:22Z",
    "usage": {},
    "feedback": {},
    "attachments": [
      {
        "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
        "filename": "string",
        "kind": "pdf",
        "byte_size": 0,
        "status": "ready"
      }
    ]
  }
}
Empty
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Assistant Context

Who and where (RO-300): the user, the workspace (time zone, local time and date), the role and the credential with its scopes. Any API key or connector may call it.

Confirm Assistant Action

Run a proposed plan (RO-303): its steps run in order as the signed-in user, through the same routes, permissions and compliance checks as the app; the first failure stops it. Answers with the assistant's message about the outcome (results, background progress to poll, pages to open, what is still missing such as a mailbox). 409 when the plan was already decided or replaced by a newer message (or older than a day).