List collection metadata (HTTP)

For details about additional languages, see:

Gets information about the collections in a keyspace.

Ready to write code? See the examples for this method to get started.

Result

The status.collections field in the response describes each collection.

Example response:

{
  "status": {
    "collections": [
      {
        "name": "student_collection",
        "options": {
          "defaultId": {
            "type": "objectId"
          },
          "vector": {
            "dimension": 1024,
            "metric": "cosine"
          }
        },
        "lexical": {
          "enabled": true,
          "analyzer": "standard"
        },
        "rerank": {
          "enabled": true,
          "service": {
            "provider": "nvidia",
            "modelName": "nvidia/llama-3.2-nv-rerankqa-1b-v2"
          }
        }
      },
      {
        "name": "book_collection",
        "options": {
          "vector": {
            "dimension": 1024,
            "metric": "cosine",
            "sourceModel": "other",
            "service": {
              "provider": "nvidia",
              "modelName": "NV-Embed-QA"
            }
          },
          "lexical": {
            "enabled": false
          },
          "rerank": {
            "enabled": false
          }
        }
      }
    ]
  }
}

Signature

Use the findCollections command.

curl -sS -L -X POST "API_ENDPOINT/api/json/v1/KEYSPACE_NAME" \
--header "Token: APPLICATION_TOKEN" \
--header "Content-Type: application/json" \
--data '{
  "findCollections": {
    "options": {
      "explain": true
    }
  }
}'

Parameters

Name Type Summary

Name	Type	Summary
`options.explain`	`true`	Must be `true` to return metadata about the collections. Otherwise, only the collection names are returned.

options.explain

true

Must be true to return metadata about the collections. Otherwise, only the collection names are returned.

Examples

The following examples demonstrate how to get collection metadata.

curl -sS -L -X POST "API_ENDPOINT/v1/KEYSPACE_NAME" \
  --header "Token: APPLICATION_TOKEN" \
  --header "Content-Type: application/json" \
  --data '{
  "findCollections": {
    "options": {
      "explain": true
    }
  }
}'

List collection metadata (HTTP)

Result

Signature

Parameters

Examples

Was this helpful?

Give Feedback