Gets a DocumentCollection (cloud only)

Deprecated

GET

Returns a DocumentCollection if it exists.

collectionNamestringRequired

Name of the Document Collection

created_atstringOptional

descriptionstringOptional

document_countintegerOptional

document_embedded_countintegerOptional

embedding_dimensionsintegerOptional

embedding_model_namestringOptional

is_auto_embeddedbooleanOptionalDefaults to false

is_indexedbooleanOptionalDefaults to false

is_normalizedbooleanOptionalDefaults to false

metadatamap from strings to anyOptional

namestringOptional

updated_atstringOptional

uuidstringOptional

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	"key": "value"
13	},
14	"name": "name",
15	"updated_at": "updated_at",
16	"uuid": "uuid"
17	}

1	curl https://api.getzep.com/api/v2/collections/collectionName \
2	-H "Authorization: Api-Key <apiKey>"