Create a video

POST 
/api/video

Creates a hosted video. A video can be uploaded in any common video format and will be converted to mp4. The upload video will be converted to any of the selected resolutions and will receive a unique url for each. It's important to decide if your video will be public or private by setting isPublic correctly. Public video urls are accessible by anyone and private video urls are signed with an expiration timestamp. You can optionally use thumbnail_timestamps_seconds to generate thumbnails for timestamps within the video uploaded for each resolution selected.

Request

Header Parameters

X-API-KEY stringrequired

Hyperserve api key

multipart/form-data

Body

required

file required
resolutions stringrequired

Comma separated string of selected resolutions, possible values are 144p, 240p, 360p, 480p, 720p, 1080p, 1440p, 4k, 8k.

thumbnail_timestamps_seconds string

Comma separated string of timestamps in seconds

isPublic stringrequired

Stringified true or false

Responses

201

The video has been sucessfully created and is processing

application/json

Schema

Schema

videoId uuidrequired
status stringrequired

Possible values: [pending, ready, fail]

Example (from schema)

{
  "videoId": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "status": "pending"
}

Loading...