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

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}/text

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

Query Parameters

offset?integer

Characters to skip (default 0).

Formatint64

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/text?offset=0" \
  -H "X-Workspace-Id: string"

curl -X GET "http://localhost:8000/api/v1/assistant/attachments/497f6eca-6276-4993-bfeb-53cbbbba6f08/text?offset=0" \  -H "X-Workspace-Id: string"

{
  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",
  "filename": "string",
  "kind": "pdf",
  "status": "ready",
  "error": "string",
  "offset": 0,
  "text": "string",
  "total_chars": 0,
  "next_offset": 0
}

Empty

{
  "detail": [
    {
      "loc": [
        "string"
      ],
      "msg": "string",
      "type": "string",
      "input": null,
      "ctx": {}
    }
  ]
}