SDKsTypeScript
Configuration
Constructor options and per-call request options for the BimpeAI TypeScript SDK.
Constructor options
new BimpeAI({
apiKey: string, // required
baseUrl?: string, // default 'https://api.bimpe.ai'
timeout?: number, // per-request ms; default 30_000
maxRetries?: number, // default 2
fetch?: typeof fetch, // override for tests or edge runtimes
defaultHeaders?: Record<string, string>,
logger?: { debug; warn }, // structured hooks; off by default
});The SDK targets the /api/v1/console paths under baseUrl, and identifies itself with a User-Agent like bimpeai-sdk-typescript/<version> (<runtime>; <platform>).
The logger hooks, if provided, receive a message and an optional context object on debug and warn; nothing is logged by default. The exported VERSION constant holds the package version.
Per-call options
The methods that accept a second options argument (agents.create, agents.knowledgeBases.create, workflows.create, and conversations.messages.send, plus streamTicket) take a RequestOptions object with these fields:
| Field | Description |
|---|---|
idempotencyKey | Sent as Idempotency-Key on write requests |
signal | An AbortSignal to cancel the request |
timeout | Per-request timeout in milliseconds; overrides the client default |
maxRetries | Number of retry attempts; overrides the client default |
headers | Merged over the client's default headers |
Each field overrides the client-level setting for that one call only.