POST /accounts/{account_id}/realtime/kit/{app_id}/recordings/track
Starts track recording for a meeting. Track recording currently records separate participant audio tracks as WebM files in the RealtimeKit bucket. Video track recording is in development. For more information, refer to Track recording.
Servers
- https://api.cloudflare.com/client/v4
Path parameters
| Name | Type | Required | Description |
|---|---|---|---|
app_id |
String | Yes | |
account_id |
String | Yes |
Request headers
| Name | Type | Required | Description |
|---|---|---|---|
Content-Type |
String | Yes |
The media type of the request body.
Default value: "application/json" |
Request body fields
| Name | Type | Required | Description |
|---|---|---|---|
user_ids[] |
Array | No |
Optional list of participant user IDs to record. Selective track recording ( |
layers |
Object | No |
Optional audio layer configuration. If omitted, RealtimeKit records all participant audio using the default file name prefix. |
layers.name |
Object | No | |
layers.name.file_name_prefix |
String | No |
A file name prefix to apply for files generated from this layer |
layers.name.media_kind |
String | No |
Media kind to record. Track recording currently supports audio only. Valid values:
Default value: "audio" |
meeting_id |
String | Yes |
ID of the meeting to record. |
How to start integrating
- Add HTTP Task to your workflow definition.
- Search for the API you want to integrate with and click on the name.
- This loads the API reference documentation and prepares the Http request settings.
- Click Test request to test run your request to the API and see the API's response.