embed > tasks

List video embedding tasks

Changed on
<Note title="Note"> This method will be deprecated in a future version. Migrate to the [Embed API v2](/v1.3/api-reference/create-embeddings-v2) for continued support and access to new features. </Note> 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>
get/embed/tasks

Request

  • Base URL: https://api.twelvelabs.io/v1.3
  • URL: https://api.twelvelabs.io/v1.3/embed/tasks
  • Auth: API key in header x-api-key

Query parameters

started_atstring

Retrieve the embedding tasks that were created after the given date and time, expressed in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ").

ended_atstring

Retrieve the embedding tasks that were created before the given date and time, expressed in the RFC 3339 format ("YYYY-MM-DDTHH:mm:ssZ").

statusstring

Filter the embedding tasks by their current status.

Values: processing, ready, or failed.

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.

Response

A list of async embedding tasks has successfully been retrieved.

Changes