AIDK API Reference / aidk-react / UseEngineClientOptions
Interface: UseEngineClientOptions ​
Defined in: packages/react/src/hooks/useEngineClient.ts:25
Extends ​
Properties ​
| Property | Type | Description | Inherited from | Defined in |
|---|---|---|---|---|
api? | EngineClientApi | Custom API implementations. Override individual methods or provide your own implementations. | EngineClientConfig.api | packages/client/src/engine-client.ts:143 |
baseUrl? | string | Base URL for API requests | EngineClientConfig.baseUrl | packages/client/src/engine-client.ts:98 |
callbacks? | TransportCallbacks | Lifecycle callbacks | EngineClientConfig.callbacks | packages/client/src/engine-client.ts:162 |
channels? | ChannelClient | Pre-configured ChannelClient. If provided, transport is ignored and this is used directly. | EngineClientConfig.channels | packages/client/src/engine-client.ts:126 |
maxReconnectAttempts? | number | - | EngineClientConfig.maxReconnectAttempts | packages/client/src/engine-client.ts:152 |
maxReconnectDelay? | number | - | EngineClientConfig.maxReconnectDelay | packages/client/src/engine-client.ts:151 |
metadata? | Record<string, unknown> | Additional metadata to include in requests | EngineClientConfig.metadata | packages/client/src/engine-client.ts:113 |
reconnectDelay? | number | Reconnection settings (only used if transport not provided) | EngineClientConfig.reconnectDelay | packages/client/src/engine-client.ts:150 |
requestTimeout? | number | Request timeout in milliseconds (default: 30000). Applies to execute and stream fetch requests. Set to 0 to disable timeout. | EngineClientConfig.requestTimeout | packages/client/src/engine-client.ts:159 |
routes? | EngineRoutes | Custom route builders (optional) | EngineClientConfig.routes | packages/client/src/engine-client.ts:116 |
sessionId? | string | Session ID (auto-generated if not provided) | EngineClientConfig.sessionId | packages/client/src/engine-client.ts:101 |
skipAutoConnect? | boolean | Skip automatic channel connection (for manual control) | - | packages/react/src/hooks/useEngineClient.ts:27 |
tenantId? | string | Tenant ID for multi-tenant apps | EngineClientConfig.tenantId | packages/client/src/engine-client.ts:107 |
threadId? | string | Thread ID for conversation context | EngineClientConfig.threadId | packages/client/src/engine-client.ts:110 |
transport? | ChannelTransport | Pre-configured transport. If provided (and channels is not), this transport is used. Otherwise, an SSETransport is created with default settings. | EngineClientConfig.transport | packages/client/src/engine-client.ts:133 |
userId? | string | User ID for context enrichment | EngineClientConfig.userId | packages/client/src/engine-client.ts:104 |