saranskumar Goal
Define APIs that clearly support product actions and client needs.
When to Use
- Frontend and backend planning are converging.
- A feature needs endpoint or action design.
- Integrations, webhooks, or async jobs affect contract design.
Instructions
- Start from user actions and backend capabilities.
- Define the minimal contract set for v1.
- Specify payloads, validation needs, and error shapes.
- Include auth requirements, pagination, filtering, and async status where needed.
- Mark unstable contracts and assumptions.
Constraints
- Do not leak internal table structure directly.
- Avoid generic endpoints with unclear business meaning.
- Keep contracts small and explicit.
Output Format
- API inventory
- Request/response shapes
- Auth/error notes
- Async/webhook notes
Examples
- "Design the API for report generation and export."
- "What endpoints do we need for invite-based workspaces?"