Skip to main content
GET
List Documents

Authorizations

x-api-key
string
header
required

Project API Key.

Path Parameters

collectionName
string
required

Collection name.

Query Parameters

size
integer

Max number of documents to return at once.

Required range: 1 <= x <= 100
pageToken
string

Opaque search position, not a snapshot pin. For a stable export, use the same immutable tag and unchanged filters/projection across pages.

includeVectors
boolean
default:false

Set to true to include vector values in the response. Defaults to false.

refKind
enum<string>

Read ref kind. Must be supplied together with refName. Selecting a ref that does not exist returns 404 ResourceNotFound; selecting an alias whose target is dangling returns 400 BadRequest.

Available options:
branch,
tag,
alias
refName
string

Read ref name. Must be supplied together with refKind.

Required string length: 3 - 52
Pattern: ^[a-zA-Z0-9_-]{3,52}$

Response

Documents list.

total
integer
required

Number of documents returned in this page, including documents provided through docsUrl. Not the total collection size.

docs
object[]
required
isDocsInline
boolean
required

Whether docs are included inline. When false, docs is empty and the result items must be downloaded from docsUrl.

nextPageToken
string
docsUrl
string

Presigned download URL when isDocsInline is false. GET the complete URL without forwarding the LambdaDB API key. Returns a JSON array of result items, not an object with a docs field.