API Reference
Where each Sarvex API surface lives and which contract governs it.
Sarvex exposes four distinct surfaces. Each has exactly one authority — the docs below are generated from, or defer to, it.
| Surface | Audience | Authority | Reference |
|---|---|---|---|
| Control-plane REST API | Console, operators, integrators | sarvex-v1-control-plane.yaml (OpenAPI 3.0.3) |
Control-plane API — generated |
Connector ingest (/connector/*) |
Store plugins (WooCommerce, Magento) | Same OpenAPI file, tag Connector Ingest | Connector ingest |
| UCP endpoints | AI shopping agents | The external ucp.dev specification | UCP endpoints |
| Sync-plane events | Sarvex services | sarvex-v1-syncing-plane-async.yaml (AsyncAPI 2.6.0) |
Events — generated |
Start with Conventions and Authentication; they apply to every control-plane operation.