Thankly SDK for JavaScript
    Preparing search index...

    Interface ThanklyServerConfig

    Configuration for createThanklyServer.

    interface ThanklyServerConfig {
        apiHost: string;
        clientId?: string;
        clientSecret?: string;
        requireAuthentication?: boolean;
        secretTokenKey?: string;
        storageAdapter?: StorageAdapter | StorageAdapterType;
    }
    Index
    apiHost clientId? clientSecret? requireAuthentication? secretTokenKey? storageAdapter?
    apiHost: string

    Base URL of the Thankly API, e.g. https://api.thankly.ai. No trailing slash.

    clientId?: string

    Cognito client id issued for your organisation. Required unless requireAuthentication is false.

    clientSecret?: string

    Cognito client secret.

    Server-side only — this authenticates as your whole organisation. Load it from the environment or a secret manager; never inline it, and never let it reach a bundle a user can read.

    Required unless requireAuthentication is false.

    requireAuthentication?: boolean

    Send Cognito credentials with each request. Defaults to on; turn it off only against an API running in the LOCAL stage. Deployed APIs require it.

    secretTokenKey?: string

    Key the cached access token is stored under. Namespace it if one process serves several orgs.

    storageAdapter?: StorageAdapter | StorageAdapterType

    Where the access token is cached between calls. Defaults to in-memory, which is what a backend usually wants — a shared store only helps if several processes should reuse one token.

    Settings
    Member Visibility

    On This Page
    Properties