Link Search Menu Expand Document

PDF Text Search from URL Asynchronously - PowerShell

PDF Search Text sample in PowerShell demonstrating ‘PDF Text Search from URL Asynchronously’

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

# Direct URL of PDF file to get information
$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 = ""

# Search string. 
$SearchString = '\d{1,}\.\d\d' #Regular expression to find numbers like '100.00'

# Enable regular expressions (Regex) 
$RegexSearch = 'True'

# (!) Make asynchronous job
$Async = $true

# Prepare URL for PDF text search API call.
# See documentation:
$query = ""

# Prepare request body (will be auto-converted to JSON by Invoke-RestMethod)
# See documentation:
$body = @{
    "password" = $Password
    "pages" = $Pages
    "url" = $SourceFileURL
    "searchString" = $SearchString
    "regexSearch" = $RegexSearch
    "async" = $Async
} | ConvertTo-Json

try {
    # Execute request
    $response = Invoke-WebRequest -Method Post -Headers @{ "x-api-key" = $API_KEY; "Content-Type" = "application/json" } -Body $body -Uri $query

    $jsonResponse = $response.Content | ConvertFrom-Json

    if ($jsonResponse.error -eq $false) {
        # Asynchronous job ID
        $jobId = $jsonResponse.jobId

        # URL of generated JSON file with search result that will available after the job completion
        $resultFileUrl = $jsonResponse.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.
        do {
            $statusCheckUrl = "" + $jobId
            $jsonStatus = Invoke-RestMethod -Method Get -Headers @{ "x-api-key" = $API_KEY } -Uri $statusCheckUrl

            # Display timestamp and status (for demo purposes)
            Write-Host "$(Get-date): $($jsonStatus.status)"

            if ($jsonStatus.status -eq "success") {
                # Get JSON for search result
                $jsonSearchResult = Invoke-RestMethod -Method Get -Headers @{ "x-api-key" = $API_KEY } -Uri $resultFileUrl
                # Display found result in console
                foreach ($item in $jsonSearchResult)
                    Write-Host "Found text $($item.text) at coordinates $($item.left), $($"
            elseif ($jsonStatus.status -eq "working") {
                # Pause for a few seconds
                Start-Sleep -Seconds 3
            else {
                Write-Host $jsonStatus.status
        while ($true)
    else {
        # Display service reported error
        Write-Host $jsonResponse.message
catch {
    # Display request error
    Write-Host $_.Exception
@echo off

powershell -NoProfile -ExecutionPolicy Bypass -Command "& .\PDFTextSearchFromUrlAsynchronously.ps1"
echo Script finished with errorlevel=%errorlevel%

pause 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 Text endpoint