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."

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.

Headers

x-api-keystringRequired

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