APIs
The API surface in Xema is split by capability so teams can integrate only what they need. This section explains what each public API is for, when to use it, and what behavior to expect in production.
Quick Links
| Page | What it covers |
|---|---|
| API Reference | Every public operation, generated from the published API specifications |
| 01 Public API Catalog | Where the public APIs are served |
| 02 API Selection Guide | How to choose the right API per integration scenario |
| 03 Streaming and SSE Guide | Realtime endpoints, reconnect model, and SSE contracts |
| 04 Activity Feed Realtime Frames | Deep integration guide for realtime frames with examples |
| 05 Knowledge Base API Guide | Spaces, pages, proposals, ingestion, knowledge graph and reviewed document authoring |
| 06 Project Registry API Guide | Projects, wallets and variables, the manifest, bindings and access |
| 07 Search and Rendering Guide | Search modes, facets and result types; PDF and DOCX rendering |
Getting Started
Recommended order for new integrations:
- Public API Catalog — identify the APIs you actually need.
- API Selection Guide — map your use case to a minimal integration footprint.
- Streaming and SSE Guide — add realtime behavior only where it adds product value.
- Activity Feed Realtime Frames — implement resilient stream consumers with concrete patterns.
FAQ
Q: Does this section list internal/private services? A: No. It documents only APIs with public ingress on the xema.dev domain.
Q: Does this replace Swagger? A: No. Swagger is the endpoint contract. This section is the capability and adoption guide.