This page shows you how to use the fetch endpoint to fetch documents by ID from a collection.

ParameterDescriptionTypeRequiredDefault
idsThe document IDs to fetch up to 1,000.string[]
includeVectorsIndicates whether vector values are included in the response.booleanfalse
consistentReadDetermines the read consistency model: If set to true, then the operation uses strongly consistent reads; otherwise, the operation uses eventually consistent reads.booleanfalse

To fetch documents, specify the document IDs.

python
url = f"https://{baseUrl}/projects/{projectName}/collections/{collectionName}/query"
headers = {"content-type" : "application/json", "x-api-key" : f"{YOUR_API_KEY}"}

fetch = {
	"ids": ["33201222"]
}

r = requests.post(url, headers=headers, json=fetch)

The response will look like this:

{
  "took": 76,
  "total": 1,
  "docs": [
    {
      "collection": "example_collection",
      "score": 1.0,
      "doc": {
        "id": "33201222",
        "url": "https://en.wikipedia.org/wiki/LambdaDB",
        "title": "LambdaDB",
        "text": "LambdaDB is a freeware audio player for Windows, Android and Linux (through Wine) ... "
      }
    }
  ]
}