Skip to main content
The REST API contract is generated from the API route definitions and rendered in the Reference tab’s REST API section. Most product endpoints live under /v1/.

Authentication

Human routes can fall back to the first workspace in local development. Agent routes resolve the workspace from the bearer token.

List response envelope

Every list endpoint returns the same envelope:
Only items is always present. Other fields appear when the endpoint has that metadata.

Example agent completion

Error envelope

Errors use a stable JSON envelope:
Branch on code and structured details when building clients.

OpenAPI contract

Every Fortress REST endpoint is described by a single OpenAPI 3.1 document generated directly from the route definitions. Use it to:
  • Generate typed clients in any language.
  • Validate requests and responses in your own code.
  • Power editor tooling and API explorers.

Fetch the live contract

GET /openapi.json returns the contract for the running server, including request schemas, response schemas, and auth metadata.
The same document is published as a static artifact alongside this site, so the REST API section in the Reference tab stays in lockstep with the deployed routes.