Link Search Menu Expand Document

Add Text to Existing PDF - Python

PDF Add Text, Signatures and Images to PDF sample in Python demonstrating ‘Add Text to Existing PDF’
import os
import requests # pip install requests

# Visit Knowledgebase for adding Text Macros to PDF 

# The authentication key (API Key).
# Get your own by registering at
API_KEY = "******************************************"

# Base URL for Web API requests

# Direct URL of source PDF file.
# You can also upload your own file into and use it as url. Check "Upload File" samples for code snippets:    
SourceFileUrl = ""

#Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'.
Pages = ""

# PDF document password. Leave empty for unprotected documents.
Password = ""

# Destination PDF file name
DestinationFile = ".//result.pdf"

# Text annotation params
Type = "annotation"
X = 400
Y = 600
FontName = "Times New Roman"
FontSize = 24
Color = "FF0000"

def main(args = None):

def addTextToExistingPDF(destinationFile):
    import json
    """Add Text using Web API"""

    # Prepare requests params as JSON
    # See documentation:
    payload = json.dumps({
        "name": os.path.basename(destinationFile),
        "password": Password,
        "url": SourceFileUrl,
        "annotations": [{
            "text": Text,
            "x": X,
            "y": Y,
            "fontname": FontName,
            "size": FontSize,
            "color": Color,
            "pages": Pages

    # Prepare URL for 'PDF Edit' API request
    url = "{}/pdf/edit/add".format(BASE_URL)

    # Execute request and get response as JSON
    response =, data=payload, headers={ "x-api-key": API_KEY })
    if (response.status_code == 200):
        json = response.json()

        if json["error"] == False:
            #  Get URL of result file
            resultFileUrl = json["url"]            
            # Download result file
            r = requests.get(resultFileUrl, stream=True)
            if (r.status_code == 200):
                with open(destinationFile, 'wb') as file:
                    for chunk in r:
                print(f"Result file saved as \"{destinationFile}\" file.")
                print(f"Request error: {response.status_code} {response.reason}")
            # Show service reported error
        print(f"Request error: {response.status_code} {response.reason}")

if __name__ == '__main__':
    main() Web API: the Web API with a set of tools for documents manipulation, data conversion, data extraction, splitting and merging of documents. Includes image recognition, built-in OCR, barcode generation and barcode decoders to decode bar codes from scans, pictures and pdf.

Get your API key here!

Download Source Code (.zip)

return to the previous page explore PDF Add Text, Signatures and Images to PDF endpoint