Archipelag.io API Reference

Interactive API documentation powered by Scalar.

How it works

• index.html — Single-page app that loads Scalar from CDN and renders the OpenAPI spec
• openapi.json — OpenAPI 3.1 specification (generated by the coordinator app)

Updating the spec

The OpenAPI spec is served by the coordinator at /api/v1/openapi.json. To update the static copy:

# From production
npm run fetch-spec

# From local dev server
npm run fetch-spec:local

Local development

npm run dev
# Opens at http://localhost:3000

Deployment

Deployed to Cloudflare Pages. On push to main, Cloudflare serves the static files directly (no build step needed).

Cloudflare Pages settings:

• Build command: (none)
• Build output directory: /
• Root directory: api-docs

The coordinator app also serves Scalar at /api/v1/docs for authenticated try-it-out against the live API.

Contributing

The OpenAPI spec is generated from the coordinator codebase. If you find inaccuracies in the API documentation, please open an issue describing the discrepancy.

For general contribution guidelines, see our Contributing Guide and Code of Conduct.