Collections
Overview of the Collections API
Collections are named groups of embedded items used by Enrich functions for semantic search.
Each collection is referenced by a collectionName, which supports dot notation for
hierarchical paths (e.g. customers.premium.vip). Names must contain only letters,
digits, underscores, and dots, and each segment must start with a letter or underscore.
Items
Items carry either a string or a JSON object in their data field. When items are added
or updated, their data is embedded asynchronously — POST /v3/collections/items and
PUT /v3/collections/items return immediately with a pending status and an eventID
that can be correlated with webhook notifications once processing completes.
Listing and hierarchy
Use GET /v3/collections with parentCollectionName to list collections under a path,
or collectionNameSearch for a case-insensitive substring match. GET /v3/collections/items
retrieves a specific collection's items; pass includeSubcollections=true to fold in items
from all descendant collections.
Token counting
Use POST /v3/collections/token-count to check whether texts fit within the embedding
model's 8,192-token-per-text limit before submitting them for embedding.
See also
- Enrich functions — use collections from a workflow