POST /accounts/{account_id}/realtimekit/recordings

Starts recording a meeting. The meeting can be started by an organization admin directly, or a participant with permissions to start a recording, based on the type of authorization used.

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
`url`	String	No	Pass a custom url to record arbitary screen
`audio_config`	Object	No	Object containing configuration regarding the audio that is being recorded.
`audio_config.export_file`	Boolean	No	Controls whether to export audio file seperately Default value: true
`audio_config.channel`	String	No	Audio signal pathway within an audio file that carries a specific sound source. Valid values: `"stereo"` `"mono"` Default value: "stereo"
`audio_config.codec`	String	No	Codec using which the recording will be encoded. If VP8/VP9 is selected for videoConfig, changing audioConfig is not allowed. In this case, the codec in the audioConfig is automatically set to vorbis. Valid values: `"MP3"` `"AAC"` Default value: "AAC"
`realtimekit_bucket_config`	Object	No
`realtimekit_bucket_config.enabled`	Boolean	Yes	Controls whether recordings are uploaded to RealtimeKit's bucket. If set to false, `download_url`, `audio_download_url`, `download_url_expiry` won't be generated for a recording.
`rtmp_out_config`	Object	No
`rtmp_out_config.rtmp_url`	String	No	RTMP URL to stream to
`allow_multiple_recordings`	Boolean	No	By default, a meeting allows only one recording to run at a time. Enabling the `allow_multiple_recordings` parameter to true allows you to initiate multiple recordings concurrently in the same meeting. This allows you to record separate videos of the same meeting with different configurations, such as portrait mode or landscape mode. Default value: false
`storage_config`	Object	No
`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"
`storage_config.region`	String	No	Region of the storage medium.
`storage_config.port`	Number	No	SSH destination server port for SFTP type storage medium
`storage_config.username`	String	No	SSH destination server username for SFTP type storage medium
`storage_config.bucket`	String	No	Name of the storage medium's bucket.
`storage_config.auth_method`	String	No	Authentication method used for "sftp" type storage medium Valid values: `"PASSWORD"` `"KEY"`
`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.
`storage_config.type`	String	Yes	Type of storage media. Valid values: `"gcs"` `"sftp"` `"aws"` `"azure"` `"digitalocean"`
`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.
`storage_config.host`	String	No	SSH destination server host for SFTP type storage medium
`storage_config.path`	String	No	Path relative to the bucket root at which the recording will be placed.
`storage_config.secret`	String	No	Secret key of the storage medium. Similar to `access_key`, it is only writeable by clients, not readable.
`video_config`	Object	No
`video_config.export_file`	Boolean	No	Controls whether to export video file seperately Default value: true
`video_config.height`	Integer	No	Height of the recording video in pixels Default value: 720
`video_config.width`	Integer	No	Width of the recording video in pixels Default value: 1280
`video_config.codec`	String	No	Codec using which the recording will be encoded. Valid values: `"VP8"` `"H264"` Default value: "H264"
`video_config.watermark`	Object	No	Watermark to be added to the recording
`video_config.watermark.size`	Object	No	Size of the watermark
`video_config.watermark.size.height`	Integer	No	Height of the watermark in px
`video_config.watermark.size.width`	Integer	No	Width of the watermark in px
`video_config.watermark.url`	String	No	URL of the watermark image
`video_config.watermark.position`	String	No	Position of the watermark Valid values: `"right bottom"` `"right top"` `"left bottom"` `"left top"` Default value: "left top"
`file_name_prefix`	String	No	Update the recording file name.
`max_seconds`	Integer	No	Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours.
`meeting_id`	String	No	ID of the meeting to record.
`interactive_config`	Object	No	Allows you to add timed metadata to your recordings, which are digital markers inserted into a video file to provide contextual information at specific points in the content range. The ID3 tags containing this information are available to clients on the playback timeline in HLS format. The output files are generated in a compressed .tar format.
`interactive_config.type`	String	No	The metadata is presented in the form of ID3 tags. Valid values: `"ID3"`

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.