Public API Catalog

The catalog below lists where the public Xema APIs are served and which APIs there are. Use it as a map before you start endpoint-level implementation; the operations themselves are in the API reference.

Public APIs

Every service that registers routes annotated as public in the gateway's route registry is reachable under these bases. Biome APIs are served per biome under the biome API host (<biome>.api.xema.dev). The installation owner can narrow or widen what each base exposes through the public-exposure settings; see Public exposure.

Available APIs

Generated from the specification each published public API client ships. The full reference: API reference.

Each base path is relative to your deployment's API host. Operations that exist only for the Xema web app, and internal routes, are not public and are not listed.

Reading the Docs Programmatically

The documentation you are reading is available as data. Four read-only operations need no credentials. The paths below are relative to your deployment's API host:

Set XEMA_API_URL to your deployment's API host, then fetch a page as Markdown:

1curl "$XEMA_API_URL/api/docs-api/markdown?path=apis/01-public-api-catalog"

Search returns pages that contain every term in q, ignoring case. Terms are matched as plain text, so characters such as . or * carry no special meaning. Title and heading matches rank above matches in the body. q is required, at most 200 characters and at most 10 terms. limit defaults to 10 and is capped at 25.

1curl "$XEMA_API_URL/api/docs-api/search?q=workflow%20approval&limit=5"

Each result has path, title, snippet and score. Pass path unchanged to the markdown or content operation.

These operations are rate limited. When a request is refused you receive 429 Too Many Requests with a Retry-After header giving the seconds to wait; retry after that interval. Fetch the tree or a page once and reuse it rather than polling. Operations other than GET are refused.

Scope Notes

• This catalog includes only APIs with public xema.dev ingress.
• Internal services and private domains are intentionally excluded from public documentation.
• Use the next page to pick the minimal API set for your scenario.

Next: API Selection Guide →