Download OpenAPI specification:Download
This API allows management of video files. There is the capability of generating a signed url for upload or playback, as well as requesting deletion of an uploaded video. Videos should first be uploaded via the signed url before playback or deletion endpoints are used.
An API key must be provided under the "Authentication" header for each request
Request a signed S3 URL to upload a new video file
Requires an AWS Secret Name and Policy access to a shared secret) Optional file extension
| extension | string File Extension, defaults to "mp4" |
{- "extension": "string"
}{- "signedUrl": "string",
- "videoAssetId": "213f6253-9413-4d31-b85c-9a2b325cc885"
}Request to upload a new video - returned temporary credentials for multi-part S3 upload
Requires an AWS Secret Name and Policy access to a shared secret) Optional file extension
| extension | string File Extension, defaults to "mp4" |
{- "extension": "string"
}{- "bucket": "string",
- "key": "string",
- "credentials": "string",
- "videoAssetId": "213f6253-9413-4d31-b85c-9a2b325cc885"
}Request signed s3 playback urls for all uploaded video files for a given videoAssetId
Requires an AWS Secret Name and Policy access to a shared secret) | videoAssetId required | string <uuid> ID of videos to return |
| hls | boolean If set, return HLS playback URL |
{- "playbackUrls": [
- "string"
]
}Request deletion of a previously uploaded video file
Requires an AWS Secret Name and Policy access to a shared secret) | videoAssetId required | string <uuid> ID of video to delete |
{- "videoAssetId": "213f6253-9413-4d31-b85c-9a2b325cc885"
}Request a single signed s3 playback url for a previously uploaded video file
Requires an AWS Secret Name and Policy access to a shared secret) | videoAssetId required | string <uuid> ID of a video to return |
| hls | boolean If set, return HLS playback URL |
{- "playbackUrl": "string"
}Request a single S3 signed URL for the first sprite in a preivously uploaded video file
Requires an AWS Secret Name and Policy access to a shared secret) | recordedFileId required | string <uuid> ID of Video to access sprite for |
{- "frameDuration": 0,
- "framesPerSprite": 0,
- "frameWidth": 0,
- "frameHeight": 0,
- "signedSpriteUrl": "string"
}