Convert any file using POSTER-TILING

API for converting any file using POSTER-TILING.

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
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.
poster_background_color Type: string Pattern: ^#([0-9a-fA-F]{3}\|[0-9a-fA-F]{6})$ Default: #FFFFFF	Hex colour printed around the image where it does not fill the sheets, and behind transparent areas.
poster_dpi Type: integer Minimum: True Maximum: 600 Default: 150	Print resolution of the poster in dots per inch. With the by_dpi sizing mode it also sets the physical size of the poster (width in mm = width in pixels / dpi x 25.4); a PDF or SVG keeps its own physical size.
poster_fit_mode Type: string Enum: contain cover fill Default: contain	How the image fills the poster. contain keeps the whole image and fills the free space with poster_background_color, cover fills the poster and crops what is left over, fill stretches the image to the poster.
poster_grid_cols Type: integer Minimum: True Maximum: 20	Number of sheet columns of the poster. Required with the by_grid sizing mode. poster_grid_cols x poster_grid_rows must not exceed 100 sheets, e.g. 20x5 is accepted but 20x20 is not.
poster_grid_rows Type: integer Minimum: True Maximum: 20	Number of sheet rows of the poster. Required with the by_grid sizing mode. poster_grid_cols x poster_grid_rows must not exceed 100 sheets, e.g. 20x5 is accepted but 20x20 is not.
poster_guides Type: boolean Default: False	Print assembly guides on every sheet - corner marks, the outer trim line, the outline of the overlap strips and the position of the sheet in the poster.
poster_orientation Type: string Enum: auto portrait landscape Default: auto	Orientation of the sheets. auto picks the orientation that needs fewer sheets, or that prints the bigger image when both need the same number of sheets.
poster_overlap_mm Type: number Minimum: False Maximum: 100 Default: 12	Strip in millimeters printed on both neighbouring sheets along the inner seams, to line them up when gluing. The outer edges of the poster get no overlap. It must be bigger than poster_printable_margin_mm, otherwise it is raised to twice the margin; 0 disables it.
poster_page_size Type: string Pattern: ^(a3\|a4\|letter\|legal\|\d+(\.\d+)?x\d+(\.\d+)?)$ Default: a4	Size of the sheets the poster is printed on. Either a3, a4, letter, legal or a custom size in millimeters written as two sides, e.g. 210x297 (each side between 50 and 1500 mm). The order of the two sides does not matter, poster_orientation turns the sheets.
poster_printable_margin_mm Type: number Minimum: False Maximum: 50 Default: 5	Margin in millimeters, on all four edges of every sheet, that the printer cannot print on. The poster is only placed inside the remaining printable area, the margin stays white and can be trimmed.
poster_sizing_mode Type: string Enum: by_dpi by_grid by_size Default: by_dpi	How the size of the poster is chosen. by_dpi prints the image at poster_dpi, by_grid scales it over poster_grid_cols x poster_grid_rows sheets, by_size scales it to poster_target_width_mm and/or poster_target_height_mm. A poster can use at most 100 sheets.
poster_target_height_mm Type: number Minimum: True Maximum: 30000	Height of the poster in millimeters with the by_size sizing mode. When only the width or only the height is given, the other one follows the aspect ratio of the image.
poster_target_width_mm Type: number Minimum: True Maximum: 30000	Width of the poster in millimeters with the by_size sizing mode. When only the width or only the height is given, the other one follows the aspect ratio of the image.

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": "poster-tiling",
        "options": {
            <conversion options here>
        }
    }]
}