Skip to main content
POST
/
v1
/
pdf
/
edit
/
delete-text
PDF Search and Delete Text
curl --request POST \
  --url https://api.pdf.co/v1/pdf/edit/delete-text \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data @- <<EOF
{
  "url": "https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-search-and-replace/sample-agreement-template-signature-page-1.pdf",
  "searchstring": "<string>",
  "searchstrings": [
    "[CLIENT-NAME]",
    "[CLIENT-COMPANY]",
    "[CLIENT-SIGNATURE]",
    "1 FEB 2023"
  ],
  "regex": false,
  "casesensitive": true,
  "replacementlimit": 2,
  "makeunsearchable": true,
  "pages": "1,2,3-7",
  "name": "<string>",
  "async": false,
  "password": "<string>",
  "expiration": 60,
  "profiles": "{'UsePatch': true, 'PatchColor': '#000000'}",
  "httpusername": "<string>",
  "httppassword": "<string>"
}
EOF
{
  "status": "success",
  "message": "Success",
  "url": "https://pdf-temp-files.s3.us-west-2.amazonaws.com/output.pdf",
  "jobId": "6YSZD3U872ZYYFEDMQCQSGEEO8YSF5WA",
  "credits": 2,
  "remainingCredits": 1480582,
  "duration": 33
}

Authorizations

​
x-api-key
string
header
required

Body

application/json
​
url
string<uri>
default:https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-search-and-replace/sample-agreement-template-signature-page-1.pdf
required

URL to the source file url attribute.

​
searchstring
string

The string to search.

​
searchstrings
string[]

The array of strings to search.

​
regex
boolean
default:false

Set to true to use regular expression for search string(s).

​
casesensitive
boolean
default:true

Set to false to don't use case-sensitive search.

​
replacementlimit
number
default:2

Limit the number of searches & replacements for every item. The value 0 means every found occurrence will be replaced.

​
makeunsearchable
boolean
​
pages
string
default:all pages

Page indices/ranges (0-based). Items are comma-separated. Each item is one of: N (e.g., 0), N-M (e.g., 3-7), N- (open-ended, e.g., 10-), Whitespace is allowed. If not specified, the default configuration processes all pages.

Example:

"1,2,3-7"

​
name
string

File name for generated output.

​
async
boolean
default:false

Set async to true for long processes to run in the background, API will then return a jobId which you can use with the Background Job Check endpoint. Also see Webhooks & Callbacks

​
password
string

Password for the PDF file.

​
expiration
number
default:60

Sets the expiration time for the output link, in minutes. After this period, generated output file(s) are automatically deleted from PDF.co Temporary Files Storage. The maximum allowed duration depends on your subscription plan. For permanent storage of input files (e.g., reusable images, PDF templates, documents), use PDF.co Built‑In Files Storage.

​
profiles
string
default:{'UsePatch': true, 'PatchColor': '#000000'}

Profiles are used configure extra options for specific API endpoints and may be unique to an API. For more information, see Profiles and the documentation of each endpoint for profiles specific to it.

​
httpusername
string

HTTP auth user name if required to access source URL.

​
httppassword
string

HTTP auth password if required to access source URL.

Response

Success.

​
status
string

Status of the API response.

Example:

"success"

​
message
string

Descriptive message for the response status.

Example:

"Success"

​
url
string<uri>

URL to the output file.

Example:

"https://pdf-temp-files.s3.us-west-2.amazonaws.com/output.pdf"

​
jobId
string

Unique identifier for the job.

Example:

"6YSZD3U872ZYYFEDMQCQSGEEO8YSF5WA"

​
credits
integer

Credits used for this operation.

Example:

2

​
remainingCredits
integer

Credits remaining after this operation.

Example:

1480582

​
duration
integer

Time taken to complete the request, in milliseconds.

Example:

33