Docs
OverviewGuidesZero & MCPAPI referenceChangelog
Assistant

Get Assistant Attachment

One of the user's attached files (RO-323).

API key access

Not available to API keys or connected apps: only a signed-in person can call this route.
GET/api/v1/assistant/attachments/{attachment_id}

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

attachment_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/attachments/497f6eca-6276-4993-bfeb-53cbbbba6f08" \  -H "X-Workspace-Id: string"
{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "filename": "string",
  "kind": "pdf",
  "media_type": "string",
  "byte_size": 0,
  "status": "ready",
  "error": "string",
  "text_chars": 0,
  "meta": {
    "property1": null,
    "property2": null
  },
  "created_at": "2019-08-24T14:15:22Z"
}
Empty
{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}

Get Assistant Attachment Text

The text read from an attached file, 8,000 characters at a time from `offset` (Oro's `read_attachment`, RO-323).

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).