OCT-103 Gumlet outreach
POST/video/live/assets

Create a live streaming asset

Creates a live streaming asset for a live video source. Supply live_source_id and resolution; orientation accepts landscape or potrait, and start_at uses date-time format. A 200 response includes the asset ID, stream key, stream URL, status, and playback details.

  • IdempotentThe SDK sends Idempotency-Key, so a retried request is only applied once.

6 body fields

Live streaming asset configuration. live_source_id and resolution are required.

live_source_idstringrequired

Gumlet live video source/collection id.

mp4_accessbooleanoptional

Creates <code>MP4</code> version for download purpose.

orientationstringoptional

The stream orientation: landscape or potrait.

Allowed:landscapepotrait
resolutionstringrequired

Required resolutions in HLS delivery format for live stream. Can be an array of string out of the following values: 240p, 360p, 480p, 540p, 720p, and 1080p. Resized rendition will retain the input aspect ratio.

start_atstringoptional

The scheduled start time in date-time format.

titlestringoptional

Your live stream asset title

5 status codes
200Returns the created live asset, including its identifier, source, status, stream key, stream URL, playback details, thumbnail URLs, and timestamps.
created_atintegeroptional
Default:0
inputobjectoptional
live_asset_idstringoptional
live_video_source_idstringoptional
outputobjectoptional
statusstringoptional
stream_keystringoptional
stream_urlstringoptional
thumbnailobjectoptional
updated_atintegeroptional
Default:0
vod_asset_idstringoptional
400Returned when the request is invalid.

One documented failure

  • parameter_missing

    One or more required values are missing.

errorobjectrequired
401Returned when the request is unauthorized.

One documented failure

  • source_not_found

    Could not find any video source with specified source ID.

errorobjectoptional
403Returned when the monthly live streaming quota is exceeded.

One documented failure

  • live_stream_monthly_usage_quota_exceeded

    You have already exceeded your monthly quota for live streaming usage. Please upgrade your plan.

errorobjectrequired
422Returned when request validation fails.

One documented failure

  • invalid_parameter

    body must have required property '<field>'

errorobjectrequired

Error handling

A 400 is returned for a bad request, a 401 for an unauthorized request, a 403 when the monthly live streaming quota is exceeded, and a 422 when request validation fails. live_source_id and resolution are required; orientation must be landscape or potrait, and start_at must use date-time format.