Pricing Templates
Log in Sign up
Integrations / Cloudflare / ...

POST /accounts/{account_id}/realtimekit/meetings

Create a meeting for the given organization ID.

Servers

Path parameters

Name Type Required Description
account_id String Yes

Request headers

Name Type Required Description
Content-Type String Yes The media type of the request body.

Default value: "application/json"

Request body fields

Name Type Required Description
persist_chat Boolean No

If a meeting is set to persist_chat, meeting chat would remain for a week within the meeting space.

Default value: false
session_keep_alive_time_in_secs Number No

Time in seconds, for which a session remains active, after the last participant has left the meeting.

Default value: 60
ai_config Object No

The AI Config allows you to customize the behavior of meeting transcriptions and summaries
ai_config.transcription Object No

Transcription Configurations
ai_config.transcription.keywords[] Array No

Adds specific terms to improve accurate detection during transcription.
ai_config.transcription.profanity_filter Boolean No

Control the inclusion of offensive language in transcriptions.

Default value: false
ai_config.transcription.language String No

Specifies the language code for transcription to ensure accurate results.

Valid values:

  • "en-US"
  • "nl"
  • "pl"
  • "fr"
  • "el"
  • "en-IN"
  • "sv"
  • "ru"
  • "hi"
  • "de"

Default value: "en-US"
ai_config.summarization Object No

Summary Config
ai_config.summarization.summary_type String No

Defines the style of the summary, such as general, team meeting, or sales call.

Valid values:

  • "general"
  • "lecture"
  • "client_check_in"
  • "daily_standup"
  • "one_on_one_meeting"
  • "team_meeting"
  • "sales_call"
  • "code_review"
  • "interview"

Default value: "general"
ai_config.summarization.text_format String No

Determines the text format of the summary, such as plain text or markdown.

Valid values:

  • "plain_text"
  • "markdown"

Default value: "markdown"
ai_config.summarization.word_limit Integer No

Sets the maximum number of words in the meeting summary.

Default value: 500
live_stream_on_start Boolean No

Specifies if the meeting should start getting livestreamed on start.

Default value: false
record_on_start Boolean No

Specifies if the meeting should start getting recorded as soon as someone joins the meeting.

Default value: false
title String No

Title of the meeting
summarize_on_end Boolean No

Automatically generate summary of meetings using transcripts. Requires Transcriptions to be enabled, and can be retrieved via Webhooks or summary API.

Default value: false
preferred_region String No

The region in which this meeting should be created.

Valid values:

  • "ap-south-1"
  • "eu-central-1"
  • null
  • "ap-southeast-1"
  • "us-east-1"
recording_config Object No

Recording Configurations to be used for this meeting. This level of configs takes higher preference over organization level configs on the RealtimeKit developer portal.
recording_config.live_streaming_config Object No
recording_config.live_streaming_config.rtmp_url String No

RTMP URL to stream to
recording_config.audio_config Object No

Object containing configuration regarding the audio that is being recorded.
recording_config.audio_config.export_file Boolean No

Controls whether to export audio file seperately

Default value: true
recording_config.audio_config.channel String No

Audio signal pathway within an audio file that carries a specific sound source.

Valid values:

  • "stereo"
  • "mono"

Default value: "stereo"
recording_config.audio_config.codec String No

Codec using which the recording will be encoded. If VP8/VP9 is selected for videoConfig, changing audioConfig is not allowed. In this case, the codec in the audioConfig is automatically set to vorbis.

Valid values:

  • "MP3"
  • "AAC"

Default value: "AAC"
recording_config.realtimekit_bucket_config Object No
recording_config.realtimekit_bucket_config.enabled Boolean Yes

Controls whether recordings are uploaded to RealtimeKit's bucket. If set to false, download_url, audio_download_url, download_url_expiry won't be generated for a recording.
recording_config.storage_config Object No
recording_config.storage_config.private_key String No

Private key used to login to destination SSH server for SFTP type storage medium, when auth_method used is "KEY"
recording_config.storage_config.region String No

Region of the storage medium.
recording_config.storage_config.port Number No

SSH destination server port for SFTP type storage medium
recording_config.storage_config.username String No

SSH destination server username for SFTP type storage medium
recording_config.storage_config.bucket String No

Name of the storage medium's bucket.
recording_config.storage_config.auth_method String No

Authentication method used for "sftp" type storage medium

Valid values:

  • "PASSWORD"
  • "KEY"
recording_config.storage_config.password String No

SSH destination server password for SFTP type storage medium when auth_method is "PASSWORD". If auth_method is "KEY", this specifies the password for the ssh private key.
recording_config.storage_config.type String Yes

Type of storage media.

Valid values:

  • "gcs"
  • "sftp"
  • "aws"
  • "azure"
  • "digitalocean"
recording_config.storage_config.access_key String No

Access key of the storage medium. Access key is not required for the gcs storage media type.

Note that this field is not readable by clients, only writeable.
recording_config.storage_config.host String No

SSH destination server host for SFTP type storage medium
recording_config.storage_config.path String No

Path relative to the bucket root at which the recording will be placed.
recording_config.storage_config.secret String No

Secret key of the storage medium. Similar to access_key, it is only writeable by clients, not readable.
recording_config.video_config Object No
recording_config.video_config.export_file Boolean No

Controls whether to export video file seperately

Default value: true
recording_config.video_config.height Integer No

Height of the recording video in pixels

Default value: 720
recording_config.video_config.width Integer No

Width of the recording video in pixels

Default value: 1280
recording_config.video_config.codec String No

Codec using which the recording will be encoded.

Valid values:

  • "VP8"
  • "H264"

Default value: "H264"
recording_config.video_config.watermark Object No

Watermark to be added to the recording
recording_config.video_config.watermark.size Object No

Size of the watermark
recording_config.video_config.watermark.size.height Integer No

Height of the watermark in px
recording_config.video_config.watermark.size.width Integer No

Width of the watermark in px
recording_config.video_config.watermark.url String No

URL of the watermark image
recording_config.video_config.watermark.position String No

Position of the watermark

Valid values:

  • "right bottom"
  • "right top"
  • "left bottom"
  • "left top"

Default value: "left top"
recording_config.file_name_prefix String No

Adds a prefix to the beginning of the file name of the recording.
recording_config.max_seconds Number No

Specifies the maximum duration for recording in seconds, ranging from a minimum of 60 seconds to a maximum of 24 hours.

How to start integrating

  1. Add HTTP Task to your workflow definition.
  2. Search for the API you want to integrate with and click on the name.
    • This loads the API reference documentation and prepares the Http request settings.
  3. Click Test request to test run your request to the API and see the API's response.
All third party trademarks (including logos and icons) are the property of their respective owners, which do not sponsor, authorize, or endorse this website.
Pricing Templates Integrations Blog Contact Us Help
© 2025 SimWorkflow
Terms of Service Privacy Policy