v52

OpenAPI 3.1.0raw.githubusercontent.com2026-07-311,1941,9384.1 MB

Room Compositions

Create a room composition.

Asynchronously create a room composition.

post/room_compositions

Request body

formatstring

The desired format of the room composition.

resolutionstring

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

session_idstring uuid

id of the room session associated with the room composition.

video_layoutobject

Describes the video layout of the room composition in terms of regions.

webhook_event_failover_urlstring uri

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'.

webhook_event_urlstring uri

The URL where webhooks related to this room composition will be sent. Must include a scheme, such as 'https'.

webhook_timeout_secsinteger

Specifies how many seconds to wait before timing out a webhook.

Example request

{
  "format": "mp4",
  "resolution": "800x600",
  "session_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777b0",
  "webhook_event_failover_url": "https://failover.example.com",
  "webhook_event_url": "https://example.com",
  "webhook_timeout_secs": 25
}

Response

Create room composition response.

Example response

{
  "data": {
    "completed_at": "2022-02-25T05:39:56.377426Z",
    "download_url": "https://example.com",
    "duration_secs": 84,
    "ended_at": "2022-02-24T23:22:24.577677Z",
    "format": "mp4",
    "id": "7103dc53-ee59-4b54-a58b-c77d99ceb037",
    "record_type": "composition",
    "resolution": "1280x720",
    "room_id": "f981dbb3-228a-44e9-ac54-e87f0e2658b0",
    "session_id": "8f728d7b-00e2-4c59-8c27-f564b828df87",
    "size_mb": 6,
    "started_at": "2022-02-24T23:21:00.077209Z",
    "status": "enqueued",
    "user_id": "12a04ec9-0f91-4a91-9f3a-a19d9931182e",
    "video_layout": {
      "first": {
        "height": 720,
        "video_sources": [
          "7b61621f-62e0-4aad-ab11-9fd19e272e73"
        ],
        "width": 1280,
        "x_pos": 0,
        "y_pos": 0,
        "z_pos": 0
      }
    },
    "webhook_event_url": "https://webhook.site/544663ce-b692-4f9c-80ed-e5ad97cd5c02"
  }
}