API Reference

createLoggingMiddleware() - Request/response logging
createCachingMiddleware() - Response caching
createRetryMiddleware() - Automatic retry with backoff
createTransformMiddleware() - Request/response transformation
createCostTrackingMiddleware() - Track API costs
createOpenTelemetryMiddleware() - Distributed tracing (async)
createValidationMiddleware() - Request validation
createSecurityMiddleware() - PII redaction, sanitization, prompt-injection detection, HTTP header policy
createConversationHistoryMiddleware() - Conversation state

View Middleware Guide →

Integration Packages

@johnhenry/aimatey-http

HTTP server integration for Express, Fastify, Hono, and Node.js http.

Key Exports:

ExpressMiddleware - Express.js integration
FastifyHandler - Fastify handler
HonoMiddleware - Hono middleware
NodeHTTPListener - Node.js http integration

View Examples →

Quick Links

By Use Case

Building a Chat App? → Tutorial: Building a Chat API
HTTP API? → Examples
Multi-Provider Routing? → Tutorial: Multi-Provider
Need Caching? → Middleware Package
Testing? → Testing Guide

By Package

@johnhenry/aimatey-core - Bridge, Router, Middleware
@johnhenry/aimatey-frontend - Frontend adapters
@johnhenry/aimatey-backend - Backend adapters
@johnhenry/aimatey-middleware - Middleware
All 23 published packages - HTTP, React, patterns, MCP, wrappers, CLI, native backends, and more

Common Interfaces

BackendAdapter Interface

interface BackendAdapter {
  readonly metadata: AdapterMetadata;
  fromIR(request: IRChatRequest): unknown;
  toIR(response: unknown, originalRequest: IRChatRequest, latencyMs: number): IRChatResponse;
  execute(request: IRChatRequest, signal?: AbortSignal): Promise<IRChatResponse>;
  /** Returns the stream itself, not a Promise */
  executeStream(request: IRChatRequest, signal?: AbortSignal): IRChatStream;
  healthCheck?(): Promise<boolean>;
}

FrontendAdapter Interface

interface FrontendAdapter {
  readonly metadata: AdapterMetadata;
  toIR(request: unknown): Promise<IRChatRequest>;
  fromIR(response: IRChatResponse): Promise<unknown>;
  fromIRStream(stream: IRChatStream): AsyncGenerator<unknown, void, undefined>;
  validate?(request: unknown): Promise<void>;
}

Middleware Interface

type Middleware = (
  context: MiddlewareContext,
  next: () => Promise<IRChatResponse>
) => Promise<IRChatResponse>;

// context.request is the IR request (readable and replaceable),
// context.state is a per-request scratch object shared between middleware.

TypeScript Support

All packages include full TypeScript definitions. Import types:

import type {
  IRChatRequest,
  IRChatResponse,
  IRStreamChunk,
  BackendAdapter,
  FrontendAdapter,
  Middleware
} from '@johnhenry/aimatey-types';

Version Compatibility

All aimatey packages use synchronized versioning. Always use matching versions across packages:

{
  "dependencies": {
    "@johnhenry/aimatey-core": "^0.2.0",
    "@johnhenry/aimatey-frontend": "^0.2.0",
    "@johnhenry/aimatey-backend": "^0.2.0"
  }
}

Auto-Generated Documentation

Detailed API documentation is auto-generated from TypeScript source code using TypeDoc:

View All Packages → - Complete directory of all 23 published packages, with symbol-level reference generated from source

Contributing

Found an issue with the API? Want to request a new feature?

Explore the API: