API ReferenceManage 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>

Path parameters

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

Headers

x-api-keystringRequired

Request

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

Response

The assets have been successfully removed from the entity.
_idstring or null
The unique identifier of the entity.
namestring or null
The name of the entity.
descriptionstring or null
A description of the entity.
metadataobject or null
Custom metadata for the entity.
asset_idslist of strings or null
An array of asset IDs associated with the entity.
statusenum or null

The current status of the entity creation process. Possible values are:

  • 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_atstring or nullformat: "date-time"

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

updated_atstring or nullformat: "date-time"

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

Errors