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 |
|
|
bleed_mm
Type: number Minimum: False Maximum: 20 |
Bleed in millimeters added on every side of every page. The content keeps its size and position, the TrimBox records where to cut, and the page edges are mirrored into the bleed so that no white strip shows after trimming. A page that already has enough bleed of its own beyond its TrimBox keeps it. Defaults to 0, or to the bleed of printer_preset. |
|
color_profile
Type: string Enum: gracol2006 fogra39 |
The printing condition the colours are prepared for, every colour is converted to CMYK with its output profile. gracol2006 is Coated GRACoL 2006 (ISO 12647-2:2004, CGATS TR 006, commercial printing in North America), fogra39 is Coated FOGRA39 (ISO 12647-2:2004, coated paper in Europe). Defaults to gracol2006, or to the profile of printer_preset. |
|
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. |
|
pdfx_standard
Type: string Enum: pdfx1a pdfx3 pdfx4 |
The PDF/X standard of the print-ready file. pdfx1a (PDF/X-1a:2001) and pdfx3 (PDF/X-3:2002) do not allow transparency, so the pages using it are flattened into images; pdfx4 (PDF/X-4) keeps it. Defaults to pdfx4, or to the standard of printer_preset. |
|
printer_preset
Type: string Enum: gelato |
Ready-made settings of a print service. gelato is PDF/X-4, gracol2006 and 4 mm of bleed. pdfx_standard, color_profile and bleed_mm still override it, e.g. 3 mm of bleed for Gelato photobooks. |
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": "convert-pdfx",
"options": {
<conversion options here>
}
}]
}