API Reference

Base URL

All API requests are made to the following base URL:

Authentication

Every request must include your API key as a Bearer token in the Authorization header:

See Authentication for how to create, scope, and rotate keys.

Requests and responses

Request and response bodies are JSON. Send Content-Type: application/json on requests with a body. Timestamps are ISO 8601 in UTC, and every resource has a stable, prefixed identifier (for example job_abc123).

Errors

offload.run uses conventional HTTP status codes. 2xx means success, 4xx indicates a problem with your request, and 5xx indicates a problem on our side. Error responses carry a machine-readable code and a human-readable message:

{
  "error": {
    "code": "invalid_input",
    "message": "The 'input' field must be a valid URL."
  }
}

Next steps

• Authentication — API keys and the Authorization header.
• Endpoints — create, retrieve, and list jobs.
• Webhooks — get notified when jobs finish.