v50

latestOpenAPI 3.1.0raw.githubusercontent.com2024-10-175745153.1 KB

room

Create a room user

Call this endpoint to add a user to a room, specifying a display name at a minimum. The response will contain a joining URL for Livepeer's default meeting app. Alternatively the joining token can be used with a custom app.

post/room/{id}/user

Path parameters

idstring required

Request body

namestring required

Display name

canPublishboolean

Whether a user is allowed to publish audio/video tracks

canPublishDataboolean

Whether a user is allowed to publish data messages to the room

metadatastring

User defined payload to store for the participant

Example request

{
  "name": "name",
  "canPublish": true,
  "canPublishData": true
}

Response

Success

idstring

The ID of the user

joinUrlstring

Joining URL - use this for Livepeer's default meeting app (see the multiparticipant streaming guide for more info).

tokenstring

Joining JWT - this can be used if you have a custom meeting app (see the multiparticipant streaming guide for more info).

Example response

{
  "id": "d32ae9e6-c459-4931-9898-e86e2f5e7e16",
  "joinUrl": "https://meet.livepeer.chat",
  "token": "token"
}