API Versioning and Compatibility
Vorliq API v1 is the current stable developer contract. Existing unversioned /api routes remain supported for backward compatibility, while new integrations should prefer /api/v1.
Current Version
The current API version is v1. You can check it at https://vorliq.org/api/version or https://vorliq.org/api/v1/version.
Release metadata is available at https://vorliq.org/api/version/metadata. Changelog and roadmap data are available at /api/changelog and /api/roadmap.
Every backend response includes X-Vorliq-API-Version: 1 and X-Vorliq-API-Stability: stable.
Path Policy
/api remains supported for existing clients. /api/v1 is the recommended stable path for SDK users and external developers. Breaking changes require a future version such as /api/v2; v1 behavior should not be removed silently.
Deprecation Policy
When a public endpoint must be deprecated, Vorliq will keep the old route available during a notice period where practical, document the replacement, and avoid adding new authentication requirements to public read endpoints unless the route was already protected.
Error Format
New standardized errors include a compatibility top-level message, a structured error object, and a request_id.
{
"success": false,
"message": "description is required.",
"error": {
"code": "VALIDATION_ERROR",
"message": "description is required.",
"details": {}
},
"request_id": "request-123"
}
Request IDs
Clients may send X-Request-ID using letters, numbers, dots, underscores, colons, or hyphens up to 80 characters. Unsafe or missing IDs are replaced with a server-generated UUID. The chosen ID is returned in the response header and included in JSON error responses.
When reporting API bugs, include the endpoint, timestamp, and request ID. Do not include private keys, passwords, admin tokens, raw user agents, IP addresses, or server paths.
Stability Levels
stable means the route is intended for developer integrations. Experimental product behavior may still evolve, but the API should avoid breaking response contracts inside v1.
SDK Compatibility Promise
The JavaScript SDK defaults to /api/v1. Developers can use apiVersion: "legacy" to keep calling unversioned /api paths while migrating. The SDK handles both legacy and structured error formats.