Retrieve an entity

This method retrieves details about the specified entity.

entity_collection_idstringRequired

The unique identifier of the entity collection.

entity_idstringRequired

The unique identifier of the entity to retrieve.

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. Possible values are:

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.

1	{
2	"_id": "6298d673f1090f1100476d4c",
3	"name": "John Doe",
4	"description": "Famous soccer player",
5	"metadata": {},
6	"asset_ids": [
7	"6298d673f1090f1100476d4c",
8	"6298d673f1090f1100476d4d"
9	],
10	"status": "processing",
11	"created_at": "2022-06-02T10:30:00Z",
12	"updated_at": "2022-06-02T10:30:00Z"
13	}

1	curl https://api.twelvelabs.io/v1.3/entity-collections/6298d673f1090f1100476d4c/entities/6298d673f1090f1100476d4c \
2	-H "x-api-key: <apiKey>"