List entities for an asset

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

{
  "data": [
    {
      "_id": "6298d673f1090f1100476d4c",
      "entity_collection_id": "7309e784f2191g2211587e5d",
      "name": "John Doe",
      "description": "Famous soccer player",
      "metadata": {
        "sport": "soccer",
        "team": "Team A",
        "role": "forward"
      },
      "asset_ids": [
        "6298d673f1090f1100476d4c",
        "6298d673f1090f1100476d4d"
      ],
      "status": "ready",
      "created_at": "2022-06-02T10:30:00Z",
      "updated_at": "2022-06-02T10:30:00Z"
    }
  ],
  "page_info": {
    "limit_per_page": 10,
    "page": 1,
    "total_page": 1,
    "total_results": 2
  }
}

This method returns a list of entities whose asset_ids array contains the specified asset.

Authentication

x-api-keystring

Your API key.

Note

You can find your API key on the API Keys page.

Path parameters

asset_idstringRequired

The unique identifier of the asset.

Query parameters

pageintegerOptionalDefaults to 1

A number that identifies the page to retrieve.

Default: 1.

page_limitintegerOptionalDefaults to 10

The number of items to return on each page.

Default: 10. Max: 50.

Response

The entities have been successfully retrieved.

datalist of objects

A list of entities that reference the specified asset.

page_infoobject

An object that provides information about pagination.

Errors

400

Bad Request Error

$	curl https://api.twelvelabs.io/v1.3/assets/6298d673f1090f1100476d4c/entities \
>	-H "x-api-key: <apiKey>"

1	{
2	"data": [
3	{
4	"_id": "6298d673f1090f1100476d4c",
5	"entity_collection_id": "7309e784f2191g2211587e5d",
6	"name": "John Doe",
7	"description": "Famous soccer player",
8	"metadata": {
9	"sport": "soccer",
10	"team": "Team A",
11	"role": "forward"
12	},
13	"asset_ids": [
14	"6298d673f1090f1100476d4c",
15	"6298d673f1090f1100476d4d"
16	],
17	"status": "ready",
18	"created_at": "2022-06-02T10:30:00Z",
19	"updated_at": "2022-06-02T10:30:00Z"
20	}
21	],
22	"page_info": {
23	"limit_per_page": 10,
24	"page": 1,
25	"total_page": 1,
26	"total_results": 2
27	}
28	}