extract-design-images

• Last updated on May 27, 2025
• •
• 1 minute to read

This command is used to extract images from a design and place them in the artifact storage. Images are extracted from design elements of the type image-item. Each image-item can store multiple image variants, which are determined by the image-source parameter:

• Unconverted: The original image in its native format, often inconvenient for processing (e.g., EPS). This is optional and is set by a specialized method.
• Original: The original image converted into a convenient format for interaction.
• Current: The image with applied effects.

Parameters

• imageSources: Limits the extracted image variants based on the image-source. Possible values: All | PreferUnconverted | Unconverted | Current.
• takeUploadedByUserOnly: Limits the extracted images based on the 'Uploaded by User' attribute. Valid values: true | false.
• takeFromPlaceholdersOnly: Limits the extracted images based on whether the image is placed in a placeholder or not. Valid values: (true | false).
• outputArchiveType: If specified, the rendering result will be packed into an archive. Possible values: Zip | SevenZip. Default: Not specified.
• outputArchiveCompressionType: Supported compression types: None | Copy | Default | Deflate | Deflate64 | Lzma | Lzma2. Default: Default.

All parameter values support argument interpolation following the common rules.

Example

This is how you can extract original images in their native format as an archive.

{
  "description": "Extract original images",
  "name": "extract",
  "type": "extract-design-images",
  "inputArtifacts": [
    "design"
  ],
  "parameters": {
    "imageSources": "Unconverted",
    "takeUploadedByUserOnly": "true",
    "outputArchiveType": "Zip",
    "outputArchiveCompressionType": "Lzma"
  },
  "outputArtifacts": [
    "original-images"
  ]
}