Skip to main content

Export for Print (Asset)

GET 
/api/v1/assets/:asset_id/addons/print_export

Produce a print-ready CMYK file from an existing asset by asset ID. The original file for the given asset is downloaded and converted locally (RGB→CMYK at the requested DPI, default 300) using the selected ICC profile.

Behaviour and response type are controlled by the mode and disposition query parameters; the output format is controlled by format.

Mode​

ValueMeaning
get_imageReturn the print file only. No save. disposition is ignored.
save_imageSave the result only. Response is JSON. Requires disposition.
get_image_and_saveReturn the print file and also save it. Requires disposition.

Disposition​

ValueMeaning
add_conversionSave the result as a named conversion on the asset identified by {asset_id}. conversion_name controls the conversion key (default print_ready).
add_new_assetSave the result as a new asset. Optional: metadata=inherit to copy source asset custom data and set lineage.
ParameterMeaning
formatOutput format: tiff (CMYK, LZW, lossless — default), jpeg (CMYK), pdf (print PDF), pdfx (PDF/X-1a).
cmyk_profileCMYK ICC output profile, e.g. USWebCoatedSWOP (default), CoatedFOGRA39, JapanColor2001Coated.
rendering_intentperceptual, relative_colorimetric (default), saturation, absolute_colorimetric.
dpiPrint resolution stamped into the file, 72–1200 (default 300).
target_sizeOptional target print size — a preset (A6,A5,A4,A3,A2,letter,legal,tabloid) or a custom spec { "unit": "cm"|"in"|"px", "width": W, "height": H }. Omit for native resolution.
allow_upscaleWhen true, allows an AI upscale (charged in AI credits) if the source is smaller than target_size requires at the chosen DPI. When false (default), an under-sized source returns 400.

Validation Rules​

  • If mode is save_image or get_image_and_save, disposition is required.
  • If disposition is add_conversion, conversion_name must match ^[a-zA-Z0-9_-]{1,30}$.
  • metadata is only allowed when disposition is add_new_asset. Allowed value: inherit.

Response​

  • mode = get_image (default) or get_image_and_save: the print file in the body. Content-Type is image/tiff, image/jpeg, or application/pdf depending on format.
  • mode = save_image on a stored asset: heavy CMYK output is produced asynchronously — the API responds 202 with { "job_id": "<id>", "status": "QUEUED" }. Poll GET /api/v1/jobs/{job_id} for completion. On completion the job result mirrors the save response below.

Billing: each successful export counts against your plan's Print Export quota. Using allow_upscale additionally consumes AI credits when an upscale is performed.

Request​

Responses​

Successful operation. For get_image/get_image_and_save, the print file bytes with the format's Content-Type.