Skip to main content

Type Alias: AppSettingsResponse

type AppSettingsResponse: components["schemas"]["AppSettingsResponse"];

Properties

PropertyTypeRequiredDescription
idstringYesSettings ID
appIdstringYesApp ID
tokenProviderType"access_key" | "webservice" | "rooms"YesToken provider type
botUserIdstringNoBot User ID (for access_key provider)
webserviceUrlstringNoWebservice URL (for webservice provider)
webserviceMethodstringNoWebservice method
botUserDataobjectNoBot peer userData
isConfiguredbooleanYesWhether settings are configured
hasSecretbooleanYesWhether a project secret is cached locally for HMAC authentication
debugAudioEnabledbooleanNoWhether debug audio storage is enabled for transcription debugging
projectNamestringNoHuman-readable project name (synced from Payment system)
e2eEncryptionMode"disabled" | "automatic" | "manual"NoEnd-to-end encryption mode for the bot
e2eEncryptionPasswordstringNoDecrypted manual cipher password (only returned when mode=manual). Will be removed once a webhook-based mechanism replaces at-rest storage.

Defined in

4Players/cortex-typescript-sdk/src/resources/settings.ts:8