Create a live

Live Test Server (live data - latest nightly version)

https://peertube2.cpy.re/api/v1

POST

/videos/live

Live VideosVideo

Request Example

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://peertube2.cpy.re/api/v1/videos/live' \
--form 'channelId=""' \
--form 'name=""'

Response Example

200 - Example 1

{
    "video": {
        "id": {},
        "shortUUID": {},
        "uuid": {}
    }
}

Request

Body Params multipart/form-data

category

string

optional

channelId

string

required

Channel id that will contain this live video

commentsEnabled

string

optional

Enable or disable comments for this live video/replay

description

string

optional

Live video/replay description

downloadEnabled

string

optional

Enable or disable downloading for the replay of this live video

language

string

optional

licence

string

optional

name

string

required

Live video/replay name

nsfw

string

optional

Whether or not this live video/replay contains sensitive content

permanentLive

string

optional

User can stream multiple times in a permanent live

previewfile

file

optional

Live video/replay preview file

privacy

string

optional

saveReplay

string

optional

support

string

optional

A text tell the audience how to support the creator

Example:

Please support our work on https://soutenir.framasoft.org/en/ <3

tags

string

optional

Live video/replay tags (maximum 5 tags each between 2 and 30 characters)

thumbnailfile

file

optional

Live video/replay thumbnail file

Responses

🟢200successful operation

application/json

Body

video

object

optional

id

object

optional

shortUUID

object

optional

uuid

object

optional

🟠400Disambiguate via `type`: - default type for a validation error - `live_conflicting_permanent_and_save_replay` for conflicting parameters set

🟠403Disambiguate via `type`: - `live_not_enabled` for a disabled live feature - `live_not_allowing_replay` for a disabled replay feature - `max_instance_lives_limit_reached` for the absolute concurrent live limit - `max_user_lives_limit_reached` for the user

Modified at 2022-09-10 22:29:50

Get information about a live