Skip to main content
GET
/
collections
/
{collectionName}
/
docs
cURL
curl --request GET \
  --url https://{projectHost}/collections/{collectionName}/docs \
  --header 'x-api-key: <api-key>'
{
  "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": "eyJpZCI6ICJhYmMiLCAiY3JlYXRlZF9hdCI6ICIyMDI0LTExLTA1VDE0OjI3OjU2KzAwOjAwIn0=",
  "isDocsInline": true
}

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

Next page token.

includeVectors
boolean
default:false

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

Response

Documents list.

total
integer
required
docs
object[]
required
isDocsInline
boolean
required
nextPageToken
string
docsUrl
string