API Reference Overview
This section provides detailed API reference documentation for every VentureKit package, including exported functions, types, interfaces, and classes.
Generated Documentation
Section titled “Generated Documentation”API reference pages are generated from TypeScript source code using TypeDoc. To regenerate after code changes:
pnpm run apiPackages
Section titled “Packages”Free (@venturekit/*)
Section titled “Free (@venturekit/*)”- @venturekit/core — Types, presets, config resolution, validation
- @venturekit/runtime — Handler, context, response, errors, middleware, logger, WebSocket
- @venturekit/infra — defineVenture, getResolvedConfig, VentureDefinition
- @venturekit/auth — Cognito config, roles, scope checking, JWT session utilities
- @venturekit/data — RDS config, query, transactions, migration utilities
- @venturekit/storage — S3 config, CDN, lifecycle types
- @venturekit/integrations — HTTP client, OAuth2, API key management
- @venturekit/notify — Notify client, providers, templates, dispatcher, admin helpers, WhatsApp webhooks
- @venturekit/billing — Payment processing client, Zazu adapter, webhook events, mock provider
- @venturekit/mcp — MCP request handler, tool registry, bearer tokens, token store
- @venturekit/testing — Test harness (documented on its package page)
Pro (@venturekit-pro/*)
Section titled “Pro (@venturekit-pro/*)”- @venturekit-pro/ai — Embeddings, vector stores, RAG, agents, tools, chat, images, cost ledger, model catalog
- @venturekit-pro/billing — Plans, feature limits, usage mapping, subscriptions, invoices, migrations
- @venturekit-pro/chat — Chat manager, rooms, messages, presence,
ChatStore - @venturekit-pro/tenancy — Tenant context, resolution, middleware, quota enforcement, tenant CRUD
- @venturekit-pro/audit —
record,listEvents,countEvents,monthlyEventCounts, pruning - @venturekit-pro/social — Adapters, registry, validation, media helpers, platform catalog