Type Alias: AppSettingsResponse
Properties
| Property | Type | Required | Description |
|---|---|---|---|
id | string | Yes | Settings ID |
appId | string | Yes | App ID |
tokenProviderType | "access_key" | "webservice" | "rooms" | Yes | Token provider type |
botUserId | string | No | Bot User ID (for access_key provider) |
webserviceUrl | string | No | Webservice URL (for webservice provider) |
webserviceMethod | string | No | Webservice method |
webserviceHeaders | object | No | HTTP headers sent to the token webservice |
webserviceBodyTemplate | string | No | Request body template with {{roomId}} placeholder |
webserviceResponseTokenPath | string | No | JSONPath used to extract the token from the webservice response |
hasAccessKey | boolean | No | Whether an ODIN access key is stored for this project (the key itself is never returned) |
botUserData | object | No | Bot peer userData |
hasSecret | boolean | Yes | Whether a project secret is cached locally for HMAC authentication |
debugAudioEnabled | boolean | No | Whether debug audio storage is enabled for transcription debugging |
projectName | string | No | Human-readable project name (synced from Payment system) |
e2eEncryptionMode | "disabled" | "automatic" | "manual" | No | End-to-end encryption mode for the bot |
e2eEncryptionPassword | string | No | Decrypted manual cipher password (only returned when mode=manual). Will be removed once a webhook-based mechanism replaces at-rest storage. |
odinSdkVersion | "v1" | "v2" | No | ODIN SDK major the transcription bot joins rooms with (v1 = ODIN 1.x, v2 = ODIN 2.x) |
announcementsEnabled | boolean | No | Whether the bot speaks a recording announcement when joining and before leaving a room |
announcementJoinText | string | No | Text spoken when the bot joins the room |
announcementLeaveText | string | No | Text spoken immediately before the bot leaves the room |
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. |
transcriberInstanceId | string | Yes | Plugin instance that transcribes this project; null = the default Cortex transcription (billed per minute) |
Defined in
odin-transcription-service/packages/cortex-typescript-sdk/src/resources/settings.ts:8