Add to PDF

The file parameter allows you to select a local PDF file to be uploaded to pdfRest’s processing server. Use file to upload a PDF that you would like to insert an image into.

The id parameter allows you to submit a resource ID generated by one of our API Tools. Each of our API Tools assigns a unique resource ID to your output file(s), allowing you to chain requests together without having to download intermediate files between requests.

For example, you can submit the output ID you receive from our Convert to PDF tool to insert an image file into your new PDF.

Compatible with the /pdf-with-added-image endpoint.

The image_file parameter allows you to select a local image to be uploaded to pdfRest’s processing server.

The following file formats are accepted:

• .gif
• .jpg/.jpeg
• .png
• .tif/.tiff

Compatible with the /pdf-with-added-image endpoint.

The image_id parameter allows you to submit a resource ID generated by one of our API Tools. Each of our API Tools assigns a unique resource ID to your file(s), allowing you to chain requests together without having to download intermediate files between requests.

For example, you can submit the output ID you receive from the /jpg endpoint of our PDF to Images tool to insert the generated image into an input PDF file.

The following file formats are accepted:

• .gif
• .jpg/.jpeg
• .png
• .tif/.tiff

The output parameter lets you set a filename (without extension) for your resulting PDF.

The x parameter lets you set the horizontal position of the image in PDF units (1 PDF unit = 1/72 inch).

By default, the origin of the PDF coordinate system is in the lower-left corner of the document, so the x parameter indicates the position relative to the left edge of the page. If the PDF has an offset origin, this can affect the position at which the image will be inserted.

The y parameter lets you set the vertical position of the image in PDF units (1 PDF unit = 1/72 inch).

By default, the origin of the PDF coordinate system is in the lower-left corner of the document, so the y parameter indicates the position relative to the bottom edge of the page. If the PDF has an offset origin, this can affect the position at which the image will be inserted.

The page parameter lets you set the page of the input PDF into which the image will be inserted. Specify a page number within the number of pages in the input PDF.

Compatible with the /pdf-with-added-attachment endpoint.

The file_to_attach parameter lets you upload a file to pdfRest's processing server to attach to an input PDF. Select any kind of file to add to PDF.

Compatible with the /pdf-with-added-attachment endpoint.

The id_to_attach parameter allows you to submit a resource ID generated by one of our API Tools. Each of our API Tools assigns a unique resource ID to your output file(s), allowing you to chain requests together without having to download intermediate files between requests.

id_to_attach also lets you attach a file that was uploaded previously to an input PDF document.

text_objects is a JSON-formatted string consisting of an array of one or more objects containing options to add and format text.

Text Object options:

• font: (string) specify the font of the given string. See available fonts here: pdfRest Documentation | Fonts
• max_width: (string) the maximum width of the text column in PDF Units (72 PDF Units = 1 inch). The text will wrap to conform to this width.
• opacity: (string) text opacity (0.0 - 1.0)
• page: (string) page number on which to add text. You can provide a page number, or you can use “all” to add the text to every page at the same X/Y position.
• rotation: (string) rotation in degrees of the text block
• text: (string) the string of text to add
• text_color_cmyk or text_color_rgb: (string) comma-delineated string of color values (RGB example: “53,5,102", CMYK example: “0,100,100,0”). Use one of these to set the text color.
• text_size: (string) font size of the text (5 - 100)
• x: (string) horizontal starting position of the text in PDF Units (72 PDF Units = 1 inch)
• y: (string) vertical starting position of the text in PDF Units (72 PDF Units = 1 inch)
• is_rtl: (string) Set to "true" to insert right-to-left (RTL) language text

Example:

[
   {
      "font":"Arial",
      "max_width":"100",
      "opacity":"1",
      "page":"all",
      "rotation":"80",
      "text":"Hello, PDF world!",
      "text_color_rgb":"0,0,0",
      "text_size":"12",
      "x":"144",
      "y":"144"
   },
   {
      "font":"Times New Roman",
      "max_width":"100",
      "opacity":"1",
      "page":"all",
      "rotation":"0",
      "text":"More text to add!",
      "text_color_rgb":"128,0,2",
      "text_size":"72",
      "x":"144",
      "y":"720"
   }
]