LiveStreams

Create a Media Asset for prerecorded livestreams

Creates a BaseVideo after a direct upload through createUploadSignature or createMultipartUploadSignature, matching the CMS upload flow. Pass the key returned by that operation as s3_key. The object must exist under the authenticated channel's S3 prefix; external S3 URLs are not supported. Transcoding starts asynchronously, so use listBaseVideos to check transcoding_status before starting the livestream.

post/api/v1/base_videos

Request

  • Base URL: https://api.firework.com
  • URL: https://api.firework.com/api/v1/base_videos
  • Auth: OAuth 2 (client credentials, token URL /oauth/token, scopes: livestreams:write)

Request body

titlestring required

Display name for the Media Asset

channel_idstring

Channel ID (optional when the authenticated business has exactly one channel)

s3_keystring required

The key returned by createUploadSignature or createMultipartUploadSignature after the upload completes

Response

BaseVideo created and queued for transcoding

idstring

BaseVideo ID

titlestring
urlstring nullable
inserted_atstring date-time
durationnumber nullable
thumbnail_urlstring nullable
transcoding_status'pending' | 'transcoded' | 'error'

Changes

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