ByteScout Cloud API Server – PDF Make Searchable API – PowerShell – Advanced Conversion Options

Home
/
Articles
/
ByteScout Cloud API Server – PDF Make Searchable API – PowerShell – Advanced Conversion Options

printable version:
ByteScout-Cloud-API-Server-PowerShell-Advanced-Conversion-Options.pdf

How to PDF make searchable API for advanced conversion options in PowerShell with ByteScout Cloud API Server

Learn in simple ways: How to PDF make searchable API for advanced conversion options in PowerShell

Writing of the code to PDF make searchable API in PowerShell can be done by developers of any level using ByteScout Cloud API Server. ByteScout Cloud API Server helps with advanced conversion options in PowerShell. ByteScout Cloud API Server is API server that is ready to use and can be installed and deployed in less than 30 minutes on your own Windows server or server in a cloud. It can save data and files on your local server-based file storage or in Amazon AWS S3 storage. Data is processed solely on the API server and is powered by ByteScout engine, no cloud services or Internet connection is required for data processing..

Use the code displayed below in your application to save a lot of time on writing and testing code. For implementation of this functionality, please copy and paste the code below into your app using code editor. Then compile and run your app. Use of ByteScout Cloud API Server in PowerShell is also described in the documentation given along with the product.

Free! Free! Free! ByteScout free trial version is available for FREE download from our website. Programming tutorials along with source code samples are assembled.

On-demand (REST Web API) version:
Web API (on-demand version)

On-premise offline SDK for Windows:
60 Day Free Trial (on-premise)

MakeSearchablePdfFromUrlAsynchronously.ps1

      # Please NOTE: In this sample we're assuming Cloud Api Server is hosted at "https://localhost". 
# If it's not then please replace this with with your hosting url.

# Cloud API asynchronous "Make Searchable PDF" job example.
# Allows to avoid timeout errors when processing huge or scanned PDF documents.

# Direct URL of source PDF file.
$SourceFileURL = "https://bytescout-com.s3.amazonaws.com/files/demo-files/cloud-api/pdf-make-searchable/sample.pdf"
# 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 = ""
# OCR language. "eng", "fra", "deu", "spa"  supported currently. Let us know if you need more.
$Language = "eng"
# Destination PDF file name
$DestinationFile = ".\result.pdf"
# (!) Make asynchronous job
$Async = $true

# Sample profile that sets advanced conversion options
# Advanced options are properties of SearchablePDFMaker class from ByteScout PDF Extractor SDK used in the back-end:
# https://cdn.bytescout.com/help/BytescoutPDFExtractorSDK/html/5dee0c85-e13d-b93b-ab0f-d4b42ef60756.htm
$Profiles = '{ "profiles": [ { "profile1": { "OCRLanguage": "eng", "OCRResolution":  300 } } ] }'

# Prepare URL for `Make Searchable PDF` API call
$query = "https://localhost/pdf/makesearchable?name={0}&password={1}&pages={2}&lang={3}&url={4}&async={5}&profiles={6}" -f `
    $(Split-Path $DestinationFile -Leaf), $Password, $Pages, $Language, $SourceFileURL, $Async, $Profiles
$query = [System.Uri]::EscapeUriString($query)

try {
    # Execute request
    $jsonResponse = Invoke-RestMethod -Method Get  -Uri $query

    if ($jsonResponse.error -eq $false) {
        # Asynchronous job ID
        $jobId = $jsonResponse.jobId
        # URL of generated PDF file that will available after the job completion
        $resultFileUrl = $jsonResponse.url

        # Check the job status in a loop. 
        do {
            $statusCheckUrl = "https://localhost/job/check?jobid=" + $jobId
            $jsonStatus = Invoke-RestMethod -Method Get  -Uri $statusCheckUrl

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

            if ($jsonStatus.status -eq "success") {
                # Download PDF file
                Invoke-WebRequest  -OutFile $DestinationFile -Uri $resultFileUrl
                Write-Host "Generated PDF file saved as `"$($DestinationFile)`" file."
                break
            }
            elseif ($jsonStatus.status -eq "working") {
                # Pause for a few seconds
                Start-Sleep -Seconds 3
            }
            else {
                Write-Host $jsonStatus.status
                break
            }
        }
        while ($true)
    }
    else {
        # Display service reported error
        Write-Host $jsonResponse.message
    }
}
catch {
    # Display request error
    Write-Host $_.Exception
}

ON-PREMISE OFFLINE SDK

60 Day Free Trial or Visit ByteScout Cloud API Server Home Page

Explore ByteScout Cloud API Server Documentation

Explore Samples

Sign Up for ByteScout Cloud API Server Online Training

ON-DEMAND REST WEB API

Get Your API Key

Explore Web API Docs

Explore Web API Samples

run.bat

      @echo off

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

pause