Skip to content

OpenAPI explorer#

Interactive Swagger UI. Points at the OpenAPI schema of a running swarm instance.

Configuring the spec URL

By default, the explorer below points at the managed-SaaS production API. To inspect your own instance, change the URL to your deployment's /openapi.json.

Managed SaaS    https://api.theaisingularity.org/openapi.json
Local dev       http://localhost:8000/openapi.json
Self-hosted     https://<your-swarm>/openapi.json

Can't see the explorer?#

The Swagger UI above requires the mkdocs-swagger-ui-tag plugin + network access to the OpenAPI JSON URL. If you're reading the rendered docs offline, open the spec directly:

# Local dev
open http://localhost:8000/docs     # FastAPI's built-in Swagger UI
open http://localhost:8000/redoc    # ReDoc alternative
open http://localhost:8000/openapi.json  # raw spec

Both /docs (Swagger) and /redoc ship with every FastAPI instance and are the authoritative source.

Downloading the spec#

curl -o swarm-openapi.json http://localhost:8000/openapi.json

Use with:

openapi-generator-cli generate \
  -i swarm-openapi.json \
  -g python \
  -o ./swarm-client-py

Import → File → swarm-openapi.json → Postman generates a collection of requests.

New → From File → swarm-openapi.json

Schema stability#

We version the OpenAPI schema alongside the API version:

  • /openapi.json is the current major (v1)
  • Breaking schema changes happen at major bumps only
  • Deprecated fields are marked deprecated: true for ≥6 months before removal