List entities in an entity collection

GET

https://api.twelvelabs.io/v1.3/entity-collections/:entity_collection_id/entities

GET

/v1.3/entity-collections/:entity_collection_id/entities

curl -G https://api.twelvelabs.io/v1.3/entity-collections/6298d673f1090f1100476d4c/entities \
     -H "x-api-key: <apiKey>" \
     --data-urlencode "name=My entity" \
     -d status=ready \
     -d sort_by=created_at

{
  "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 the entities in the specified entity collection.

Authentication

x-api-keystring

Your API key.

Note

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

Path parameters

entity_collection_idstringRequired

The unique identifier of the entity collection for which the platform will retrieve the entities.

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.

namestringOptional

Filter entities by name.

statusenumOptional

Filter entities by status.

Allowed values:

sort_byenumOptionalDefaults to created_at

The field to sort on. The following options are available:

created_at: Sorts by the time, in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the entity was created.
updated_at: Sorts by the time, in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”), when the entity collection was updated.
name: Sorts by the name.

Allowed values:

sort_optionstringOptionalDefaults to desc

The sorting direction. The following options are available:

asc
desc

Default: desc.

Response

The entities have been successfully retrieved.

datalist of objectsOptional

An array containing the entities.

page_infoobjectOptional

An object that provides information about pagination.

Errors

400

Bad Request Error