Viewing Collection Metadata

Auth required: Authorization: <main_api_key> header.

Returns metadata about the collection, including the number of indexed documents.

Example

Node.js

const meta = await client.getCollection("posts");
// { name: "posts", id_type: "number", document_count: 42 }

Fetch

const res = await fetch("http://localhost:3000/collections/posts", {
  headers: { Authorization: "SecretApiKey" },
});
const meta = await res.json();

cURL

# GET /collections/{collection_name}
#
# Response: 200 OK
# {
#   "name": "posts",
#   "id_type": "number",
#   "document_count": 42,
# }

curl http://localhost:3000/collections/posts \
  -H "Authorization: SecretApiKey"

Endpoint Definition

Field	Value
Method	GET
Path	/collections/{collection}

Path Parameters

Param	Type	Description
collection	string	Collection name

Response Body

Field	Type	Description
name	string	Collection name
id_type	string	"number" or "string"
document_count	integer	Number of indexed documents

Response: 200 OK