Gym API Docs | BurnProof

Reserved Route

/api-docs/gym

Gym API docs will live here once verification, queue, and management endpoints are documented.

Planned Structure

Authentication and required headers
Endpoint groups separated by resource or workflow
Concrete request, response, and error examples

Navigation

This route is live now so future links, sidebars, and settings pages can point to a stable role-based documentation URL.

Back To API Docs Index

Machine-Readable Placeholder

The route is already exposing a stable summary block so AI clients can discover that this docs URL exists before the full endpoint set is published.

script#gym-api-docs-summary[type="application/json"]

Inspect Placeholder JSON

{
  "docsUrl": "/api-docs/gym",
  "role": "gym",
  "sections": [
    "authentication",
    "resources",
    "request examples",
    "response examples"
  ],
  "status": "planned",
  "title": "Gym API Docs"
}