What Is It?
The Design Doc is a Markdown file generated specifically to be read by LLMs. It removes the fluff and provides exactly what an AI needs to write code against your API:- Context - High-level architecture summary
- Authentication - Exact headers and token flows required
- Type Definitions - Full TypeScript interfaces for your entities
- Endpoints - Compact list of routes, methods, and parameters
- Examples - Usage patterns
Why It Matters
When you paste the Design Doc into an AI assistant’s context, it understands: ✅ Exactly which endpoints exist ✅ What parameters each endpoint accepts ✅ How to authenticate requests ✅ The shape of response data No hallucination. The AI won’t make up endpoints that don’t exist.Sample Design Doc
How to Use It
Integration Examples
With Lovable
With Cursor
With v0
Dynamic URLs
The Design Doc automatically includes your deployed API URL, not a placeholder. After deployment, it shows:Updating the Design Doc
The Design Doc regenerates whenever you:- Apply a new spec
- Generate a new blueprint
- Deploy changes
SDKs
Get pre-built Python and TypeScript clients.
