API Reference Overview

This section provides detailed API reference documentation for every VentureKit package, including exported functions, types, interfaces, and classes.

Generated Documentation

API reference pages are generated from TypeScript source code using TypeDoc. To regenerate after code changes:

pnpm run api

Packages

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

Pro (@venturekit-pro/*)

• @venturekit-pro/ai — Embeddings, vector stores, RAG, agents, tools
• @venturekit-pro/billing — Plans, feature limits, usage mapping, migrations
• @venturekit-pro/comms — Email, SMS, push, chat, broadcast messaging
• @venturekit-pro/tenancy — Tenant context, resolution, middleware, quota enforcement