video

Create a video upload

Creates a video record and returns a presigned PUT URL plus a server-chosen contentType (from the filename extension). Upload the original file with HTTP PUT to uploadUrl, using exactly the returned Content-Type header value. Then call POST /api/video/{id}/complete-upload to verify the object and queue transcoding. Output resolutions are MP4. isPublic controls whether playback URLs are public or time-limited signed URLs. Requires the X-API-KEY header; see https://docs.hyperserve.io/guides/getting-started.

post/api/video

Request

  • Base URL: https://api.hyperserve.io
  • URL: https://api.hyperserve.io/api/video
  • Auth: API key in header X-API-KEY

Headers

X-API-KEYstring required

Hyperserve api key

Request body

filenamestring required
resolutionsstring[] required
isPublicboolean required
thumbnailTimestampsSecondsnumber[]
customMetadataobject

Response

Video record created. Upload the file to the provided URL, then call complete-upload.

idstring uuid required

Video id; use in complete-upload and subsequent API calls

uploadUrlstring uri required

Presigned PUT URL for the original file (expires after a short time)

contentTypestring required

Exact value to send as the Content-Type header on the presigned PUT (derived from filename extension)

isPublicboolean required
resolutionsobject required

Per-resolution status; all start as pending_upload until processing completes

Changes

No recorded changes to this operation across all 1 revision of this API.