AIDK API Reference / aidk-client
aidk-client ​
AIDK Client ​
Browser client for connecting to AIDK agents. Provides real-time streaming, tool execution coordination, and channel-based communication.
Architecture ​
Two layers for progressive adoption:
- EngineClient - Opinionated client with AIDK conventions (recommended)
- Core Primitives - SSETransport, ChannelClient for custom implementations
Quick Start ​
import { createEngineClient } from 'aidk-client';
const client = createEngineClient({
baseUrl: 'http://localhost:3001',
userId: 'user-123',
});
// Execute an agent
const execution = await client.execute({ input: 'Hello!' });
// Stream responses
for await (const event of execution.stream()) {
if (event.type === 'text') console.log(event.text);
}Custom Transports ​
For custom transport implementations, use the core primitives:
import { SSETransport, ChannelClient } from 'aidk-client/core';
const transport = new SSETransport({
buildUrl: () => '/my/sse/endpoint',
send: (data) => fetch('/my/publish', { method: 'POST', body: data }),
});
const channels = new ChannelClient({ transport });See ​
- EngineClient - Main client class
- createEngineClient - Factory function
- ExecutionHandler - Execution lifecycle management
Classes ​
| Class | Description |
|---|---|
| ChannelClient | - |
| EngineClient | - |
| ExecutionHandler | ExecutionHandler - Full execution management |
| SSETransport | Base transport interface - all transports implement this |
| StreamProcessor | StreamProcessor - Framework-agnostic stream event processor |
Interfaces ​
| Interface | Description |
|---|---|
| Channel | Connected channel instance |
| ChannelClientConfig | - |
| ChannelDefinition | Channel definition - the contract for a channel |
| ChannelEvent | - |
| ChannelEventType | - |
| ChannelTarget | - |
| ChannelTransport | Base transport interface - all transports implement this |
| EngineClientConfig | - |
| EngineInput | Engine input for client-side execution requests. |
| EngineRoutes | - |
| Execution | - |
| ExecutionHandlerCallbacks | - |
| ExecutionHandlerConfig | - |
| ExecutionMetrics | - |
| ExecutionMetricsType | - |
| ExecutionResult | - |
| ExecutionResultType | - |
| ExecutionType | - |
| SendMessageOptions | - |
| SSETransportConfig | Common configuration for transports with reconnection |
| StreamEventContext | Context for processing a stream event |
| StreamProcessorCallbacks | - |
| TransportCallbacks | Core client primitives |
| TransportInfo | Core client primitives |
| TransportReconnectConfig | Common configuration for transports with reconnection |
Type Aliases ​
| Type Alias | Description |
|---|---|
| ConnectionInfo | - |
| ConnectionState | - |
| EngineClientCallbacks | - |
| TransportState | ChannelTransport - Abstract bidirectional transport interface |
| type | Type helper for defining payload types |
Functions ​
| Function | Description |
|---|---|
| createEngineClient | Create a new client instance |
| createMessage | Create a Message object with generated ID and timestamp |
| defineChannel | Define a channel contract |
| generateMessageId | Generate a unique message ID |
| getEngineClient | Get or create the default client instance |
References ​
AbortError ​
Re-exports AbortError
AudioBlock ​
Re-exports AudioBlock
AudioMimeType ​
Re-exports AudioMimeType
BlockType ​
Re-exports BlockType
BlockTypes ​
Re-exports BlockTypes
ClientToolDefinition ​
Re-exports ClientToolDefinition
CodeBlock ​
Re-exports CodeBlock
CodeLanguage ​
Re-exports CodeLanguage
ContentBlock ​
Re-exports ContentBlock
ContentDeltaEvent ​
Re-exports ContentDeltaEvent
ContentEndEvent ​
Re-exports ContentEndEvent
ContentEvent ​
Re-exports ContentEvent
ContentInput ​
Re-exports ContentInput
ContentInputArray ​
Re-exports ContentInputArray
ContentStartEvent ​
Re-exports ContentStartEvent
CsvBlock ​
Re-exports CsvBlock
DocumentBlock ​
Re-exports DocumentBlock
DocumentMimeType ​
Re-exports DocumentMimeType
EngineErrorEvent ​
Re-exports EngineErrorEvent
EngineEvent ​
Re-exports EngineEvent
EngineStreamEvent ​
Re-exports EngineStreamEvent
ExecutionEndEvent ​
Re-exports ExecutionEndEvent
ExecutionEvent ​
Re-exports ExecutionEvent
ExecutionStartEvent ​
Re-exports ExecutionStartEvent
ForkEndEvent ​
Re-exports ForkEndEvent
ForkStartEvent ​
Re-exports ForkStartEvent
GeneratedImageBlock ​
Re-exports GeneratedImageBlock
HtmlBlock ​
Re-exports HtmlBlock
ImageBlock ​
Re-exports ImageBlock
ImageMimeType ​
Re-exports ImageMimeType
isContentBlock ​
Re-exports isContentBlock
isDeltaEvent ​
Re-exports isDeltaEvent
isEngineEvent ​
Re-exports isEngineEvent
isFinalEvent ​
Re-exports isFinalEvent
isForkEvent ​
Re-exports isForkEvent
isMessage ​
Re-exports isMessage
isSpawnEvent ​
Re-exports isSpawnEvent
isStreamEvent ​
Re-exports isStreamEvent
JsonBlock ​
Re-exports JsonBlock
MediaSourceType ​
Re-exports MediaSourceType
Message ​
Re-exports Message
MessageEndEvent ​
Re-exports MessageEndEvent
MessageEvent ​
Re-exports MessageEvent
MessageInput ​
Re-exports MessageInput
MessageRole ​
Re-exports MessageRole
MessageStartEvent ​
Re-exports MessageStartEvent
ModelConfig ​
Re-exports ModelConfig
ModelInput ​
Re-exports ModelInput
ModelOutput ​
Re-exports ModelOutput
NewEngineStreamEvent ​
Renames and re-exports EngineStreamEvent
normalizeContentArray ​
Re-exports normalizeContentArray
normalizeContentInput ​
Re-exports normalizeContentInput
normalizeMessageInput ​
Re-exports normalizeMessageInput
NotFoundError ​
Re-exports NotFoundError
ReasoningBlock ​
Re-exports ReasoningBlock
ReasoningDeltaEvent ​
Re-exports ReasoningDeltaEvent
ReasoningEndEvent ​
Re-exports ReasoningEndEvent
ReasoningEvent ​
Re-exports ReasoningEvent
ReasoningStartEvent ​
Re-exports ReasoningStartEvent
SpawnEndEvent ​
Re-exports SpawnEndEvent
SpawnStartEvent ​
Re-exports SpawnStartEvent
SSEClient ​
Renames and re-exports SSETransport
SSEClientCallbacks ​
Renames and re-exports TransportCallbacks
SSEClientConfig ​
Renames and re-exports SSETransportConfig
SSEConnectionInfo ​
Renames and re-exports TransportInfo
SSEConnectionState ​
Renames and re-exports TransportState
StopReason ​
Re-exports StopReason
StreamChunkType ​
Re-exports StreamChunkType
StreamErrorEvent ​
Re-exports StreamErrorEvent
StreamEvent ​
Re-exports StreamEvent
StreamEventBase ​
Re-exports StreamEventBase
TextBlock ​
Re-exports TextBlock
TickEndEvent ​
Re-exports TickEndEvent
TickEvent ​
Re-exports TickEvent
TickStartEvent ​
Re-exports TickStartEvent
TimelineEntry ​
Re-exports TimelineEntry
TokenUsage ​
Re-exports TokenUsage
ToolCall ​
Re-exports ToolCall
ToolCallDeltaEvent ​
Re-exports ToolCallDeltaEvent
ToolCallEndEvent ​
Re-exports ToolCallEndEvent
ToolCallEvent ​
Re-exports ToolCallEvent
ToolCallStartEvent ​
Re-exports ToolCallStartEvent
ToolConfirmationRequiredEvent ​
Re-exports ToolConfirmationRequiredEvent
ToolConfirmationResponse ​
Re-exports ToolConfirmationResponse
ToolConfirmationResult ​
Re-exports ToolConfirmationResult
ToolConfirmationResultEvent ​
Re-exports ToolConfirmationResultEvent
ToolDefinition ​
Re-exports ToolDefinition
ToolExecutionType ​
Re-exports ToolExecutionType
ToolExecutor ​
Re-exports ToolExecutor
ToolIntent ​
Re-exports ToolIntent
ToolResult ​
Re-exports ToolResult
ToolResultBlock ​
Re-exports ToolResultBlock
ToolResultEvent ​
Re-exports ToolResultEvent
ToolUseBlock ​
Re-exports ToolUseBlock
TransportError ​
Re-exports TransportError
ValidationError ​
Re-exports ValidationError
VideoBlock ​
Re-exports VideoBlock
VideoMimeType ​
Re-exports VideoMimeType
XmlBlock ​
Re-exports XmlBlock