APIs

Versioned REST. OpenAPI documented.The OrvexCore API is designed for reliability and predictability — versioned endpoints, consistent error shapes, OpenAPI 3.0 documentation, and an interactive playground.

REST + webhook event delivery

OpenAPI 3.0 + Swagger UI

Schema-validated request bodies

Idempotency key support

Get started All infrastructure

Technical details

Versioned endpoints

All API routes are versioned (/v1/) with deprecation notices published at least 6 months before removal.

OpenAPI 3.0 documentation

Full API documentation auto-generated from decorators with request/response examples for every endpoint.

Consistent error responses

Standardised error shapes with machine-readable codes, human-readable messages, and field-level validation errors.

JWT authentication

Bearer token authentication with role-based scopes enforced at the route level.

Rate limiting

Per-tenant rate limits with configurable burst allowances and rate limit headers in responses.

Request validation

Class-validator DTO validation with automatic 400 responses for malformed requests.