POST /accounts/{account_id}/realtimekit/recordings/track

Starts a track recording in a meeting. Track recordings consist of "layers". Layers are used to map audio/video tracks in a meeting to output destinations. More information about track recordings is available in the Track Recordings Guide Page.

Servers

https://api.cloudflare.com/client/v4

Path parameters

Name	Type	Required	Description
`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
`layers`	Object	Yes
`layers.name`	Object	No
`layers.name.outputs[]`	Array	No
`layers.name.outputs[].type`	String	No	The type of output destination this layer is being exported to. Valid values: `"STORAGE_CONFIG"` `"REALTIMEKIT_BUCKET"` Default value: "REALTIMEKIT_BUCKET"
`layers.name.outputs[].storage_config`	Object	No
`layers.name.outputs[].storage_config.private_key`	String	No	Private key used to login to destination SSH server for SFTP type storage medium, when auth_method used is "KEY"
`layers.name.outputs[].storage_config.region`	String	No	Region of the storage medium.
`layers.name.outputs[].storage_config.port`	Number	No	SSH destination server port for SFTP type storage medium
`layers.name.outputs[].storage_config.username`	String	No	SSH destination server username for SFTP type storage medium
`layers.name.outputs[].storage_config.bucket`	String	No	Name of the storage medium's bucket.
`layers.name.outputs[].storage_config.auth_method`	String	No	Authentication method used for "sftp" type storage medium Valid values: `"PASSWORD"` `"KEY"`
`layers.name.outputs[].storage_config.password`	String	No	SSH destination server password for SFTP type storage medium when auth_method is "PASSWORD". If auth_method is "KEY", this specifies the password for the ssh private key.
`layers.name.outputs[].storage_config.type`	String	Yes	Type of storage media. Valid values: `"gcs"` `"sftp"` `"aws"` `"azure"` `"digitalocean"`
`layers.name.outputs[].storage_config.access_key`	String	No	Access key of the storage medium. Access key is not required for the `gcs` storage media type. Note that this field is not readable by clients, only writeable.
`layers.name.outputs[].storage_config.host`	String	No	SSH destination server host for SFTP type storage medium
`layers.name.outputs[].storage_config.path`	String	No	Path relative to the bucket root at which the recording will be placed.
`layers.name.outputs[].storage_config.secret`	String	No	Secret key of the storage medium. Similar to `access_key`, it is only writeable by clients, not readable.
`layers.name.file_name_prefix`	String	No	A file name prefix to apply for files generated from this layer
`max_seconds`	Number	No	Maximum seconds this recording should be active for (beta)
`meeting_id`	String	No	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.