CreateRoomCompositionRequest

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/telnyx/json-schema/telnyx-create-room-composition-request-schema.json",
  "title": "CreateRoomCompositionRequest",
  "x-generated": "2026-10-30",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/telnyx-room-compositions-api-openapi.yml#/components/schemas/CreateRoomCompositionRequest",
  "properties": {
    "format": {
      "default": "mp4",
      "description": "The desired format of the room composition.",
      "type": "string"
    },
    "resolution": {
      "default": "1280x720",
      "description": "The desired resolution (width/height in pixels) of the resulting video of the room composition. Both width and height are required to be between 16 and 1280; and width * height should not exceed 1280 * 720",
      "type": "string"
    },
    "session_id": {
      "description": "id of the room session associated with the room composition.",
      "format": "uuid",
      "type": "string"
    },
    "video_layout": {
      "additionalProperties": {
        "$ref": "#/$defs/VideoRegion"
      },
      "description": "Describes the video layout of the room composition in terms of regions.",
      "type": "object"
    },
    "webhook_event_failover_url": {
      "default": "",
      "description": "The failover URL where webhooks related to this room composition will be sent if sending to the primary URL fails. Must include a scheme, such as 'https'.",
      "format": "uri",
      "type": "string"
    },
    "webhook_event_url": {
      "description": "The URL where webhooks related to this room composition will be sent. Must include a scheme, such as 'https'.",
      "format": "uri",
      "type": "string"
    },
    "webhook_timeout_secs": {
      "default": null,
      "description": "Specifies how many seconds to wait before timing out a webhook.",
      "maximum": 30,
      "minimum": 0,
      "type": "integer"
    }
  },
  "type": "object",
  "$defs": {
    "VideoRegion": {
      "properties": {
        "height": {
          "description": "Height of the video region",
          "minimum": 16,
          "type": "integer"
        },
        "max_columns": {
          "description": "Maximum number of columns of the region's placement grid. By default, the region has as many columns as needed to layout all the specified video sources.",
          "maximum": 1000,
          "minimum": 1,
          "type": "integer"
        },
        "max_rows": {
          "description": "Maximum number of rows of the region's placement grid. By default, the region has as many rows as needed to layout all the specified video sources.",
          "maximum": 1000,
          "minimum": 1,
          "type": "integer"
        },
        "video_sources": {
          "description": "Array of video recording ids to be composed in the region. Can be \"*\" to specify all video recordings in the session",
          "items": {
            "format": "uuid",
            "type": "string"
          },
          "type": "array"
        },
        "width": {
          "description": "Width of the video region",
          "minimum": 16,
          "type": "integer"
        },
        "x_pos": {
          "default": 0,
          "description": "X axis value (in pixels) of the region's upper left corner relative to the upper left corner of the whole room composition viewport.",
          "type": "integer"
        },
        "y_pos": {
          "default": 0,
          "description": "Y axis value (in pixels) of the region's upper left corner relative to the upper left corner of the whole room composition viewport.",
          "type": "integer"
        },
        "z_pos": {
          "default": 0,
          "description": "Regions with higher z_pos values are stacked on top of regions with lower z_pos values",
          "maximum": 99,
          "minimum": -99,
          "type": "integer"
        }
      },
      "type": "object"
    }
  }
}