Compare Images API
Side-by-side slider, difference heatmap and a similarity score.
Environment
| Environment | Base URL |
|---|---|
| Production | https://api.sadafiles.com/v1 |
There is one environment and no sandbox, so every request here is real and counts toward your limits.
Request
POSThttps://api.sadafiles.com/v1/tools/compare-images
- Content type
- multipart/form-data
- Auth
- X-API-Key with tools:run
- Accepts
- jpg, png, webp, avif, gif, bmp, tiff, heic and 1 more
- Files per request
- 2
- Largest file
- 2 GB
- Job timeout
- 120 s
- Rate weight
- 2 units
- Web tool
- Use Compare Images without code
Parameters
Send these as a JSON string in the options form field. Anything else is rejected.
| Name | Type | Default | Allowed |
|---|---|---|---|
threshold | number | 0.1 | min 0, max 1 |
heatmap | boolean | true | — |
Response
| Status | Body | When |
|---|---|---|
201 | png, json | The run finished within 60 seconds |
202 | Job summary JSON | Still running; poll the job |
4xx, 5xx | Error JSON | See error codes |
A file response carries X-Sada-Job and X-Sada-Expires-At. For long work, post to /v1/tools/compare-images/jobs instead. See jobs and webhooks.
Also runs on the device
In the web tool and apps, Compare Images can run locally with no upload. The API always processes on the server.
Try it yourself!
Pick a file, set the options and run a real request with your key. The code follows your changes.