Sign in
room

Creates a room

post/room

Request body

maxPeersinteger nullable

Maximum amount of peers allowed into the room

videoCodec'h264' | 'vp8' nullable

Enforces video codec for each peer in the room

webhookUrlstring nullable

URL where Jellyfish notifications will be sent

Example request

{
  "maxPeers": 10,
  "webhookUrl": "https://backend.address.com/jellyfish-notifications-endpoint"
}

Response

Room successfully created

Example response

{
  "data": {
    "jellyfish_address": "jellyfish1:5003",
    "room": {
      "components": [
        {
          "id": "component-1",
          "type": "hls"
        }
      ],
      "config": {
        "maxPeers": 10,
        "webhookUrl": "https://backend.address.com/jellyfish-notifications-endpoint"
      },
      "id": "room-1",
      "peers": [
        {
          "id": "peer-1",
          "status": "disconnected",
          "type": "webrtc"
        }
      ]
    }
  }
}

Changes