Skip to main content
GET
List documents (unified, att-centric)
Canonical library list. Each row is a ChatAttachment — this id is what the unified viewer and the other /attachments/{att_id}/ routes use. The list is the caller’s organization, plus (on a personal credential only) documents the caller still owns after an org move. An API key stays inside the key’s tenant.
GET /api/v2/documents/ is the older chat-centric list ({id} = Deep Reader chat pk). Prefer this attachment list unless you are driving that older surface.

Authorizations

Authorization
string
header
required

Organisation API key from Settings → API / /api/keys/. The secret is shown once. Send Authorization: Bearer sk-abacus-…. One active key per organisation. Ingest (/api/v2/ingest/*) refuses API keys — that surface is Auth0-only with ingest:read / ingest:write scopes.

Query Parameters

from_batch
integer

Only docs belonging to this batch id.

from_chat
integer

Only docs whose home chat is this id.

has_schema
boolean

Filter by whether a schema is pinned.

order
string

Sort field (whitelisted).

page
integer

1-based page number.

page_size
integer

Items per page (1-100, default 24).

processing_status
enum<string>

Filter by status. Omit for 'completed'; pass 'all' to disable.

Available options:
all,
completed,
failed,
pending
q
string

Case-insensitive file-name substring match.

Response

200 - application/json

Paginated envelope for the document-library list endpoint.

documents
object[]
required
page
integer
required
page_size
integer
required
total
integer
required
has_more
boolean
required