aidk-express

AIDK Express

Express.js middleware and utilities for AIDK agent backends. Provides SSE transport, middleware, and route helpers.

Features

SSE Transport - Server-Sent Events for real-time streaming
Engine Middleware - Attach engine context to requests
Channel Routes - Pub/sub channel communication
Agent Routes - Execute and stream agent responses

Quick Start

typescript

import express from 'express';
import { withEngine, agentRoutes, channelRoutes } from 'aidk-express';

const app = express();

// Attach engine to all requests
app.use(withEngine({ engine: createEngine() }));

// Add agent endpoints
app.use('/api/agents', agentRoutes());

// Add channel endpoints
app.use('/api/channels', channelRoutes());

Classes

Class	Description
SSETransport	Transport adapter for external communication (e.g., SSE, WebSocket). Optional add-on layer - channels work without transport.

Interfaces

Interface	Description
CreateExpressMiddlewareConfig	Configuration for createExpressMiddleware
EngineRequest	Extended request with engine context. Use this type in your handlers.
ExpressEngineConfig	Express-specific config (extends base with Express types)
SSETransportConfig	Configuration for ChannelTransport.
TransportConfig	-

Type Aliases

Type Alias	Description
AgentRegistry	Agent registry - maps agent IDs to component definitions

Functions

Function	Description
createExpressMiddleware	Creates Express middleware with pre-configured agent routes.
createSSETransport	Create or configure the SSE transport singleton.
getSSETransport	Get the SSE transport singleton.
resetSSETransport	Reset the singleton (for testing).
setupStreamingResponse	Set up SSE headers for streaming response
withEngine	Creates middleware that extracts execution context from the request.
withTransport	Creates middleware that joins the SSE connection to appropriate rooms. Must be used after withEngine middleware.
writeSSEEvent	Write an SSE event
writeSSEEventSafe	Write an SSE event with error serialization