Link Search Menu Expand Document

Replace Text From URL Asynchronously - Python

PDF Search and Replace Text sample in Python demonstrating ‘Replace Text From URL Asynchronously’
""" Cloud API asynchronous "PDF To Text" job example.
    Allows to avoid timeout errors when processing huge or scanned PDF documents.
import os
import requests # pip install requests
import time
import datetime

# 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 = ""
# PDF document password. Leave empty for unprotected documents.
Password = ""
# Destination PDF file name
DestinationFile = ".\\result.pdf"
# (!) Make asynchronous job
Async = True

def main(args = None):
    replaceStringFromPdf(SourceFileURL, DestinationFile)

def replaceStringFromPdf(uploadedFileUrl, destinationFile):
    """Replace Text from PDF using Web API"""

    # Prepare requests params as JSON
    # See documentation:
    parameters = {}
    parameters["async"] = Async
    parameters["name"] = os.path.basename(destinationFile)
    parameters["password"] = Password
    parameters["url"] = uploadedFileUrl
    parameters["searchString"] = "Your Company Name"
    parameters["replaceString"] = "XYZ LLC"

    # Prepare URL for 'Replace Text from PDF' API request
    url = "{}/pdf/edit/replace-text".format(BASE_URL)

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

        if json["error"] == False:
            # Asynchronous job ID
            jobId = json["jobId"]
            #  URL of the result file
            resultFileUrl = json["url"]
            # Check the job status in a loop. 
            # If you don't want to pause the main thread you can rework the code 
            # to use a separate thread for the status checking and completion.
            while True:
                status = checkJobStatus(jobId) # Possible statuses: "working", "failed", "aborted", "success".
                # Display timestamp and status (for demo purposes)
                print("%H:%M.%S") + ": " + status)
                if status == "success":
                    # 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}")
                elif status == "working":
                    # Pause for a few seconds
            # Show service reported error
        print(f"Request error: {response.status_code} {response.reason}")

def checkJobStatus(jobId):
    """Checks server job status"""

    url = f"{BASE_URL}/job/check?jobid={jobId}"
    response = requests.get(url, headers={ "x-api-key": API_KEY })
    if (response.status_code == 200):
        json = response.json()
        return json["status"]
        print(f"Request error: {response.status_code} {response.reason}")

    return None

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 Search and Replace Text endpoint