assistant

Read pages of a PDF attached to an AI Assistant message

Read some of a PDF's pages as text, each laid out as the page prints it: a table's columns stay side by side and each of its rows stays one line, with the gaps between columns cut to three spaces. offset is the first page wanted, counted from zero, and limit the most to read; a read also stops at a size, so read on from next_offset. A spreadsheet has rows instead of pages. Only your own files.

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

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}/pages/
  • Auth: one of:
    • API key in header X-API-Key
    • HTTP bearer

Path parameters

attachment_idstring uuid required

Query parameters

offsetinteger

The first page wanted, counted from zero.

limitinteger

How many pages to read, at most 50.

Response

Successful Response

attachment_idstring uuid required
filenamestring required
next_offsetinteger nullable required

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

offsetinteger required

The first page here, counted from zero.

page_countinteger required

Pages in the whole PDF, not in this read.

pagesstring[] required

Each page's text, in page order. A page with no text is empty, and a page whose text could not be read says so.

Changes

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