API reference / Create an image job

Create an image job

Queue an image and return immediately. API keys always use credits. The browser editor uses credits first; at zero balance, Fast processing can use the five-per-day free allowance. Files expire after one hour.

POST/api/jobs
Authenticate with X-API-Key. Keep your key on your server; never embed it in a public website.

Request parameters

image_filebinary

JPG, PNG or WebP file, up to 22 MB. Choose exactly one input source.

image_urlstring

Public HTTP or HTTPS image URL. Private hosts, credentials, non-standard ports and unsafe redirects are rejected.

qualitystringdefault: fast

Fast uses 1 credit. Fine detail (quality) uses 2. Output resolution is independent of quality.

fastquality

Response

202 · Success
{
  "id": "image_id",
  "name": "photo.jpg",
  "status": "queued",
  "quality": "fast",
  "credits": 1,
  "created": 1789052400,
  "expires": 1789056000,
  "original_url": "/api/files/image_id/original.png"
}

Errors use a structured error.code and error.message. See error handling →

Clearcut support