Image Compression API

Create an API key in your dashboard, then use HTTP Basic auth (user api, password = key) or send Authorization: Bearer <key>.

curl --user api:YOUR_API_KEY ...
# or
curl -H "Authorization: Bearer YOUR_API_KEY" ...

POST the image as the request body to /api/v1/shrink. Optional query parameters: level (fast / default / best) and filename.

curl -i --user api:YOUR_API_KEY \
  --data-binary @photo.jpg \
  "https://bitinz.com/api/v1/shrink?level=default&filename=photo.jpg"

Successful requests usually return 201 with status done. The Location header and output.url point to the download. Compression-Count is your usage this month.

HTTP/1.1 201 Created
Location: https://bitinz.com/api/v1/results/<id>/download
Compression-Count: 1

{
  "id": "<id>",
  "status": "done",
  "input":  { "size": 2277375, "type": "image/jpeg" },
  "output": { "size": 992450, "type": "image/jpeg", "ratio": 0.436,
              "url": "https://bitinz.com/api/v1/results/<id>/download" },
  "unchanged": false,
  "expiresAt": "2026-10-02T12:00:00Z"
}

Accepted and waiting: 202

A longer queue may return 202 Accepted with status pending. Location points to the job status, not the download. Keep this URL and poll it instead of submitting the image again.

HTTP/1.1 202 Accepted
Location: https://bitinz.com/api/v1/results/<id>

{
  "id": "<id>",
  "status": "pending",
  "input": { "size": 2277375 },
  "expiresAt": "2026-10-02T12:00:00Z"
}

Poll the job status

Send GET /api/v1/results/{id} to the URL returned in Location every 1–2 seconds. pending means queued (queuePosition gives its current place); processing means compression is underway. When status is done, download from downloadUrl. failed means the job could not finish; failure identifies the category and note explains why.

curl "https://bitinz.com/api/v1/results/<id>"

{
  "id": "<id>",
  "status": "done",
  "available": true,
  "downloadUrl": "/api/v1/results/<id>/download",
  "outputSize": 992450,
  "unchanged": false
}

Results can be downloaded until they expire; afterwards the URL returns 410.

curl -o photo.min.jpg "https://bitinz.com/api/v1/results/<id>/download"

{ "error": { "code": "...", "message": "..." } }