Blueprints / Drawing text

Read one printed table

One printed table, by the id the table list gave: its header and rows as printed, line breaks inside cells kept, as arrays (format=rows) or one markdown block (format=markdown). Large schedules page by rows: follow next_cursor until it is null; total_rows gives the full count.

An id that no longer exists answers 200 with status: not_found and a reason: re_extracted (the sheet was read for tables again since the id was given; list the tables for the new id) or unknown. unavailable means the tables could not be read just now; retry. On a lossy table (read before the structured form existed) rows are rebuilt from the markdown: line breaks in cells are flattened, short rows are padded and there are no cell boxes.

404 when the sheet is not in one of your projects; 422 for a malformed table id (never build or edit one), a bad format, or a cursor from another table or format.

get/v1/blueprints/{blueprint_id}/tables/{table_id}

Request

  • Base URL: https://api.kamai.io (the document declares no server; this is the origin it was published from)
  • URL: https://api.kamai.io/v1/blueprints/{blueprint_id}/tables/{table_id}
  • Auth: HTTP bearer

Path parameters

blueprint_idstring required
table_idstring required

Query parameters

format'rows' | 'markdown'

rows (default): header and rows as arrays, with each cell's box; use it when code needs cells, columns or positions. markdown: one markdown table, header repeated on every page; use it to show the table to a person or pass it to a language model.

cursorstring nullable

next_cursor of the previous page of rows, with the same format.

limitinteger nullable

Rows per page, 1..1000; 1,000 when left out.

Response

Successful Response

status'ok' | 'not_found' | 'unavailable' required

ok; not_found: no table has this id on this sheet now (see reason); unavailable: the tables could not be read just now, retry.

total_rowsinteger nullable

All the table's rows, across pages.

next_cursorstring nullable

Pass it as cursor for the next rows, with the same format; null on the last page.

reason're_extracted' | 'unknown' nullable

Why not_found: re_extracted, the sheet was read again since this id was given (list the tables for the new id); unknown, no such table on this sheet.

notestring nullable

A plain-English explanation: why not_found/unavailable, or what lossy means.

table_idstring nullable

The id asked for (on not_found and unavailable).

Changes

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