bot

Start Recording

Changed on Oct 31, 2026

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/

Request

Base URL
https://us-east-1.recall.ai
URL
https://us-east-1.recall.ai/api/v1/bot/{id}/start_recording/
Auth
API key in header Authorization

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.