Sign in
room

Creates a room

post/room

Request body

maxPeersinteger nullable

Maximum amount of peers allowed into the room

peerlessPurgeTimeoutinteger nullable

Duration (in seconds) after which the room will be removed if no peers are connected. If not provided, this feature is disabled.

roomIdstring nullable

Custom id used for identifying room within Jellyfish. Must be unique across all rooms. If not provided, random UUID is generated.

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,
  "peerlessPurgeTimeout": 60,
  "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,
        "peerlessPurgeTimeout": 60,
        "webhookUrl": "https://backend.address.com/jellyfish-notifications-endpoint"
      },
      "id": "room-1",
      "peers": [
        {
          "id": "peer-1",
          "metadata": {
            "name": "JellyfishUser"
          },
          "status": "disconnected",
          "type": "webrtc"
        }
      ]
    }
  }
}

Changes