List documents
Lists documents in a workspace with cursor-based pagination. Use the after parameter with the nextCursor value from the response to fetch subsequent pages. Pass hash (a hex SHA-256) to find documents with identical content — a non-empty result means the document already exists, so an upload can be skipped.
Path Parameters
Workspace identifier.
Query Parameters
Filter by file extension. Each entry expands to its format's full
extension set (so jpg also matches jpeg).
A supported file extension.
csv, docx, htm, html, jpeg, jpg, json, log, pdf, png, rtf, tif, tiff, txt, wav, x-elide-docprops, x-elide-exif, xlsx, xml Filter to documents whose content is exactly this SHA-256. Lets a client check whether identical content already exists in the workspace before uploading it.
^[0-9a-fA-F]{64}$Filter by modality (text, tabular, image, audio).
A supported document modality.
audio, image, metadata, tabular, text Search by document name (case-insensitive, partial match).
Cursor pointing to the last item of the previous page.
Obtain this from the nextCursor field in the response.
Whether to include the total item count in the response's total field.
Defaults to false, since counting is an extra query; set it to true
only when the count is actually needed.
The maximum number of records to return (1-100, default: 20).
1 <= x <= 100Response
Generic paginated response wrapper.
Provides a consistent structure for all paginated API responses with
cursor-based pagination support. When next_cursor is present, there
are more items to fetch.
Generic paginated response wrapper.
Provides a consistent structure for all paginated API responses with
cursor-based pagination support. When next_cursor is present, there
are more items to fetch.