Sign in

v3

latestOpenAPI 3.1.02026-07-3197486526.1 KB
entityCollections > entities

Remove assets from an entity

This method removes from the specified entity. Assets are used to identify the entity in media content, and removing assets may impact the accuracy of entity recognition in searches if too few assets remain.

When assets are removed, the entity may temporarily enter a "processing" state while the system updates the necessary data. Once processing is complete, the entity status will return to "ready."

<Note title="Notes"> - This operation only removes the association between the entity and the specified assets; it does not delete the assets themselves. - An entity must always have at least one asset associated with it. You can't remove the last asset from an entity. </Note>
delete/entity-collections/{entity_collection_id}/entities/{entity_id}/assets

Path parameters

entity_collection_idstring required

The unique identifier of the entity collection that contains the entity from which assets will be removed.

entity_idstring required

The unique identifier of the entity within the specified entity collection from which the assets will be removed.

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

asset_idsstring[] required

An array of asset IDs to remove from the entity.

Response

The assets have been successfully removed from 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.

metadataEntityMetadata

Custom metadata for the entity.

asset_idsstring[]

An array of asset IDs associated with the entity.

status'processing' | 'ready'

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.
created_atstring date-time

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

updated_atstring date-time

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