View the contents of any item (folder, sheet, doc bundle, memo, image). The query parameters (where/sort/select/limit/offset/boxes) are sheet-only and are ignored on every other kind.

get/view

Request

  • Base URL: https://api.space-ocr.com
  • URL: https://api.space-ocr.com/view
  • Auth: HTTP bearer

Query parameters

pathstring required

Slash-separated path. Folders are addressed by name. Sheets can be addressed by name (must be unique within the parent folder) or by the uniqueKey returned by /create.

Example:/invoices/2024/march
string
OR
string[]
string
OR
string[]
selectstring

[Sheets only] Comma-separated column names to return (projection), e.g. vendor,total. Filters both values keys and cells paths (by their first segment).

limitinteger

[Sheets only] Max rows to return (1–500). Does not paginate doc bundle pages.

offsetinteger nullable

[Sheets only] Rows to skip for pagination (pair with limit; see nextOffset in the response).

boxes'0' | '1' | 'true' | 'false'

[Sheets only] Set 0/false to drop the per-row cells map (boxes/quads) for a lean payload. values/review are kept. Doc bundle page cells are always returned.

Response

OK

unknown required

Changes

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