v52

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

Room Compositions

View a list of room compositions.

get/room_compositions

Query parameters

session_idstring uuid

The session_id for filtering room compositions.

status'completed' | 'processing' | 'enqueued'

The status for filtering room compositions.

Consolidated filter parameter (deepObject style). Originally: filter[date_created_at][eq], filter[date_created_at][gte], filter[date_created_at][lte], filter[session_id], filter[status]

{
  "date_created_at": {
    "eq": "2021-04-25",
    "gte": "2021-04-25",
    "lte": "2021-04-25"
  },
  "session_id": "92e7d459-bcc5-4386-9f5f-6dd14a82588d",
  "status": "completed"
}

numberinteger

The page number to load.

sizeinteger

The size of the page.

Consolidated page parameter (deepObject style). Originally: page[size], page[number]

Response

List room compositions 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"
    }
  ],
  "meta": {
    "page_number": 2,
    "page_size": 25,
    "total_pages": 3,
    "total_results": 55
  }
}