curl --request GET \
--url https://{projectHost}/collections/{collectionName}/docs \
--header 'x-api-key: <api-key>'import requests
url = "https://{projectHost}/collections/{collectionName}/docs"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://{projectHost}/collections/{collectionName}/docs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{projectHost}/collections/{collectionName}/docs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{projectHost}/collections/{collectionName}/docs"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{projectHost}/collections/{collectionName}/docs")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{projectHost}/collections/{collectionName}/docs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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": "Too many requests"
}{
"message": "Internal server error"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}List documents
List documents in a collection. Vector values are excluded unless includeVectors is true.
curl --request GET \
--url https://{projectHost}/collections/{collectionName}/docs \
--header 'x-api-key: <api-key>'import requests
url = "https://{projectHost}/collections/{collectionName}/docs"
headers = {"x-api-key": "<api-key>"}
response = requests.get(url, headers=headers)
print(response.text)const options = {method: 'GET', headers: {'x-api-key': '<api-key>'}};
fetch('https://{projectHost}/collections/{collectionName}/docs', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://{projectHost}/collections/{collectionName}/docs",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"net/http"
"io"
)
func main() {
url := "https://{projectHost}/collections/{collectionName}/docs"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://{projectHost}/collections/{collectionName}/docs")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://{projectHost}/collections/{collectionName}/docs")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"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": "Too many requests"
}{
"message": "Internal server error"
}{
"message": "<string>"
}{
"message": "<string>"
}{
"message": "<string>"
}Authorizations
Project API Key.
Path Parameters
Collection name.
Query Parameters
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.
Set to true to include vector values in the response. Defaults to false.
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.
branch, tag, alias Read ref name. Must be supplied together with refKind.
3 - 52^[a-zA-Z0-9_-]{3,52}$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?