Create a video indexing task

post

https://api.twelvelabs.io/v1.3/tasks

This method creates a video indexing task that uploads and indexes a video.
Ensure your video meets the requirements in the Prerequisites section of the Upload single videos page.

Upload options:

Local file: Use the video_file parameter.
Publicly accessible URL: Use the video_url parameter.

NOTES:

The platform supports video URLs that can play without additional user interaction or custom video players. Ensure your URL points to the raw video file, not a web page containing the video. Links to third-party hosting sites, cloud storage services, or videos requiring extra steps to play are not supported.
This endpoint is rate-limited. For details, see the Rate limits page.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Request to upload a video to an index.

index_id

string

required

The unique identifier of the index to which the video is being uploaded.

provide_transcription

boolean

Defaults to false

A boolean value specifying whether or not you provide a transcription for this video.

video_file

file

Specify this parameter to upload a video from your local file system.

transcription_file

file

When the provide_transcription parameter is set to true, and you want to provide a transcription from the local file system, use the transcription_file parameter to pass your transcription file to the platform. It must be a stream of bytes encoded as multipart/form-data. The transcription must be in the SRT or VTT format.

video_url

string

Specify this parameter to upload a video from a publicly accessible URL.

transcription_url

string

When the provide_transcription parameter is set to true, and you want to provide a transcription from a publicly accessible URL, use the transcription_url parameter to specify the URL of your transcription. The transcription must be in the SRT or VTT format.

enable_video_stream

boolean

Defaults to true

This parameter indicates if the platform stores the video for streaming. When set to true, the platform stores the video, and you can retrieve its URL by calling the GET method of the /indexes/{index-id}/videos/{video-id} endpoint. You can then use this URL to access the stream over the HLS protocol.

Headers

x-api-key

string

required

Your API key.

NOTE: You can find your API key on the API Key page.

Responses

200A video indexing task has successfully been created.

400The request has failed.