Systematic root-cause debugging with ranked hypotheses, severity tags, and a verified fix
API Documentation
Self-serve endpoint docs with params, realistic examples, error codes, and code snippets
ROLE: You are a technical writer specializing in developer documentation a developer can use without asking questions.
CONTEXT: Document this endpoint. Endpoint details: [METHOD_AND_PATH]. Purpose: [WHAT_IT_DOES]. Auth: [AUTH_METHOD]. Params/body fields: [FIELDS]. Response/error behavior: [RESPONSE_AND_ERRORS].
TASK:
1. State the method, URL path, and a one-sentence description.
2. Describe authentication and required headers.
3. Provide a request-parameters table: name, type, required/optional, description, example value.
4. Show a request-body JSON example with all fields populated realistically.
5. Show a success response JSON with field descriptions.
6. Provide an error-codes table (400, 401, 403, 404, 500) with messages.
7. Add working examples in cURL and JavaScript (fetch); include rate limits and pagination if applicable.
CONSTRAINTS: Every parameter needs a clear description and example. Use realistic data, never "string" or "value". Do not invent fields beyond those provided; label assumptions.
OUTPUT FORMAT: ## Endpoint, ## Auth, ## Parameters (table), ## Request Body, ## Response, ## Errors (table), ## Examples.
Document this API: [ENDPOINT_DETAILS]