Add Images to PDF

Adds images to selected pages of a PDF and makes the modified PDF available for download.

Image Placement: Each item in image_files corresponds by position to an item in input_options. Provide at least one placement-options item for every uploaded image.

Endpoint

post https://www.zohoapis.com/pdfeditor/api/v1/pdf/addimages

Copy full URL

OAuth Scope

ZohoWriter.pdfEditor.ALLCopied!

curl --request POST \
  --url https://www.zohoapis.com/pdfeditor/api/v1/pdf/addimages \
  --header 'Authorization: Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52' \
  --header 'content-type: multipart/form-data' \
  -F 'file=@file_path' \
  -F 'image_files=approved-stamp.png' \
  -F 'input_options=[
  [
    {
      "page_ranges": "1,3-5",
      "image_rect": {
        "top": "48px",
        "left": "72px",
        "width": "160px",
        "height": "80px"
      },
      "odd_or_even_pages": "odd"
    }
  ]
]' \
  -F 'output_settings={
  "name": "Quarterly Review Approved.pdf"
}'

import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
import java.io.IOException;
import java.net.http.HttpTimeoutException;

public class Main {
  public static void main(String[] args) throws Exception{

    HttpRequest request = HttpRequest.newBuilder()
        .uri(URI.create("https://www.zohoapis.com/pdfeditor/api/v1/pdf/addimages"))
        .header("content-type", "multipart/form-data")
        .header("Authorization", "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52")
        .method("POST", HttpRequest.BodyPublishers.noBody())
        .build();
    HttpResponse response = HttpClient.newHttpClient().send(request, HttpResponse.BodyHandlers.ofString());
    System.out.println(response.body());
  
  }
}

import http.client

conn = http.client.HTTPSConnection("www.zohoapis.com")

headers = {
    'content-type': "multipart/form-data",
    'Authorization': "Zoho-oauthtoken d92d4xxxxxxxxxxxxx15f52"
    }

conn.request("POST", "/pdfeditor/api/v1/pdf/addimages", headers=headers)

res = conn.getresponse()
data = res.read()

print(data.decode("utf-8"))


    headersMap = Map();
    headersMap.put("Accept", "application/json");

    list_of_text=List();
    file=invokeurl
    [
      url : "public fileURL link"
      type : GET
    ];
    list_of_text.add({"paramName":"file","content":file,"stringPart":"false"});
    list_of_text.add({"paramName":"image_files","content":"approved-stamp.png","stringPart":"true"});
    list_of_text.add({"paramName":"input_options","content":"[object Object]","stringPart":"true"});
    list_of_text.add({"paramName":"output_settings","content":"[object Object]","stringPart":"true"});

    response = invokeUrl
    [
        url: "https://www.zohoapis.com/pdfeditor/api/v1/pdf/addimages"
        type: POST
        headers: headersMap
        files: list_of_text
        connection: connection_name
    ]

    info response;

Request Body

multipart/form-data

filebinary(Required)

The source PDF to modify, uploaded directly or imported from a publicly accessible URL. The file must be no larger than 50 MB, contain no more than 400 pages, and have no page larger than 2,400 square inches. Its filename must not exceed 255 characters. Supported formats: pdf.

Example

quarterly-review.pdf

image_filesarray[binary](Required)

The images to place in the PDF, uploaded directly or imported from publicly accessible URLs. Provide between 1 and 10 files, each no larger than 10 MB and with a filename not exceeding 255 characters. Supported formats: jpg, jpeg, png.

Example

[
  "approved-stamp.png"
]

Range :[1 .. 10]

input_optionsarray[array](Required)

The image-placement groups. Provide between 1 and 10 groups.

Example

[
  [
    {
      "page_ranges": "1,3-5",
      "image_rect": {
        "top": "48px",
        "left": "72px",
        "width": "160px",
        "height": "80px"
      },
      "odd_or_even_pages": "odd"
    }
  ]
]

Range :[1 .. 10]

output_settingsJSON Object(Required)

Configures the name of the modified PDF.

Example

{
  "name": "Quarterly Review Approved.pdf"
}

Show Sub-Attributes

namestring(Required)

The name to assign to the modified PDF. The .pdf extension is appended when it is omitted.

Example

Quarterly Review Approved.pdf

Maximum Length :255Copied!

// Note: payload contains multiple type attributes

// type: file
file = quarterly-review.pdf

// type: array[file]
image_files = [
  "approved-stamp.png"
]

// type: array
input_options = [
  [
    {
      "page_ranges": "1,3-5",
      "image_rect": {
        "top": "48px",
        "left": "72px",
        "width": "160px",
        "height": "80px"
      },
      "odd_or_even_pages": "odd"
    }
  ]
]

// type: object
output_settings = {
  "name": "Quarterly Review Approved.pdf"
}

▼ Show full

  {
    "status": "inprogress",
    "status_check_url": "https://www.zohoapis.com/pdfeditor/api/v1/pdf/addimages/job/qE8Vn4M2kP7sR9xW"
  }

▼ Show full

Rate Limits

Duration1 minute

Threshold50

Lock Period5 minutes 30 seconds

Duration1 hour

Threshold200

Lock Period15 minutes

Duration1 day

Threshold2000

Lock Period2 hours

Duration - Time window for the threshold.
Threshold - Number of API calls allowed within the specified duration.
Lock Period - Wait time before consecutive API requests.