Base URL

https://api.rotor.sh

All API endpoints are versioned under /v1/.

Authentication

All /v1/* routes require a workspace API key passed as a Bearer token:

Authorization: Bearer rt_ws_your_key_here

Workspace keys are prefixed rt_ws_ and scoped to a single workspace. Generate them from your workspace settings at rotor.sh.

Rate Limits

Requests are rate-limited per workspace based on your plan:

Error Format

All errors return a consistent JSON envelope:

{
  "error": {
    "code": "QUOTA_EXCEEDED",
    "message": "Monthly job quota exceeded for this workspace",
    "details": { "used": 10000, "limit": 10000, "plan": "free" }
  }
}

Tag Groups

The OpenAPI spec below groups endpoints by resource:

• Queues — create, list, get, delete queues; per-queue metrics
• Jobs — enqueue single + batch; get status; retry; DLQ management
• Schedules — create, list, pause, resume, delete recurring jobs
• Status — workspace health check + quota usage
• Usage — billing-period execution breakdown
• Metrics — Prometheus-compatible counters (internal; gated at infra level)

OpenAPI Spec

Download the full machine-readable spec:

curl https://api.rotor.sh/doc -o openapi.json

The spec covers all /v1 endpoints with full request/response schemas. You can import it into Insomnia, Postman, or any OpenAPI-compatible client.

Endpoints at a glance