Sign in

v3

latestOpenAPI 3.1.02026-07-3197486526.1 KB
entityCollections > entities

Update an entity

This method updates the specified entity within an entity collection. This operation allows modification of the entity's name, description, or metadata. Note that this endpoint does not affect the assets associated with the entity.

patch/entity-collections/{entity_collection_id}/entities/{entity_id}

Path parameters

entity_collection_idstring required

The unique identifier of the entity collection containing the entity to be updated.

entity_idstring required

The unique identifier of the entity to update.

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

namestring

The new name for the entity.

descriptionstring

An updated description for the entity.

metadataEntityCollectionsEntityCollectionIdEntitiesEntityIdPatchRequestBodyContentApplicationJsonSchemaMetadata

Updated metadata for the entity. If provided, this completely replaces the existing metadata. Use this to store custom key-value pairs related to the entity.

Response

The entity has been successfully updated.

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