Supported Features
Add Text or Images to PDF
Add text, images, and annotations to your PDF documents with precise positioning and styling options.
Input
| Name | Description | Required |
|---|---|---|
| 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 | Enter the text for the text object. Macros like line breaks (\\n or {{$$newLine}}) or page numbers ({{$$PageNumber}}) can be inserted. | Yes |
| Image URL | URL to image, base64 encoded image, or filetoken:// link to image stored in PDF.co Files storage. | Yes |
| X Coordinate | Determine the X coordinate for text placement. Use PDF.co PDF Inspector to find or measure PDF coordinates. | Yes |
| Y Coordinate | Specify the Y coordinate. Use PDF.co PDF Inspector to find or measure PDF coordinates. | Yes |
| Font Size | Set the font size, with the default being 12. | No |
| Font Color | Choose the text color in hex format (#RRGGBB or #AARRGGBB, with AA as transparency). The default is #000000. | No |
| Font Bold | Enable this to apply bold styling to the font. | No |
| Font Italic | Enable this to apply italic styling to the font. | No |
| Font Strikeout | Enable this to apply strikeout styling to the font. | No |
| Font Underline | Enable this to apply underline styling to the font. | No |
| Font Name | Select the font name from the available font list. The default font is Arial. | No |
| Pages | Indicate specific page numbers or ranges where the text should be added. Leave blank to include all pages. The first page is numbered 0. Example: 0,2-5,7-. | No |
| Link | Add an optional clickable link (starting with http://, https://, mailto:name@example.com, etc.). | No |
| Width | Define the width of the text box. Coordinates start at the top left (use the PDF.co PDF Inspector to measure coordinates). | No |
| Height | Define the height of the text box. Coordinates start at the top left (use the PDF.co PDF Inspector to measure coordinates). | No |
| Alignment | Set text alignment as Center, Right, or Left. Default is Center. | No |
| Transparent | Set the text background as transparent. | No |
| Keep Aspect Ratio | Keep the aspect ratio of the image. | No |
| File Name | File name for the generated output, the input must be in string format. | No |
| Webhook URL | The callback URL or Webhook used to receive the output data. | No |
| HTTP Username | HTTP auth user name if required to access source URL. | No |
| HTTP Password | HTTP auth password if required to access source URL. | No |
| Custom Profiles | Use JSON to customize PDF processing with options like output resolution, OCR settings, text extraction methods, encryption, and image handling. Check our Custom Profile section to see all available parameters for your current endpoint. | No |
Custom Profiles
You can set additional options for the operation used in the PDF.co node by using Custom Profiles. A custom profile is a string in JSON-like format containing predefined parameters. Here’s an example of a Custom Profiles input:base64 format. You can find the list of available parameters for customizing profiles in the PDF.co operation documentation below:
| Parameter | Type | Default | Description |
|---|---|---|---|
outputDataFormat | string | - | If you require your output as base64 format, set this to base64 |
Pages[0].SetCropBox() | array[string] | - | Crop a PDF file using an array to define the crop area. The crop box is defined by a rectangle [x, y, width, height] in PDF points (1 Point = 1/72 inches). |
DisableLigatures | boolean | false | To disable ligaturization, for example for Hebrew. |
FlattenDocument() | boolean | false | Flattening a document renders it as read-only. Handy if you want to remove editing or copying capability. |
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. |
Custom Profiles to:
- Crop a PDF File
- Disable Ligaturization
- Flatten Document
- Visit this page for general information on Profiles usage.
Output
| Name | Description |
|---|---|
jobId | Unique identifier for the background job. |
pageCount | Number of pages in the PDF document. |
error | Indicates whether an error occurred (false means success) |
status | Status code of the request (200, 404, 500, etc.). For more information, see Response Codes. |
credits | Number of credits consumed by the request |
remainingCredits | Number of credits remaining in the account |
duration | Time taken for the operation in milliseconds |
url | Direct URL to the final PDF file stored in S3. |
name | Name of the output file |
outputLinkValidTill | Timestamp indicating when the output link will expire |