API Endpoint Template

Use this page as a starting point for every endpoint.

Summary

Describe what the endpoint does and who should use it.

Endpoint

POST /api/example

Authentication

State whether the endpoint requires auth and which scheme applies.

Request body

{
  "example": true
}

Response

{
  "success": true
}

Errors

• 400 invalid request
• 401 missing auth
• 500 server error

Notes

• Keep the summary short and specific.
• Put the request example right after the summary.
• Use bullets for errors so the page stays consistent with the rest of the docs.