Add to PDF

Add to PDF is a REST API tool designed to enhance your PDFs by inserting new content, including text, images, and file attachments. By using Add to PDF, developers can seamlessly integrate additional elements into PDFs, ensuring precision and flexibility without altering the existing content.

Automate content enhancement workflows, eliminating the need for manual editing in Acrobat, Illustrator, or other software.
Place images with precision, ensuring they complement the existing PDF layout without disrupting underlying content.
Attach any file format to a PDF, providing additional context or resources directly within the document.
Leverage advanced positioning features to tailor content placement to specific requirements.
Customize text insertion for both LTR and RTL languages with font, size, color, rotation, line width, and more.
Support variable data printing by dynamically inserting personalized text, such as customer names and addresses.

A bubbling flask with code brackets inside

Try Now with API Lab

Start right from your browser - upload files, choose parameters, generate code, and send API Calls directly from API Lab!

to receive your free API Key.

Parameters

Api-Key

Required Parameters

POST

curl -X POST "https://api.pdfrest.com/pdf-with-added-image" \ 
  -H "Accept: application/json" \ 
  -H "Content-Type: multipart/form-data" \
  -H "Api-Key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" \
  curl -X POST "https://api.pdfrest.com/pdf-with-added-image" \ 
  -H "Accept: application/json" \ 
  -H "Content-Type: multipart/form-data" \
  -H "Api-Key: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx" \
  

Response

The response for your API Call will display here.The response for your API Call will display here.

Once you've sent your POST request and received a valid response, you can download your output file using the output URL.

Build Your Solution

You have document processing problems, we have Solutions. Explore the many ways pdfRest can align your documents with your business objectives.

Browse all Solutions

Integrate pdfRest with Microsoft Power Automate

Add Generated Barcodes to PDF Forms

Create an e-Invoicing PDF Workflow for Regulatory Compliance

Integrate PDF API Tools with Salesforce Apex Code

Control your Backend with pdfRest API Toolkit Self-Hosted

Why is pdfRest the best API to add text, images, or attachments to PDF?

pdfRest offers the best solution for adding text, images, or attachments to PDF documents, because it supports precise image positioning, robust variable data printing, and flexible file attachments.

Add Image to PDF with Precise Positioning

The Add to PDF API Tool, accessible via the /pdf-with-added-image endpoint, simplifies the process of adding images to a PDF, allowing you to place them exactly where you need them.

Whether you're adding logos, diagrams, or photographs, the Add to PDF API Tool supports a wide range of the most common graphic image formats, ensuring high-quality preservation of color accuracy and resolution. This versatility allows you to maintain the visual integrity of your images, regardless of the format:

JPEG (.jpg, .jpeg): Ideal for photographs and images with complex color gradients.
TIF (.tif, .tiff): Perfect for high-resolution images that require lossless compression.
PNG (.png): Suitable for images with transparency and sharp edges, such as logos and icons.
GIF (.gif): Best for simple graphics and images with limited color palettes.

By leveraging the Add to PDF API Tool, you can seamlessly integrate images into your PDFs, enhancing the document's visual appeal and functionality. Whether you're preparing marketing materials, technical documents, or personalized content, this tool provides the flexibility and precision needed to achieve professional results.

Add Text to PDF for Variable Data Printing

Effortlessly create custom PDFs tailored for each customer, user, or recipient with precision and ease. Automate and streamline your workflow by adding variable data to template PDFs with the /pdf-with-added-text and /pdf-with-added-image endpoints, including personalized logos, photos, and user information. The Add to PDF tool allows you to "stamp" content exactly where you need it, without altering the underlying content of the PDF.

With the ability to customize text insertion—choosing font, size, color, rotation, opacity, position, page, and line width—you can ensure that every document meets your specific requirements. This flexibility supports both LTR and RTL languages, making it ideal for multilingual applications.

Whether you need to add your customers' business logos to their invoices, addresses onto envelopes, or personalized messages and branding elements to marketing materials, the Add to PDF API Tool simplifies the process. It supports variable data printing, allowing you to dynamically insert personalized text, such as customer names or addresses, ensuring each document is uniquely tailored to its recipient.

Attach File to PDF for e-Invoicing Compliance

With the Add to PDF API Tool, you can use the /pdf-with-added-attachment endpoint to effortlessly add any file as an attachment to a PDF. This capability is invaluable for a variety of reasons, such as providing supplementary information, facilitating collaboration, and preserving backups.

Attaching files to PDFs is particularly crucial in meeting the requirements of various e-invoicing standards worldwide. For instance, ZUGFeRD is a German standard for e-invoicing that relies on the PDF/A-3 format with attached XML files. Similarly, the Saudi Arabia FATOORAH standard also mandates XML files to be attached to PDF/A-3 documents.

By using the Add to PDF API Tool, you can ensure compliance with these standards and streamline your document workflows. Whether you're attaching XML files for e-invoicing or adding supplementary documents for enhanced collaboration, this tool provides a seamless solution for integrating additional content into your PDFs.

Check out other videos

Start from Code Examples

First, you'll need an API Key - to:
- Stay anonymous with a Guest API Key for 10 free API Calls
- Sign up for an upgraded API Key with unlimited, continuous service
Choose your programming language
Copy and paste the code to your project
Update Api-Key field with your unique API Key
Update file with the local path to your input
Run this code to send an API Call

See more code examples in our
GitHub repository

Try pdfRest with just a few clicks
Download our Postman Collection

Need more help?

Start with a Tutorial for step-by-step guidance

How to Add Attachments to PDF Files in .NET with C#

How to Add Attachments to PDF Files with JavaScript in NodeJS

How to Add Attachments to PDF Files with PHP

How to Add Attachments to PDF Files with Python

How to Add Images to PDF Files in .NET with C#

How to Add Images to PDF Files with Java

How to Add Images to PDF Files with JavaScript in NodeJS

How to Add Images to PDF Files with PHP

How to Add Images to PDF Files with Python

1 of 2 pages (10 items)

Customize Your Solution

File

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.

Image File

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

Image Id

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

Output

The output parameter lets you set a filename (without extension) for your compressed 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.

Page

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.

File to Attach

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.

Id to Attach

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

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 | Required | Specify the font of the given string. See Font List for a complete list.
max_width - String | Required | 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 | Required | Text opacity (0.0 - 1.0)
page - String | Required | 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 | Required | Rotation in degrees of the text block
text - String | Required | String of text to add
text_color_cmyk or text_color_rgb - String | Required | 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 | Required | Font size of the text (5 - 100)
x - String | Required | Horizontal starting position of the text in PDF Units (72 PDF Units = 1 inch)
y - String | Required | Vertical starting position of the text in PDF Units (72 PDF Units = 1 inch)
is_rtl - String | Optional | 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":"שלום עולם",
      "text_color_rgb":"128,0,2",
      "text_size":"72",
      "x":"144",
      "y":"720",
      "is_rtl":"true"
   }
]

See Documentation

Generate a self-service API Key now!

Create your FREE API Key to start processing PDFs in seconds, only possible with pdfRest.

Compare Plans