Input
| Name | Description | Required |
|---|---|---|
| Source PDF URL | Provide the URL to the source PDF document, or a filetoken:// link from PDF.co Built-In Files Storage. If you use another cloud service such as Google Drive or Dropbox ensure the link is publicly accessible. | Yes |
| Text Search String | Specify the text string for searching within the PDF pages. | Yes |
| Enable Case-Sensitive Search | Activate this to True for case-sensitive search. Default is False. | No |
| Enable Regular Expression Search | Set this to True to incorporate regular expressions in your search. The default is False. | No |
| Exclude Pages with Identified Text | Opt this to True to exclude pages where the text is found. Default is False. | No |
| OCR Language | Select the OCR language for text recognition in scanned PDFs. Default is English. | No |
| Base Filename for New PDFs | Define the base filename for the newly created segmented PDF files. | No |
| Custom Profiles | A JSON string which adds options for the conversion process. See Custom Profiles for more. | No |
Source PDF URL & Google
When using Google Drive, it’s typically recommended to choose the File option. For more advanced file integration techniques, see Integrating File Sources with pdf.co.
Output
| Name | Description |
|---|---|
url1 | This represents the temporary URL of the output file hosted on the PDF.co file server. |
url2 | Similarly, this is the temporary URL for another output file on the PDF.co file server. This pattern is used for all output files. |
urls | This is an array of temporary URLs, each pointing to an output file. |
outputLinkValidTill | A timestamp which indicates how long the url will be available for. |
error | Details of any errors (if any). |
status | The response status code. If all good this will be 200. |
jobId | The unique identifier for the job. |
credits | The credits spent on the process. |
remainingCredits | The credits left on your account. |
duration | The time it took for the process. |
Custom profiles
Use Custom Profiles to enhance your workflow with additional processing options. EnterJSON configuration to customize OCR settings, output format, text extraction methods, and more.
Sample JSON
| Parameter | Type | Default | Description |
|---|---|---|---|
outputDataFormat | string | - | If you require your output as base64 format, set this to base64 |
DataEncryptionAlgorithm | string | - | Controls the encryption algorithm used for data encryption. See User-Controlled Encryption for more information. The available algorithms are: AES128, AES192, AES256. |
DataEncryptionKey | string | - | Controls the encryption key used for data encryption. See User-Controlled Encryption for more information. |
DataEncryptionIV | string | - | Controls the encryption IV used for data encryption. See User-Controlled Encryption for more information. |
DataDecryptionAlgorithm | string | - | Controls the decryption algorithm used for data decryption. See User-Controlled Encryption for more information. The available algorithms are: AES128, AES192, AES256. |
DataDecryptionKey | string | - | Controls the decryption key used for data decryption. See User-Controlled Encryption for more information. |
DataDecryptionIV | string | - | Controls the decryption IV used for data decryption. See User-Controlled Encryption for more information. |