Skip to main content

Documentation Index

Fetch the complete documentation index at: https://docs.ringbee.dev/llms.txt

Use this file to discover all available pages before exploring further.

Base URL

https://api.ringbee.dev

Authentication

Include your API key in every request:
X-API-Key: mk_live_abc123...

Response format

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" }

Rate limits

PlanRequests/min
Free10
Pro60
Business300
EnterpriseUnlimited

Job lifecycle

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