entityCollections > entities

Add assets to an entity

Changed on

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

post/entity-collections/{entity_collection_id}/entities/{entity_id}/assets

Request

  • Base URL: https://api.twelvelabs.io/v1.3
  • URL: https://api.twelvelabs.io/v1.3/entity-collections/{entity_collection_id}/entities/{entity_id}/assets
  • Auth: API key in header x-api-key

Path parameters

entity_collection_idstring required

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

entity_idstring required

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

Request body

asset_idsstring[] required

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.

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.

Changes

  • b8591e05c0baRevision changes
    • warning

      deleted the header request parameter x-api-key

    • info

      the endpoint scheme security x-api-key was added to the API

  • 6205c7327cdeRevision changes
    • info

      api operation id create-assets removed and replaced with entityCollections_entities_createAssets