List video embedding tasks
This method returns a list of the video embedding tasks in your account. The platform returns your video embedding tasks sorted by creation date, with the newest at the top of the list.
<Note title="Notes">
- Video embeddings are stored for seven days
- When you invoke this method without specifying the `started_at` and `ended_at` parameters, the platform returns all the video embedding tasks created within the last seven days.
</Note>
Authentication
x-api-keystring
Your API key.
<Note title="Note">
You can find your API key on the <a href="https://playground.twelvelabs.io/dashboard/api-key" target="_blank">API Key</a> page.
</Note>
Query parameters
started_at
Retrieve the video embedding tasks that were created after the given date and time, expressed in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”).
ended_at
Retrieve the video embedding tasks that were created before the given date and time, expressed in the RFC 3339 format (“YYYY-MM-DDTHH:mm:ssZ”).
status
Filter video embedding tasks by their current status. Possible values are processing, ready, or failed.
page
A number that identifies the page to retrieve.
Default: 1.
page_limit
The number of items to return on each page.
Default: 10.
Max: 50.
Response
A list of video embedding tasks has successfully been retrieved.
data
An array that contains up to page_limit video embedding tasks.
page_info
An object that provides information about pagination.
