Skip to main content
POST
Fetch Documents

Authorizations

x-api-key
string
header
required

Project API Key.

Path Parameters

collectionName
string
required

Collection name.

Body

application/json
ids
string[]
required

A list of 1 to 1000 nonblank document IDs to fetch. The count limit does not guarantee that all requested document bodies fit within response size limits.

Required array length: 1 - 1000 elements
Minimum string length: 1
consistentRead
boolean
default:false

Overlay eligible pending writes on the selected branch's committed data. Defaults to false. Allowed when ref selects a branch directly or an alias that currently targets a branch; the alias is resolved to its branch when the request is admitted. Tag reads and an alias that targets a tag reject true with 400. Pending bulk imports are excluded. Returns 429 if the pending payload exceeds the consistent-read limit.

includeVectors
boolean
default:false

If your application need to include vector values in the response, set includeVectors to true.

fields
object

An object to specify a list of field names to include and/or exclude in the result.

partitionFilter
PartitionFilter · object
ref
RefContext · object

Read ref selector. A ref that does not exist returns 404 ResourceNotFound; an alias whose target is dangling returns 400 BadRequest.

Response

Fetched documents.

total
integer
required

Total number of documents returned.

took
integer
required

Elapsed time in milliseconds.

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.

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.