The current Platform API reference is implemented as a route list at
/openapi.json. A complete schema-level OpenAPI document is not published
yet.Authentication
Platform API requests use platform tokens with thewzp_ prefix.
wzw_ prefix and are intended for data-plane
access to specific worlds.
Base URL
Current resources
The Platform API currently covers these management resources:| Resource | Routes |
|---|---|
| Organizations | /v1/organizations, /v1/organizations/:organizationId |
| Groups | /v1/organizations/:organizationId/groups |
| Worlds | /v1/organizations/:organizationId/worlds |
| Platform tokens | /v1/auth/api-tokens, /v1/organizations/:organizationId/platform-tokens |
| World auth tokens | /v1/organizations/:organizationId/worlds/:worldId/auth/tokens |
| Usage | /v1/organizations/:organizationId/usage, /v1/organizations/:organizationId/worlds/:worldId/usage |
organizationId path parameters accept either an organization ID or slug.
Data-plane boundary
The Platform API does not execute SPARQL, search triples, import RDF, or export RDF. Those operations belong to the Worlds Data API and@worlds/client.
The intended production boundary is:
wzp_platform tokens manage organizations, worlds, tokens, and usage.wzw_world tokens authorize world data access.- Data-plane services can integrate with platform usage and limits, but that enforcement path is not fully documented yet.
Usage and limits
Wazoo usage and limits are billed by compute time. Data-plane services should report the compute time consumed by world operations so the Platform API can aggregate usage and enforce limits. The production model is:- Worlds Data API operations consume compute time.
- The Platform API records and aggregates compute-time usage.
- Entitlements and limits decide whether an organization or world can continue running work.