The settings block

{
  "recording": {
    "enabled": true,
    "methods": {
      "bot": {
        "start": "on_join",
        "mode": "audio_only",
        "silence_detection": {
          "alert": true
        }
      }
    }
  },
  "transcription": {
    "language": "ca"
  },
  "summary": {
    "template": "discovery_call",
    "language": "same_as_transcript"
  },
  "branding": {
    "brand_kit_id": "brk_01k6acme00000000000000000"
  },
  "sources": {
    "recording.enabled": { "assignment_id": "asg_01k6a3ext00000000000000000" },
    "recording.methods.bot.start": { "assignment_id": "asg_01k6a1ana00000000000000000" },
    "recording.methods.bot.mode": { "assignment_id": "asg_01k6a1ana00000000000000000" },
    "recording.methods.bot.silence_detection.alert": { "assignment_id": "asg_01k6a1ana00000000000000000" },
    "transcription.language": { "assignment_id": "asg_01k6a1ana00000000000000000" },
    "summary.template": { "assignment_id": "asg_01k6a1ana00000000000000000" },
    "summary.language": { "assignment_id": "asg_01k6a1ana00000000000000000" },
    "branding.brand_kit_id": { "assignment_id": "asg_01k6a0wks00000000000000000" }
  },
  "assignments": [
    { "id": "asg_01k6a3ext00000000000000000", "settings_id": "set_01k6rec00000000000000000000", "scope": ["member:mem_01k69x9s8x7c2dvq3m5n6p4ab", "meetings:external"], "own": true },
    { "id": "asg_01k6a1ana00000000000000000", "settings_id": "set_01k6sa1es0000000000000000a", "scope": ["member:mem_01k69x9s8x7c2dvq3m5n6p4ab"], "own": true },
    { "id": "asg_01k6a0wks00000000000000000", "settings_id": "set_01k6wks00000000000000000000", "scope": ["workspace:wks_01k6a2r9s8x7c2dvq3m5n6p4ab"], "own": false }
  ]
}

{
  "recording": {
    "enabled": true,
    "methods": {
      "bot": {
        "start": "on_join",
        "mode": "audio_only",
        "silence_detection": {
          "alert": true
        }
      }
    }
  },
  "transcription": {
    "language": "ca"
  },
  "summary": {
    "template": "discovery_call",
    "language": "same_as_transcript"
  },
  "branding": {
    "brand_kit_id": "brk_01k6acme00000000000000000"
  },
  "sources": {
    "recording.enabled": { "assignment_id": "asg_01k6a3ext00000000000000000" },
    "recording.methods.bot.start": { "assignment_id": "asg_01k6a1ana00000000000000000" },
    "recording.methods.bot.mode": { "assignment_id": "asg_01k6a1ana00000000000000000" },
    "recording.methods.bot.silence_detection.alert": { "assignment_id": "asg_01k6a1ana00000000000000000" },
    "transcription.language": { "assignment_id": "asg_01k6a1ana00000000000000000" },
    "summary.template": { "assignment_id": "asg_01k6a1ana00000000000000000" },
    "summary.language": { "assignment_id": "asg_01k6a1ana00000000000000000" },
    "branding.brand_kit_id": { "assignment_id": "asg_01k6a0wks00000000000000000" }
  },
  "assignments": [
    { "id": "asg_01k6a3ext00000000000000000", "settings_id": "set_01k6rec00000000000000000000", "scope": ["member:mem_01k69x9s8x7c2dvq3m5n6p4ab", "meetings:external"], "own": true },
    { "id": "asg_01k6a1ana00000000000000000", "settings_id": "set_01k6sa1es0000000000000000a", "scope": ["member:mem_01k69x9s8x7c2dvq3m5n6p4ab"], "own": true },
    { "id": "asg_01k6a0wks00000000000000000", "settings_id": "set_01k6wks00000000000000000000", "scope": ["workspace:wks_01k6a2r9s8x7c2dvq3m5n6p4ab"], "own": false }
  ]
}

Workspaces, members and meetings carry settings: the values that apply, sources saying which assignment supplied each one, and every assignment that reaches the object. A meeting is resolved exactly; a member as for a meeting in no category; a workspace as for a member with nothing of their own. See Which setting wins.

Attributes

object

Whether the meeting is recorded, and how. Always a value.

Show properties

boolean

Whether it is recorded.

object

How it is recorded.

Show properties

object

The notetaker bot that joins the call.

Show properties

string

on_join: Records as soon as it joins.
on_command: Joins paused, until someone types !resume.

string

audio_and_video: Audio and video.
audio_only: Audio only.

object

What the bot does when nobody speaks for a while.

Show properties

boolean

Whether the bot posts a chat message after a long silence.

object

How the recording is transcribed.

Show properties

string

A language tag, auto or multi.

object

How the summary is written.

Show properties

string

The template’s slug or tpl_ id.

string

A language tag, or same_as_transcript.

object

How the notetaker is branded.

Show properties

string

The brand kit the bot is sent with, or none (also when the plan does not include notetaker customization).

object

For every field, by its dotted path (recording.enabled, transcription.language…), where the value came from.

Show properties

string | null

The assignment whose settings supplied the value; null when none did, and reason says why.

string

Present when no assignment supplied the value.

happyscribe_default: Nothing sets it; MeetingKit’s default applies.
no_meeting_url: The meeting has no link to join, so nothing records it.
unsupported_platform: The link is not Zoom, Google Meet or Microsoft Teams.
member_paused: The member paused their notetaker.
bot_cancelled: The bot sent to this meeting was cancelled before it joined.

object[]

Every assignment that reaches the object, most specific first.

Show properties

string

Beginning with asg_.

string

The settings it applies, beginning with set_.

string[]

Its conditions.

boolean

Whether the assignment names this object itself, rather than reaching it from above.

{
  "recording": {
    "enabled": true,
    "methods": {
      "bot": {
        "start": "on_join",
        "mode": "audio_only",
        "silence_detection": {
          "alert": true
        }
      }
    }
  },
  "transcription": {
    "language": "ca"
  },
  "summary": {
    "template": "discovery_call",
    "language": "same_as_transcript"
  },
  "branding": {
    "brand_kit_id": "brk_01k6acme00000000000000000"
  },
  "sources": {
    "recording.enabled": { "assignment_id": "asg_01k6a3ext00000000000000000" },
    "recording.methods.bot.start": { "assignment_id": "asg_01k6a1ana00000000000000000" },
    "recording.methods.bot.mode": { "assignment_id": "asg_01k6a1ana00000000000000000" },
    "recording.methods.bot.silence_detection.alert": { "assignment_id": "asg_01k6a1ana00000000000000000" },
    "transcription.language": { "assignment_id": "asg_01k6a1ana00000000000000000" },
    "summary.template": { "assignment_id": "asg_01k6a1ana00000000000000000" },
    "summary.language": { "assignment_id": "asg_01k6a1ana00000000000000000" },
    "branding.brand_kit_id": { "assignment_id": "asg_01k6a0wks00000000000000000" }
  },
  "assignments": [
    { "id": "asg_01k6a3ext00000000000000000", "settings_id": "set_01k6rec00000000000000000000", "scope": ["member:mem_01k69x9s8x7c2dvq3m5n6p4ab", "meetings:external"], "own": true },
    { "id": "asg_01k6a1ana00000000000000000", "settings_id": "set_01k6sa1es0000000000000000a", "scope": ["member:mem_01k69x9s8x7c2dvq3m5n6p4ab"], "own": true },
    { "id": "asg_01k6a0wks00000000000000000", "settings_id": "set_01k6wks00000000000000000000", "scope": ["workspace:wks_01k6a2r9s8x7c2dvq3m5n6p4ab"], "own": false }
  ]
}

Overview

Endpoints

Attributes

​Attributes

Attributes