API ReferenceManage entities

Retrieve an entity

This method retrieves details about the specified entity.

Authentication

x-api-keystring
Your API key. <Note title="Note"> You can find your API key on the <a href="https://playground.twelvelabs.io/dashboard/api-key" target="_blank">API Key</a> page. </Note>

Path parameters

entity_collection_idstringRequired
The unique identifier of the entity collection.
entity_idstringRequired
The unique identifier of the entity to retrieve.

Response

The entity has been successfully retrieved.
_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. **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.
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