Sign in
OpenAPI 3.1.02026-08-1297488528.7 KB

b6d766c2c340

entityCollections

Create an entity collection

This method creates an entity collection.

post/entity-collections

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

namestring required

The name of the entity collection. Make sure you use a succinct and descriptive name.

descriptionstring

Optional description of the entity collection.

Response

The entity collection has been successfully created.

_idstring

The unique identifier of the entity collection.

namestring

The name of the entity collection.

descriptionstring

The description of the entity collection.

created_atstring date-time

The date and time, in RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the entity collection was created.

updated_atstring date-time

The date and time, in RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the entity collection was last updated.