API ReferenceUpload videos

Create a video indexing task

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.

Headers

x-api-keystringRequired

Request

This endpoint expects a multipart form containing an optional file.
index_idstringRequired

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

video_filefileOptional

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

video_urlstringOptional

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

enable_video_streambooleanOptionalDefaults 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.

Response

A video indexing task has successfully been created.

_idstringOptional

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

video_idstringOptional

A string representing the unique identifier of the video associated with the specified video indexing task.

Errors