PDF Search and Replace Text with Image

Search and replace text in PDF.

Available methods

• [POST] /pdf/edit/replace-text-with-image

[POST] /pdf/edit/replace-text-with-image

• url required. URL to the source file. Supports links from Google Drive, Dropbox and from built-in PDF.co files storage. For uploading files via API please check Files Upload section. If you are randomly getting Too Many Requests or Access Denied error for your input url, please try to add cache: to enable built-in url caching.
• searchString required for single text replacement. Word or phrase to be replaced. Must be a String.
• replaceImage required. Image url to be inserted in doc: http://www.xyz.com/image.png.
• caseSensitive optional. Set to false to use case-insensitive search.
• name optional. File name for generated output. Must be a String.
• password optional. Password of PDF file. Must be a String.
• pages optional. Comma-separated list of page indices (or ranges) to process. IMPORTANT: the very first page starts at 0 (zero). To set a range use the dash -, for example: 0,2-5,7-. To set a range from index to the last page use range like this: 2- (from page #3 as the index starts at zero and till the of the document). For ALL pages just leave this param empty. Example: 0,2-5,7- means first page, then 3rd page to 6th page, and then the range from 8th (index = 7) page till the end of the document. Must be a String.
• encrypt optional. Enable encryption for output file. Must be one of: true, false.
• async optional. Runs processing asynchronously. Returns Use JobId that you may use with /job/check to check state of the processing (possible states: working, failed, aborted and success). Must be one of: true, false.
• profiles optional. Must be a String. You can set additional and extra options using this parameter that allows you to set custom configuration. See profiles samples for examples.

Description

• Method: POST
• URL: /v1/pdf/edit/replace-text-with-image

Query parameters

No query parameters accepted.

Body payload

Example responses

/pdf/edit/replace-text-with-image

{
    "url": "https://pdf-temp-files.s3.amazonaws.com/0e8f486dbf8a4764a1468b3d7c222e4c/sample.pdf",
    "pageCount": 4,
    "error": false,
    "status": 200,
    "name": "sample.pdf",
    "remainingCredits": 59926
}

Code Snippets

CURL

curl --location --request POST 'https://api.pdf.co/v1/pdf/edit/replace-text-with-image' \
--header 'x-api-key: ' \
--form 'url="https://bytescout-com.s3-us-west-2.amazonaws.com/files/demo-files/cloud-api/pdf-to-text/sample.pdf"' \
--form 'caseSensitive="true"' \
--form 'searchString="Your Company Name"' \
--form 'replaceImage="https://bytescout-com.s3-us-west-2.amazonaws.com/files/demo-files/cloud-api/pdf-edit/logo.png"' \
--form 'pages="0"'

JavaScript

var myHeaders = new Headers();
myHeaders.append("x-api-key", "");

var formdata = new FormData();
formdata.append("url", "https://bytescout-com.s3-us-west-2.amazonaws.com/files/demo-files/cloud-api/pdf-to-text/sample.pdf");
formdata.append("caseSensitive", "true");
formdata.append("searchString", "Your Company Name");
formdata.append("replaceImage", "https://bytescout-com.s3-us-west-2.amazonaws.com/files/demo-files/cloud-api/pdf-edit/logo.png");
formdata.append("pages", "0");

var requestOptions = {
	method: 'POST',
	headers: myHeaders,
	body: formdata,
	redirect: 'follow'
};

fetch("https://api.pdf.co/v1/pdf/edit/replace-text-with-image", requestOptions)
	.then(response => response.text())
	.then(result => console.log(result))
	.catch(error => console.log('error', error));

NodeJs

var request = require('request');
var options = {
	'method': 'POST',
	'url': 'https://api.pdf.co/v1/pdf/edit/replace-text-with-image',
	'headers': {
		'x-api-key': ''
	},
	formData: {
		'url': 'https://bytescout-com.s3-us-west-2.amazonaws.com/files/demo-files/cloud-api/pdf-to-text/sample.pdf',
		'caseSensitive': 'true',
		'searchString': 'Your Company Name',
		'replaceImage': 'https://bytescout-com.s3-us-west-2.amazonaws.com/files/demo-files/cloud-api/pdf-edit/logo.png',
		'pages': '0'
	}
};
request(options, function (error, response) {
	if (error) throw new Error(error);
	console.log(response.body);
});

PHP

<?php

$curl = curl_init();

curl_setopt_array($curl, array(
	CURLOPT_URL => 'https://api.pdf.co/v1/pdf/edit/replace-text-with-image',
	CURLOPT_RETURNTRANSFER => true,
	CURLOPT_ENCODING => '',
	CURLOPT_MAXREDIRS => 10,
	CURLOPT_TIMEOUT => 0,
	CURLOPT_FOLLOWLOCATION => true,
	CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
	CURLOPT_CUSTOMREQUEST => 'POST',
	CURLOPT_POSTFIELDS => array('url' => 'https://bytescout-com.s3-us-west-2.amazonaws.com/files/demo-files/cloud-api/pdf-to-text/sample.pdf','caseSensitive' => 'true','searchString' => 'Your Company Name','replaceImage' => 'https://bytescout-com.s3-us-west-2.amazonaws.com/files/demo-files/cloud-api/pdf-edit/logo.png','pages' => '0'),
	CURLOPT_HTTPHEADER => array(
		'x-api-key: '
	),
));

$response = curl_exec($curl);

curl_close($curl);
echo $response;

Java

import java.io.*;
import okhttp3.*;
public class main {
	public static void main(String []args) throws IOException{
		OkHttpClient client = new OkHttpClient().newBuilder()
			.build();
		MediaType mediaType = MediaType.parse("text/plain");
		RequestBody body = new MultipartBody.Builder().setType(MultipartBody.FORM)
			.addFormDataPart("url","https://bytescout-com.s3-us-west-2.amazonaws.com/files/demo-files/cloud-api/pdf-to-text/sample.pdf")
			.addFormDataPart("caseSensitive","true")
			.addFormDataPart("searchString","Your Company Name")
			.addFormDataPart("replaceImage","https://bytescout-com.s3-us-west-2.amazonaws.com/files/demo-files/cloud-api/pdf-edit/logo.png")
			.addFormDataPart("pages","0")
			.build();
		Request request = new Request.Builder()
			.url("https://api.pdf.co/v1/pdf/edit/replace-text-with-image")
			.method("POST", body)
			.addHeader("x-api-key", "")
			.build();
		Response response = client.newCall(request).execute();
		System.out.println(response.body().string());
	}
}

C#

using System;
using RestSharp;
namespace HelloWorldApplication {
	class HelloWorld {
		static void Main(string[] args) {
			var client = new RestClient("https://api.pdf.co/v1/pdf/edit/replace-text-with-image");
			client.Timeout = -1;
			var request = new RestRequest(Method.POST);
			request.AddHeader("x-api-key", "");
			request.AlwaysMultipartFormData = true;
			request.AddParameter("url", "https://bytescout-com.s3-us-west-2.amazonaws.com/files/demo-files/cloud-api/pdf-to-text/sample.pdf");
			request.AddParameter("caseSensitive", "true");
			request.AddParameter("searchString", "Your Company Name");
			request.AddParameter("replaceImage", "https://bytescout-com.s3-us-west-2.amazonaws.com/files/demo-files/cloud-api/pdf-edit/logo.png");
			request.AddParameter("pages", "0");
			IRestResponse response = client.Execute(request);
			Console.WriteLine(response.Content);
		}
	}
}

Python

import requests

url = "https://api.pdf.co/v1/pdf/edit/replace-text-with-image"

payload={'url': 'https://bytescout-com.s3-us-west-2.amazonaws.com/files/demo-files/cloud-api/pdf-to-text/sample.pdf',
'caseSensitive': 'true',
'searchString': 'Your Company Name',
'replaceImage': 'https://bytescout-com.s3-us-west-2.amazonaws.com/files/demo-files/cloud-api/pdf-edit/logo.png',
'pages': '0'}
files=[

]
headers = {
	'x-api-key': ''
}

response = requests.request("POST", url, headers=headers, data=payload, files=files)

print(response.text)

Powershell

$headers = New-Object "System.Collections.Generic.Dictionary[[String],[String]]"
$headers.Add("x-api-key", "")

$multipartContent = [System.Net.Http.MultipartFormDataContent]::new()
$stringHeader = [System.Net.Http.Headers.ContentDispositionHeaderValue]::new("form-data")
$stringHeader.Name = "url"
$stringContent = [System.Net.Http.StringContent]::new("https://bytescout-com.s3-us-west-2.amazonaws.com/files/demo-files/cloud-api/pdf-to-text/sample.pdf")
$stringContent.Headers.ContentDisposition = $stringHeader
$multipartContent.Add($stringContent)

$stringHeader = [System.Net.Http.Headers.ContentDispositionHeaderValue]::new("form-data")
$stringHeader.Name = "caseSensitive"
$stringContent = [System.Net.Http.StringContent]::new("true")
$stringContent.Headers.ContentDisposition = $stringHeader
$multipartContent.Add($stringContent)

$stringHeader = [System.Net.Http.Headers.ContentDispositionHeaderValue]::new("form-data")
$stringHeader.Name = "searchString"
$stringContent = [System.Net.Http.StringContent]::new("Your Company Name")
$stringContent.Headers.ContentDisposition = $stringHeader
$multipartContent.Add($stringContent)

$stringHeader = [System.Net.Http.Headers.ContentDispositionHeaderValue]::new("form-data")
$stringHeader.Name = "replaceImage"
$stringContent = [System.Net.Http.StringContent]::new("https://bytescout-com.s3-us-west-2.amazonaws.com/files/demo-files/cloud-api/pdf-edit/logo.png")
$stringContent.Headers.ContentDisposition = $stringHeader
$multipartContent.Add($stringContent)

$stringHeader = [System.Net.Http.Headers.ContentDispositionHeaderValue]::new("form-data")
$stringHeader.Name = "pages"
$stringContent = [System.Net.Http.StringContent]::new("0")
$stringContent.Headers.ContentDisposition = $stringHeader
$multipartContent.Add($stringContent)

$body = $multipartContent

$response = Invoke-RestMethod 'https://api.pdf.co/v1/pdf/edit/replace-text-with-image' -Method 'POST' -Headers $headers -Body $body
$response | ConvertTo-Json