---
title: Recordings
---
[Skip to content](#_top)
[API Reference](https://developers.cloudflare.com/api)
[Realtime Kit](https://developers.cloudflare.com/api/resources/realtime_kit)
Copy Markdown
Open in **Claude**Open in **ChatGPT**Open in **Cursor**
---
**Copy Markdown****View as Markdown**
# Recordings
##### [Fetch all recordings for an App](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/recordings/methods/get_recordings)
GET/accounts/{account\_id}/realtime/kit/{app\_id}/recordings
##### [Start recording a meeting](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/recordings/methods/start_recordings)
POST/accounts/{account\_id}/realtime/kit/{app\_id}/recordings
##### [Fetch active recording](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/recordings/methods/get_active_recordings)
GET/accounts/{account\_id}/realtime/kit/{app\_id}/recordings/active-recording/{meeting\_id}
##### [Fetch details of a recording](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/recordings/methods/get_one_recording)
GET/accounts/{account\_id}/realtime/kit/{app\_id}/recordings/{recording\_id}
##### [Pause/Resume/Stop recording](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/recordings/methods/pause_resume_stop_recording)
PUT/accounts/{account\_id}/realtime/kit/{app\_id}/recordings/{recording\_id}
##### [Start recording participant audio tracks](https://developers.cloudflare.com/api/resources/realtime_kit/subresources/recordings/methods/start_track_recording)
POST/accounts/{account\_id}/realtime/kit/{app\_id}/recordings/track
##### ModelsExpand Collapse
RecordingGetRecordingsResponse object {data, paging, success }
data: array of object {id, audio\_download\_url, download\_url, 11 more }
id: string
ID of the recording
formatuuid
Link to this property
audio\_download\_url: string
If the audio\_config is passed, the URL for downloading the audio recording is returned.
formaturi
Link to this property
download\_url: string
URL where the recording can be downloaded.
formaturi
Link to this property
download\_url\_expiry: string
Timestamp when the download URL expires.
formatdate-time
Link to this property
file\_size: number
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
ID of the meeting session this recording is for.
formatuuid
Link to this property
started\_time: string
Timestamp when this recording actually started after being invoked. Usually a few seconds after invoked_time.
formatdate-time
Link to this property
status: "INVOKED"or "RECORDING"or "UPLOADING"or 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
Timestamp when this recording was stopped. Optional; is present only when the recording has actually been stopped.
formatdate-time
Link to this property
meeting: optional object {id, created\_at, updated\_at, 9 more }
id: string
ID of the meeting.
formatuuid
Link to this property
created\_at: string
Timestamp the object was created at. The time is returned in ISO format.
formatdate-time
Link to this property
updated\_at: string
Timestamp the object was updated at. The time is returned in ISO format.
formatdate-time
Link to this property
live\_stream\_on\_start: optional boolean
Specifies if the meeting should start getting livestreamed on start.
Link to this property
persist\_chat: optional boolean
Specifies if Chat within a meeting should persist for a week.
Link to this property
record\_on\_start: optional boolean
Specifies if the meeting should start getting recorded as soon as someone joins the meeting.
Link to this property
recording\_config: optional object {audio\_config, file\_name\_prefix, live\_streaming\_config, 4 more }
Recording Configurations to be used for this meeting. This level of configs takes higher preference over App level configs on the RealtimeKit developer portal.
audio\_config: optional object {channel, codec, export\_file }
Object containing configuration regarding the audio that is being recorded.
channel: optional "mono"or "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: optional "MP3"or "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: optional boolean
Controls whether to export audio file seperately
Link to this property
Link to this property
file\_name\_prefix: optional string
Adds a prefix to the beginning of the file name of the recording.
Link to this property
live\_streaming\_config: optional object {rtmp\_url }
rtmp\_url: optional string
RTMP URL to stream to
formaturi
Link to this property
Link to this property
max\_seconds: optional number
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: optional object {enabled }
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
storage\_config: optional object {access\_key, auth\_method, bucket, 9 more } or object {access\_key, region, auth\_method, 9 more } or object {private\_key, access\_key, auth\_method, 9 more } or object {password, access\_key, auth\_method, 9 more }
One of the following:
object {access\_key, auth\_method, bucket, 9 more }
access\_key: optional 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: optional "KEY"or "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: optional string
Name of the storage medium’s bucket.
Link to this property
host: optional string
SSH destination server host for SFTP type storage medium
Link to this property
password: optional 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: optional string
Path relative to the bucket root at which the recording will be placed.
Link to this property
port: optional number
SSH destination server port for SFTP type storage medium
Link to this property
private\_key: optional 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: optional string
Region of the storage medium.
Link to this property
secret: optional string
Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable.
Link to this property
type: optional "gcs"
Link to this property
username: optional string
SSH destination server username for SFTP type storage medium
Link to this property
Link to this property
object {access\_key, region, auth\_method, 9 more }
access\_key: unknown
minLength1
Link to this property
region: unknown
minLength1
Link to this property
auth\_method: optional "KEY"or "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: optional string
Name of the storage medium’s bucket.
Link to this property
host: optional string
SSH destination server host for SFTP type storage medium
Link to this property
password: optional 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: optional string
Path relative to the bucket root at which the recording will be placed.
Link to this property
port: optional number
SSH destination server port for SFTP type storage medium
Link to this property
private\_key: optional 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: optional string
Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable.
Link to this property
type: optional "aws"or "azure"or "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: optional string
SSH destination server username for SFTP type storage medium
Link to this property
Link to this property
object {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: optional 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: optional "KEY"
Link to this property
bucket: optional string
Name of the storage medium’s bucket.
Link to this property
host: optional string
SSH destination server host for SFTP type storage medium
Link to this property
password: optional 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: optional string
Path relative to the bucket root at which the recording will be placed.
Link to this property
port: optional number
SSH destination server port for SFTP type storage medium
Link to this property
region: optional string
Region of the storage medium.
Link to this property
secret: optional string
Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable.
Link to this property
type: optional "aws"or "azure"or "digitalocean"or 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: optional string
SSH destination server username for SFTP type storage medium
Link to this property
Link to this property
object {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: optional 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: optional "PASSWORD"
Link to this property
bucket: optional string
Name of the storage medium’s bucket.
Link to this property
host: optional string
SSH destination server host for SFTP type storage medium
Link to this property
path: optional string
Path relative to the bucket root at which the recording will be placed.
Link to this property
port: optional number
SSH destination server port for SFTP type storage medium
Link to this property
private\_key: optional 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: optional string
Region of the storage medium.
Link to this property
secret: optional string
Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable.
Link to this property
type: optional "aws"or "azure"or "digitalocean"or 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: optional string
SSH destination server username for SFTP type storage medium
Link to this property
Link to this property
Link to this property
video\_config: optional object {codec, export\_file, height, 2 more }
codec: optional "H264"or "VP8"or "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: optional boolean
Controls whether to export video file seperately
Link to this property
height: optional number
Height of the recording video in pixels
maximum1920
minimum1
Link to this property
watermark: optional object {position, size, url }
Watermark to be added to the recording
position: optional "left top"or "right top"or "left bottom"or "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: optional object {height, width }
Size of the watermark
height: optional number
Height of the watermark in px
minimum1
Link to this property
width: optional number
Width of the watermark in px
minimum1
Link to this property
Link to this property
url: optional string
URL of the watermark image
formaturi
Link to this property
Link to this property
width: optional number
Width of the recording video in pixels
maximum1920
minimum1
Link to this property
Link to this property
Link to this property
session\_keep\_alive\_time\_in\_secs: optional number
Time in seconds, for which a session remains active, after the last participant has left the meeting.
maximum600
minimum60
Link to this property
status: optional "ACTIVE"or "INACTIVE"
Whether the meeting is ACTIVE or INACTIVE. Users will not be able to join an INACTIVE meeting.
One of the following:
"ACTIVE"
Link to this property
"INACTIVE"
Link to this property
Link to this property
summarize\_on\_end: optional boolean
Automatically generate summary of meetings using transcripts. Requires Transcriptions to be enabled, and can be retrieved via Webhooks or summary API.
Link to this property
title: optional string
Title of the meeting.
Link to this property
transcribe\_on\_end: optional boolean
Automatically generate transcripts when the meeting ends.
Link to this property
Link to this property
recording\_duration: optional number
Total recording time in seconds.
Link to this property
storage\_config: optional object {access\_key, auth\_method, bucket, 9 more } or object {access\_key, region, auth\_method, 9 more } or object {private\_key, access\_key, auth\_method, 9 more } or object {password, access\_key, auth\_method, 9 more }
One of the following:
object {access\_key, auth\_method, bucket, 9 more }
access\_key: optional 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: optional "KEY"or "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: optional string
Name of the storage medium’s bucket.
Link to this property
host: optional string
SSH destination server host for SFTP type storage medium
Link to this property
password: optional 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: optional string
Path relative to the bucket root at which the recording will be placed.
Link to this property
port: optional number
SSH destination server port for SFTP type storage medium
Link to this property
private\_key: optional 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: optional string
Region of the storage medium.
Link to this property
secret: optional string
Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable.
Link to this property
type: optional "gcs"
Link to this property
username: optional string
SSH destination server username for SFTP type storage medium
Link to this property
Link to this property
object {access\_key, region, auth\_method, 9 more }
access\_key: unknown
minLength1
Link to this property
region: unknown
minLength1
Link to this property
auth\_method: optional "KEY"or "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: optional string
Name of the storage medium’s bucket.
Link to this property
host: optional string
SSH destination server host for SFTP type storage medium
Link to this property
password: optional 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: optional string
Path relative to the bucket root at which the recording will be placed.
Link to this property
port: optional number
SSH destination server port for SFTP type storage medium
Link to this property
private\_key: optional 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: optional string
Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable.
Link to this property
type: optional "aws"or "azure"or "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: optional string
SSH destination server username for SFTP type storage medium
Link to this property
Link to this property
object {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: optional 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: optional "KEY"
Link to this property
bucket: optional string
Name of the storage medium’s bucket.
Link to this property
host: optional string
SSH destination server host for SFTP type storage medium
Link to this property
password: optional 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: optional string
Path relative to the bucket root at which the recording will be placed.
Link to this property
port: optional number
SSH destination server port for SFTP type storage medium
Link to this property
region: optional string
Region of the storage medium.
Link to this property
secret: optional string
Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable.
Link to this property
type: optional "aws"or "azure"or "digitalocean"or 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: optional string
SSH destination server username for SFTP type storage medium
Link to this property
Link to this property
object {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: optional 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: optional "PASSWORD"
Link to this property
bucket: optional string
Name of the storage medium’s bucket.
Link to this property
host: optional string
SSH destination server host for SFTP type storage medium
Link to this property
path: optional string
Path relative to the bucket root at which the recording will be placed.
Link to this property
port: optional number
SSH destination server port for SFTP type storage medium
Link to this property
private\_key: optional 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: optional string
Region of the storage medium.
Link to this property
secret: optional string
Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable.
Link to this property
type: optional "aws"or "azure"or "digitalocean"or 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: optional string
SSH destination server username for SFTP type storage medium
Link to this property
Link to this property
Link to this property
Link to this property
paging: object {end\_offset, start\_offset, total\_count }
end\_offset: number
Link to this property
start\_offset: number
Link to this property
total\_count: number
minimum0
Link to this property
Link to this property
success: boolean
Link to this property
[Link to this property](<#(resource)%20realtime_kit.recordings%20%3E%20(model)%20recording_get_recordings_response%20%3E%20(schema)>)
RecordingStartRecordingsResponse object {success, data }
success: boolean
Success status of the operation
Link to this property
data: optional object {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
If the audio\_config is passed, the URL for downloading the audio recording is returned.
formaturi
Link to this property
download\_url: string
URL where the recording can be downloaded.
formaturi
Link to this property
download\_url\_expiry: string
Timestamp when the download URL expires.
formatdate-time
Link to this property
file\_size: number
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
ID of the meeting session this recording is for.
formatuuid
Link to this property
started\_time: string
Timestamp when this recording actually started after being invoked. Usually a few seconds after invoked_time.
formatdate-time
Link to this property
status: "INVOKED"or "RECORDING"or "UPLOADING"or 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
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: optional number
Total recording time in seconds.
Link to this property
start\_reason: optional object {caller, reason }
caller: optional object {name, type, user\_Id }
name: optional string
Name of the user who started the recording.
Link to this property
type: optional "ORGANIZATION"or "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: optional string
The user ID of the person who started the recording.
formatuuid
Link to this property
Link to this property
reason: optional "API\_CALL"or "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
Link to this property
stop\_reason: optional object {caller, reason }
caller: optional object {name, type, user\_Id }
name: optional string
Name of the user who stopped the recording.
Link to this property
type: optional "ORGANIZATION"or "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: optional string
The user ID of the person who stopped the recording.
formatuuid
Link to this property
Link to this property
reason: optional "API\_CALL"or "INTERNAL\_ERROR"or "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
Link to this property
storage\_config: optional object {access\_key, auth\_method, bucket, 9 more } or object {access\_key, region, auth\_method, 9 more } or object {private\_key, access\_key, auth\_method, 9 more } or object {password, access\_key, auth\_method, 9 more }
One of the following:
object {access\_key, auth\_method, bucket, 9 more }
access\_key: optional 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: optional "KEY"or "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: optional string
Name of the storage medium’s bucket.
Link to this property
host: optional string
SSH destination server host for SFTP type storage medium
Link to this property
password: optional 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: optional string
Path relative to the bucket root at which the recording will be placed.
Link to this property
port: optional number
SSH destination server port for SFTP type storage medium
Link to this property
private\_key: optional 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: optional string
Region of the storage medium.
Link to this property
secret: optional string
Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable.
Link to this property
type: optional "gcs"
Link to this property
username: optional string
SSH destination server username for SFTP type storage medium
Link to this property
Link to this property
object {access\_key, region, auth\_method, 9 more }
access\_key: unknown
minLength1
Link to this property
region: unknown
minLength1
Link to this property
auth\_method: optional "KEY"or "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: optional string
Name of the storage medium’s bucket.
Link to this property
host: optional string
SSH destination server host for SFTP type storage medium
Link to this property
password: optional 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: optional string
Path relative to the bucket root at which the recording will be placed.
Link to this property
port: optional number
SSH destination server port for SFTP type storage medium
Link to this property
private\_key: optional 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: optional string
Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable.
Link to this property
type: optional "aws"or "azure"or "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: optional string
SSH destination server username for SFTP type storage medium
Link to this property
Link to this property
object {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: optional 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: optional "KEY"
Link to this property
bucket: optional string
Name of the storage medium’s bucket.
Link to this property
host: optional string
SSH destination server host for SFTP type storage medium
Link to this property
password: optional 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: optional string
Path relative to the bucket root at which the recording will be placed.
Link to this property
port: optional number
SSH destination server port for SFTP type storage medium
Link to this property
region: optional string
Region of the storage medium.
Link to this property
secret: optional string
Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable.
Link to this property
type: optional "aws"or "azure"or "digitalocean"or 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: optional string
SSH destination server username for SFTP type storage medium
Link to this property
Link to this property
object {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: optional 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: optional "PASSWORD"
Link to this property
bucket: optional string
Name of the storage medium’s bucket.
Link to this property
host: optional string
SSH destination server host for SFTP type storage medium
Link to this property
path: optional string
Path relative to the bucket root at which the recording will be placed.
Link to this property
port: optional number
SSH destination server port for SFTP type storage medium
Link to this property
private\_key: optional 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: optional string
Region of the storage medium.
Link to this property
secret: optional string
Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable.
Link to this property
type: optional "aws"or "azure"or "digitalocean"or 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: optional string
SSH destination server username for SFTP type storage medium
Link to this property
Link to this property
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)>)
RecordingGetActiveRecordingsResponse object {data, success }
data: object {id, audio\_download\_url, download\_url, 9 more }
Data returned by the operation
id: string
ID of the recording
formatuuid
Link to this property
audio\_download\_url: string
If the audio\_config is passed, the URL for downloading the audio recording is returned.
formaturi
Link to this property
download\_url: string
URL where the recording can be downloaded.
formaturi
Link to this property
download\_url\_expiry: string
Timestamp when the download URL expires.
formatdate-time
Link to this property
file\_size: number
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
ID of the meeting session this recording is for.
formatuuid
Link to this property
started\_time: string
Timestamp when this recording actually started after being invoked. Usually a few seconds after invoked_time.
formatdate-time
Link to this property
status: "INVOKED"or "RECORDING"or "UPLOADING"or 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
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: optional number
Total recording time in seconds.
Link to this property
Link to this property
success: boolean
Success status of the operation
Link to this property
[Link to this property](<#(resource)%20realtime_kit.recordings%20%3E%20(model)%20recording_get_active_recordings_response%20%3E%20(schema)>)
RecordingGetOneRecordingResponse object {success, data }
success: boolean
Success status of the operation
Link to this property
data: optional object {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
If the audio\_config is passed, the URL for downloading the audio recording is returned.
formaturi
Link to this property
download\_url: string
URL where the recording can be downloaded.
formaturi
Link to this property
download\_url\_expiry: string
Timestamp when the download URL expires.
formatdate-time
Link to this property
file\_size: number
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
ID of the meeting session this recording is for.
formatuuid
Link to this property
started\_time: string
Timestamp when this recording actually started after being invoked. Usually a few seconds after invoked_time.
formatdate-time
Link to this property
status: "INVOKED"or "RECORDING"or "UPLOADING"or 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
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: optional number
Total recording time in seconds.
Link to this property
start\_reason: optional object {caller, reason }
caller: optional object {name, type, user\_Id }
name: optional string
Name of the user who started the recording.
Link to this property
type: optional "ORGANIZATION"or "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: optional string
The user ID of the person who started the recording.
formatuuid
Link to this property
Link to this property
reason: optional "API\_CALL"or "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
Link to this property
stop\_reason: optional object {caller, reason }
caller: optional object {name, type, user\_Id }
name: optional string
Name of the user who stopped the recording.
Link to this property
type: optional "ORGANIZATION"or "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: optional string
The user ID of the person who stopped the recording.
formatuuid
Link to this property
Link to this property
reason: optional "API\_CALL"or "INTERNAL\_ERROR"or "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
Link to this property
storage\_config: optional object {access\_key, auth\_method, bucket, 9 more } or object {access\_key, region, auth\_method, 9 more } or object {private\_key, access\_key, auth\_method, 9 more } or object {password, access\_key, auth\_method, 9 more }
One of the following:
object {access\_key, auth\_method, bucket, 9 more }
access\_key: optional 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: optional "KEY"or "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: optional string
Name of the storage medium’s bucket.
Link to this property
host: optional string
SSH destination server host for SFTP type storage medium
Link to this property
password: optional 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: optional string
Path relative to the bucket root at which the recording will be placed.
Link to this property
port: optional number
SSH destination server port for SFTP type storage medium
Link to this property
private\_key: optional 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: optional string
Region of the storage medium.
Link to this property
secret: optional string
Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable.
Link to this property
type: optional "gcs"
Link to this property
username: optional string
SSH destination server username for SFTP type storage medium
Link to this property
Link to this property
object {access\_key, region, auth\_method, 9 more }
access\_key: unknown
minLength1
Link to this property
region: unknown
minLength1
Link to this property
auth\_method: optional "KEY"or "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: optional string
Name of the storage medium’s bucket.
Link to this property
host: optional string
SSH destination server host for SFTP type storage medium
Link to this property
password: optional 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: optional string
Path relative to the bucket root at which the recording will be placed.
Link to this property
port: optional number
SSH destination server port for SFTP type storage medium
Link to this property
private\_key: optional 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: optional string
Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable.
Link to this property
type: optional "aws"or "azure"or "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: optional string
SSH destination server username for SFTP type storage medium
Link to this property
Link to this property
object {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: optional 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: optional "KEY"
Link to this property
bucket: optional string
Name of the storage medium’s bucket.
Link to this property
host: optional string
SSH destination server host for SFTP type storage medium
Link to this property
password: optional 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: optional string
Path relative to the bucket root at which the recording will be placed.
Link to this property
port: optional number
SSH destination server port for SFTP type storage medium
Link to this property
region: optional string
Region of the storage medium.
Link to this property
secret: optional string
Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable.
Link to this property
type: optional "aws"or "azure"or "digitalocean"or 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: optional string
SSH destination server username for SFTP type storage medium
Link to this property
Link to this property
object {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: optional 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: optional "PASSWORD"
Link to this property
bucket: optional string
Name of the storage medium’s bucket.
Link to this property
host: optional string
SSH destination server host for SFTP type storage medium
Link to this property
path: optional string
Path relative to the bucket root at which the recording will be placed.
Link to this property
port: optional number
SSH destination server port for SFTP type storage medium
Link to this property
private\_key: optional 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: optional string
Region of the storage medium.
Link to this property
secret: optional string
Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable.
Link to this property
type: optional "aws"or "azure"or "digitalocean"or 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: optional string
SSH destination server username for SFTP type storage medium
Link to this property
Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20realtime_kit.recordings%20%3E%20(model)%20recording_get_one_recording_response%20%3E%20(schema)>)
RecordingPauseResumeStopRecordingResponse object {success, data }
success: boolean
Success status of the operation
Link to this property
data: optional object {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
If the audio\_config is passed, the URL for downloading the audio recording is returned.
formaturi
Link to this property
download\_url: string
URL where the recording can be downloaded.
formaturi
Link to this property
download\_url\_expiry: string
Timestamp when the download URL expires.
formatdate-time
Link to this property
file\_size: number
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
ID of the meeting session this recording is for.
formatuuid
Link to this property
started\_time: string
Timestamp when this recording actually started after being invoked. Usually a few seconds after invoked_time.
formatdate-time
Link to this property
status: "INVOKED"or "RECORDING"or "UPLOADING"or 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
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: optional number
Total recording time in seconds.
Link to this property
start\_reason: optional object {caller, reason }
caller: optional object {name, type, user\_Id }
name: optional string
Name of the user who started the recording.
Link to this property
type: optional "ORGANIZATION"or "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: optional string
The user ID of the person who started the recording.
formatuuid
Link to this property
Link to this property
reason: optional "API\_CALL"or "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
Link to this property
stop\_reason: optional object {caller, reason }
caller: optional object {name, type, user\_Id }
name: optional string
Name of the user who stopped the recording.
Link to this property
type: optional "ORGANIZATION"or "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: optional string
The user ID of the person who stopped the recording.
formatuuid
Link to this property
Link to this property
reason: optional "API\_CALL"or "INTERNAL\_ERROR"or "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
Link to this property
storage\_config: optional object {access\_key, auth\_method, bucket, 9 more } or object {access\_key, region, auth\_method, 9 more } or object {private\_key, access\_key, auth\_method, 9 more } or object {password, access\_key, auth\_method, 9 more }
One of the following:
object {access\_key, auth\_method, bucket, 9 more }
access\_key: optional 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: optional "KEY"or "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: optional string
Name of the storage medium’s bucket.
Link to this property
host: optional string
SSH destination server host for SFTP type storage medium
Link to this property
password: optional 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: optional string
Path relative to the bucket root at which the recording will be placed.
Link to this property
port: optional number
SSH destination server port for SFTP type storage medium
Link to this property
private\_key: optional 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: optional string
Region of the storage medium.
Link to this property
secret: optional string
Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable.
Link to this property
type: optional "gcs"
Link to this property
username: optional string
SSH destination server username for SFTP type storage medium
Link to this property
Link to this property
object {access\_key, region, auth\_method, 9 more }
access\_key: unknown
minLength1
Link to this property
region: unknown
minLength1
Link to this property
auth\_method: optional "KEY"or "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: optional string
Name of the storage medium’s bucket.
Link to this property
host: optional string
SSH destination server host for SFTP type storage medium
Link to this property
password: optional 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: optional string
Path relative to the bucket root at which the recording will be placed.
Link to this property
port: optional number
SSH destination server port for SFTP type storage medium
Link to this property
private\_key: optional 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: optional string
Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable.
Link to this property
type: optional "aws"or "azure"or "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: optional string
SSH destination server username for SFTP type storage medium
Link to this property
Link to this property
object {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: optional 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: optional "KEY"
Link to this property
bucket: optional string
Name of the storage medium’s bucket.
Link to this property
host: optional string
SSH destination server host for SFTP type storage medium
Link to this property
password: optional 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: optional string
Path relative to the bucket root at which the recording will be placed.
Link to this property
port: optional number
SSH destination server port for SFTP type storage medium
Link to this property
region: optional string
Region of the storage medium.
Link to this property
secret: optional string
Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable.
Link to this property
type: optional "aws"or "azure"or "digitalocean"or 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: optional string
SSH destination server username for SFTP type storage medium
Link to this property
Link to this property
object {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: optional 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: optional "PASSWORD"
Link to this property
bucket: optional string
Name of the storage medium’s bucket.
Link to this property
host: optional string
SSH destination server host for SFTP type storage medium
Link to this property
path: optional string
Path relative to the bucket root at which the recording will be placed.
Link to this property
port: optional number
SSH destination server port for SFTP type storage medium
Link to this property
private\_key: optional 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: optional string
Region of the storage medium.
Link to this property
secret: optional string
Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable.
Link to this property
type: optional "aws"or "azure"or "digitalocean"or 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: optional string
SSH destination server username for SFTP type storage medium
Link to this property
Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20realtime_kit.recordings%20%3E%20(model)%20recording_pause_resume_stop_recording_response%20%3E%20(schema)>)
RecordingStartTrackRecordingResponse object {success, data }
success: boolean
Success status of the operation
Link to this property
data: optional object {recording }
Data returned by the operation
recording: object {id, audio\_download\_url, download\_url, 9 more }
id: string
ID of the recording
formatuuid
Link to this property
audio\_download\_url: string
If the audio\_config is passed, the URL for downloading the audio recording is returned.
formaturi
Link to this property
download\_url: string
URL where the recording can be downloaded.
formaturi
Link to this property
download\_url\_expiry: string
Timestamp when the download URL expires.
formatdate-time
Link to this property
file\_size: number
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
ID of the meeting session this recording is for.
formatuuid
Link to this property
started\_time: string
Timestamp when this recording actually started after being invoked. Usually a few seconds after invoked_time.
formatdate-time
Link to this property
status: "INVOKED"or "RECORDING"or "UPLOADING"or 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
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: optional number
Total recording time in seconds.
Link to this property
Link to this property
Link to this property
[Link to this property](<#(resource)%20realtime_kit.recordings%20%3E%20(model)%20recording_start_track_recording_response%20%3E%20(schema)>)