Design Docs

The bridge between your Backend and AI Coding Assistants.

If you use tools like Lovable, Bolt, Cursor, or v0, the Design Doc artifact is your most powerful tool.

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

# Task Manager API

## Base URL
https://abc123.execute-api.us-east-2.amazonaws.com

## Authentication
All endpoints require a Bearer token:
Authorization: Bearer <jwt_token>

## TypeScript Interfaces

interface Task {
  id: string;
  title: string;
  description?: string;
  priority: 'low' | 'medium' | 'high';
  status: 'pending' | 'active' | 'done';
  project_id: string;
  assignee_id?: string;
  due_date?: string;
  created_at: string;
  updated_at: string;
}

interface Project {
  id: string;
  name: string;
  org_id: string;
  created_at: string;
}

## Endpoints

### Tasks
GET    /v1/tasks           List tasks (paginated)
POST   /v1/tasks           Create task
GET    /v1/tasks/:id       Get task
PUT    /v1/tasks/:id       Update task
DELETE /v1/tasks/:id       Delete task

### Projects
GET    /v1/projects        List projects
POST   /v1/projects        Create project
...

How to Use It

1. Download the Design Doc

   Go to Artifacts tab → Click Design Doc → Download

2. Copy to Clipboard

   Or click Copy to copy the full document

3. Paste into AI Tool

   Paste into Lovable, Bolt, Cursor, or v0’s context window

4. Prompt

   “Build a dashboard using this backend”

Integration Examples

With Lovable

[Paste Design Doc]

Build a task management dashboard with:
- A sidebar showing projects
- A main area listing tasks for the selected project
- Ability to create, edit, and delete tasks
- Filter by priority and status

With Cursor

[Paste Design Doc]

Create a React component that:
- Fetches tasks from the API
- Displays them in a table
- Allows inline editing of the status field

With v0

[Paste Design Doc]

Design a modern, minimal task board with:
- Kanban columns for each status
- Drag and drop between columns
- Task cards showing title, priority, and assignee

Dynamic URLs

The Design Doc automatically includes your deployed API URL, not a placeholder. After deployment, it shows:

Base URL: https://your-actual-api.execute-api.us-east-2.amazonaws.com

This means AI-generated code will work immediately without URL updates.

Updating the Design Doc

The Design Doc regenerates whenever you:

• Apply a new spec
• Generate a new blueprint
• Deploy changes

Always use the latest version after making changes.

SDKs

Get pre-built Python and TypeScript clients.