--- title: Start recording a meeting --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/typescript) [Realtime Kit](https://developers.cloudflare.com/api/typescript/resources/realtime_kit) [Recordings](https://developers.cloudflare.com/api/typescript/resources/realtime_kit/subresources/recordings) Copy Markdown Open in **Claude**Open in **ChatGPT**Open in **Cursor** --- **Copy Markdown****View as Markdown** # Start recording a meeting client.realtimeKit.recordings.startRecordings(stringappID, RecordingStartRecordingsParams {account\_id, meeting\_id, allow\_multiple\_recordings, 9 more } params, RequestOptionsoptions?): [RecordingStartRecordingsResponse]() {success, data } POST/accounts/{account\_id}/realtime/kit/{app\_id}/recordings Starts recording a meeting. The meeting can be started by an App admin directly, or a participant with permissions to start a recording, based on the type of authorization used. ##### Security API Token The preferred authorization scheme for interacting with the Cloudflare API. [Create a token](https://developers.cloudflare.com/fundamentals/api/get-started/create-token/). **Example:**`Authorization: Bearer Sn3lZJTBX6kkg7OdcBUAxOO963GEIyGQqnFTOFYY` ##### Accepted Permissions (at least one required) `Realtime Admin``Realtime` ##### ParametersExpand Collapse appID: string The app identifier tag. [Link to this property](<#(resource)%20realtime_kit.recordings%20%3E%20(method)%20start_recordings%20%3E%20(params)%20default%20%3E%20(param)%20app_id%20%3E%20(schema)>)

params: RecordingStartRecordingsParams {account\_id, meeting\_id, allow\_multiple\_recordings, 9 more }

account\_id: string Path param: The account identifier tag. maxLength32 Link to this property meeting\_id: string Body param: ID of the meeting to record. formatuuid Link to this property allow\_multiple\_recordings?: boolean Body param: 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. Link to this property

audio\_config?: AudioConfig Body param: Object containing configuration regarding the audio that is being recorded.

channel?: "mono"| "stereo" Audio signal pathway within an audio file that carries a specific sound source.

One of the following: "mono" Link to this property "stereo" Link to this property

Link to this property

codec?: "MP3"| "AAC" 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.

One of the following: "MP3" Link to this property "AAC" Link to this property

Link to this property export\_file?: boolean Controls whether to export audio file seperately Link to this property

Link to this property file\_name\_prefix?: string Body param: Update the recording file name. Link to this property

interactive\_config?: InteractiveConfig Body param: 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.

type?: "ID3" The metadata is presented in the form of ID3 tags. Link to this property

Link to this property max\_seconds?: number Body param: Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours. maximum86400 minimum60 Link to this property

realtimekit\_bucket\_config?: RealtimekitBucketConfig Body param

enabled: boolean 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. Link to this property

Link to this property

rtmp\_out\_config?: RtmpOutConfig Body param

rtmp\_url?: string RTMP URL to stream to formaturi Link to this property

Link to this property

storage\_config?: UnionMember0 {access\_key, auth\_method, bucket, 9 more } | UnionMember1 {access\_key, region, auth\_method, 9 more } | UnionMember2 {private\_key, access\_key, auth\_method, 9 more } | UnionMember3 {password, access\_key, auth\_method, 9 more } | null Body param

One of the following:

UnionMember0 {access\_key, auth\_method, bucket, 9 more }

access\_key?: string 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. Link to this property

auth\_method?: "KEY"| "PASSWORD" Authentication method used for “sftp” type storage medium

One of the following: "KEY" Link to this property "PASSWORD" Link to this property

Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property password?: string 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. Link to this property path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property private\_key?: string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property type?: "gcs" Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property

Link to this property

UnionMember1 {access\_key, region, auth\_method, 9 more }

access\_key: unknown minLength1 Link to this property region: unknown minLength1 Link to this property

auth\_method?: "KEY"| "PASSWORD" Authentication method used for “sftp” type storage medium

One of the following: "KEY" Link to this property "PASSWORD" Link to this property

Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property password?: string 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. Link to this property path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property private\_key?: string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property

type?: "aws"| "azure"| "digitalocean"

One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property

Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property

Link to this property

UnionMember2 {private\_key, access\_key, auth\_method, 9 more }

private\_key: string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property access\_key?: string 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. Link to this property auth\_method?: "KEY" Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property password?: string 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. Link to this property path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property

type?: "aws"| "azure"| "digitalocean"| 2 more Type of storage media.

One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property "gcs" Link to this property "sftp" Link to this property

Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property

Link to this property

UnionMember3 {password, access\_key, auth\_method, 9 more }

password: string 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. Link to this property access\_key?: string 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. Link to this property auth\_method?: "PASSWORD" Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property private\_key?: string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property region?: string Region of the storage medium. Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property

type?: "aws"| "azure"| "digitalocean"| 2 more Type of storage media.

One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property "gcs" Link to this property "sftp" Link to this property

Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property

Link to this property

Link to this property url?: string Body param: Pass a custom url to record arbitary screen formaturi Link to this property

video\_config?: VideoConfig Body param

codec?: "H264"| "VP8"| "VP9" Codec using which the recording will be encoded.

One of the following: "H264" Link to this property "VP8" Link to this property "VP9" Link to this property

Link to this property export\_file?: boolean Controls whether to export video file seperately Link to this property height?: number Height of the recording video in pixels maximum1920 minimum1 Link to this property

watermark?: Watermark {position, size, url } Watermark to be added to the recording

position?: "left top"| "right top"| "left bottom"| "right bottom" Position of the watermark

One of the following: "left top" Link to this property "right top" Link to this property "left bottom" Link to this property "right bottom" Link to this property

Link to this property

size?: Size {height, width } Size of the watermark

height?: number Height of the watermark in px minimum1 Link to this property width?: number Width of the watermark in px minimum1 Link to this property

Link to this property url?: string URL of the watermark image formaturi Link to this property

Link to this property width?: number Width of the recording video in pixels maximum1920 minimum1 Link to this property

Link to this property

[Link to this property](<#(resource)%20realtime_kit.recordings%20%3E%20(method)%20start_recordings%20%3E%20(params)%20default>) ##### ReturnsExpand Collapse

RecordingStartRecordingsResponse {success, data }

success: boolean Success status of the operation Link to this property

data?: Data {id, audio\_download\_url, download\_url, 12 more } Data returned by the operation

id: string ID of the recording formatuuid Link to this property audio\_download\_url: string| null If the audio\_config is passed, the URL for downloading the audio recording is returned. formaturi Link to this property download\_url: string| null URL where the recording can be downloaded. formaturi Link to this property download\_url\_expiry: string| null Timestamp when the download URL expires. formatdate-time Link to this property file\_size: number| null File size of the recording, in bytes. Link to this property invoked\_time: string Timestamp when this recording was invoked. formatdate-time Link to this property output\_file\_name: string File name of the recording. Link to this property session\_id: string| null ID of the meeting session this recording is for. formatuuid Link to this property started\_time: string| null Timestamp when this recording actually started after being invoked. Usually a few seconds after invoked_time. formatdate-time Link to this property

status: "INVOKED"| "RECORDING"| "UPLOADING"| 3 more Current status of the recording.

One of the following: "INVOKED" Link to this property "RECORDING" Link to this property "UPLOADING" Link to this property "UPLOADED" Link to this property "ERRORED" Link to this property "PAUSED" Link to this property

Link to this property stopped\_time: string| null Timestamp when this recording was stopped. Optional; is present only when the recording has actually been stopped. formatdate-time Link to this property recording\_duration?: number Total recording time in seconds. Link to this property

start\_reason?: StartReason {caller, reason }

caller?: Caller {name, type, user\_Id }

name?: string Name of the user who started the recording. Link to this property

type?: "ORGANIZATION"| "USER" The type can be an App or a user. If the type is user, then only the user_Id and name are returned.

One of the following: "ORGANIZATION" Link to this property "USER" Link to this property

Link to this property user\_Id?: string The user ID of the person who started the recording. formatuuid Link to this property

Link to this property

reason?: "API\_CALL"| "RECORD\_ON\_START" Specifies if the recording was started using the “Start a Recording”API or using the parameter RECORD\_ON\_START in the “Create a meeting” API. If the recording is initiated using the “RECORD\_ON\_START” parameter, the user details will not be populated.

One of the following: "API\_CALL" Link to this property "RECORD\_ON\_START" Link to this property

Link to this property

stop\_reason?: StopReason {caller, reason }

caller?: Caller {name, type, user\_Id }

name?: string Name of the user who stopped the recording. Link to this property

type?: "ORGANIZATION"| "USER" The type can be an App or a user. If the type is user, then only the user_Id and name are returned.

One of the following: "ORGANIZATION" Link to this property "USER" Link to this property

Link to this property user\_Id?: string The user ID of the person who stopped the recording. formatuuid Link to this property

Link to this property

reason?: "API\_CALL"| "INTERNAL\_ERROR"| "ALL\_PEERS\_LEFT" Specifies the reason why the recording stopped.

One of the following: "API\_CALL" Link to this property "INTERNAL\_ERROR" Link to this property "ALL\_PEERS\_LEFT" Link to this property

Link to this property

One of the following:

UnionMember0 {access\_key, auth\_method, bucket, 9 more }

auth\_method?: "KEY"| "PASSWORD" Authentication method used for “sftp” type storage medium

One of the following: "KEY" Link to this property "PASSWORD" Link to this property

Link to this property

UnionMember1 {access\_key, region, auth\_method, 9 more }

access\_key: unknown minLength1 Link to this property region: unknown minLength1 Link to this property

auth\_method?: "KEY"| "PASSWORD" Authentication method used for “sftp” type storage medium

One of the following: "KEY" Link to this property "PASSWORD" Link to this property

Link to this property bucket?: string Name of the storage medium’s bucket. Link to this property host?: string SSH destination server host for SFTP type storage medium Link to this property password?: string 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. Link to this property path?: string Path relative to the bucket root at which the recording will be placed. Link to this property port?: number SSH destination server port for SFTP type storage medium Link to this property private\_key?: string Private key used to login to destination SSH server for SFTP type storage medium, when auth\_method used is “KEY” Link to this property secret?: string Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property

type?: "aws"| "azure"| "digitalocean"

One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property

Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property

Link to this property

UnionMember2 {private\_key, access\_key, auth\_method, 9 more }

type?: "aws"| "azure"| "digitalocean"| 2 more Type of storage media.

One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property "gcs" Link to this property "sftp" Link to this property

Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property

Link to this property

UnionMember3 {password, access\_key, auth\_method, 9 more }

type?: "aws"| "azure"| "digitalocean"| 2 more Type of storage media.

One of the following: "aws" Link to this property "azure" Link to this property "digitalocean" Link to this property "gcs" Link to this property "sftp" Link to this property

Link to this property username?: string SSH destination server username for SFTP type storage medium Link to this property

Link to this property

[Link to this property](<#(resource)%20realtime_kit.recordings%20%3E%20(model)%20recording_start_recordings_response%20%3E%20(schema)>) ### Start recording a meeting TypeScript HTTPTypeScriptPythonGoTerraform ``` import Cloudflare from 'cloudflare'; const client = new Cloudflare({ apiToken: process.env['CLOUDFLARE_API_TOKEN'], // This is the default and can be omitted }); const response = await client.realtimeKit.recordings.startRecordings( '14a396e7-ca44-4937-bf1f-050a69118543', { account_id: '023e105f4ecef8ad9ca31a8372d0c353', meeting_id: '97440c6a-140b-40a9-9499-b23fd7a3868a', audio_config: { channel: 'stereo', codec: 'AAC', export_file: true, }, file_name_prefix: 'string', interactive_config: { type: 'ID3' }, max_seconds: 60, realtimekit_bucket_config: { enabled: true }, video_config: { codec: 'H264', export_file: true, height: 720, watermark: { position: 'left top', size: { height: 1, width: 1 }, url: 'http://example.com', }, width: 1280, }, }, ); console.log(response.success); ``` 200 example ``` { "success": true, "data": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "audio_download_url": "https://example.com", "download_url": "https://example.com", "download_url_expiry": "2019-12-27T18:11:19.117Z", "file_size": 0, "invoked_time": "2019-12-27T18:11:19.117Z", "output_file_name": "output_file_name", "session_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "started_time": "2019-12-27T18:11:19.117Z", "status": "INVOKED", "stopped_time": "2019-12-27T18:11:19.117Z", "recording_duration": 0, "start_reason": { "caller": { "name": "RealtimeKit_test", "type": "ORGANIZATION", "user_Id": "d61f6956-e68f-4375-bf10-c38a704d1bec" }, "reason": "API_CALL" }, "stop_reason": { "caller": { "name": "RealtimeKit_test", "type": "ORGANIZATION", "user_Id": "d61f6956-e68f-4375-bf10-c38a704d1bec" }, "reason": "API_CALL" }, "storage_config": { "auth_method": "KEY", "bucket": "bucket", "host": "host", "path": "path", "port": 0, "region": "us-east-1", "type": "gcs", "username": "username" } } } ``` ##### Returns Examples 200 example ``` { "success": true, "data": { "id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "audio_download_url": "https://example.com", "download_url": "https://example.com", "download_url_expiry": "2019-12-27T18:11:19.117Z", "file_size": 0, "invoked_time": "2019-12-27T18:11:19.117Z", "output_file_name": "output_file_name", "session_id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e", "started_time": "2019-12-27T18:11:19.117Z", "status": "INVOKED", "stopped_time": "2019-12-27T18:11:19.117Z", "recording_duration": 0, "start_reason": { "caller": { "name": "RealtimeKit_test", "type": "ORGANIZATION", "user_Id": "d61f6956-e68f-4375-bf10-c38a704d1bec" }, "reason": "API_CALL" }, "stop_reason": { "caller": { "name": "RealtimeKit_test", "type": "ORGANIZATION", "user_Id": "d61f6956-e68f-4375-bf10-c38a704d1bec" }, "reason": "API_CALL" }, "storage_config": { "auth_method": "KEY", "bucket": "bucket", "host": "host", "path": "path", "port": 0, "region": "us-east-1", "type": "gcs", "username": "username" } } } ```