API & SDKsDocuments

List documents

Returns a paginated list of documents the authenticated user has access to. Results can be filtered by providing specific document IDs. Regular users will only see documents they own or have access to through collections. Superusers can see all documents. The documents are returned in order of last modification, with most recent first.

Headers

AuthorizationstringRequired

Bearer authentication of the form Bearer <token>, where token is your auth token.

X-API-KeystringRequired

Query parameters

idsstringOptional
A list of document IDs to retrieve. If not provided, all documents will be returned.
offsetintegerOptional>=0Defaults to 0
Specifies the number of objects to skip. Defaults to 0.
limitintegerOptional>=1<=1000Defaults to 100
Specifies a limit on the number of objects to return, ranging between 1 and 100. Defaults to 100.
include_summary_embeddingsbooleanOptionalDefaults to false
Specifies whether or not to include embeddings of each document summary.
owner_onlybooleanOptionalDefaults to false
If true, only returns documents owned by the user, not all accessible documents.

Response

Successful Response
resultslist of objects
total_entriesinteger

Errors