API Reference
SDKsSample appsIntegrationsDiscordPlayground

The task object

A task represents a request to upload and index a video. The task object is composed of the following fields:

  • _id: A string representing the unique identifier of the task. It is assigned by the API service when a new task is created.
  • created_at: A string indicating the date and time, in the RFC 3339 format, that the task was created.
  • estimated_time: A string indicating the estimated date and time, in the RFC 3339 format, that the video is ready to be searched.
  • index_id: A string representing the index to which the video has been uploaded.
  • video_id: A string representing the unique identifier of the video associated with this video indexing task. The API returns this field only when the video has successfully been indexed.
  • metadata: An object that contains the following information about the video:
    • duration
    • filename
    • height
    • width
  • status: A string indicating the status of the video indexing task. It can take one of the following values:
    • Validating: Your video has finished uploading, and the API service is validating it by ensuring it meets the requirements in the Prerequisites section of the Upload single videos page.
    • Pending: The platform is spawning a new worker server to process your video.
    • Queued: A worker server has been assigned, and the platform is preparing to begin indexing.
    • Indexing: The platform transforms the video you uploaded into embeddings. An embedding is a compressed version of the video and contains all the information that Twelve Labs' deep-learning models need to perform downstream tasks.
    • Ready: The platform has finished indexing your video.
    • Failed: If an error occurs, the status is set to Failed.
  • hls: The platform returns this object only for the videos that you uploaded with the disable_video_stream parameter set to false. This object has the following fields:
    • video_url: A string representing the URL of the video. You can use this URL to access the stream over the HLS protocol.
    • thumbnail_urls: An array containing the URL of the thumbnail.
    • status: A string representing the encoding status of the video file from its original format to a streamable format.
    • updated_at: A string indicating the date and time, in the RFC 3339 format, that the encoding status was last updated.
  • updated_at: A string indicating the date and time, in the RFC 3339 format, that the task object was last updated. The API service updates this field every time the video indexing task transitions to a different state.