v1

latestOpenAPI 3.1.1MIT License2026-07-122354100.9 KB
Documents

Retrieve a list of documents

Retrieve a paginated list of documents for the authenticated organization.

get/v1/namespace/{namespaceId}/documents

Path parameters

namespaceIdstring required

The id of the namespace (prefixed with ns_)

Example:ns_123

The id of the namespace (prefixed with ns_)

Query parameters

statusesDocumentStatus[]

Comma separated list of statuses to filter by.

orderBy'createdAt'

The field to order by. Default is createdAt.

order'asc' | 'desc'

The order to sort by. Default is desc.

ingestJobIdstring

The ingest job ID to filter documents by.

cursorstring

The cursor to paginate by.

cursorDirection'forward' | 'backward'

The direction to paginate by.

perPagenumber

The number of records to return per page.

Headers

x-tenant-idstring

Optional tenant id to use for the request. If not provided, the namespace will be used directly. Must be alphanumeric and up to 64 characters.

Optional tenant id to use for the request. If not provided, the namespace will be used directly. Must be alphanumeric and up to 64 characters.

Response

The retrieved ingest jobs

successtrue required