Sign in

v3

latestOpenAPI 3.1.02026-07-3197486526.1 KB
indexes > videos

List videos

<Info>This method will be deprecated in a future version. New implementations should use the List indexed assets method.</Info>

This method returns a list of the videos in the specified index. By default, the platform returns your videos sorted by creation date, with the newest at the top of the list.

get/indexes/{index-id}/videos

Path parameters

index-idstring required

The unique identifier of the index for which the platform will retrieve the videos.

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.

sort_bystring

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

  • updated_at: Sorts by the time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), when the item was updated.
  • created_at: Sorts by the time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"), when the item was created.

Default: created_at.

sort_optionstring

The sorting direction. The following options are available:

  • asc
  • desc

Default: desc.

filenamestring

Filter by filename.

gtenumber double
ltenumber double

Filter by duration in seconds. Pass an object with gte and/or lte for range filtering. For exact match, set both to the same value.

gtenumber double
ltenumber double

Filter by frames per second. Pass an object with gte and/or lte for range filtering. For exact match, set both to the same value.

gteinteger
lteinteger

Filter by width in pixels. Pass an object with gte and/or lte for range filtering. For exact match, set both to the same value.

gteinteger
lteinteger

Filter by height in pixels. Pass an object with gte and/or lte for range filtering. For exact match, set both to the same value.

gtenumber double
ltenumber double

Filter by size in bytes. Pass an object with gte and/or lte for range filtering. For exact match, set both to the same value.

created_atstring

Filter videos by the creation date and time of their associated indexing tasks, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"). The platform returns the videos whose indexing tasks were created on the specified date at or after the given time.

updated_atstring

This filter applies only to videos updated using the PUT method of the /indexes/{index-id}/videos/{video-id} endpoint. It filters videos by the last update date and time, in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ"). The platform returns the video indexing tasks that were last updated on the specified date at or after the given time.

user_metadataobject

To enable filtering by custom fields, you must first add user-defined metadata to your video by calling the PUT method of the /indexes/:index-id/videos/:video-id endpoint.

Examples:

  • To filter on a string: ?category=recentlyAdded
  • To filter on an integer: ?batchNumber=5
  • To filter on a float: ?rating=9.3
  • To filter on a boolean: ?needsReview=true

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 video vectors in the specified index have successfully been retrieved.