Convert any file using COMPARE-IMAGE

API for converting any file using COMPARE-IMAGE.

Here are all available conversion options you can use in the "options" section of conversions (see the example JSON below the table).

Here are all available conversion options you can use in the "options" section of conversions (see the example JSON on the right).

Option Name	Description
allow_multiple_outputs Type: boolean Default: False	If the conversion produces more than one output file, by default all of them are compressed in just one file. Set this option to true if you want a download link for each file.
allow_multiple_outputs_threshold Type: integer Minimum: 2 Maximum: 400
diff_color Type: string Enum: red green blue yellow orange violet black white	The color to use to show the pixels that are different in the diff image
download_password Type: string Pattern: ^[ -~]{0,1000}$ Example: secret_password	A password to protect the download. To download the file send the password in the x-api2convert-download-password header or set a cookie named x-api2convert-download-password (the legacy x-oc-download-password header and cookie are still accepted). The value contains a comma separated list of passwords.
method Type: string Enum: ae butteraugli lpips mae ncc pdc psnr rmse ssim	The algorithm to use for image comparison. Two values deserve a special mention. "ae" does not return a pixel count: for each color channel it accumulates, over every pixel exceeding the threshold, how far apart the two images are in that channel, so the higher the value the more strongly the images differ; its "all" entry is the average of the red, green and blue values. "pdc" is the one reporting how many pixels are considered different according to the threshold option: it gives the count per color channel, and its "all" entry counts the pixels that differ in at least one channel.
threshold Type: number Minimum: False Maximum: 100	Sets the threshold in percentage over which color is to be considered different between the two images. A zero means that the pixels have to be identical to be considered equal.

Output Example

POST /v2/jobs HTTP/1.1
Host: https://api.api2convert.com
X-Api2convert-Api-Key: <your API key here>
Content-Type: application/json
{
    "input": [{
        "type": "remote",
        "source": "https://example-files.online-convert.com/raster%20image/png/example_small.png"
    }],
    "conversion": [{
        "category": "operation",
        "target": "compare-image",
        "options": {
            <conversion options here>
        }
    }]
}