API Reference

Base URL

https://api.ringbee.dev

Include your API key in every request:

X-API-Key: mk_live_abc123...

All responses are JSON. Successful responses return 2xx status codes. Errors return 4xx or 5xx with an error field:

{ "error": "Description of what went wrong" }

pending → processing → completed
                     → failed
pending → cancelled

Jobs are processed asynchronously. Use polling (GET /v1/jobs/{id}) or webhooks to know when a job completes.