Create via API

Creates a new room. This provides a more scalable way of creating a room.

curl --location --request POST 'https://api.100ms.live/v2/rooms' \
--header 'Authorization: Bearer <management_token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "name": "new-room-1662723668",
    "description": "This is a sample description for the room",
    "template_id": "<template_id of the template you wish to associate with the room>"
}'

{
    "id": "631b2654f771854d9bf633df",
    "name": "new-room-1662723668",
    "enabled": true,
    "description": "This is a sample description for the room",
    "customer_id": "627cdddff2e4e30487862ad1",
    "app_id":"62510797903d857ab8ec3ba5",
    "recording_info": {
        "enabled": false
    },
    "template_id": "63188115d11d6db790c73c60",
    "template": "sample-template-name",
    "region": "us",
    "created_at": "2022-09-09T11:41:08.082Z",
    "updated_at": "2022-09-09T11:41:08.074Z"
}

Main Arguments

webhook arguments

recording info arguments

recording_info in the room acts as an atomic property. It depends on the recording settings defined in a template as below:

• If the recording_info key is not provided in the API, the room will fill it with recording settings from the template. And the response body will include recording_source_template: true. This implies that whenever recording info is modified in the template, the recording settings for the room will also be updated.
• If the recording_info key is provided in the API, the recording settings of the room won't be affected by the template at all.

To know more about recording please visit Recording.

upload_info arguments

Options arguments

Credentials arguments

The access keys should have read(GetObject) and write(PutObject) permissions for the storage bucket. For more details check - https://docs.aws.amazon.com/IAM/latest/UserGuide/id_credentials_access-keys.html

Errors

More info on API errors here - https://www.100ms.live/docs/server-side/v2/how-to-guides/make-api-calls#errors