Document

Gets a DocumentCollection

GET
Returns a DocumentCollection if it exists.

Path parameters

collectionNamestringRequired
Name of the Document Collection

Response

This endpoint returns an object
created_at
stringOptional
description
stringOptional
document_count
integerOptional
Number of documents in the collection
document_embedded_count
integerOptional
Number of documents with embeddings
embedding_dimensions
integerOptional
embedding_model_name
stringOptional
is_auto_embedded
booleanOptional
is_indexed
booleanOptional
is_normalized
booleanOptional
metadata
map from strings to anyOptional
name
stringOptional
updated_at
stringOptional
uuid
stringOptional

Errors

GET
1curl https://api.getzep.com/api/v2/collections/collectionName \
2 -H "Authorization: Api-Key <apiKey>"
1{
2 "created_at": "created_at",
3 "description": "description",
4 "document_count": 1,
5 "document_embedded_count": 1,
6 "embedding_dimensions": 1,
7 "embedding_model_name": "embedding_model_name",
8 "is_auto_embedded": true,
9 "is_indexed": true,
10 "is_normalized": true,
11 "metadata": {
12 "metadata": {
13 "key": "value"
14 }
15 },
16 "name": "name",
17 "updated_at": "updated_at",
18 "uuid": "uuid"
19}