Your build starts here
Replace bracketed details with your own goal, context, and checks. Keep the first build small enough to inspect.
Design [API operation] for [consumer and user outcome]. Inspect the existing API conventions and relevant access policy.
Specify the method and path, accepted input, validation rules, allowed caller, success representation, and stable error categories. Include representative request and response examples. Define the behavior of repeated requests, an acknowledgement lost after completion, and an update based on stale data where applicable.
Implement the operation within the existing architecture. Verify valid, invalid, unauthorized, repeated, and relevant outdated requests. Document compatibility assumptions and configuration requirements. Keep private credentials and raw internal exceptions out of the consumer-facing contract.Make this prompt yours
Replace bracketed fields with your goal, current behavior, and relevant evidence. Keep requirements that affect the task. Check the result against the acceptance criteria you supplied.
The docs behind it
These references explain the underlying concepts and APIs. The prompt templates and project plans are original examples to adapt to your own setup.
- MDN — HTTP request methods
- IETF — RFC 9457 Problem Details for HTTP APIs
- OpenAPI Initiative — API descriptions and schemas
Documentation links checked .
Editorial review · October 28, 2026
Supported: Original, unexecuted API-design template. Methods, representation, errors, and invalid-input checks are appropriate; the requested contract is a design deliverable.