Skip to main content
GET
List documents

Path Parameters

workspaceId
string<uuid>
required

Workspace identifier.

Query Parameters

formats
enum<string>[]

Filter by file extension. Each entry expands to its format's full extension set (so jpg also matches jpeg).

A supported file extension.

Available options:
csv,
docx,
htm,
html,
jpeg,
jpg,
json,
log,
pdf,
png,
rtf,
tif,
tiff,
txt,
wav,
x-elide-docprops,
x-elide-exif,
xlsx,
xml
hash
string

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.

Pattern: ^[0-9a-fA-F]{64}$
modality
enum<string>[]

Filter by modality (text, tabular, image, audio).

A supported document modality.

Available options:
audio,
image,
metadata,
tabular,
text

Search by document name (case-insensitive, partial match).

after
string

Cursor pointing to the last item of the previous page. Obtain this from the nextCursor field in the response.

includeCount
boolean
default:false

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.

limit
integer<uint32>

The maximum number of records to return (1-100, default: 20).

Required range: 1 <= x <= 100

Response

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.

items
object[]
required

Items in this page.

nextCursor
string

Cursor to fetch the next page. Present only when more items exist.

total
integer<int64>

Total count of items matching the query (if requested).