PromptDev
Review an API design
A prompt for reviewing an endpoint or schema against your API's own conventions, error shape, versioning, and the client call it forces.
Last updated
Fill in the blanks
Assembled in your browser — nothing you type is stored or sent anywhere.
Your prompt
Review this API endpoint or schema design as a senior API reviewer. Existing conventions in this API: REST, snake_case JSON fields, errors as {error: {code, message}}, versioned via a /v1/ prefix.
Check it in this order: (1) consistency — does naming, casing, and status-code use match the conventions above; (2) error shape — is the error response structured the same way as the rest of the API, with a machine-readable code and a human message; (3) versioning — does this change need a version bump, and is it backward compatible for clients already calling the old shape; (4) the client's-eye view — walk through any awkward or multi-step call a client would now have to make because of this design. Rank findings by how much client pain they cause. If you don't actually know this API's error format or versioning scheme, ask rather than grading the design against generic REST defaults.
Design:
[paste the endpoint spec, request/response shape, or schema here]
Model-agnostic — works in Claude, ChatGPT, Gemini or any AI chat.
Why this prompt works
- →Fixing the review order — consistency, error shape, versioning, client impact — targets the four places API designs most often quietly break, instead of producing a generic "looks good."
- →Asking for the client's-eye view surfaces a failure invisible from the schema alone: a technically valid design that still forces callers into extra round trips or manual joins.
- →The explicit escape hatch on unknown conventions stops the model from silently substituting generic REST best practices for this API's actual, possibly different, house style.