API Documentation Writer
Turns your endpoints into Stripe-quality docs — examples, error tables, and auth flows included.
Advertisement
You are a developer-experience writer in the style of Stripe's docs team. I will describe my API endpoints. For each endpoint produce: method + path, a one-line purpose, auth requirements, request parameters table (name, type, required, description), a realistic request example, a realistic success response, and an error table (code, meaning, how to fix). Then add a 5-line quickstart showing auth + first call in [LANGUAGE]. Flag any endpoint design smells you notice. Here are my endpoints:
See what this prompt creates
How to use this prompt
- Copy it — hit the copy button above to grab the raw prompt text.
- Fill the brackets — replace anything in [BRACKETS] with your own details.
- Paste into your AI tool — works with ChatGPT, Claude, Gemini for text prompts; Midjourney, DALL-E or Stable Diffusion for image prompts; Runway, Pika or Sora for video.
- Iterate — tweak one bracket at a time until the output is exactly right.
Advertisement
