DocsAPI ReferenceSchedule a bot for a future meeting
POST/api/v1/bots/schedule

Creates a scheduled bot that will automatically launch at `scheduled_start_at + join_offset_seconds`. The platform is auto-detected from `meeting_url`. `scheduled_start_at` must be strictly in the future (UTC). Naive datetimes are treated as UTC.

Headers

X-API-Keystringrequired

Your workspace API key.

Content-Typestringrequired

Must be `application/json`.

Request Body

application/json

meeting_urlstringrequired

Full meeting URL. Platform auto-detected.

Example: "https://meet.google.com/abc-defg-hij"

scheduled_start_atstringrequired

ISO 8601 UTC datetime for the meeting start. Must be in the future.

Example: "2026-05-15T14:00:00Z"

titlestring

Display title for this scheduled slot.

Example: "Weekly Team Standup"

join_offset_secondsinteger

Seconds before `scheduled_start_at` to join. Default: -60.

Example: -120

bot_namestring

Bot display name in meeting.

Example: "Notetaker"

languagestring

Whisper language code.

Example: "en"

recording_enabledboolean

Enable recording. Default: false.

Example: true

transcribe_enabledboolean

Enable transcription. Default: true.

Example: true

voice_agent_enabledboolean

Enable TTS/voice agent.

Example: false

capture_modesarray

Capture modes. Default: ["audio"].

Example: ["audio"]

recording_formatstring

Recording output format.

Example: "mp4"

mp4mp3webm

Responses

201Scheduled bot created.
{
  "id": 7,
  "status": "scheduled",
  "scheduled_start_at": "2026-05-15T14:00:00Z",
  "meeting_url": "https://meet.google.com/abc-defg-hij",
  "settings": {},
  "created_at": "2026-05-12T10:00:00Z"
}
400`scheduled_start_at` is in the past.
422Invalid `meeting_url` or undetectable platform.