Create a meeting
realtime_kit.meetings.create(strapp_id, MeetingCreateParams**kwargs) -> MeetingCreateResponse
POST/accounts/{account_id}/realtime/kit/{app_id}/meetings
Create a meeting for the given App ID.
Security
API Token
The preferred authorization scheme for interacting with the Cloudflare API. Create a token.
Example:
Accepted Permissions (at least one required)
Parameters
live_stream_on_start: Optional[bool]
Specifies if the meeting should start getting livestreamed on start.
record_on_start: Optional[bool]
Specifies if the meeting should start getting recorded as soon as someone joins the meeting.
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
Automatically generate summary of meetings using transcripts. Requires Transcriptions to be enabled, and can be retrieved via Webhooks or summary API.
Create a meeting
import os
from cloudflare import Cloudflare
client = Cloudflare(
api_token=os.environ.get("CLOUDFLARE_API_TOKEN"), # This is the default and can be omitted
)
meeting = client.realtime_kit.meetings.create(
app_id="app_id",
account_id="023e105f4ecef8ad9ca31a8372d0c353",
)
print(meeting.success){
"success": true,
"data": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"created_at": "2019-12-27T18:11:19.117Z",
"updated_at": "2019-12-27T18:11:19.117Z",
"ai_config": {
"summarization": {
"summary_type": "general",
"text_format": "plain_text",
"word_limit": 150
},
"transcription": {
"keywords": [
"string"
],
"language": "en-US",
"profanity_filter": true
}
},
"live_stream_on_start": true,
"persist_chat": true,
"record_on_start": true,
"recording_config": {
"audio_config": {
"channel": "mono",
"codec": "MP3",
"export_file": true
},
"file_name_prefix": "file_name_prefix",
"live_streaming_config": {
"rtmp_url": "rtmp://a.rtmp.youtube.com/live2"
},
"max_seconds": 60,
"realtimekit_bucket_config": {
"enabled": true
},
"storage_config": {
"type": "aws",
"auth_method": "KEY",
"bucket": "bucket",
"host": "host",
"password": "password",
"path": "path",
"port": 0,
"private_key": "private_key",
"region": "us-east-1",
"secret": "secret",
"username": "username"
},
"video_config": {
"codec": "H264",
"export_file": true,
"height": 720,
"watermark": {
"position": "left top",
"size": {
"height": 1,
"width": 1
},
"url": "https://example.com"
},
"width": 1280
}
},
"session_keep_alive_time_in_secs": 60,
"status": "ACTIVE",
"summarize_on_end": true,
"title": "title",
"transcribe_on_end": true
}
}Returns Examples
{
"success": true,
"data": {
"id": "182bd5e5-6e1a-4fe4-a799-aa6d9a6ab26e",
"created_at": "2019-12-27T18:11:19.117Z",
"updated_at": "2019-12-27T18:11:19.117Z",
"ai_config": {
"summarization": {
"summary_type": "general",
"text_format": "plain_text",
"word_limit": 150
},
"transcription": {
"keywords": [
"string"
],
"language": "en-US",
"profanity_filter": true
}
},
"live_stream_on_start": true,
"persist_chat": true,
"record_on_start": true,
"recording_config": {
"audio_config": {
"channel": "mono",
"codec": "MP3",
"export_file": true
},
"file_name_prefix": "file_name_prefix",
"live_streaming_config": {
"rtmp_url": "rtmp://a.rtmp.youtube.com/live2"
},
"max_seconds": 60,
"realtimekit_bucket_config": {
"enabled": true
},
"storage_config": {
"type": "aws",
"auth_method": "KEY",
"bucket": "bucket",
"host": "host",
"password": "password",
"path": "path",
"port": 0,
"private_key": "private_key",
"region": "us-east-1",
"secret": "secret",
"username": "username"
},
"video_config": {
"codec": "H264",
"export_file": true,
"height": 720,
"watermark": {
"position": "left top",
"size": {
"height": 1,
"width": 1
},
"url": "https://example.com"
},
"width": 1280
}
},
"session_keep_alive_time_in_secs": 60,
"status": "ACTIVE",
"summarize_on_end": true,
"title": "title",
"transcribe_on_end": true
}
}