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 |
| Conversion Type | Choose which document format you want to convert your PDF to, such as CSV, HTML, TXT, JSON, XML, JPG, PNG, TIFF, WEBP, XLS or XLSX. | Yes |
| Pages | Specify page indices as comma-separated values or ranges to process (e.g. “0, 1, 2-” or “1, 2, 3-7”). The first-page index is 0. Use ”!” before a number for inverted page numbers (e.g. “!0” for the last page). If not specified, the default configuration processes all pages. The input must be in string format. | No |
| Line Grouping | Controls how lines of text are grouped when extracting data from a PDF. Line grouping within table cells. The available modes are: 1, 2, 3. For more information, see Line Grouping. | No |
| Unwrap | Unwrap lines into a single line within table cells in provided PDF documents. This is only applicable when lineGrouping is set to 1. | No |
| OCR Language Name or ID | Set the language for OCR (text from image) to use for scanned PDF, PNG, and JPG documents input when extracting text. see Language Support. You can also use 2 languages simultaneously like this: eng+deu (any combination). | No |
| Extraction Region | Defines coordinates for extraction. Use PDF Edit Add Helper to get or measure PDF coordinates. The format is {x} {y} {width} {height}. | 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. This profile parameter is only available for PDF to JPG, PNG, WEBP, and TIFF operations. |
ColumnDetectionMode | string | ContentGroupsAndBorders | Controls column detection/alignment in PDF table extraction. See Column Detection Mode for more information. This profile parameter is only available for PDF to CSV and XLS operations. |
OCRMode | string | Auto | Specifies how OCR (Optical Character Recognition) should process input content, offering various modes to tailor text extraction based on content type such as images, fonts, and vector graphics. For more information, see OCR Extraction Modes. This profile parameter is available for PDF to CSV, JSON, Text, XLS, XML, HTML, JPG, PNG, WEBP and TIFF operations. |
OCRResolution | integer | 300 | Use this parameter to change the OCR resolution from the default 300 dpi. The range is from 72 to 1200 dpi.This profile parameter is available for PDF to CSV, JSON, Text, XLS, XML, HTML, JPG, PNG, WEBP and TIFF operations. |
RotationAngle | integer | - | Use manual rotation to handle PDFs with vertically drawn text. Normally, OCR automatically detects page rotation in PDFs and extracts text accurately. However, in some cases, the PDF might not have an actual rotated page --- Rather, the text itself is drawn vertically. In such scenarios, auto-detection may fail. You can use this parameter to manually set the page rotation. The available angles are: 0, 1, 2, 3.This profile parameter is available for PDF to CSV, JSON, Text, XLS, XML, HTML, JPG, PNG, WEBP and TIFF operations. |
LineGroupingMode | string | None | Controls line grouping in PDF text extraction. Modes: None (no grouping), GroupByRows (merge rows if all cells align), GroupByColumns (merge cells by column), JoinOrphanedRows (merge single-cell rows to above if no separator).This profile parameter is available for PDF to CSV, JSON, Text, XLS, XML, HTML, JPG, PNG, WEBP and TIFF operations. |
ConsiderFontColors | boolean | false | Controls whether font colors should be considered when detecting table structure and merging text objects during PDF extraction. Set to true to consider font colors.This profile parameter is available for PDF to CSV, JSON, Text, XLS, XML, HTML, JPG, PNG, WEBP and TIFF operations. |
DetectNewColumnBySpacesRatio | string | 1.2 | Controls how spaces between words are interpreted for column detection in PDF text extraction. It defines the ratio of space width that determines when text should be treated as being in separate columns. This profile parameter is available for PDF to CSV, JSON, Text, XLS, XML, HTML, JPG, PNG, WEBP and TIFF operations. |
AutoAlignColumnsToHeader | boolean | true | Controls how columns are detected and aligned during table extraction from PDF documents. It affects both table structure detection and text extraction with formatting preservation. Set to true to automatically align columns to the header row. When set to true (default), the row with the most columns is used as the header, and all other rows are aligned to this structure --- ideal for well-structured tables. When set to false, columns are analyzed independently across all rows to build the structure, which works better for inconsistent or irregular tables.This profile parameter is available for PDF to CSV, JSON, Text, XLS, XML, HTML, JPG, PNG, WEBP and TIFF operations. |
OCRImagePreprocessingFilters | object | - | Image preprocessing filters for OCR. Use methods like AddGammaCorrection() and AddGrayscale() by including them as JSON keys. See sample usage. |
.AddGammaCorrection() | array[string (float format)] | ["1.4"] | Adds a gamma correction filter to the image preprocessing pipeline used during OCR (Optical Character Recognition). This filter adjusts the brightness and contrast of an image by applying a non-linear gamma correction to improve text recognition quality. This profile parameter is available for PDF to CSV, JSON, Text, XLS, XML, HTML, JPG, PNG, WEBP and TIFF operations. |
.AddGrayscale() | boolean | false | Set to true to preprocessing filter that converts a colored document/image to grayscale before performing OCR.This profile parameter is available for PDF to CSV, JSON, Text, XLS, XML, HTML, JPG, PNG, WEBP and TIFF operations. |
RenderTextObjects | boolean | true | Controls whether to render text objects in the PDF document. When set to true, it will render all text objects in the PDF document. Set to false to skip over text objects during rendering. See Disable Text Layer for more information. This profile parameter is only available for PDF to JPG, PNG, WEBP and TIFF operations. |
RenderImageObjects | boolean | true | Render image objects or not. This profile parameter is only available for PDF to JPG, PNG and WEBP operations. |
RenderVectorObjects | boolean | true | Render vector objects or not. This profile parameter is only available for PDF to JPG, PNG and WEBP operations. |
JPEGQuality | integer | 85 | See profiles.JPEGQuality This profile parameter is only available for PDF to JPG operation. |
WEBPQuality | integer | 75 | See profiles.WEBPQuality This profile parameter is only available for PDF to WEBP operation. |
TIFFCompression | string | LZW | See profiles.TIFFCompression This profile parameter is only available for PDF to TIFF operation. |
RenderingResolution | integer | 120 | See Set Image Resolution for more information. This profile parameter is only available for PDF to JPG, PNG, WEBP and TIFF operations. |
OptimizeImages | boolean | true | Some PDF may have high quality images used in the document and you may need to keep the quality of these images in the output HTML. By default PDF to HTML is optimizing images and you can easily turn it off. See Control Image Quality for more information. This profile parameter is only available for PDF to HTML operation. |
OutputPageWidth | integer | 1024 | Control page width (in pixels) for output HTML. Height is calculated and used according to the original pdf pages ratio. See Control Output Page Width for more information. This profile parameter is only available for PDF to HTML operation. |
AdditionalCssStyles | string | “ | To inject CSS for layout options in your HTML. Example: #canvas { zoom: 50%; }. Scale the div that contains all generated HTML pages by 50%. See Inject CSS for more information.This profile parameter is only available for PDF to HTML operation. |
SaveVectors | boolean | false | Controls whether to save vector graphics during PDF to HTML conversion. Set to true to save vector graphics.This profile parameter is only available for PDF to CSV, JSON, XLS and XML operations. |
SaveImages | string | None | Controls how images are saved during PDF to HTML conversion. Modes: None (no images), OuterFile (save to sub-folder), Embed (embed as Base64 data:URI).This profile parameter is only available for PDF to CSV, JSON, XLS, XML and HTML operations. |
ConsiderFontSizes | boolean | false | Set to true to this parameter makes the converter consider font size differences in document text when detecting and parsing table structures. This can be helpful in cases where tables are formatted using different font sizes to distinguish between headers, data cells, or other structural elements.This profile parameter is only available for PDF to CSV, JSON, XLS and XML operations. |
ExtractionArea | array[number] | - | Extract text in a specific area by defining the extraction area - set with points in the format [x, y, width, height].This profile parameter is only available for PDF to CSV, JSON, XLS and XML operations. |
ExtractShadowLikeText | boolean | true | Controls whether to extract invisible text from a PDF document. Set to false to skip over invisible text during extraction. This is particularly useful when dealing with PDFs that contain hidden text layers or when you only want to extract visible content. When this value is set to false, OCRMode must be set to Auto to properly apply the shadow text filtering effect.This profile parameter is only available for PDF to CSV, JSON, XLS and XML operations. |
DataEncryptionAlgorithm | string | - | Controls the encryption algorithm used for data encryption. See User-Controlled Encryption for more information. The available algorithms are: AES128, AES192, AES256.This profile parameter is available for PDF to CSV, JSON, Text, XLS, XML, HTML, JPG, PNG, WEBP and TIFF operations. |
DataEncryptionKey | string | - | Controls the encryption key used for data encryption. See User-Controlled Encryption for more information. This profile parameter is available for PDF to CSV, JSON, Text, XLS, XML, HTML, JPG, PNG, WEBP and TIFF operations. |
DataEncryptionIV | string | - | Controls the encryption IV used for data encryption. See User-Controlled Encryption for more information. This profile parameter is available for PDF to CSV, JSON, Text, XLS, XML, HTML, JPG, PNG, WEBP and TIFF operations. |
DataDecryptionAlgorithm | string | - | Controls the decryption algorithm used for data decryption. See User-Controlled Encryption for more information. The available algorithms are: AES128, AES192, AES256.This profile parameter is available for PDF to CSV, JSON, Text, XLS, XML, HTML, JPG, PNG, WEBP and TIFF operations. |
DataDecryptionKey | string | - | Controls the decryption key used for data decryption. See User-Controlled Encryption for more information. This profile parameter is available for PDF to CSV, JSON, Text, XLS, XML, HTML, JPG, PNG, WEBP and TIFF operations. |
DataDecryptionIV | string | - | Controls the decryption IV used for data decryption. See User-Controlled Encryption for more information. This profile parameter is available for PDF to CSV, JSON, Text, XLS, XML, HTML, JPG, PNG, WEBP and TIFF operations. |
Custom Profiles to:
- Fix incorrect data positions caused by overlapping invisible text or objects. For more details, please refer to this guideline.
- Disable images.
- Control image quality.
- Control output page width.
- Inject CSS.
- Disable text layer.
- Set image resolution.
- Set image preprocessing filters.
- 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 |