REST API
API SURFACE
What is, and is not, a developer API.
The API implements 87 published operations. Only 39 of them are a developer contract, and that is what /api/openapi.json serves: every operation it carries is annotated with x-eventium-tier, classified by intended exposure and by the authorization the server actually enforces.
| Tier | Operations | Documented |
|---|---|---|
| Public | 3 | Yes, below. No credential needed. |
| Developer | 27 | Yes, below. This is the supported external surface. |
| Account and sign-in flows | 9 | In Authentication. |
| Privileged | 3 | Named below, with prerequisites. |
| Internal infrastructure | 45 | No. |
The classification is derived from the route-to-capability map the server itself enforces, not from naming conventions, and the served schema, this page and the repository snapshot are generated from that one classifier so they cannot drift apart.
Three operations that used to appear here are gone rather than reclassified: GET and POST /api/rules and POST /api/rules/apply were published placeholders with no registered route, and answered 405 to every method. A documented operation that cannot be called is a false contract, so they were removed from the specification on 2026-11-10. Behavioural rules are available through MCP; see REST or MCP.
Public
| Method | Path | Purpose |
|---|---|---|
| GET | /api/health | Liveness. 200 when the API is serving. |
| GET | /api/health/deps | Dependency health, including upstream services. |
| GET | /api/public-config | Client configuration safe to expose to browsers. |
Developer surface
All of these accept either an API key in X-Api-Key or a signed-in browser session. Where a capability is named, your credential must carry it — see Authentication. Start with GET /api/me/capabilities: it reports what the credential you hold may actually do, which is cheaper than discovering it one 403 at a time.
| Method | Path | Capability |
|---|---|---|
| GET | /api/me/capabilities | — |
| GET | /api/me/scopes | — |
| GET | /api/api-keys | — |
| POST | /api/api-keys | — |
| DELETE | /api/api-keys/{key_id} | — |
| POST | /api/chat/stream | single_agent |
| GET | /api/chat/threads | single_agent |
| POST | /api/chat/threads | single_agent |
| POST | /api/documents/ingest | — |
| POST | /api/media/uploads/init | media_upload |
| GET | /api/mcp/tools | — |
| POST | /api/mcp/tools/install | — |
| POST | /api/mcp/tools/invoke | — |
| GET | /api/skills | — |
| POST | /api/skills/install | — |
| GET | /api/marketplace/listings | marketplace_browse |
| POST | /api/marketplace/listings | marketplace_publish |
| POST | /api/marketplace/listings/{listing_id}/install | marketplace_install |
| GET | /api/webhooks/endpoints | — |
| POST | /api/webhooks/endpoints | — |
| PATCH | /api/webhooks/endpoints/{endpoint_id} | — |
| DELETE | /api/webhooks/endpoints/{endpoint_id} | — |
| GET | /api/webhooks/events | — |
| GET | /api/webhooks/deliveries | — |
| POST | /api/webhooks/test | — |
| POST | /api/workspaces/{workspace_id}/agent-selection | multi_agent |
| POST | /api/workspaces/{workspace_id}/memory-selection | multi_agent |
A capability entry of — means authentication alone is sufficient; it does not mean unauthenticated. /api/mcp/tools is the installable-catalogue listing for your account, not MCP protocol discovery — for that see MCP.
Reading your own usage and allowance is free and always permitted: see Plans and usage.
Privileged
Three operations are real but conditional. They are named here so you can recognise them, not so you can build on them.
| Method | Path | Prerequisite |
|---|---|---|
| GET | /api/runtime/context | Runtime and session bootstrap; not a general data-read API. |
| GET | /api/runtime/status | Runtime and session bootstrap. |
| POST | /api/dev/sandbox-key | Environment-gated sandbox provisioning utility. Issues a bounded sandbox credential with no internal billing bypass and no administrative permissions. Not a route to a production credential — create those in the API keys console. |
Internal infrastructure
Forty-five operations are internal and deliberately undocumented. Nearly all are the native memory-engine administration surface: operations that create and destroy memory Banks, administer Domains and Zones, and manage the engine's own user and agent lifecycle. They are gated on an internal runtime-administration capability that is explicitly denied to the billing-admin, editor, member and viewer roles.
They are omitted because they are not integration points. They carry no stability contract, no versioning commitment and no supported client, and several are destructive against shared state. Atlas capability is available to you — through the scoped developer operations above and through MCP, rather than through raw engine administration.
The one remaining internal operation opens a billing-portal session, which belongs to the account UI rather than to an API client.
The schema is the contract
This page states which operations are supported and why. For exact request and response shapes read the live specification, which is generated from the running service and so cannot drift from it.
curl -s https://api.eventium.ai/api/openapi.jsonInteractive: /apidocs/. Tiers change as the platform evolves, so treat this page as current rather than permanent, and re-read /api/me/capabilities instead of caching an authorization decision.