Skip to content

API Reference

Auto-generated from TypeScript source using TypeDoc. Every public type, function, class, and interface is documented with signatures, parameters, and return types.

ModuleImport PathDescription
Core Exports@witqq/agent-sdkTypes, errors, registry, createAgentService
Auth@witqq/agent-sdk/authAuthentication tokens, providers, OAuth
Testing@witqq/agent-sdk/testingcreateMockAgentService, test helpers
ModuleImport PathDescription
Copilot@witqq/agent-sdk/copilotGitHub Copilot CLI backend
Claude@witqq/agent-sdk/claudeClaude CLI backend
Vercel AI@witqq/agent-sdk/vercel-aiVercel AI SDK backend
Mock LLM@witqq/agent-sdk/mock-llmMock backend for testing
ModuleImport PathDescription
Chat Exports@witqq/agent-sdk/chatAll re-exports
Runtime@witqq/agent-sdk/chat/runtimecreateChatRuntime, adapter factories
Server@witqq/agent-sdk/chat/serverHTTP handler, auth middleware
React@witqq/agent-sdk/chat/reactComponents, hooks, client
Core Types@witqq/agent-sdk/chat/coreMessages, sessions, options
Events@witqq/agent-sdk/chat/eventsStreaming event types
Sessions@witqq/agent-sdk/chat/sessionsSession store interfaces
Storage@witqq/agent-sdk/chat/storagePersistent storage interfaces
SQLite@witqq/agent-sdk/chat/sqliteSQLite storage implementation
Backends@witqq/agent-sdk/chat/backendsBackend adapter interfaces
Errors@witqq/agent-sdk/chat/errorsChat-specific error types
State@witqq/agent-sdk/chat/stateReactive state management
Context@witqq/agent-sdk/chat/contextContext accumulation
Accumulator@witqq/agent-sdk/chat/accumulatorEvent accumulator
Terminal window
npm run docs:api # Generate markdown to packages/sdk/docs/api/
node packages/docs-site/scripts/sync-api-docs.mjs # Sync into Starlight
npm run docs:site # Rebuild site