API ReferenceManage entities

Add assets to an entity

This method adds assets to the specified entity within an entity collection. Assets are used to identify the entity in media content, and adding multiple assets can improve the accuracy of entity recognition in searches. When assets are added, the entity may temporarily enter the "processing" state while the platform updates the necessary data. Once processing is complete, the entity status will return to "ready."

Authentication

x-api-keystring
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>

Path parameters

entity_collection_idstringRequired
The unique identifier of the entity collection that contains the entity to which assets will be added.
entity_idstringRequired
The unique identifier of the entity within the specified entity collection to which the assets will be added.

Request

This endpoint expects an object.
asset_idslist of stringsRequired
An array of asset IDs to add to the entity.

Response

The assets have been successfully added to the entity.
_idstring
The unique identifier of the entity.
entity_collection_idstring
The unique identifier of the entity collection this entity belongs to.
namestring
The name of the entity.
descriptionstring
A description of the entity.
metadataobject
Custom metadata for the entity.
asset_idslist of strings
An array of asset IDs associated with the entity.
statusenum

The current status of the entity creation process.

Values:

  • processing: The entity is being processed and is not yet ready for use in searches.
  • ready: The entity is fully processed and can be used in search queries.
Allowed values:
created_atstringformat: "date-time"

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

updated_atstringformat: "date-time"

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

Errors

400
Bad Request Error