StructuredFor ProfessionalsCoding & Tech

Write a clear, complete API endpoint specification.

When designing a new endpoint or documenting an existing one for internal or external consumption

ChatGPT Β· Claude Β· GeminiΒ·IntermediateΒ·~1100 tokens
Curated by the AIPP team
Last updated 14 May 2026 Β· v3
write-a-clear-complete-api-endpoint-specification.md Β· 1100 words
You are a senior {{role}} brought in to help a professional complete a {{use_case}} task.

# Context
- Category: Coding & Tech
- Use case: Write a clear, complete API endpoint specification
- Source task:
  - Write a complete API endpoint specification for: {{describe_the_endpoint_what_it_does_and_what_busi}}. Authentication method: {{jwt_api_key_oauth_none}}. Request method: {{get_post_put_patch_delete}}.
  - Specification format:
  - 1. Endpoint summary (one sentence : what this does).
  - 2. URL and HTTP method.
  - 3. Authentication and authorisation requirements.
  - 4. Request parameters (query params, path params, request body : name | type | required | description | example).
  - 5. Response schema (success : status code, body structure with field names, types, and example values).
  - 6. Error responses (list all possible error codes with meaning and example response body).
  - 7. Rate limiting (if applicable).
  - 8. Example cURL request.
  - 9. Notes (edge cases, business logic constraints, deprecation warnings).

# Goal
A complete API spec with request/response schemas, all error codes, and an example cURL β€” ready for developers

# Constraints
- Produce a complete, usable first draft in one response.
- Avoid generic filler, vague advice, and corporate-sounding language.
- Make the output specific, practical, and ready to use.

# Output
A complete API spec with request/response schemas, all error codes, and an example cURL β€” ready for developers

The variables to fill in

PlaceholderWhat to put thereExample
{{role}}Rolesenior backend engineer and API design specialist
{{describe_the_endpoint_what_it_does_and_what_busi}}Describe the endpoint what it does and what busiwhat it does and what business logic it supports
{{jwt_api_key_oauth_none}}Jwt api key oauth noneJWT
{{get_post_put_patch_delete}}Get post put patch deleteGET
{{use_case}}Your specific valuewrite a clear, complete api endpoint specification

How to customize this prompt

  1. Replace each {{double-curly}} with your real context.
  2. Adjust the constraints section to match your tone β€” formal, casual, blunt.
  3. If the engagement is recurring, change the duration line to mention milestones rather than days.
  4. Run it in your tool of choice. The output should be ready to paste with at most one small edit.

When to use

When designing a new endpoint or documenting an existing one for internal or external consumption

PRO TIP

Share the spec with the frontend developer or API consumer before building. A 30-minute spec review prevents a 3-day integration rework.

Related prompts

Structured

Blog Post Drafting Engine

Write a complete, SEO-optimised blog post on the given topic. Include a compelling headline, an engaging introduction, 4-5 subheadings with detailed body paragraphs, and a strong conclusion with a cal

Structured

Email Newsletter Writer

Write a complete email newsletter including subject line, preview text, opening hook, main body content (3 short sections), and a clear call to action.

Structured

YouTube Video Script Writer

Write a complete YouTube video script including a strong hook (first 30 seconds), structured main content with transitions, and a closing that encourages likes, comments, and subscriptions.

Structured

LinkedIn Article Builder

Write a complete LinkedIn article that establishes professional authority, shares a genuine insight, and encourages professional discussion.

β˜… EXPLORE MORE PROMPTS

More for Professionals

Browse all prompts built for Professionals β€” free and premium, ready to copy.

Browse more prompts β†’