entityCollections > entities

Delete an entity

Changed on

This method deletes a specific entity from an entity collection. It permanently removes the entity and its associated data, but does not affect the assets associated with this entity.

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

Request

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

Path parameters

entity_collection_idstring required

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

entity_idstring required

The unique identifier of the entity to delete.

Response

Successful response

Changes

    • warning

      deleted the header request parameter x-api-key

    • info

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

    • info

      api operation id delete removed and replaced with entityCollections_entities_delete