Start Recording

Instructs the bot to start recording the meeting. This will restart the current recording if one is already in progress.

The base rate limit for this endpoint is:

300 requests per min per workspace

post/api/v1/bot/{id}/start_recording/

Path parameters

idstring uuid required

A UUID string identifying this bot.

Request body

video_mixed_layout'speaker_view' | 'gallery_view' | 'gallery_view_v2' | 'audio_only'

speaker_view - speaker_view
gallery_view - gallery_view
gallery_view_v2 - gallery_view_v2
audio_only - audio_only

video_mixed_participant_video_when_screenshare'hide' | 'beside' | 'overlap'

hide - hide
beside - beside
overlap - overlap

start_recording_on'call_join' | 'participant_join' | 'participant_speak'

call_join - call_join
participant_join - participant_join
participant_speak - participant_speak

metadataobject

Example request

{
  "transcript": {
    "provider": {
      "assembly_ai_async_chunked": {
        "speech_model": null,
        "language_code": "en_us",
        "language_detection": true,
        "language_confidence_threshold": 0.7,
        "punctuate": true,
        "format_text": true,
        "multichannel": true,
        "webhook_url": "https://your-webhook-url.tld/path",
        "webhook_auth_header_name": "webhook-secret",
        "webhook_auth_header_value": "webhook-secret-value",
        "auto_highlights": true,
        "audio_start_from": 10,
        "audio_end_at": 280,
        "filter_profanity": true,
        "redact_pii": true,
        "redact_pii_audio": true,
        "redact_pii_audio_quality": "mp3",
        "redact_pii_policies": [
          "us_social_security_number",
          "credit_card_number"
        ],
        "redact_pii_sub": "hash",
        "speaker_labels": true,
        "speakers_expected": 2,
        "content_safety": true,
        "iab_categories": true,
        "custom_spelling": [],
        "disfluencies": false,
        "sentiment_analysis": true,
        "auto_chapters": true,
        "entity_detection": true,
        "speech_threshold": 0.5,
        "summarization": true,
        "summary_model": "informative",
        "summary_type": "bullets",
        "custom_topics": true,
        "topics": [],
        "speech_understanding": {
          "request": {
            "translation": {
              "target_languages": [
                "es",
                "de"
              ],
              "formal": true,
              "match_original_utterance": true
            }
          }
        }
      },
      "gladia_v2_streaming": {
        "custom_metadata": {
          "user": "John Doe"
        },
        "realtime_processing": {
          "custom_vocabulary_config": {
            "vocabulary": [
              "Westeros",
              {
                "value": "Stark"
              },
              {
                "value": "Night's Watch",
                "pronunciations": [
                  "Nightz Watch"
                ],
                "intensity": 0.4,
                "language": "en"
              }
            ],
            "default_intensity": 0.5
          },
          "custom_spelling_config": {
            "spelling_dictionary": {
              "Gettleman": [
                "gettleman"
              ],
              "SQL": [
                "Sequel"
              ]
            }
          },
          "translation_config": {
            "target_languages": [
              "en"
            ]
          }
        },
        "callback_config": {
          "url": "https://callback.example"
        }
      }
    }
  }
}

Response

idstring uuid required

bot_namestring

The name of the bot that will be displayed in the call. (Note: Authenticated Google Meet bots will use the Google account name and this field will be ignored.)

join_atstring date-time nullable

The time at which the bot will join the call, formatted in ISO 8601. This field can only be read from scheduled bots that have not yet joined a call.

metadataobject

Changes

Changed in 3 of the 6 revisions of this API.41911

Aug 25, 202656a9d14b7f103See the full diff
- ●
  removed the optional property recordings/items/media_shortcuts/allOf[RecordingShortcuts]/transcript/allOf[TranscriptArtifactShortcut]/provider/allOf[TranscriptArtifactProvider]/gladia_v2_async/callback from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property recordings/items/media_shortcuts/allOf[RecordingShortcuts]/transcript/allOf[TranscriptArtifactShortcut]/provider/allOf[TranscriptArtifactProvider]/gladia_v2_async/callback_config from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property recordings/items/media_shortcuts/allOf[RecordingShortcuts]/transcript/allOf[TranscriptArtifactShortcut]/provider/allOf[TranscriptArtifactProvider]/gladia_v2_async/callback_url from the response with the 200 status
  response-optional-property-removed
Aug 21, 202655ce8c277c241See the full diff
- ○
  added the optional property recordings/items/media_shortcuts/allOf[RecordingShortcuts]/transcript/allOf[TranscriptArtifactShortcut]/provider/allOf[TranscriptArtifactProvider]/deepgram_async/credential_id to the response with the 200 status
  response-optional-property-added
Jul 26, 202601244e56b3a141610See the full diff
- ▲
  the realtime_endpoints/items/ request property type/format changed from object/ to / (media type: application/json)
  request-property-type-changed
- ▲
  added BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointRtmp BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointWebsocket BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointWebhook BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointDesktopSdkCallback to the recording_config/allOf[BotRecordingConfig]/realtime_endpoints/items/ response property oneOf list for the response status 200
  response-property-one-of-added
- ▲
  the recording_config/allOf[BotRecordingConfig]/realtime_endpoints/items/ response's property type/format changed from object/ to / for status 200
  response-property-type-changed
- ▲
  removed the required property recording_config/allOf[BotRecordingConfig]/realtime_endpoints/items/type from the response with the 200 status
  response-required-property-removed
- ●
  removed the request property realtime_endpoints/items/events (media type: application/json)
  request-property-removed
- ●
  removed the request property realtime_endpoints/items/events (media type: application/x-www-form-urlencoded)
  request-property-removed
- ●
  removed the request property realtime_endpoints/items/events (media type: multipart/form-data)
  request-property-removed
- ●
  removed the request property realtime_endpoints/items/metadata (media type: application/json)
  request-property-removed
- ●
  removed the request property realtime_endpoints/items/metadata (media type: application/x-www-form-urlencoded)
  request-property-removed
- ●
  removed the request property realtime_endpoints/items/metadata (media type: multipart/form-data)
  request-property-removed
- ●
  removed the request property realtime_endpoints/items/type (media type: application/json)
  request-property-removed
- ●
  removed the request property realtime_endpoints/items/type (media type: application/x-www-form-urlencoded)
  request-property-removed
- ●
  removed the request property realtime_endpoints/items/type (media type: multipart/form-data)
  request-property-removed
- ●
  removed the request property realtime_endpoints/items/url (media type: application/json)
  request-property-removed
- ●
  removed the request property realtime_endpoints/items/url (media type: application/x-www-form-urlencoded)
  request-property-removed
- ●
  removed the request property realtime_endpoints/items/url (media type: multipart/form-data)
  request-property-removed
- ●
  removed the optional property recording_config/allOf[BotRecordingConfig]/realtime_endpoints/items/events from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property recording_config/allOf[BotRecordingConfig]/realtime_endpoints/items/metadata from the response with the 200 status
  response-optional-property-removed
- ●
  removed the optional property recording_config/allOf[BotRecordingConfig]/realtime_endpoints/items/url from the response with the 200 status
  response-optional-property-removed
- ●
  added the new melia-1 enum value to the recordings/items/media_shortcuts/allOf[RecordingShortcuts]/transcript/allOf[TranscriptArtifactShortcut]/provider/allOf[TranscriptArtifactProvider]/speechmatics_async/transcription_config/operating_point response property for the response status 200
  response-property-enum-value-added
- ○
  added discriminator to realtime_endpoints/items/ request property (media type: application/json)
  request-property-discriminator-added
- ○
  added discriminator to realtime_endpoints/items/ request property (media type: application/x-www-form-urlencoded)
  request-property-discriminator-added
- ○
  added discriminator to realtime_endpoints/items/ request property (media type: multipart/form-data)
  request-property-discriminator-added
- ○
  added BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointRtmpRequest BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointWebsocketRequest BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointWebhookRequest BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointDesktopSdkCallbackRequest to the realtime_endpoints/items/ request property oneOf list (media type: application/json)
  request-property-one-of-added
- ○
  added BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointRtmpRequest BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointWebsocketRequest BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointWebhookRequest BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointDesktopSdkCallbackRequest to the realtime_endpoints/items/ request property oneOf list (media type: application/x-www-form-urlencoded)
  request-property-one-of-added
- ○
  added BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointRtmpRequest BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointWebsocketRequest BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointWebhookRequest BotRecordingConfigRealtimeEndpointBotRecordingConfigRealtimeEndpointDesktopSdkCallbackRequest to the realtime_endpoints/items/ request property oneOf list (media type: multipart/form-data)
  request-property-one-of-added
- ○
  the realtime_endpoints/items/ request property type/format was generalized from object/ to / (media type: application/x-www-form-urlencoded)
  request-property-type-generalized
- ○
  the realtime_endpoints/items/ request property type/format was generalized from object/ to / (media type: multipart/form-data)
  request-property-type-generalized
- ○
  added the optional property recordings/items/media_shortcuts/allOf[RecordingShortcuts]/transcript/allOf[TranscriptArtifactShortcut]/provider/allOf[TranscriptArtifactProvider]/speechmatics_async/transcription_config/model to the response with the 200 status
  response-optional-property-added
- ○
  added discriminator to recording_config/allOf[BotRecordingConfig]/realtime_endpoints/items/ response property for the response status 200
  response-property-discriminator-added
This revision also has 7 changes that name no endpoint, such as unreferenced schemas being removed. See the revision's changelog

Full history