Create live session

POST

public

create-live-event-session

Create live session

curl --request POST \
  --url https://backend.codedamn.com/api/public/create-live-event-session \
  --header 'Content-Type: application/json' \
  --header 'FERMION-API-KEY: <api-key>' \
  --data '
{
  "data": [
    {
      "data": {
        "estimatedStartAtIso": "2023-11-07T05:31:56Z",
        "estimatedEventDurationInMinutes": 15,
        "eventTitle": "Untitled event",
        "shouldUseDrmForViewer": false,
        "shouldAddEveryoneOnStageByDefault": false
      }
    }
  ]
}
'

[
  {
    "output": {
      "status": "ok",
      "data": {
        "liveEventId": "<string>",
        "liveEventSessionId": "<string>"
      }
    }
  }
]

Authorizations

FERMION-API-KEY

string

header

required

Body

application/json

API Request Body

data

object[]

required

Show child attributes

data.data

object

required

Show child attributes

data.data.estimatedStartAtIso

string<date-time>

required

Estimated start time in ISO format. This is only used as a hint and is not enforced (you may start live event before/after this as well)

data.data.estimatedEventDurationInMinutes

required

Estimated duration of the live event in minutes. Must be one of: 15, 30, 45, 60, 90, 120, 180, 240, 300, or 360 minutes

Available options:

15

data.data.eventTitle

string

default:Untitled event

The title of the event. This will be visible to users inside call

data.data.shouldUseDrmForViewer

boolean

default:false

If passed as true, the HLS playback on viewer side will use DRM protection (widevine and fairplay)

data.data.shouldAddEveryoneOnStageByDefault

boolean

default:false

If passed as true, then everyone would be added on stage by default. Note that the max number of students on stage (stage limit) is enforced by the plan limit you have with Fermion.

Response

200 - application/json

API Response Body

output

object

required

Option 1
Option 2

Show child attributes

output.status

enum<string>

required

Available options:

ok

output.data

object

required

Show child attributes

output.data.liveEventId

string

required

This is the event ID of the live event.

output.data.liveEventSessionId

string

required

This is the session ID of the live event session you must use in your other API calls to modify the session.

Delete live event session Delete a live event session. This operation cannot be undone. Authentication with the "FERMION-API-KEY" header is required to use this endpoint. Rate limit: Maximum 60 requests in a window of 1m.

⌘I

Create live session

curl --request POST \
  --url https://backend.codedamn.com/api/public/create-live-event-session \
  --header 'Content-Type: application/json' \
  --header 'FERMION-API-KEY: <api-key>' \
  --data '
{
  "data": [
    {
      "data": {
        "estimatedStartAtIso": "2023-11-07T05:31:56Z",
        "estimatedEventDurationInMinutes": 15,
        "eventTitle": "Untitled event",
        "shouldUseDrmForViewer": false,
        "shouldAddEveryoneOnStageByDefault": false
      }
    }
  ]
}
'

[
  {
    "output": {
      "status": "ok",
      "data": {
        "liveEventId": "<string>",
        "liveEventSessionId": "<string>"
      }
    }
  }
]

Using API

Endpoints

Authorizations

Body

Response