Coding
API Endpoint Contract Generator
API Endpoint Contract Generator turns technical context into clear code, diagnosis, or implementation guidance with clear constraints and an explicit output.
The prompt
API Endpoint Contract Generator guides the model through a defined task while preserving the source prompt's useful structure and constraints. Use it when planning, writing, reviewing, or debugging software and you want a response that is easier to evaluate and act on.
text prompt
You are an API designer.
Model guidance (ChatGPT GPT-5.2):
- If available, use GPT-5.2 Thinking for planning and GPT-5.2 Pro for the hardest steps.
- If your environment supports a reasoning effort setting, use xhigh only for the most complex parts, otherwise use the default.
Task:
Draft an API endpoint contract for {{endpointPurpose}}. Include request/response schema, error cases, authentication, and examples.
Inputs:
- What the endpoint does: {{endpointPurpose}}
- Core entities and fields: {{entities}}
- Constraints (rate limits, auth): {{constraints}}
Output requirements:
- Return JSON only. Do not wrap in Markdown or code fences.
- Do not add keys beyond the schema.
- Populate clarifying_questions if any critical input is missing or ambiguous, but still produce a best-effort deliverable.
- Keep explanations brief. Put the main work in deliverable_markdown.
JSON schema (example values only, keep the same keys):
{
"title": "API Endpoint Contract Generator",
"deliverable_type": "API endpoint specification",
"clarifying_questions": [],
"assumptions": [],
"deliverable_markdown": "",
"quality_checks": [
"Schema is consistent and complete",
"Includes meaningful error cases",
"Examples match the schema",
"Notes versioning and backward compatibility"
],
"next_steps": []
}
Tune the prompt, not the plumbing.
Every control comes from this prompt’s content schema. Changes stay in your browser and update instantly.
Customized prompt1321 characters
You are an API designer.
Model guidance (ChatGPT GPT-5.2):
- If available, use GPT-5.2 Thinking for planning and GPT-5.2 Pro for the hardest steps.
- If your environment supports a reasoning effort setting, use xhigh only for the most complex parts, otherwise use the default.
Task:
Draft an API endpoint contract for a specific endpoint purpose. Include request/response schema, error cases, authentication, and examples.
Inputs:
- What the endpoint does: a specific endpoint purpose
- Core entities and fields: a specific entities
- Constraints (rate limits, auth): a specific constraints
Output requirements:
- Return JSON only. Do not wrap in Markdown or code fences.
- Do not add keys beyond the schema.
- Populate clarifying_questions if any critical input is missing or ambiguous, but still produce a best-effort deliverable.
- Keep explanations brief. Put the main work in deliverable_markdown.
JSON schema (example values only, keep the same keys):
{
"title": "API Endpoint Contract Generator",
"deliverable_type": "API endpoint specification",
"clarifying_questions": [],
"assumptions": [],
"deliverable_markdown": "",
"quality_checks": [
"Schema is consistent and complete",
"Includes meaningful error cases",
"Examples match the schema",
"Notes versioning and backward compatibility"
],
"next_steps": []
}
Useful structure, room to move.
API Endpoint Contract Generator guides the model through a defined task while preserving the source prompt's useful structure and constraints. Use it when planning, writing, reviewing, or debugging software and you want a response that is easier to evaluate and act on.
The prompt establishes the job first, then supplies concrete decisions a model can act on. The variables preserve that structure while letting you change the subject, context, or output.
Related prompts
Observability Alerts and SLO Spec
Observability Alerts and SLO Spec turns technical context into clear code, diagnosis, or implementation guidance with clear constraints and an explicit output.
ChatGPTClaudeGemini
Bug Bash Consolidation and Fix Prioritization
Bug Bash Consolidation and Fix Prioritization turns technical context into clear code, diagnosis, or implementation guidance with clear constraints and an explicit output.
ChatGPTClaudeGemini
Bug Report Triage and Repro Steps
Bug Report Triage and Repro Steps turns technical context into clear code, diagnosis, or implementation guidance with clear constraints and an explicit output.
ChatGPTClaudeGemini
Claude Artifacts Spec to Code Feature Pack
Claude Artifacts Spec to Code Feature Pack turns technical context into clear code, diagnosis, or implementation guidance with clear constraints and an explicit output.
ChatGPTClaudeGemini