Skip to main content
POST
This endpoint requires authentication and the createLivestream permission.

Request Body

string
required
Title of the livestream
string
required
Description of the livestream
string
YouTube URL for the livestream
string
Custom streaming URL
string
Scheduled start time in ISO 8601 format
array
required
Array of tags associated with the livestream
string
URL of the livestream thumbnail
string
UUID of the uploaded thumbnail file

Response

Returns the created livestream object.
string
Livestream’s unique identifier (UUID)
string
Title of the livestream
string
Description of the livestream
string
YouTube URL for the livestream
string
Custom streaming URL
string
Current status of the livestream (defaults to “scheduled”)
string
Scheduled start time in ISO 8601 format
array
Array of tags associated with the livestream
string
URL of the livestream thumbnail
object
Thumbnail file information
string
UUID of the user who created the livestream
string
UUID of the user who last updated the livestream
string
Creation timestamp in ISO 8601 format
string
Last update timestamp in ISO 8601 format

Error Responses

object
Error details when the request fails
Common error cases:
  • 400 Bad Request: Invalid request body
  • 401 Unauthorized: Missing or invalid access token
  • 403 Forbidden: Missing required permission