API Reference

Alpha Software

AIDK is currently in alpha (v0.1.x). APIs may change between releases. We recommend pinning to exact versions until 1.0.

Welcome to the AIDK API Reference. This documentation is auto-generated from source code and provides detailed information about all packages, classes, functions, and types.

Packages Overview

Core Framework

Package	Description	Install
aidk	Main framework - Engine, Components, Hooks, Tools	npm i aidk
aidk-kernel	Low-level primitives - Procedures, Context, Telemetry	npm i aidk-kernel
aidk-shared	Shared types - Messages, Blocks, Errors	npm i aidk-shared

Client Libraries

Package	Description	Install
aidk-client	Browser client - SSE, Channels, Execution	npm i aidk-client
aidk-react	React hooks and components	npm i aidk-react
aidk-angular	Angular services and modules	npm i aidk-angular

Server Frameworks

Package	Description	Install
aidk-express	Express.js middleware	npm i aidk-express
aidk-nestjs	NestJS module and decorators	npm i aidk-nestjs
aidk-server	Server utilities and persistence	npm i aidk-server

Provider Adapters

Package	Description	Install
aidk-openai	OpenAI native adapter	npm i aidk-openai
aidk-google	Google AI native adapter	npm i aidk-google

Library Adapters

Package	Description	Install
aidk-ai-sdk	Vercel AI SDK integration	npm i aidk-ai-sdk

Quick Navigation

By Concept

• Execution: Engine, ExecutionHandle
• Components: Component, JSX
• State: signal, computed, effect
• Tools: createTool, ToolDefinition
• Messages: Message, ContentBlock
• Channels: ChannelService

Most Used APIs

API	Description
Engine	Main execution orchestrator
createTool()	Create type-safe tools
createModel()	Create model adapters
signal()	Create reactive state
useExecution()	React hook for agent execution

TypeScript Support

All packages include full TypeScript definitions. Import types directly:

import type { Message, ContentBlock, ToolDefinition, EngineConfig } from "aidk";