--- title: Recordings --- [Skip to content](#_top) [API Reference](https://developers.cloudflare.com/api/python) [Realtime Kit](https://developers.cloudflare.com/api/python/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/python/resources/realtime_kit/subresources/recordings/methods/get_recordings) realtime\_kit.recordings.get\_recordings(strapp\_id, RecordingGetRecordingsParams\*\*kwargs) -> [RecordingGetRecordingsResponse]() GET/accounts/{account\_id}/realtime/kit/{app\_id}/recordings ##### [Start recording a meeting](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/recordings/methods/start_recordings) realtime\_kit.recordings.start\_recordings(strapp\_id, RecordingStartRecordingsParams\*\*kwargs) -> [RecordingStartRecordingsResponse]() POST/accounts/{account\_id}/realtime/kit/{app\_id}/recordings ##### [Fetch active recording](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/recordings/methods/get_active_recordings) realtime\_kit.recordings.get\_active\_recordings(strmeeting\_id, RecordingGetActiveRecordingsParams\*\*kwargs) -> [RecordingGetActiveRecordingsResponse]() GET/accounts/{account\_id}/realtime/kit/{app\_id}/recordings/active-recording/{meeting\_id} ##### [Fetch details of a recording](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/recordings/methods/get_one_recording) realtime\_kit.recordings.get\_one\_recording(strrecording\_id, RecordingGetOneRecordingParams\*\*kwargs) -> [RecordingGetOneRecordingResponse]() GET/accounts/{account\_id}/realtime/kit/{app\_id}/recordings/{recording\_id} ##### [Pause/Resume/Stop recording](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/recordings/methods/pause_resume_stop_recording) realtime\_kit.recordings.pause\_resume\_stop\_recording(strrecording\_id, RecordingPauseResumeStopRecordingParams\*\*kwargs) -> [RecordingPauseResumeStopRecordingResponse]() PUT/accounts/{account\_id}/realtime/kit/{app\_id}/recordings/{recording\_id} ##### [Start recording participant audio tracks](https://developers.cloudflare.com/api/python/resources/realtime_kit/subresources/recordings/methods/start_track_recording) realtime\_kit.recordings.start\_track\_recording(strapp\_id, RecordingStartTrackRecordingParams\*\*kwargs) -> [RecordingStartTrackRecordingResponse]() POST/accounts/{account\_id}/realtime/kit/{app\_id}/recordings/track ##### ModelsExpand Collapse
class RecordingGetRecordingsResponse: …
data: List\[Data] id: str ID of the recording formatuuid Link to this property audio\_download\_url: Optional\[str] If the audio\_config is passed, the URL for downloading the audio recording is returned. formaturi Link to this property download\_url: Optional\[str] URL where the recording can be downloaded. formaturi Link to this property download\_url\_expiry: Optional\[datetime] Timestamp when the download URL expires. formatdate-time Link to this property file\_size: Optional\[float] File size of the recording, in bytes. Link to this property invoked\_time: datetime Timestamp when this recording was invoked. formatdate-time Link to this property output\_file\_name: str File name of the recording. Link to this property session\_id: Optional\[str] ID of the meeting session this recording is for. formatuuid Link to this property started\_time: Optional\[datetime] Timestamp when this recording actually started after being invoked. Usually a few seconds after invoked_time. formatdate-time Link to this property
status: Literal\["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: Optional\[datetime] 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\[DataMeeting] id: str ID of the meeting. formatuuid Link to this property created\_at: datetime Timestamp the object was created at. The time is returned in ISO format. formatdate-time Link to this property updated\_at: datetime Timestamp the object was updated at. The time is returned in ISO format. formatdate-time Link to this property live\_stream\_on\_start: Optional\[bool] Specifies if the meeting should start getting livestreamed on start. Link to this property persist\_chat: Optional\[bool] Specifies if Chat within a meeting should persist for a week. Link to this property record\_on\_start: Optional\[bool] Specifies if the meeting should start getting recorded as soon as someone joins the meeting. Link to this property
recording\_config: Optional\[DataMeetingRecordingConfig] 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\[DataMeetingRecordingConfigAudioConfig] Object containing configuration regarding the audio that is being recorded.
channel: Optional\[Literal\["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: Optional\[Literal\["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: Optional\[bool] Controls whether to export audio file seperately Link to this property
Link to this property file\_name\_prefix: Optional\[str] Adds a prefix to the beginning of the file name of the recording. Link to this property
live\_streaming\_config: Optional\[DataMeetingRecordingConfigLiveStreamingConfig] rtmp\_url: Optional\[str] RTMP URL to stream to formaturi Link to this property
Link to this property max\_seconds: Optional\[float] 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\[DataMeetingRecordingConfigRealtimekitBucketConfig] enabled: bool 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\[DataMeetingRecordingConfigStorageConfig] One of the following:
class DataMeetingRecordingConfigStorageConfigUnionMember0: … access\_key: Optional\[str] 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\[Literal\["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: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] 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\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] 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\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property type: Optional\[Literal\["gcs"]] Link to this property username: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataMeetingRecordingConfigStorageConfigUnionMember1: … access\_key: object minLength1 Link to this property region: object minLength1 Link to this property
auth\_method: Optional\[Literal\["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: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] 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\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] 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\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataMeetingRecordingConfigStorageConfigUnionMember2: … private\_key: str 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\[str] 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\[Literal\["KEY"]] Link to this property bucket: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] 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\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property region: Optional\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataMeetingRecordingConfigStorageConfigUnionMember3: … password: str 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\[str] 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\[Literal\["PASSWORD"]] Link to this property bucket: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property path: Optional\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] 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\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
Link to this property
video\_config: Optional\[DataMeetingRecordingConfigVideoConfig]
codec: Optional\[Literal\["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: Optional\[bool] Controls whether to export video file seperately Link to this property height: Optional\[int] Height of the recording video in pixels maximum1920 minimum1 Link to this property
watermark: Optional\[DataMeetingRecordingConfigVideoConfigWatermark] Watermark to be added to the recording
position: Optional\[Literal\["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: Optional\[DataMeetingRecordingConfigVideoConfigWatermarkSize] Size of the watermark height: Optional\[int] Height of the watermark in px minimum1 Link to this property width: Optional\[int] Width of the watermark in px minimum1 Link to this property
Link to this property url: Optional\[str] URL of the watermark image formaturi Link to this property
Link to this property width: Optional\[int] 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\[float] 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\[Literal\["ACTIVE", "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\[bool] 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\[str] Title of the meeting. Link to this property transcribe\_on\_end: Optional\[bool] Automatically generate transcripts when the meeting ends. Link to this property
Link to this property recording\_duration: Optional\[int] Total recording time in seconds. Link to this property
storage\_config: Optional\[DataStorageConfig] One of the following:
class DataStorageConfigUnionMember0: … access\_key: Optional\[str] 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\[Literal\["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: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] 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\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] 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\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property type: Optional\[Literal\["gcs"]] Link to this property username: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataStorageConfigUnionMember1: … access\_key: object minLength1 Link to this property region: object minLength1 Link to this property
auth\_method: Optional\[Literal\["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: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] 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\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] 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\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataStorageConfigUnionMember2: … private\_key: str 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\[str] 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\[Literal\["KEY"]] Link to this property bucket: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] 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\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property region: Optional\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataStorageConfigUnionMember3: … password: str 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\[str] 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\[Literal\["PASSWORD"]] Link to this property bucket: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property path: Optional\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] 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\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] 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: Paging end\_offset: float Link to this property start\_offset: float Link to this property total\_count: float minimum0 Link to this property
Link to this property success: bool Link to this property
[Link to this property](<#(resource)%20realtime_kit.recordings%20%3E%20(model)%20recording_get_recordings_response%20%3E%20(schema)>)
class RecordingStartRecordingsResponse: … success: bool Success status of the operation Link to this property
data: Optional\[Data] Data returned by the operation id: str ID of the recording formatuuid Link to this property audio\_download\_url: Optional\[str] If the audio\_config is passed, the URL for downloading the audio recording is returned. formaturi Link to this property download\_url: Optional\[str] URL where the recording can be downloaded. formaturi Link to this property download\_url\_expiry: Optional\[datetime] Timestamp when the download URL expires. formatdate-time Link to this property file\_size: Optional\[float] File size of the recording, in bytes. Link to this property invoked\_time: datetime Timestamp when this recording was invoked. formatdate-time Link to this property output\_file\_name: str File name of the recording. Link to this property session\_id: Optional\[str] ID of the meeting session this recording is for. formatuuid Link to this property started\_time: Optional\[datetime] Timestamp when this recording actually started after being invoked. Usually a few seconds after invoked_time. formatdate-time Link to this property
status: Literal\["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: Optional\[datetime] 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\[int] Total recording time in seconds. Link to this property
start\_reason: Optional\[DataStartReason]
caller: Optional\[DataStartReasonCaller] name: Optional\[str] Name of the user who started the recording. Link to this property
type: Optional\[Literal\["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: Optional\[str] The user ID of the person who started the recording. formatuuid Link to this property
Link to this property
reason: Optional\[Literal\["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
Link to this property
stop\_reason: Optional\[DataStopReason]
caller: Optional\[DataStopReasonCaller] name: Optional\[str] Name of the user who stopped the recording. Link to this property
type: Optional\[Literal\["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: Optional\[str] The user ID of the person who stopped the recording. formatuuid Link to this property
Link to this property
reason: Optional\[Literal\["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
Link to this property
storage\_config: Optional\[DataStorageConfig] One of the following:
class DataStorageConfigUnionMember0: … access\_key: Optional\[str] 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\[Literal\["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: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] 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\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] 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\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property type: Optional\[Literal\["gcs"]] Link to this property username: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataStorageConfigUnionMember1: … access\_key: object minLength1 Link to this property region: object minLength1 Link to this property
auth\_method: Optional\[Literal\["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: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] 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\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] 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\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataStorageConfigUnionMember2: … private\_key: str 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\[str] 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\[Literal\["KEY"]] Link to this property bucket: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] 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\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property region: Optional\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataStorageConfigUnionMember3: … password: str 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\[str] 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\[Literal\["PASSWORD"]] Link to this property bucket: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property path: Optional\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] 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\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] 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)>)
class RecordingGetActiveRecordingsResponse: …
data: Data Data returned by the operation id: str ID of the recording formatuuid Link to this property audio\_download\_url: Optional\[str] If the audio\_config is passed, the URL for downloading the audio recording is returned. formaturi Link to this property download\_url: Optional\[str] URL where the recording can be downloaded. formaturi Link to this property download\_url\_expiry: Optional\[datetime] Timestamp when the download URL expires. formatdate-time Link to this property file\_size: Optional\[float] File size of the recording, in bytes. Link to this property invoked\_time: datetime Timestamp when this recording was invoked. formatdate-time Link to this property output\_file\_name: str File name of the recording. Link to this property session\_id: Optional\[str] ID of the meeting session this recording is for. formatuuid Link to this property started\_time: Optional\[datetime] Timestamp when this recording actually started after being invoked. Usually a few seconds after invoked_time. formatdate-time Link to this property
status: Literal\["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: Optional\[datetime] 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\[int] Total recording time in seconds. Link to this property
Link to this property success: bool 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)>)
class RecordingGetOneRecordingResponse: … success: bool Success status of the operation Link to this property
data: Optional\[Data] Data returned by the operation id: str ID of the recording formatuuid Link to this property audio\_download\_url: Optional\[str] If the audio\_config is passed, the URL for downloading the audio recording is returned. formaturi Link to this property download\_url: Optional\[str] URL where the recording can be downloaded. formaturi Link to this property download\_url\_expiry: Optional\[datetime] Timestamp when the download URL expires. formatdate-time Link to this property file\_size: Optional\[float] File size of the recording, in bytes. Link to this property invoked\_time: datetime Timestamp when this recording was invoked. formatdate-time Link to this property output\_file\_name: str File name of the recording. Link to this property session\_id: Optional\[str] ID of the meeting session this recording is for. formatuuid Link to this property started\_time: Optional\[datetime] Timestamp when this recording actually started after being invoked. Usually a few seconds after invoked_time. formatdate-time Link to this property
status: Literal\["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: Optional\[datetime] 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\[int] Total recording time in seconds. Link to this property
start\_reason: Optional\[DataStartReason]
caller: Optional\[DataStartReasonCaller] name: Optional\[str] Name of the user who started the recording. Link to this property
type: Optional\[Literal\["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: Optional\[str] The user ID of the person who started the recording. formatuuid Link to this property
Link to this property
reason: Optional\[Literal\["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
Link to this property
stop\_reason: Optional\[DataStopReason]
caller: Optional\[DataStopReasonCaller] name: Optional\[str] Name of the user who stopped the recording. Link to this property
type: Optional\[Literal\["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: Optional\[str] The user ID of the person who stopped the recording. formatuuid Link to this property
Link to this property
reason: Optional\[Literal\["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
Link to this property
storage\_config: Optional\[DataStorageConfig] One of the following:
class DataStorageConfigUnionMember0: … access\_key: Optional\[str] 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\[Literal\["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: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] 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\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] 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\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property type: Optional\[Literal\["gcs"]] Link to this property username: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataStorageConfigUnionMember1: … access\_key: object minLength1 Link to this property region: object minLength1 Link to this property
auth\_method: Optional\[Literal\["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: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] 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\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] 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\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataStorageConfigUnionMember2: … private\_key: str 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\[str] 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\[Literal\["KEY"]] Link to this property bucket: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] 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\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property region: Optional\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataStorageConfigUnionMember3: … password: str 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\[str] 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\[Literal\["PASSWORD"]] Link to this property bucket: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property path: Optional\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] 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\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] 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)>)
class RecordingPauseResumeStopRecordingResponse: … success: bool Success status of the operation Link to this property
data: Optional\[Data] Data returned by the operation id: str ID of the recording formatuuid Link to this property audio\_download\_url: Optional\[str] If the audio\_config is passed, the URL for downloading the audio recording is returned. formaturi Link to this property download\_url: Optional\[str] URL where the recording can be downloaded. formaturi Link to this property download\_url\_expiry: Optional\[datetime] Timestamp when the download URL expires. formatdate-time Link to this property file\_size: Optional\[float] File size of the recording, in bytes. Link to this property invoked\_time: datetime Timestamp when this recording was invoked. formatdate-time Link to this property output\_file\_name: str File name of the recording. Link to this property session\_id: Optional\[str] ID of the meeting session this recording is for. formatuuid Link to this property started\_time: Optional\[datetime] Timestamp when this recording actually started after being invoked. Usually a few seconds after invoked_time. formatdate-time Link to this property
status: Literal\["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: Optional\[datetime] 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\[int] Total recording time in seconds. Link to this property
start\_reason: Optional\[DataStartReason]
caller: Optional\[DataStartReasonCaller] name: Optional\[str] Name of the user who started the recording. Link to this property
type: Optional\[Literal\["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: Optional\[str] The user ID of the person who started the recording. formatuuid Link to this property
Link to this property
reason: Optional\[Literal\["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
Link to this property
stop\_reason: Optional\[DataStopReason]
caller: Optional\[DataStopReasonCaller] name: Optional\[str] Name of the user who stopped the recording. Link to this property
type: Optional\[Literal\["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: Optional\[str] The user ID of the person who stopped the recording. formatuuid Link to this property
Link to this property
reason: Optional\[Literal\["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
Link to this property
storage\_config: Optional\[DataStorageConfig] One of the following:
class DataStorageConfigUnionMember0: … access\_key: Optional\[str] 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\[Literal\["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: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] 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\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] 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\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property type: Optional\[Literal\["gcs"]] Link to this property username: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataStorageConfigUnionMember1: … access\_key: object minLength1 Link to this property region: object minLength1 Link to this property
auth\_method: Optional\[Literal\["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: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] 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\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] 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\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataStorageConfigUnionMember2: … private\_key: str 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\[str] 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\[Literal\["KEY"]] Link to this property bucket: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property password: Optional\[str] 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\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property region: Optional\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] SSH destination server username for SFTP type storage medium Link to this property
Link to this property
class DataStorageConfigUnionMember3: … password: str 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\[str] 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\[Literal\["PASSWORD"]] Link to this property bucket: Optional\[str] Name of the storage medium’s bucket. Link to this property host: Optional\[str] SSH destination server host for SFTP type storage medium Link to this property path: Optional\[str] Path relative to the bucket root at which the recording will be placed. Link to this property port: Optional\[float] SSH destination server port for SFTP type storage medium Link to this property private\_key: Optional\[str] 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\[str] Region of the storage medium. Link to this property secret: Optional\[str] Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable. Link to this property
type: Optional\[Literal\["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: Optional\[str] 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)>)
class RecordingStartTrackRecordingResponse: … success: bool Success status of the operation Link to this property
data: Optional\[Data] Data returned by the operation
recording: DataRecording id: str ID of the recording formatuuid Link to this property audio\_download\_url: Optional\[str] If the audio\_config is passed, the URL for downloading the audio recording is returned. formaturi Link to this property download\_url: Optional\[str] URL where the recording can be downloaded. formaturi Link to this property download\_url\_expiry: Optional\[datetime] Timestamp when the download URL expires. formatdate-time Link to this property file\_size: Optional\[float] File size of the recording, in bytes. Link to this property invoked\_time: datetime Timestamp when this recording was invoked. formatdate-time Link to this property output\_file\_name: str File name of the recording. Link to this property session\_id: Optional\[str] ID of the meeting session this recording is for. formatuuid Link to this property started\_time: Optional\[datetime] Timestamp when this recording actually started after being invoked. Usually a few seconds after invoked_time. formatdate-time Link to this property
status: Literal\["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: Optional\[datetime] 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\[int] 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)>)