API Reference#

Versioning#

The API is versioned via URL prefix. The current release uses /v0, signalling an unstable contract — breaking changes may occur before 1.0.0. Once the contract stabilizes, the codebase moves to 1.0.0 and the prefix graduates to /v1.

Prefix	Contract
`/relay`	Ingest — stable shape, versioned separately from the management API
`/v0`	Management API — unstable, breaking changes expected
`/system`	Internal, worker-only endpoints

Requests#

All POST/PUT/PATCH requests must send Content-Type: application/json with a valid JSON body, or the API responds 415/400 respectively. See Errors .

Responses#

A single resource is returned wrapped in data:

{ "data": { "...": "..." } }

A collection is cursor-paginated:

{
  "limit": 25,
  "previous": null,
  "next": "eyJpZCI6NDJ9",
  "data": [ { "...": "..." }, { "...": "..." } ]
}

Paginated list endpoints accept ?limit= (default 25, max 100) and ?cursor= query parameters.

Sections#

Authentication — token types, header, generation
Relay — the ingest endpoint
Events
Destinations
Destination Types
Event Logs
System — internal worker endpoints
Errors — error envelope, codes, and status codes