API ReferenceManage entities

Retrieve an entity collection

This method retrieves details about the specified entity collection.

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 to retrieve.

Response

The entity collection has been successfully retrieved.
_idstring or null
The unique identifier of the entity collection.
namestring or null
The name of the entity collection.
descriptionstring or null
The description of the entity collection.
created_atstring or nullformat: "date-time"

The date and time, in RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the entity collection was created.

updated_atstring or nullformat: "date-time"

The date and time, in RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the entity collection was last updated.

Errors