Bem 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 forhierarchical 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.## ItemsItems carry either a string or a JSON object in their `data` field. When items are addedor 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 hierarchyUse `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 itemsfrom all descendant collections.## Token countingUse `POST /v3/collections/token-count` to check whether texts fit within the embeddingmodel's 8,192-token-per-text limit before submitting them for embedding.
Bem Collections API is one of 22 APIs that Bem publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include Collection. The published artifact set on APIs.io includes an OpenAPI specification.
This API exposes 8 operations across 3 paths, and defines 14 schemas. It is described by OpenAPI 3.1.0, at version 1.0.0.
Requests are made against 2 base URLs: https://api.bem.ai, https://api.eu1.bem.ai.
Metadata
The identity and technical contract details declared by the specification.
Authentication & Security 1
Bem Collections API declares
1 security scheme
for authenticating requests.
An API key is passed in the header as x-api-key (API Key).
By default, every request must be authenticated.
API Key— Authenticate using API Key in request header
Paths & Operations 8
Across 3 paths, the API surfaces 8 operations — 2 DELETE, 2 GET, 3 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
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 hie…
Schemas 14
The contract defines 14 schemas that model the data the API accepts and returns. The most detailed are CollectionResponseV3 (9 properties), CollectionMetadataV3 (5 properties), UpdateCollectionItemsResponseV3 (5 properties), ListCollectionsResponseV3 (5 properties). Each schema is shown below with its type and property counts.
Specification
The full machine-readable OpenAPI contract behind this narrative.
Source
More from Bem 12
Other APIs Bem publishes across the network.
This is an independent, third-party profile of Bem Collections API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.
The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.
Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.
info@apievangelist.com
·
Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and
you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.