Public API documentation

Start with the OpenAPI schema

The canonical machine-readable contract is an OpenAPI 3.1 document. Every operation has a unique operation ID, description, typed parameters, and response schemas suitable for generating clients or function-calling tools.

• OpenAPI JSON: /openapi.json
• Agent instructions: /llms.txt

Check API status

Call GET /api/public/status to confirm that the public API is reachable and discover its version, canonical origin, documentation URL, and OpenAPI URL. The endpoint returns service metadata only. It does not return exercises, guided content, session links, attendance, accounts, billing, or organization data.

curl \
  -H "Accept: application/json" \
  https://www.pauso.com/api/public/status

Authentication and access

This status endpoint requires no API key or account. It sends permissive CORS headers and cache headers for read-only use. Standard service abuse protections may apply, so clients should cache results and avoid unnecessary repeated requests. Pauso does not currently offer a public API for creating session links or reading private attendance, billing, user, or organization data.

Errors

Public API errors are JSON. The stable code is intended for program logic, the message explains the problem, and the hint gives an agent a concrete recovery step. Unknown API paths and unsupported methods follow the same structure.

{
  "error": {
    "code": "endpoint_not_found",
    "message": "No Pauso API endpoint exists at this path.",
    "hint": "Read https://www.pauso.com/developers or https://www.pauso.com/openapi.json."
  }
}

Support and changes

The current API is versioned as 1.0.0 in the published schema. Additions will remain backward compatible within that version where practical. For integration questions or a use case that needs a private product capability, email hello@pauso.com. Access to private product data is a separate product and security decision, not an undocumented extension of this public endpoint.