Skip to content

@egain/ai-agent-sdk API Reference - v0.1.1 / ApiHelperConfig

Interface: ApiHelperConfig

API Helper service for making eGain AI Agent API calls

Table of contents

Properties

Properties

apiDomain

apiDomain: string

API domain/base URL

Defined in

core/api/ApiHelper.ts:51


language

Optional language: string

Language code (e.g., "en-us", "da-dk")

Default

ts
"en-us"

Defined in

core/api/ApiHelper.ts:57


cache

Optional cache: CacheConfig

Cache configuration options

Defined in

core/api/ApiHelper.ts:62


getToken

Optional getToken: () => Promise<null | string>

When set, API methods may omit authToken in their options; the token is resolved via this provider. If omitted, each call must pass authToken explicitly.

Type declaration

▸ (): Promise<null | string>

Returns

Promise<null | string>

Defined in

core/api/ApiHelper.ts:68

Released under the MIT License.