OpenAPI 3.1 spec

The full spec is served live at:

https://api.wholisphere.ai/openapi.json

It covers every public path under /v1/* (and the magic-link auth flow), with request/response schemas, security schemes (x-api-key, x-install-id, session cookie), and component definitions for the major payloads.

Browse it

For an interactive viewer, plug the URL into any of these:

• redocly.com — paste the URL
• petstore.swagger.io — Swagger UI
• Postman → Import → URL → https://api.wholisphere.ai/openapi.json

Generate a typed client

Any OpenAPI 3.1-compatible generator works. Examples:

# TypeScript: openapi-typescript
npx openapi-typescript https://api.wholisphere.ai/openapi.json -o ./src/wholisphere.d.ts

# Python: openapi-python-client
openapi-python-client generate --url https://api.wholisphere.ai/openapi.json

# Go: oapi-codegen
go run github.com/oapi-codegen/oapi-codegen/v2/cmd/oapi-codegen \
  -package wholisphere -generate types,client \
  https://api.wholisphere.ai/openapi.json > wholisphere.go

For TypeScript users we also publish the official typed client as @wholisphere/sdk — it’s hand-tuned for ergonomics but uses the same schemas as the spec, so wire compatibility is always preserved.

Versioning

The spec follows the same versioning policy as the API itself — see Versioning + deprecation for the compatibility promise and how deprecated routes are signaled in headers.