Skip to main content
GET
/
collections
cURL
curl --request GET \
  --url https://{projectHost}/collections \
  --header 'x-api-key: <api-key>'
{
  "collections": [
    {
      "projectName": "example-project-name",
      "collectionName": "example-collection-name",
      "indexConfigs": {
        "example-field1": {
          "type": "text",
          "analyzers": [
            "standard"
          ]
        },
        "example-field2": {
          "type": "vector",
          "dimensions": 128,
          "similarity": "cosine"
        }
      },
      "numDocs": 10000,
      "collectionStatus": "ACTIVE"
    }
  ]
}

Authorizations

x-api-key
string
header
required

Project API Key.

Query Parameters

size
integer

Max number of collections to return at once.

Required range: 1 <= x <= 100
pageToken
string

Next page token.

Response

A list of collections matched with a projectName.

collections
CollectionResponse · object[]
required
nextPageToken
string

Next page token.