Developer API / docs

Compress Image API

Recompress an image by quality, or give target_kb and the engine finds the best quality that fits under that size. If the target is impossible it says so instead of silently missing it.

POSThttps://api.gigai.tools/v1/jobsAsync

Runs as the compress-image operation inside a job. Needs a key with the jobs:write scope. Try it in the browser

Options

quality - integer, 1..100
target_kb - integer, 1..51200
format - string, one of jpeg, webp, avif

Limits

Input: png, jpg, webp, avif, gif (one file, checked by content, never by extension).
Max input size: 50 MB.
Output: jpg, webp, avif.
Time budget: 60 seconds, then the task fails with the timeout code.
Engine: sharp.

Inside a bigger job

Chain it: any task can consume this one's output by naming it in input. The recipes show working pipelines.

as one task in a graph

"step": { "operation": "compress-image", "input": ["previous-task"] }

Errors this tool returns

invalid_input, invalid_option, file_too_large, timeout, target_unreachable. The full list with fixes is on the errors page.

Convert Image · Resize Image · Crop Image · Rotate Image

Was this page helpful?

curl -X POST https://api.gigai.tools/v1/jobs \
  -H "Authorization: Bearer $GIGAI_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{ "tasks": {
    "in": { "operation": "import/url", "url": "https://example.com/input.png" },
    "work": { "operation": "compress-image", "input": ["in"] },
    "out": { "operation": "export/url", "input": ["work"] }
  } }'

# then poll until finished and follow the export URL:
curl https://api.gigai.tools/v1/jobs/JOB_ID/wait -H "Authorization: Bearer $GIGAI_API_KEY"

Finished job

{
  "id": "job_27b562f72d84a9a52324ced8",
  "status": "finished",
  "retention_s": 3600,
  "tasks": [
    { "name": "work", "operation": "compress-image",
      "status": "finished", "duration_ms": 47 },
    { "name": "out", "operation": "export/url", "status": "finished",
      "result": { "files": [
        { "id": "file_63930500160eadd44dee99f1",
          "filename": "result.jpg", "size": 10420,
          "url": "https://api.gigai.tools/v1/files/file_639.../download?e=...&s=..." }
      ]}}
  ]
}

Compress Image API

Options

Limits

Inside a bigger job

Errors this tool returns

Related tools