API Reference
REST API documentation for TinyKit Pro
API Reference
API documentation is generated from the OpenAPI specification served by your Convex backend.
Setup
- Ensure your Convex backend is deployed
- Set
NEXT_PUBLIC_CONVEX_SITE_URLenvironment variable - Run
bun docs:generate-apito generate documentation
Interactive Documentation
Once deployed, visit your Convex site URL with /scalar to access the interactive API explorer:
https://your-deployment.convex.site/scalarAvailable Endpoints
The API provides endpoints for:
- Site Settings - Retrieve public site configuration
- Mailing List - Newsletter subscription management
- Billing - Stripe webhook handling
- Email - Email preview and testing
See the Hono OpenAPI documentation for implementation details.
Convex Node.js Setup
Convex local deployments require Node.js v18 to be installed for running "use node" actions, even though our application runs on Node v22.
Suspense & Server Components Architecture
TinyKit Pro implements strategic use of React Suspense boundaries and Server Components to optimize both SEO performance and user experience. This document o...