Skip to main content

​
Base URL

All REST endpoints live at:
The cloud edge at cloud.algovoi.co.uk proxies a subset of public-read endpoints and chat-bot webhooks but is not the canonical API. Use api1.* for any authenticated API calls from your backend.

​
Content type

Every request sends and receives application/json. The gateway rejects other content types with HTTP 415.

​
Versioning

The REST API is unversioned in the URL. Breaking changes are gated by feature flag and announced in the changelog before any rollout. Webhook payloads carry an api_version field so receivers can detect schema changes.

​
Idempotency

For endpoints that create resources (POST /v1/payment-links, POST /v1/resources, etc.) you can include an Idempotency-Key header. Replays with the same key within 24 hours return the originally-created resource without creating a duplicate.

​
Request IDs

Every response includes an X-Request-Id header. Include it in support requests so we can find the matching server log line in seconds.

​
Authentication

Every authenticated endpoint requires:
See Authentication for the full key types, prefixes, and rotation flow.

​
Errors

JSON envelope: { "error": "code_string", "message": "human-readable", ...context }. See Errors for the full code list and HTTP-status mapping.

​
Rate limits

Default tenant limit is 300 requests per minute with a burst of 60. Returns 429 Too Many Requests with Retry-After headers. See Rate limits.

​
See also