Create a video indexing task

POST

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.

Request

This endpoint expects a multipart form with multiple files.
index_idstringRequired

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

provide_transcriptionbooleanOptionalDefaults to false

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

video_filefileOptional
transcription_filefileOptional
video_urlstringOptional

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

transcription_urlstringOptional

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.

disable_video_streambooleanOptionalDefaults to false

This parameter indicates if the platform stores the video for streaming. When set to false, 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.

Default: false

Response

A video indexing task has successfully been created.

_idstringOptional

A string representing the unique identifier of your video indexing task.

Errors

Built with