Sign in

v2

latestOpenAPI 3.0.12026-07-266846393.5 KB
Editing

PDF Search and Delete Text

Delete text from the PDF document with search strings.

post/v1/pdf/edit/delete-text

Request body

filestring path to a local file

The path to the local file to be uploaded.

urlstring uri required

URL to the source file url attribute.

searchstringstring

The string to search.

searchstringsstring[]

The array of strings to search.

regexboolean

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

casesensitiveboolean

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

replacementlimitnumber

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

makeunsearchableboolean
pagesstring

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.

namestring

File name for generated output.

asyncboolean

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

passwordstring

Password for the PDF file.

timeoutnumber

Timeout for output links in seconds

expirationnumber

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.

profilesstring

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.

httpusernamestring

HTTP auth user name if required to access source URL.

httppasswordstring

HTTP auth password if required to access source URL.

Example request

{
  "pages": "1,2,3-7"
}

Response

Success.

statusstring

Status of the API response.

messagestring

Descriptive message for the response status.

urlstring uri

URL to the output file.

jobIdstring

Unique identifier for the job.

creditsinteger

Credits used for this operation.

remainingCreditsinteger

Credits remaining after this operation.

durationinteger

Time taken to complete the request, in milliseconds.

Example response

{
  "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
}