Skip to main content

OpenAPI Specification

Quick Overview

Access the machine-readable OpenAPI specification and the interactive API documentation.

OpenAPI JSON​

The Public API serves an OpenAPI specification at:

<base_url>/docs/v1/openapi.json

Replace <base_url> with your WaaPY instance base URL. This specification includes all Public API endpoints, schemas, and authentication details.

Interactive API Docs​

In the WaaPY web app, you can view interactive API documentation at:

<app_url>/api-docs

The in-app API docs are powered by Scalar and show the public API specification. From there, you can explore endpoints and see authentication requirements.

Usage Notes​

  • The OpenAPI spec is generated dynamically from the backend routes.
  • Use the spec to generate client libraries or import into API testing tools.
  • All authenticated endpoints require a Bearer token with your workspace API key.