Convert anything using COMPRESS


The API for converting any file using COMPRESS.

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

Here you can see all available conversion options which you can use within 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
compression_level
Type: string
Enum: low medium high best
If set, this option tries to compress your file with no perceivable loss of quality
compression_target
Type: string
Enum: gif jpg png
Sets the target format if it's different from the input's file format
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-oc-download-password header or set a cookie named x-oc-download-password. The value contains a comma separated list of passwords.
file_size
Type: integer
Minimum: False
Maximum: 65536
Limit the target size of the image you want to compress to this size in Kilobytes (KiB). We try to do our best to achieve this limit as close as possible.

Output Example

POST /v2/jobs HTTP/1.1
Host: https://api.api2convert.com
X-Oc-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": "compress",
        "options": {
            <conversion options here>
        }
    }]
}