Interactive API Reference
The interactive API reference is served live by the running backend at /api-docs — a dark-themed Swagger UI with full request/response schemas and “Try it out”, always matching the deployed version.
- Hyperweaver Server —
/api-docsdocuments the Server’s own API. - A specific agent — open API Reference → Agent API in the app sidebar (or
/agent/api-docs). It resolves to the host you’ve selected in the navbar, and the Server relays that agent’s live spec. - Standalone agent (Direct mode) —
/api-docsis that agent’s own API.
Download the spec
- Hyperweaver Server OpenAPI — raw OpenAPI 3.0 specification
- Zoneweaver Agent OpenAPI — raw OpenAPI 3.0 specification
The interactive reference lets you explore every endpoint, view schemas, and test calls from your browser. It’s served live by the backend, so it never goes stale.