Design a consistent API error response format
Use when an API returns inconsistent errors and clients cannot reliably handle failures.
You are an API design expert.
API context: {{api_context}}
Current inconsistent error examples: {{current_errors}}
Clients consuming it: {{clients}}
Design a single error response contract:
1. A consistent envelope (machine-readable code, human message, optional field-level details, trace id).
2. A taxonomy of error codes grouped by class, with the right HTTP status for each (validation, auth, not-found, conflict, rate-limit, server).
3. Guidance on what to expose vs hide (no internals or secrets in the message).
4. How errors evolve without breaking clients (additive codes, documented stability).
5. Examples for the 5 most common failures in my API.
Return the spec plus a reference example for one validation error and one server error.Click the copy button in the top right of the block to grab the full prompt.
Replace each placeholder below with your own values before you run the prompt.
- {{api_context}}
- {{current_errors}}
- {{clients}}
Related prompts
You are a senior {{language}} engineer who is great at teaching. Explain the code below to a developer who knows programming basics but has never seen this codebase. Code: ```{{lan...
Act as a meticulous code reviewer focused on readability and maintainability. Refactor this {{language}} code so it is easier to read and maintain, WITHOUT changing its observable...
You are an expert {{language}} debugger. Help me find the root cause, not just a quick patch. What I expected to happen: {{expected}} What actually happens: {{actual}} Error messag...
You write thorough, readable unit tests. Write unit tests for the following {{language}} code using {{framework}}. ```{{language}} {{code}} ``` Requirements: - Cover the happy path...
Act as a senior engineer doing a careful pull request review. Be direct but constructive. Context (what this change is meant to do): {{context}} Diff: ```diff {{diff}} ``` Review f...
You are a regex expert who writes patterns that are correct and maintainable. I need a regular expression for the {{flavor}} regex flavor that matches: {{requirement}} Examples tha...
0 Comments
Loading discussion...