IronFlowDocs

pdf_merge

Merge multiple PDF files into a single PDF document.

Parameters

filesarrayrequired
Array of file paths to merge; supports ${ctx.key} interpolation on each entry.
output_pathstringrequired
File path for the merged output PDF; supports ${ctx.key} interpolation.
output_keystringdefault "pdf_merge"
Context key prefix for output values.

Context Output

  • <output_key>_path (default pdf_merge_path) — path to the merged PDF file.
  • <output_key>_page_count (default pdf_merge_page_count) — total number of pages in the merged document.
  • <output_key>_success (default pdf_merge_success) — true on success.

Example

local flow = Flow.new("merge_pdfs")

flow:step("merge", nodes.pdf_merge({
    files = {
        "/data/report_part1.pdf",
        "/data/report_part2.pdf",
        "/data/report_part3.pdf"
    },
    output_path = "/data/full_report.pdf"
}))

flow:step("done", nodes.log({
    message = "Merged ${ctx.pdf_merge_page_count} pages into ${ctx.pdf_merge_path}"
})):depends_on("merge")

return flow

IronFlow documentation

Find the next step

Type a keyword to search the documentation.

to move · Enter to open · Esc to close