v3

latestOpenAPI 3.1.02026-07-3197486526.1 KB
entityCollections > entities

Create multiple entities in bulk

This method creates multiple entities within a specified entity collection in a single request. Each entity must be associated with at least one asset. This endpoint is useful for efficiently adding multiple entities, such as a roster of players or a group of characters.

post/entity-collections/{entity_collection_id}/entities/bulk

Path parameters

entity_collection_idstring required

The unique identifier of the entity collection in which to create the entities.

Headers

x-api-keystring required

Your API key.

<Note title="Note"> You can find your API key on the <a href="https://playground.twelvelabs.io/dashboard/api-keys" target="_blank">API Keys</a> page. </Note>

Request body

Response

The entities have been successfully created.

success_countinteger

The number of entities that were successfully created.

failed_countinteger

The number of entities that failed to be created due to errors, such as missing assets.