VideoSDK · Schema

Room

A VideoSDK meeting room.

VideoAudioWebRTCReal-Time CommunicationLive StreamingHLSRTMPAI AgentsVideo ConferencingWebSocket

Properties

Name	Type	Description
roomId	string	Unique meeting room identifier.
customRoomId	string	Custom identifier provided at room creation.
userId	string	User ID of the room creator.
disabled	boolean	Whether the room has been deactivated.
createdAt	string	ISO 8601 timestamp of room creation.
updatedAt	string	ISO 8601 timestamp of last update.
id	string	Internal document ID.
links	object	Convenience HATEOAS links.

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://api.videosdk.live/v2/schemas/room",
  "title": "Room",
  "description": "A VideoSDK meeting room.",
  "type": "object",
  "properties": {
    "roomId": {
      "type": "string",
      "description": "Unique meeting room identifier.",
      "example": "abc-xyzw-lmno"
    },
    "customRoomId": {
      "type": "string",
      "description": "Custom identifier provided at room creation."
    },
    "userId": {
      "type": "string",
      "description": "User ID of the room creator."
    },
    "disabled": {
      "type": "boolean",
      "description": "Whether the room has been deactivated."
    },
    "createdAt": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp of room creation."
    },
    "updatedAt": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp of last update."
    },
    "id": {
      "type": "string",
      "description": "Internal document ID."
    },
    "links": {
      "type": "object",
      "description": "Convenience HATEOAS links.",
      "properties": {
        "get_room": { "type": "string", "format": "uri" },
        "get_session": { "type": "string", "format": "uri" }
      }
    }
  },
  "required": ["roomId"]
}