curl --request POST \
--url https://{projectHost}/collections/{collectionName}/docs/list \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"size": 10,
"filter": {
"queryString": {
"query": "category:docs"
}
},
"partitionFilter": {
"field": "tenant",
"in": [
"acme"
]
},
"fields": {
"include": [
"id",
"title",
"category"
]
},
"includeVectors": false
}
'{
"total": 2,
"docs": [
{
"collection": "example-collection-name",
"doc": {
"id": "doc-1",
"title": "Example document 1",
"category": "docs"
}
},
{
"collection": "example-collection-name",
"doc": {
"id": "doc-2",
"title": "Example document 2",
"category": "docs"
}
}
],
"nextPageToken": "ZXlKcFpDSTZJQ0poWW1NaQ",
"isDocsInline": true
}{
"message": "Invalid request"
}{
"message": "Authentication failed"
}{
"message": "Resource not found"
}{
"message": "<string>"
}{
"message": "Too many requests"
}{
"message": "Internal server error"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}List documents extended
List documents in a collection with optional filters, partition filtering, field selection, and vector inclusion.
curl --request POST \
--url https://{projectHost}/collections/{collectionName}/docs/list \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"size": 10,
"filter": {
"queryString": {
"query": "category:docs"
}
},
"partitionFilter": {
"field": "tenant",
"in": [
"acme"
]
},
"fields": {
"include": [
"id",
"title",
"category"
]
},
"includeVectors": false
}
'{
"total": 2,
"docs": [
{
"collection": "example-collection-name",
"doc": {
"id": "doc-1",
"title": "Example document 1",
"category": "docs"
}
},
{
"collection": "example-collection-name",
"doc": {
"id": "doc-2",
"title": "Example document 2",
"category": "docs"
}
}
],
"nextPageToken": "ZXlKcFpDSTZJQ0poWW1NaQ",
"isDocsInline": true
}{
"message": "Invalid request"
}{
"message": "Authentication failed"
}{
"message": "Resource not found"
}{
"message": "<string>"
}{
"message": "Too many requests"
}{
"message": "Internal server error"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Authorizations
Project API Key.
Path Parameters
Collection name.
Body
Max number of documents to return at once.
1 <= x <= 100Opaque search position, not a snapshot pin. For a stable export, use the same immutable tag and unchanged filters/projection across pages.
Filter applied before pagination. Supports queryString and nested bool filters. Vector and ranking query objects are not supported.
Show child attributes
Show child attributes
An object to specify a list of field names to include and/or exclude in the result.
- Option 1
- Option 2
Show child attributes
Show child attributes
If your application need to include vector values in the response, set includeVectors to true.
Read ref selector. A ref that does not exist returns 404 ResourceNotFound; an alias whose target is dangling returns 400 BadRequest.
Show child attributes
Show child attributes
Response
Documents list.
Number of documents returned in this page, including documents provided through docsUrl. Not the total collection size.
Show child attributes
Show child attributes
Whether docs are included inline. When false, docs is empty and the result items must be downloaded from docsUrl.
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.
Was this page helpful?