Room Compositions API

Rooms Compositions operations API

View a list of room compositions.

SecuritybearerAuth
Request
query Parameters
filter[date_created_at][eq]
string <date>

ISO 8601 date for filtering room compositions created on that date.

Example: filter[date_created_at][eq]=2021-04-25
filter[date_created_at][gte]
string <date>

ISO 8601 date for filtering room compositions created after that date.

Example: filter[date_created_at][gte]=2021-04-25
filter[date_created_at][lte]
string <date>

ISO 8601 date for filtering room compositions created before that date.

Example: filter[date_created_at][lte]=2021-04-25
filter[session_id]
string <uuid>

The session_id for filtering room compositions.

Example: filter[session_id]=92e7d459-bcc5-4386-9f5f-6dd14a82588d
filter[status]
string

The status for filtering room compositions.

Enum: "completed" "processing" "enqueued"
Example: filter[status]=completed
page[size]
integer [ 1 .. 250 ]
Default: 20

The size of the page

page[number]
integer >= 1
Default: 1

The page number to load

Responses
200

List room compositions response.

Response Schema: application/json
Array of objects (RoomComposition)
object (PaginationMeta)
get/room_compositions
Request samples 
Response samples 
application/json
{
  • "data": [
    • {
      • "completed_at": "2022-02-25T05:39:56.377426Z",
      • "download_url": null,
      • "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": [
            • "*"
            ],
          • "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
    }
}
Create a room composition.
Asynchronously create a room composition.


SecuritybearerAuth 
Request 
Request Body schema: application/json
required
Parameters that can be defined during room composition creation.


format
string
 Default:  "mp4"
The desired format of the room composition.


 
resolution
string
 Default:  "1280x720"
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_id
string <uuid> 
id of the room session associated with the room composition.


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


 
webhook_event_failover_url
string <url> 
 Default:  ""
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_url
string <url> 
The URL where webhooks related to this room composition will be sent. Must include a scheme, such as 'https'.


 
webhook_timeout_secs
integer  [ 0 .. 30 ] 
 Default:  null
Specifies how many seconds to wait before timing out a webhook.


 
Responses 
202
Create room composition response.


Response Schema: application/json
object (RoomComposition) 
 
completed_at
string <datetime> 
ISO 8601 timestamp when the room composition has completed.


 
created_at
string <datetime> 
ISO 8601 timestamp when the room composition was created.


 
download_url
string
Url to download the composition.


 
duration_secs
integer
Shows the room composition duration in seconds.


 
ended_at
string <datetime> 
ISO 8601 timestamp when the room composition has ended.


 
format
string
Shows format of the room composition.


 Value: "mp4"  
id
string <uuid> 
A unique identifier for the room composition.


 
record_type
string
 
room_id
string <uuid> 
Identify the room associated with the room composition.


 
session_id
string <uuid> 
Identify the room session associated with the room composition.


 
size_mb
number <float> 
Shows the room composition size in MB.


 
started_at
string <datetime> 
ISO 8601 timestamp when the room composition has stated.


 
status
string
Shows the room composition status.


 Enum: "completed" "enqueued" "processing"  
updated_at
string <datetime> 
ISO 8601 timestamp when the room composition was updated.


 
user_id
string <uuid> 
Identify the user associated with the room composition.


 
object
Describes the video layout of the room composition in terms of regions. Limited to 2 regions.


 
webhook_event_failover_url
string <url> 
 Default:  ""
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_url
string <url> 
The URL where webhooks related to this room composition will be sent. Must include a scheme, such as 'https'.


 
webhook_timeout_secs
integer  [ 0 .. 30 ] 
 Default:  null
Specifies how many seconds to wait before timing out a webhook.


 
422
Unprocessable entity. Check the 'detail' field in response for details.


Response Schema: application/json
Array of objects (Error) 
 
 Array 
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
post/room_compositions
Request samples 
application/json
{
  • "format": "mp4",
  • "resolution": "800x600",
  • "session_id": "0ccc7b54-4df3-4bca-a65a-3da1ecc777b0",
  • "video_layout": {
    • "property1": {
      • "height": 360,
      • "max_columns": 3,
      • "max_rows": 3,
      • "video_sources": [
        • "7b61621f-62e0-4aad-ab11-9fd19e272e73"
        ],
      • "width": 480,
      • "x_pos": 100,
      • "y_pos": 100,
      • "z_pos": 1
      },
    • "property2": {
      • "height": 360,
      • "max_columns": 3,
      • "max_rows": 3,
      • "video_sources": [
        • "7b61621f-62e0-4aad-ab11-9fd19e272e73"
        ],
      • "width": 480,
      • "x_pos": 100,
      • "y_pos": 100,
      • "z_pos": 1
      }
    },
  • "webhook_event_failover_url": "https://failover.example.com",
  • "webhook_event_url": "https://example.com",
  • "webhook_timeout_secs": 25
}
Response samples 
application/json
{
  • "data": {
    • "completed_at": "2022-02-25T05:39:56.377426Z",
    • "download_url": null,
    • "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": [
          • "*"
          ],
        • "width": 1280,
        • "x_pos": 0,
        • "y_pos": 0,
        • "z_pos": 0
        }
      },
    • "webhook_event_url": "https://webhook.site/544663ce-b692-4f9c-80ed-e5ad97cd5c02"
    }
}
Delete a room composition.
Synchronously delete a room composition.


SecuritybearerAuth 
Request 
path Parameters
room_composition_id
required
string <uuid> 
The unique identifier of a room composition.


 
 Example:  5219b3af-87c6-4c08-9b58-5a533d893e21
Responses 
204
The resource was deleted successfully.


404
Resource not found


Response Schema: application/json
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
delete/room_compositions/{room_composition_id}
Request samples 
Response samples 
application/json
{
  • "code": "string",
  • "detail": "string",
  • "meta": { },
  • "source": {
    • "parameter": "string",
    • "pointer": "/json/pointer"
    },
  • "title": "string"
}
View a room composition.
SecuritybearerAuth 
Request 
path Parameters
room_composition_id
required
string <uuid> 
The unique identifier of a room composition.


 
 Example:  5219b3af-87c6-4c08-9b58-5a533d893e21
Responses 
200
Get room composition response.


Response Schema: application/json
object (RoomComposition) 
 
completed_at
string <datetime> 
ISO 8601 timestamp when the room composition has completed.


 
created_at
string <datetime> 
ISO 8601 timestamp when the room composition was created.


 
download_url
string
Url to download the composition.


 
duration_secs
integer
Shows the room composition duration in seconds.


 
ended_at
string <datetime> 
ISO 8601 timestamp when the room composition has ended.


 
format
string
Shows format of the room composition.


 Value: "mp4"  
id
string <uuid> 
A unique identifier for the room composition.


 
record_type
string
 
room_id
string <uuid> 
Identify the room associated with the room composition.


 
session_id
string <uuid> 
Identify the room session associated with the room composition.


 
size_mb
number <float> 
Shows the room composition size in MB.


 
started_at
string <datetime> 
ISO 8601 timestamp when the room composition has stated.


 
status
string
Shows the room composition status.


 Enum: "completed" "enqueued" "processing"  
updated_at
string <datetime> 
ISO 8601 timestamp when the room composition was updated.


 
user_id
string <uuid> 
Identify the user associated with the room composition.


 
object
Describes the video layout of the room composition in terms of regions. Limited to 2 regions.


 
webhook_event_failover_url
string <url> 
 Default:  ""
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_url
string <url> 
The URL where webhooks related to this room composition will be sent. Must include a scheme, such as 'https'.


 
webhook_timeout_secs
integer  [ 0 .. 30 ] 
 Default:  null
Specifies how many seconds to wait before timing out a webhook.


 
404
Resource not found


Response Schema: application/json
code
required
string <int> 
 
detail
string
 
meta
object
 
object
 
title
required
string
 
get/room_compositions/{room_composition_id}
Request samples 
Response samples 
application/json
{
  • "data": {
    • "completed_at": "2022-02-25T05:39:56.377426Z",
    • "download_url": null,
    • "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": [
          • "*"
          ],
        • "width": 1280,
        • "x_pos": 0,
        • "y_pos": 0,
        • "z_pos": 0
        }
      },
    • "webhook_event_url": "https://webhook.site/544663ce-b692-4f9c-80ed-e5ad97cd5c02"
    }
}