Create quick video room

Creates an active video meeting room. Project features and default locks apply with video-specific adjustments, and a legacy public attendee invitation is also created. An optional external_user_id binds a stable creator identity. Returns room_id and a credential-bearing final_link, plus participant_id for an identity-bound creator. Invalid settings, duplicate client_room_id, and project/key mismatches are rejected.

Authorization

key<token>

In: header

hash-signature<token>

Base64-encoded HMAC-SHA256 of the resolved request body, signed with the project secret (not the API key).

In: header

Request Body

project_idstring

namestring

Required for quick creation; non-blank and at most 255 characters when external_user_id is supplied.

external_user_id?string

Optional stable creator ID. Supply at creation for stable creator identity and rejoin.

Lengthlength <= 255

logout_url?string

Optional top-level HTTP(S) room logout override; omitted, null or empty uses the project default.

Lengthlength <= 255

webhook_url?string

Optional room webhook URL; falls back to the project setting.

client_room_id?string

max_participantsstring|integer

empty_timeoutstring|integer

metadata

Response Body

application/json

curl -X POST "https://api.qriib.dev/api/v4/rooms/create_quick_video_room" \  -H "Content-Type: application/json" \  -d '{    "type": "object",    "required": [      "project_id",      "name",      "max_participants",      "empty_timeout",      "metadata"    ],    "properties": {      "project_id": {        "type": "string"      },      "name": {        "type": "string",        "description": "Required for quick creation; non-blank and at most 255 characters when external_user_id is supplied."      },      "external_user_id": {        "type": "string",        "maxLength": 255,        "description": "Optional stable creator ID. Supply at creation for stable creator identity and rejoin."      },      "logout_url": {        "type": "string",        "maxLength": 255,        "description": "Optional top-level HTTP(S) room logout override; omitted, null or empty uses the project default."      },      "webhook_url": {        "type": "string",        "description": "Optional room webhook URL; falls back to the project setting."      },      "client_room_id": {        "type": "string"      },      "max_participants": {        "oneOf": [          {            "type": "string"          },          {            "type": "integer"          }        ]      },      "empty_timeout": {        "oneOf": [          {            "type": "string"          },          {            "type": "integer"          }        ]      },      "metadata": {        "type": "object",        "required": [          "room_title",          "welcome_message"        ],        "properties": {          "room_title": {            "type": "string",            "description": "Mandatory main title of the room displayed to participants"          },          "welcome_message": {            "type": "string"          },          "room_features": {            "type": "object",            "description": "Only room_duration and breakout_room_features.allowed_number_rooms are read as room-level requests; other features come from project settings and plan policy. metadata.default_lock_settings does not override project defaults.",            "properties": {              "room_duration": {                "type": "integer"              },              "breakout_room_features": {                "type": "object",                "properties": {                  "allowed_number_rooms": {                    "type": "integer"                  }                }              }            }          }        }      }    },    "examples": [      {        "project_id": "{{projectId}}",        "name": "hisham",        "client_room_id": "daszc1s333xsw",        "max_participants": "20",        "empty_timeout": "300",        "metadata": {          "room_title": "Test room",          "welcome_message": "Welcome to room",          "room_features": {            "room_duration": 60          }        }      }    ]  }'

{
  "room_id": "room-123",
  "participant_id": "opaque-participant-id",
  "final_link": "https://meeting.example/?token=<redacted>",
  "status": true
}

{
  "error": "Invalid signature"
}

curl -X POST "https://api.qriib.dev/api/v4/rooms/create_quick_video_room" \ -H "Content-Type: application/json" \ -d '{ "type": "object", "required": [ "project_id", "name", "max_participants", "empty_timeout", "metadata" ], "properties": { "project_id": { "type": "string" }, "name": { "type": "string", "description": "Required for quick creation; non-blank and at most 255 characters when external_user_id is supplied." }, "external_user_id": { "type": "string", "maxLength": 255, "description": "Optional stable creator ID. Supply at creation for stable creator identity and rejoin." }, "logout_url": { "type": "string", "maxLength": 255, "description": "Optional top-level HTTP(S) room logout override; omitted, null or empty uses the project default." }, "webhook_url": { "type": "string", "description": "Optional room webhook URL; falls back to the project setting." }, "client_room_id": { "type": "string" }, "max_participants": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "empty_timeout": { "oneOf": [ { "type": "string" }, { "type": "integer" } ] }, "metadata": { "type": "object", "required": [ "room_title", "welcome_message" ], "properties": { "room_title": { "type": "string", "description": "Mandatory main title of the room displayed to participants" }, "welcome_message": { "type": "string" }, "room_features": { "type": "object", "description": "Only room_duration and breakout_room_features.allowed_number_rooms are read as room-level requests; other features come from project settings and plan policy. metadata.default_lock_settings does not override project defaults.", "properties": { "room_duration": { "type": "integer" }, "breakout_room_features": { "type": "object", "properties": { "allowed_number_rooms": { "type": "integer" } } } } } } } }, "examples": [ { "project_id": "{{projectId}}", "name": "hisham", "client_room_id": "daszc1s333xsw", "max_participants": "20", "empty_timeout": "300", "metadata": { "room_title": "Test room", "welcome_message": "Welcome to room", "room_features": { "room_duration": 60 } } } ] }'

Create quick video room

Authorization

Request Body

Response Body

201application/json

401application/json

Authorization

Request Body

Response Body

201application/json

401application/json

application/json

application/json

application/json

application/json