API Method: /api/live/create

Create a new live stream.

Parameters

ParameterDescription
name (required)The name of the live stream. All HTML tags will be stripped away from the name.
descriptionDescription of the live stream. The value can include save HTML tags such as <b> or <p>; however, if any disallowed tags are included, all html with be stripped from the description.
formatThe format of the live event to be created. Valid options are available through the /api/live/list-formats method.
streaming_methodThe streaming method for this live event. Valid options are: webcam, iphone, android, mobile, hardware and software.
album_idAn ID for the ID associated with the live stream.
formatThe format key to be associated with the live stream.
private_pSpecify if the live event is private or visible to users on your site.
Default is 1
Allowed values: 0 or 1
promoted_pPromote this live stream.
Default is 0
Allowed values: 0 or 1
allow_dvr_pAllow viewers to step back in time using the DVR feature?
Allowed values: 0 or 1
auto_promote_pAutomatically promote the live stream when it goes live.
Default is 0
Allowed values: 0 or 1
auto_record_pAutomatically record streams to the site's video archive.
Default is 0
Allowed values: 0 or 1
publish_recordings_pPublish recordings to the site immediately.
Default is 0
Allowed values: 0 or 1

Permission level

The minimum required permission level is:

write

Example XML Response

<response status="ok" permission_level="write" 
  message="The live stream was successfully created" cached="0">
  <live_id>123456</live_id>
  <token>hqzry7xaaekyavpjghpZkt1ykbelKjai</token>
</response>

Example JSON Response

{
  "status": "ok", 
  "message":"The live event was successfully created",
  "permission_level":"write",
  "cached":"0",
  "liveevent":{"live_id": "123456", "token": "hqzry7xaaekyavpjghpZkt1ykbelKjai"},
  "p": "1",
  "size": "1",
  "site": { ...},
  "endpoint": "/api/live/create"
}