Type Alias: UpsertAppSettingsRequest
Properties
| Property | Type | Required | Description |
|---|---|---|---|
tokenProviderType | "access_key" | "webservice" | "rooms" | Yes | Token provider type |
accessKeyConfig | unknown | No | Access Key config (required for access_key provider) |
webserviceConfig | unknown | No | Webservice config (required for webservice provider) |
botUserData | object | No | Bot peer userData as JSON (example: {"name":"Transcription Bot","role":"bot"}) |
debugAudioEnabled | boolean | No | Enable debug audio storage for transcription debugging (auto-deleted after 24h). Defaults to false when omitted. |
e2eEncryptionMode | "disabled" | "automatic" | "manual" | No | End-to-end encryption mode for the bot |
e2eEncryptionPassword | string | No | Manual cipher password (only used when mode=manual). Stored encrypted at rest. |
odinSdkVersion | "v1" | "v2" | No | ODIN SDK major the transcription bot joins rooms with. Must match the SDK major used by the project's client applications (v1 = ODIN 1.x, v2 = ODIN 2.x — the two are not interoperable). Defaults to v1 when omitted. |
announcementsEnabled | boolean | No | Whether the bot speaks a recording announcement when joining and before leaving a room. Defaults to true. |
announcementJoinText | string | No | Text spoken when the bot joins the room (example: "This conversation is now being recorded and transcribed.") |
announcementLeaveText | string | No | Text spoken immediately before the bot leaves the room (example: "Recording and transcription have stopped.") |
transcriptPush | "off" | "all" | "own" | No | Push the live transcript into the ODIN room through the bot (Cortex Room Protocol, frame cortex.transcript): off = never (default), all = every segment to every peer, own = each segment only to the peer who spoke it. Takes effect when the bot next joins a room. |
sanctionPush | boolean | No | Let the bot tell the room about sanctions (cortex.sanction / cortex.mutes frames) and enforce voice mutes on the receiving side: clients stop hearing a muted peer, and the bot stops transcribing it. Only enable once your clients handle these frames. Defaults to false. Takes effect when the bot next joins a room. |
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/settings.ts:11