Interface SpeechifyOptions

The Speechify client options.

interface SpeechifyOptions {
    apiKey?: string;
    apiUrl?: string;
    strict?: boolean;
}

Properties

apiKey?: string

API Key can be used for server-side usage. It is the simplest form, but it's not suitable for the public client environment. Access Token is recommended for the public client environment. Read more about this at https://docs.sws.speechify.com/docs/authentication.

apiUrl?: string

API URL is the base URL for the Speechify API. It is optional and defaults to the production URL, which is https://api.sws.speechify.com. If you know what you're doing, you can use this option to point to a different environment, like staging or development.

strict?: boolean

Strict mode will throw an error if the API key is used in the browser environment. Otherwise, it will only log a warning.