API Design Specification

Pro

Design RESTful or GraphQL APIs with endpoints, schemas, auth, error handling, and pagination

Template Fields

Service / DomaintextRequired

e.g., User management, E-commerce orders, Content publishing, IoT device control

API StyleselectRequired

RESTGraphQLgRPCREST + WebSocket

Key OperationsmultilineRequired

List the main things the API should do, e.g.: - Create/read/update/delete users - Upload files - Search with filters - Real-time notifications

AuthenticationselectRequired

JWT Bearer tokenAPI keyOAuth 2.0Session-basedNone (public)

API ConsumersmultiselectRequired

Web frontend (SPA)Mobile appThird-party developersInternal microservicesCLI tools

Expected Scaleselect

Low (< 100 req/min)Medium (100-1000 req/min)High (1000+ req/min)Massive (10K+ req/min)

Use This Template

This is a Pro template. Upgrade to access.

Related Resources

Blog Post

5 Prompt Patterns for API Documentation and Integration

Copy-paste prompt templates for writing API docs, generating integration guides, troubleshooting endpoints, and creating SDK examples.

Blog Post

5 Prompt Patterns for AI-Assisted Code Review

Five prompt patterns for thorough AI code reviews. Covers security audits, performance checks, readability, bug detection, and architecture review.

Blog Post

MCP and Tool Use Prompting: How to Write Prompts for AI That Uses Tools (2026)

AI models don't just generate text anymore — they call APIs, query databases, and execute code. Learn how to write prompts that guide tool-using AI effectively, from function calling basics to MCP server architecture.

Related Templates

Bug Report

Write a clear, actionable bug report that developers can act on immediately

README Generator

Create a professional README.md for any project or repository

API Endpoint Documentation

Document an API endpoint with request/response examples

Git Commit Message

Write clear, conventional commit messages with proper scope and description