Beta

Read Room File

Last updated Nov 19, 2026View as MarkdownAgent setup / MCP
POST
/v1/room-files/{room_file_id}/content

Reads a File, 256 KiB at a time: text as UTF-8, a file SMB has read as its Markdown, others as base64. The first page's about has SMB's summary and metadata. Pass offset, then next_offset while has_more. Long text: outline, then section or query (far fewer tokens; gives revision). Big unread files: download_file or download_room_file.

Authorization

headerAuthorizationBearer <token>

A signed-in SMB user's access token. Workspace-scoped operations also require SMB-Workspace-Id.

Path Parameters

room_file_id*string

Stable Room File attachment ID.

Match^rfl_[0-7][0-9A-HJKMNP-TV-Z]{25}$

Header Parameters

SMB-Workspace-Id*string

Workspace where this operation runs. Required for user tokens and Workspace API keys.

Formatuuid

Request Body

application/json
  1. body
offset?Offset

Text files: where to start, in bytes (next_offset from the last page).

Range0 <= value <= 104857600
max_bytes?MaxBytes

Text files: page size in bytes. Pages never split a character.

Range4 <= value <= 262144
Default262144
outline?boolean

Text: true returns the headings (section id, lines, tokens), not the text.

section?string

Text: one section, by outline id (s3) or heading.

Length1 <= length <= 200
query?Query

Text: lines containing this, with line and section (20 at most).

Length1 <= length <= 200

Response Body

Successful authorized response.

application/json
  1. response
file_content*
request_id*string
curl -X POST 'https://example.com/v1/room-files/string/content' \  -H 'SMB-Workspace-Id: 497f6eca-6276-4993-bfeb-53cbbbba6f08' \  -H 'Content-Type: application/json' \  -d '{}'
{  "file_content": {    "file_id": "string",    "file_version_id": "string",    "file_name": "string",    "content_type": "string",    "encoding": "utf8",    "content": "string",    "size_bytes": 0,    "total_bytes": 0,    "offset": 0,    "next_offset": 0,    "has_more": true,    "revision": 1,    "outline": {      "sections": [        {          "id": "string",          "level": 1,          "heading": "string",          "lines": [            1,            1          ],          "tokens": 0        }      ],      "lines": 0,      "tokens": 0    },    "section": {      "id": "string",      "level": 1,      "heading": "string",      "lines": [        1,        1      ],      "tokens": 0    },    "matches": [      {        "line": 1,        "section": "string",        "text": "string"      }    ],    "match_total": 0,    "about": {      "summary": "string",      "document_type": "string",      "suggested_name": "string",      "metadata": [        {          "label": "string",          "value": "string",          "page": 0,          "source": "table"        }      ],      "metadata_complete": true,      "page_count": 0,      "read_at": "2019-08-24T14:15:22Z"    }  },  "request_id": "string"}