The endpoints that return lists of items support filtering. You can use the following parameters to control sorting behavior:

• Sorting criteria: Use the sort_by parameter to specify the field you want to sort on. The following options are available:
  • updated_at: Sorts by the date and time when the item was updated.
  • created_at: Sorts by the date and time when the item was created.
• Sorting direction: Use the sort_option parameter to specify the sorting direction. The following options are available:
  • asc: For ascending order.
  • desc: For descending order. This is the default value.

The examples in this section are specific to listing your video indexing tasks. The same principles apply to other similar endpoints.

Prerequisites

• You’re familiar with the concepts that are described on the Platform overview page.
• You’ve already created an index.
• You’ve already uploaded a video.

Examples

Sort by creation date

To sort items by their creation date, invoke the list method on the task object, specifying "created_at" for the sort_by parameter.

1
from twelvelabs import TwelveLabs
2
3
client = TwelveLabs(api_key="<YOUR_API_KEY>")
4
5
tasks = client.task.list(sort_by="created_at")
6
for task in tasks:
7
    print(f"id={task.id} status={task.status} created_at={task.created_at}")

The following output was truncated for brevity:

id=65e86608bb29f13bdd6f3c2e status=pending created_at=2024-03-06T12:48:08.685Z
id=65e865b7bb29f13bdd6f3c2b status=pending created_at=2024-03-06T12:46:47.75Z
id=65e86582bb29f13bdd6f3c28 status=pending created_at=2024-03-06T12:45:54.256Z

Specify the sort order

The example code below demonstrates how to sort items by their creation date in ascending order. Specify "created_at" for the sort_by parameter and "asc" for the sort_option parameter to reverse the default sorting order:

1
from twelvelabs import TwelveLabs
2
3
client = TwelveLabs(api_key="<YOUR_API_KEY>")
4
5
tasks = client.task.list(
6
    sort_by="created_at",
7
    sort_option="asc"
8
    )
9
for task in tasks:
10
    print(f"id={task.id} status={task.status} created_at={task.created_at}")

The following output was truncated for brevity:

id=65b9f6b79e82682070384431 status=ready created_at=2024-01-31T07:28:55.406Z
id=65b9f6b89e82682070384432 status=ready created_at=2024-01-31T07:28:56.474Z
id=65b9f6b89e82682070384433 status=ready created_at=2024-01-31T07:28:56.522Z

Combine sorting and pagination

The following example code sorts items by their creation date and specifies that each page should contain 5 items:

1
from twelvelabs import TwelveLabs
2
3
client = TwelveLabs(api_key="<YOUR_API_KEY>")
4
5
tasks = client.task.list_pagination(
6
  sort_by="created_at",
7
  page_limit=5
8
)
9
10
# Utility function to print a specific page
11
def print_page(page):
12
  for task in page:
13
    print(f"id={task.id} status={task.status} created_at={task.created_at}")
14
15
print_page(tasks.data)
16
17
while True:
18
    try:
19
        print_page(next(tasks))
20
    except StopIteration:
21
        break

The following output was truncated for brevity:

id=65e86608bb29f13bdd6f3c2e status=pending created_at=2024-03-06T12:48:08.685Z
id=65e865b7bb29f13bdd6f3c2b status=pending created_at=2024-03-06T12:46:47.75Z
id=65e86582bb29f13bdd6f3c28 status=pending created_at=2024-03-06T12:45:54.256Z