Create Bot

Create a new bot.

The base rate limit for this endpoint is:

120 requests per min per workspace

Request body

meeting_urlstring required

The url of the meeting. For example, https://zoom.us/j/123?pwd=456. This field will be cleared a few days after the bot has joined a call.

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

Example request

{
  "recording_config": {
    "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