Assistant

Get Assistant Thread

A conversation with its messages and their UI components (RO-303). While `running`, poll about once a second: the assistant's message is filled in when its turn ends. A confirmation card shows its plan's current status and each step's state as the plan runs (RO-315). Assistant messages carry their usage and the user's rating; `usage` totals the chat's credits (RO-321).

API key access

Not available to API keys or connected apps: only a signed-in person can call this route.
GET/api/v1/assistant/threads/{thread_id}
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 GET "http://localhost:8000/api/v1/assistant/threads/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "X-Workspace-Id: string"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "title": "string",
  "created_at": "2019-08-24T14:15:22Z",
  "updated_at": "2019-08-24T14:15:22Z",
  "pinned_at": "2019-08-24T14:15:22Z",
  "archived_at": "2019-08-24T14:15:22Z",
  "model": "string",
  "running": true,
  "messages": [
    {
      "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"
        }
      ]
    }
  ],
  "usage": {
    "credits": 0,
    "input_tokens": 0,
    "output_tokens": 0,
    "turns": 0
  }
}
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}