Skip to main content
You are viewing legacy endpoint documentation. See the Modern docs for engine-scoped endpoints.
REST API over HTTPS. All requests and responses use JSON.

​
Base URL

https://api.usenexio.com
Versioned REST endpoints live under /api/v1/. The unauthenticated health check is GET /health.

​
Authentication

Bearer token required on all /api/v1/* endpoints. GET /health does not require authentication. See Authentication.

​
Error format

All errors use a standard envelope: 
{
  "code": "invalid_request",
  "message": "Request body is not valid JSON"
}
code is stable and safe to match programmatically. message is human-readable and may change.

​
Status codes

CodeMeaning
200Success (GET, PATCH)
201Created (POST webhook)
202Accepted and queued (POST job)
204Deleted (DELETE webhook)
400Malformed request or validation failure
401Missing or invalid API key
404Resource not found
429Rate limited — honor Retry-After header
503Temporary dependency outage, for example auth unavailable or queue unreachable

​
Rate limiting

Per-organization, per-minute window. 429 responses include a Retry-After header.

​
Versioning

Versions are in the URL path (/api/v1/). Breaking changes ship under a new version. Additive fields may be added to existing versions without notice.

​
Health check

GET /health → {"status":"ok"}
No authentication required.