Sign in
entityCollections

Retrieve an entity collection

This method retrieves details about the specified entity collection.

get/entity-collections/{entity_collection_id}

Path parameters

entity_collection_idstring required

The unique identifier of the entity collection to retrieve.

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>

Response

The entity collection has been successfully retrieved.

_idstring

The unique identifier of the entity collection.

namestring

The name of the entity collection.

descriptionstring

The description of the entity collection.

created_atstring date-time

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

updated_atstring date-time

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

Changes

Changed in 1 of the 9 revisions of this API.1

  • 5dbd6e8473c91See the full diff
    • ●

      removed the optional property docs_url from the response with the 400 status

      response-optional-property-removed