Skip to main content
GET
Read rows of a file attached to an AI Assistant message

Authorizations

X-API-Key
string
header
required

Path Parameters

attachment_id
string<uuid>
required

Query Parameters

offset
integer
default:0

The first row wanted, counted from zero under the header.

Required range: x >= 0
limit
integer
default:200

How many rows to read, at most 200.

Required range: 1 <= x <= 200

Response

Successful Response

One page of a file's rows.

rows are rows of text, one cell per column of columns, cells clipped to what a page keeps. offset is where the page starts, counted from zero under the header, and row_count is the whole file's, so a reader knows how many pages are left.

attachment_id
string<uuid>
required
columns
string[]
required
filename
string
required
offset
integer
required
row_count
integer
required

Data rows in the whole file, not on this page.

rows
string[][]
required