Upscale

POST/edit/upscale

Makes a product photo sharp at 2048 or 4096 px on the long side, restoring fabric and material detail without changing the photo.

Cost: 1 credit per photo at 2k, 2 at 4k. Images: Send one photo the same way, or up to 10 in images[] (or multipart files named images[]). It makes one image per photo, at most 12 per request.

Overview and examples: Image upscaler API.

Parameters

ParameterDescription
resolutionstringLong side of the result: 2k = 2048 px, 4k = 4096 px. Default "2k".One of: 2k, 4k
detailstring"enhanced" restores fine material detail; "natural" only sharpens what is there. Default "enhanced".One of: enhanced, natural
image_urlstringPublic https URL of the photo to edit. JPEG, PNG or WebP, up to 12 MB. Private and local addresses are refused.
image_base64stringThe photo itself, base64-encoded (a data: URI is fine). For large files use upload_id instead.
upload_idstringAn id from POST /uploads.
imagesarraySeveral photos at once (up to 10); each item is a URL string or an object with image_url, image_base64 or upload_id. Each photo is edited on its own.
webhook_urlstringhttps address Garmo POSTs the finished job to (signed, see Webhooks).
metadataobjectYour own JSON object (up to 1,000 characters), returned with the job and in the webhook.

Header Idempotency-Key (optional): see Retries and idempotency.

Example

curl https://api.garmo.studio/v1/edit/upscale \
  -H "Authorization: Bearer $GARMO_API_KEY" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "images": [
      "https://shop.example/p/ring-1.jpg",
      "https://shop.example/p/ring-2.jpg"
    ],
    "resolution": "4k"
  }'

Response: 202 Accepted

202 Accepted
{
  "id": "job_8Kq2xV7mPz4LtR9wNc3B",
  "object": "job",
  "tool": "upscale",
  "status": "processing",
  "livemode": true,
  "outputs": [
    {
      "id": "out_1",
      "status": "processing",
      "label": "4K"
    },
    {
      "id": "out_2",
      "status": "processing",
      "label": "4K"
    }
  ],
  "credits_charged": 4,
  "credits_refunded": 0,
  "metadata": {
    "sku": "DR-123"
  },
  "created_at": "2026-11-19T14:02:11Z",
  "completed_at": null
}

The finished job

GET /jobs/{id}
{
  "id": "job_8Kq2xV7mPz4LtR9wNc3B",
  "object": "job",
  "tool": "upscale",
  "status": "completed",
  "livemode": true,
  "outputs": [
    {
      "id": "out_1",
      "status": "succeeded",
      "label": "4K",
      "url": "https://….r2.cloudflarestorage.com/renders/2026/11/8f3c…0.webp?X-Amz-Signature=…",
      "url_expires_at": "2026-11-20T14:00:00Z"
    },
    {
      "id": "out_2",
      "status": "succeeded",
      "label": "4K",
      "url": "https://….r2.cloudflarestorage.com/renders/2026/11/8f3c…1.webp?X-Amz-Signature=…",
      "url_expires_at": "2026-11-20T14:00:00Z"
    }
  ],
  "credits_charged": 4,
  "credits_refunded": 0,
  "metadata": {
    "sku": "DR-123"
  },
  "created_at": "2026-11-19T14:02:11Z",
  "completed_at": "2026-11-19T14:02:58Z"
}

Errors

400 invalid_request names the parameter that is missing or wrong. Image problems are invalid_image, image_too_large or image_unreachable. 402 insufficient_credits says how many credits the request needs. All codes: Errors.