API Contract Review Prompt
Find mismatches between an API specification, examples and client expectations.
What this prompt does
Schema consistency
Check fields, types, nullability, enums, defaults, response codes, pagination and error shapes.
Consumer fit
Compare examples and client expectations with the specification and compatibility constraints.
Change assessment
Separate breaking changes from documentation gaps and identify useful runtime confirmation tests.
What to provide & what you get
- Input
- An API specification, examples and consumer expectations
- Expected output
- Contract findings covering schemas, errors, consistency and compatibility
How to use
- Provide the API specification, examples, client needs, use case and compatibility requirements.
- Run the prompt and inspect the cited contract locations and example consequences.
- Review proposed changes with consumers and use actual requests or contract tests to confirm server behavior separately.
Check the result: The task is a specification review unless real responses are supplied. Undocumented behavior must not be assumed to exist.
Copy. Paste. Run.
v1.1Edit the inputs below, then copy into your AI tool with the requested source material.
Before you start
- Paste into an AI tool that supports the requested text, files or images.
- Provide the bracketed inputs or attach the requested source material.
A quick example
An example includes null for a field that the schema declares as a required string.
A contract mismatch with separate choices for correcting the example or widening the schema.



