PDF Tools

Extract Images from a PDF

Extracts images from PDF files. Useful for media reuse, evidence collection, and document asset processing.

# Uses

Use this task for extracting images from a PDF file.

# Basic Usage

# Parameters Explained

# files

required

array

An array of PDF files from which to extract images.

# format

required

string

The output format of the images. Available options are: png, jpeg, gif

# allow_duplicates

optional

boolean

Identical images that appear multiple times in the PDF are always extracted only once, so this setting has no effect.

# function

required

string

The pdf_tools function to call, in this case it would be extract_images

# Result

If the PDF contains no images, the task still succeeds and files is empty.

The newly created files are returned in files. The same files are returned in attachments, which adds them to the stub's attachments.

        {
  "extract_images_from_pdf": {
    "success": true,
    "payload": {
      "files": [
        {
          "fileuuid": "8142ce6c-f3cd-526c-a5d3-747799ed2b01",
          "filename": "report_page_1_1.png",
          "originalname": "report_page_1_1.png",
          "contentType": "image/png",
          "visibility": "private"
        },
        {
          "fileuuid": "8142ce6c-f3cd-526c-a5d3-747799ed2b02",
          "filename": "report_page_3_1.png",
          "originalname": "report_page_3_1.png",
          "contentType": "image/png",
          "visibility": "private"
        }
      ],
      "attachments": [...]
    }
  }
}