Sign in

v3

latestOpenAPI 3.1.02026-07-3197486526.1 KB
entityCollections > entities

List entities in an entity collection

This method returns a list of the entities in the specified entity collection.

get/entity-collections/{entity_collection_id}/entities

Path parameters

entity_collection_idstring required

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

Query parameters

pageinteger

A number that identifies the page to retrieve.

Default: 1.

page_limitinteger

The number of items to return on each page.

Default: 10. Max: 50.

namestring

Filter entities by name.

status'processing' | 'ready'

Filter entities by status.

sort_by'created_at' | 'updated_at' | 'name'

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.
sort_optionstring

The sorting direction. The following options are available:

  • asc
  • desc

Default: desc.

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 entities have been successfully retrieved.