Simple Chat
Reference

API Reference

Use the live Swagger endpoints and repository OpenAPI artifacts to inspect Simple Chat APIs, integration helpers, and route coverage.

Authenticated live docs JSON and YAML output Route and cache inspection
Admin settings reference Feature reference

Use this page when you need to answer a concrete API question: what route exists, which auth model it uses, whether a deployed environment is exposing docs, or which OpenAPI helper endpoints support custom action setup.

Interactive docs

Open /swagger in a signed-in environment when you want the interactive route browser backed by the running app.

Machine-readable specs

Download /swagger.json or /swagger.yaml when you need tooling input, contract review, or export-friendly route metadata.

Route inventory

Use /api/swagger/routes and /api/swagger/cache to inspect route coverage, cache state, and documentation internals.

OpenAPI helpers

The /api/openapi/* endpoints support OpenAPI upload, validation, and auth-scheme analysis for custom action configuration.

Pick the right source of truth

Use the live Swagger endpoints when you need the currently deployed route set, auth requirements, or generated schemas. Use the repository artifact at artifacts/open_api/openapi.yaml when you are reviewing frontend dependencies or discussing API shape in a pull request without relying on a running environment.

Admin-controlled availability

The live API documentation and external health routes are controlled from Admin Settings > General.

Area Admin setting Routes
Swagger/OpenAPI Enable Swagger/OpenAPI Documentation (/swagger) /swagger, /swagger.json, /swagger.yaml
Protected health check Enable /external/healthcheck /external/healthcheck
Unauthenticated health check Enable /external/healthcheckz /external/healthcheckz

For the full operator workflow, see Configure Branding, Home Page, and Support Settings.

Documentation endpoints

Endpoint Use it for Notes
/swagger Interactive documentation UI Requires authentication and depends on API documentation being enabled in Admin Settings.
/swagger.json JSON OpenAPI output Cached and rate limited. Good for tooling and diffing.
/swagger.yaml YAML OpenAPI output Same data as JSON, but easier to read or export into YAML-based workflows.
/api/swagger/routes Route documentation status Useful when you want to confirm which endpoints are documented.
/api/swagger/cache Cache statistics and management Supports inspection and cache clearing workflows.

OpenAPI action helper endpoints

Use these when configuring custom OpenAPI-backed actions:

  • /api/openapi/upload validates an uploaded OpenAPI file and returns extracted spec metadata.
  • /api/openapi/list-uploaded lists previously stored validated specs when available.
  • /api/openapi/analyze-auth inspects the uploaded spec and suggests authentication handling.
  1. Enable API documentation in Admin Settings if the environment hides Swagger routes by default.
  2. Sign in and confirm the live docs at /swagger match the running environment.
  3. Download /swagger.json or /swagger.yaml when you need contract-oriented tooling.
  4. Use artifacts/open_api/openapi.yaml when you want a repo-side artifact for code review or frontend analysis.