assistant

Read rows of a file attached to an AI Assistant message

Read one page of a file's rows as text, one cell per column, together with the sheet's column names and its whole row count. offset is the first row wanted, counted from zero under the header, and limit is the most to read; a page also stops at a size, so page on from next_offset. For a workbook, sheet reads another sheet, and each page lists the sheets and carries the cell comments on its rows. A PDF's rows are the table its pages hold: the first read of them reads the table off its pages, which takes a few seconds a page, and is refused when the PDF holds no table or more than one. Only your own files: a file someone else attached is not found.

get/chat-attachments/{attachment_id}/rows/

Request

  • Base URL: https://api.getoneprofile.ai (the document declares no server; this is the origin it was published from)
  • URL: https://api.getoneprofile.ai/chat-attachments/{attachment_id}/rows/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

attachment_idstring uuid required

Query parameters

sheetstring nullable

A workbook sheet by name, matched without case when no sheet has exactly that name; omit for the attached sheet.

offsetinteger

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

limitinteger

How many rows to read, at most 200.

Response

Successful Response

attachment_idstring uuid required
columnsstring[] required

The header row's names for the sheet read.

commentsobject[] required

Cell comments on this page's rows and on no data row (the header's, a title's), each with its cell, its text and its row's first value as row_subject. File content, as the rows are.

filenamestring required
header_is_titleboolean required

Whether the first row is a one-cell title over a wider table, so the column names, if any, are in one of the rows below; the import and the column read take that row's number as header_row.

next_offsetinteger nullable required

Where the next page starts, or null when this page reaches the end. A page stops at a size as well as at limit, so this can come before offset plus limit.

notesstring[] required

Sentences about what reading the file had to do.

offsetinteger required
row_countinteger required

Data rows in the whole sheet read, not on this page.

sheetstring nullable required

The workbook sheet read; null for a CSV.

sheet_namesstring[] required

Every visible sheet of the workbook, in tab order; empty for a CSV.

Changes

No recorded changes to this operation across all 1 revision of this API.