> ## Documentation Index
> Fetch the complete documentation index at: https://composio-preview.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# PDF.co

> PDF.co is a REST API platform for PDF automation including PDF extraction, generation, editing, splitting, merging, form filling, barcode processing, OCR, document parsing, file conversion (PDF to Excel/CSV/JSON/XML/HTML/Image and vice versa), and AI-powered invoice parsing.

![PDF.co logo](https://mintcdn.com/composio-preview/gqjBKmmJCINafaiK/images/toolkits/pdf_co.svg?fit=max\&auto=format\&n=gqjBKmmJCINafaiK\&q=85\&s=9f81ac59ac790a521c28a1339fc1f7ec)

* **Category:** documents
* **Auth:** API\_KEY
* **Composio-managed OAuth available?** N/A
* **Tools:** 50
* **Triggers:** 0
* **Slug:** `PDF_CO`
* **Version:** 20261101\_00
* **Instant:** Supported on the latest version. Support varies by tool.

## Tools

> [accordion] Get Account Balance Info
>
> **Slug:** `PDF_CO_ACCOUNT_BALANCE_INFO`
>
> Get the PDF.co account balance and remaining credits using your own API key. Managed connections are not supported.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Barcode (Deprecated)
>
> **Slug:** `PDF_CO_BARCODE_GENERATE`
>
> Generate barcode images from supplied data, including QR codes, Code128, Code39, and PDF417, using your own PDF.co API key. DEPRECATED: Use PDFCOPostBarcodeGenerate instead. Managed connections are not supported for this legacy tool.
>
> #### Input Parameters
>
> **name** `string`
>
> Filename for the generated barcode (extension added automatically).
>
> **type** `string` *required*
>
> Barcode type (e.g., Code128, QRCode, Code39, PDF417).
>
> **value** `string` *required*
>
> Data/content to encode in the barcode.
>
> **async\_** `boolean`
>
> Process request asynchronously.
>
> **margin** `integer`
>
> Margin (white border) size around barcode in pixels.
>
> **addText** `boolean`
>
> Display human-readable text below the barcode.
>
> **fontName** `string`
>
> Font name for human-readable text (e.g., 'Arial').
>
> **fontSize** `integer`
>
> Font size (points) for human-readable text.
>
> **backColor** `string`
>
> Barcode background color (hex or rgba).
>
> **foreColor** `string`
>
> Barcode foreground color (hex e.g., '#000000' or rgba string).
>
> **resolution** `integer`
>
> Image resolution in DPI.
>
> **aspectRatio** `number`
>
> Aspect ratio (width/height) for 2D barcodes.
>
> **pdfPassword** `string`
>
> Password to protect PDF if output format is 'pdf'.
>
> **barcodeWidth** `integer`
>
> Width of the barcode image in pixels.
>
> **outputFormat** `string`
>
> Output image format ('png', 'jpg', 'pdf').
>
> **barcodeHeight** `integer`
>
> Height of the barcode image in pixels.
>
> **caseSensitive** `boolean`
>
> Treat barcode value as case-sensitive.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert Excel to CSV
>
> **Slug:** `PDF_CO_CONVERT_EXCEL_TO_CSV`
>
> Convert an Excel file (XLS/XLSX) from a URL to CSV. With your own API key, inline output can be requested; managed connections support synchronous URL output only.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Link to source XLS or XLSX file to be converted to CSV
>
> **name** `string`
>
> Desired name for the output CSV file
>
> **pages** `string`
>
> Pages to convert (e.g., '0-2,4'), default is all pages
>
> **inline** `boolean`
>
> If true, returns CSV data inline; otherwise returns URL to CSV
>
> **password** `string`
>
> Password for a protected Excel file, if applicable
>
> **profiles** `string`
>
> Conversion profiles in JSON format, see PDF.co docs for structure
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert Excel to HTML
>
> **Slug:** `PDF_CO_CONVERT_EXCEL_TO_HTML`
>
> Tool to convert an Excel file to HTML. Use when you have an Excel URL and need HTML output.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> URL to the source Excel file (xls, xlsx, or csv).
>
> **name** `string`
>
> Name for the resulting HTML file (e.g., 'report.html').
>
> **async** `boolean`
>
> Set to true to run the conversion asynchronously.
>
> **profiles** `string`
>
> Conversion profiles as a JSON string.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert Excel to JSON
>
> **Slug:** `PDF_CO_CONVERT_EXCEL_TO_JSON`
>
> Tool to convert an online Excel or CSV file to JSON format. Use when you have a public file URL and need structured data extraction.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Public URL of the source Excel/CSV file.
>
> **name** `string`
>
> Desired name for the generated JSON file.
>
> **pages** `string`
>
> Comma-separated page indices or ranges to process, e.g., '1,3-5'.
>
> **password** `string`
>
> Password for password-protected files.
>
> **profiles** `string`
>
> Custom processing profiles in JSON format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert Excel to Text
>
> **Slug:** `PDF_CO_CONVERT_EXCEL_TO_TEXT`
>
> Tool to convert Excel files to plain text. Use after providing an Excel file URL to extract spreadsheet content.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Link to the source Excel file (xls, xlsx, or csv).
>
> **name** `string`
>
> Optional name for the output file.
>
> **pages** `string`
>
> Comma-separated list of sheet indices to convert, e.g., '0,2'.
>
> **inline** `boolean`
>
> Set to true to return data inline in response instead of URL.
>
> **encrypt** `boolean`
>
> Set to true to encrypt the resulting file.
>
> **password** `string`
>
> Password for password-protected Excel files.
>
> **profiles** `string`
>
> Conversion profiles in JSON format.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert Excel to XML
>
> **Slug:** `PDF_CO_CONVERT_EXCEL_TO_XML`
>
> Convert an XLS, XLSX, or CSV file from a URL to XML. Your own API key can be used for synchronous or asynchronous requests; managed connections support synchronous URL output only.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> URL to the source file (xls, xlsx or csv).
>
> **name** `string`
>
> Output file name.
>
> **async** `boolean`
>
> Set true to run asynchronously, returning a jobId.
>
> **inline** `boolean`
>
> Set true to return XML inline, otherwise returns file URL.
>
> **callback** `string`
>
> Callback URL for async mode, used when async is true.
>
> **profiles** `object`
>
> Profiles settings.
>
> **expiration** `integer`
>
> Link expiration time in minutes.
>
> **httppassword** `string`
>
> HTTP auth password for source URL.
>
> **httpusername** `string`
>
> HTTP auth user name for source URL.
>
> **worksheetIndex** `string`
>
> Worksheet index as a string (0-based, e.g. '0' for the first worksheet).
>
> **DataDecryptionIV** `string`
>
> Initialization vector for decryption.
>
> **DataEncryptionIV** `string`
>
> Initialization vector for encryption.
>
> **DataDecryptionKey** `string`
>
> Decryption key.
>
> **DataEncryptionKey** `string`
>
> Encryption key.
>
> **DataDecryptionAlgorithm** `string ("AES128" | "AES192" | "AES256")`
>
> Decryption algorithm (AES128, AES192, AES256).
>
> **DataEncryptionAlgorithm** `string ("AES128" | "AES192" | "AES256")`
>
> Encryption algorithm (AES128, AES192, AES256).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Document Parser
>
> **Slug:** `PDF_CO_DOCUMENT_PARSER`
>
> Parse a PDF using a supplied custom template to extract structured data. This tool requires your own PDF.co API key; managed connections are not supported.
>
> #### Input Parameters
>
> **url** `string`
>
> Public URL of the PDF to parse. Required if not uploading a file. Must be a publicly accessible HTTP/HTTPS URL or a file previously uploaded to PDF.co storage.
>
> **file** `string`
>
> Raw PDF file bytes to upload directly. Required if not providing a URL.
>
> **name** `string`
>
> Custom name for the output/result file.
>
> **pages** `string`
>
> Comma-separated page indices or ranges to process (e.g., '0,2-4'). If not specified, all pages are processed.
>
> **inline** `boolean`
>
> Return parsed results inline in the response body instead of generating a file URL.
>
> **password** `string`
>
> Password for protected PDF files.
>
> **template** `string` *required*
>
> Inline YAML/JSON parsing template to extract structured data. The template defines fields to extract using regex patterns, rectangles, or static values. Example format: \{"templateVersion": 3, "templatePriority": 1, "sourceId": "invoice", "fields": \{"total": \{"type": "regex", "expression": "TOTAL\{\{Spaces}}(\{\{Number}})"}}}
>
> **async\_req** `boolean`
>
> Run parsing asynchronously and return a result URL instead of inline data.
>
> **outputFormat** `string`
>
> Output format for parsed data: JSON, CSV, or XML. Default is JSON.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upload File
>
> **Slug:** `PDF_CO_FILE_UPLOAD`
>
> Upload a local file or remote URL to PDF.co and return a hosted URL for downstream processing. This tool requires your own PDF.co API key; managed connections are not supported.
>
> #### Input Parameters
>
> **url** `string`
>
> URL of the file to upload to PDF.co. The file will be downloaded from this URL and uploaded. Either 'url' or 'file' must be provided, but not both.
>
> **file** `object`
>
> File to upload to PDF.co. Either 'file' or 'url' must be provided, but not both.
>
> **name** `string`
>
> Optional custom filename to assign on PDF.co (defaults to the file's original name).
>
> **run\_async** `boolean`
>
> Whether to execute the upload asynchronously (defaults to false).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Get Presigned Upload URL
>
> **Slug:** `PDF_CO_GET_PRESIGNED_UPLOAD_URL`
>
> Generate URLs for directly uploading a named file to PDF.co. This action requires a non-managed connection.
>
> #### Input Parameters
>
> **name** `string`
>
> Name to assign to the uploaded file, including its extension.
>
> **timeout** `string`
>
> Timeout for the output links in seconds.
>
> **contenttype** `string`
>
> MIME type that must be used as Content-Type when uploading to the returned presigned URL.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Check Job Status
>
> **Slug:** `PDF_CO_JOB_CHECK`
>
> Check the status and result of an asynchronous PDF.co job using your own API key. Managed connections are not supported.
>
> #### Input Parameters
>
> **force** `boolean`
>
> Set true to forcibly check long-running jobs. When true, returns 'unknown' for invalid job IDs instead of 'working'.
>
> **job\_id** `string` *required*
>
> The unique identifier of the asynchronous job to check status for
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add Content to PDF
>
> **Slug:** `PDF_CO_PDF_ADD`
>
> Add content such as text, images, barcodes, or links to an existing PDF. Managed connections support one plain-text annotation on one explicit page per request.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Link to the source PDF file
>
> **name** `string`
>
> Desired name for the result PDF file
>
> **pages** `string`
>
> Comma-separated page indices (e.g., '0,2-4') to process; defaults to all pages
>
> **objects** `array` *required*
>
> List of objects to add (text, image, barcode, link, document, etc.). See API docs for structure.
>
> **password** `string`
>
> Password for protected PDF, if needed
>
> **run\_async** `boolean`
>
> Run the process asynchronously; if true, returns a jobId for status checking
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Auto-Rotate PDF Pages
>
> **Slug:** `PDF_CO_PDF_AUTO_ROTATE`
>
> Automatically detect and correct PDF page rotation using OCR.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> URL of the source PDF file to auto-rotate.
>
> **lang** `string`
>
> OCR language code, or two language codes joined with '+'. When omitted, PDF.co uses its default language.
>
> **name** `string`
>
> File name for the generated PDF.
>
> **profiles** `object`
>
> Advanced PDF.co processing profile settings.
>
> **httppassword** `string`
>
> HTTP authentication password for accessing the source URL.
>
> **httpusername** `string`
>
> HTTP authentication username for accessing the source URL.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Change PDF Text Searchable
>
> **Slug:** `PDF_CO_PDF_CHANGE_TEXT_SEARCHABLE`
>
> Make scanned or image-only PDF text searchable using OCR. Managed connections require one explicit page per request and return a URL to the processed PDF.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Public URL of the source PDF file.
>
> **rect** `string`
>
> Comma-separated rectangle coordinates 'left,top,width,height' to limit OCR.
>
> **pages** `string`
>
> Single 0-indexed page number to process (e.g., '0' for the first page). The /pdf/makesearchable endpoint does not accept page ranges or comma-separated lists and will return HTTP 450 'Invalid page range specified' for values like '0-2' or '0,1'. Omit this field to OCR every page.
>
> **inline** `boolean`
>
> Whether to return the processed PDF data inline (base64) or as a URL. Set to true for inline response, false for URL.
>
> **language** `string`
>
> Language code for OCR (default: eng).
>
> **password** `string`
>
> Password for encrypted PDF, if applicable.
>
> **profiles** `string`
>
> JSON string with advanced OCR profiles and configurations.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Compress PDF
>
> **Slug:** `PDF_CO_PDF_COMPRESS`
>
> Compress a PDF using a preset or detailed image and font controls.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> URL of the source PDF file to compress.
>
> **name** `string`
>
> File name for the generated PDF.
>
> **config** `object`
>
> Partial advanced compression configuration.
>
> **password** `string`
>
> Password for opening a protected source PDF.
>
> **expiration** `integer`
>
> Number of minutes before the temporary output link expires.
>
> **colorQuality** `integer`
>
> JPEG quality for color and grayscale images from 1 to 100.
>
> **compressionLevel** `string ("low" | "medium" | "high" | "aggressive")`
>
> Ready-to-use PDF compression preset.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert PDF to Text (Simple)
>
> **Slug:** `PDF_CO_PDF_CONVERT_TO_TEXT_SIMPLE`
>
> Extract plain text from a text-based PDF without OCR or layout analysis.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> URL of the source PDF file.
>
> **name** `string`
>
> File name for the generated text output.
>
> **pages** `string`
>
> Comma-separated zero-based page indices or ranges to process, such as '0,1,2-' or '!0'.
>
> **inline** `boolean`
>
> Return extracted text in the response instead of an output URL.
>
> **password** `string`
>
> Password for a protected PDF file.
>
> **httppassword** `string`
>
> HTTP authentication password for the source URL.
>
> **httpusername** `string`
>
> HTTP authentication username for the source URL.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Generate Barcode
>
> **Slug:** `PDF_CO_PDFCO_POST_BARCODE_GENERATE`
>
> Generate barcode images in 45+ formats, including QR Code, Code 128, and Code 39, with options such as rotation, QR decoration images, and async processing. This action is unavailable for managed calls.
>
> #### Input Parameters
>
> **name** `string`
>
> Output filename for the generated barcode image.
>
> **type** `string ("AustralianPostCode" | "Aztec" | "Codabar" | "CodablockF" | "Code128" | "Code16K" | "Code39" | "Code39Extended" | "Code39Mod43" | "Code39Mod43Extended" | "Code93" | "DataMatrix" | "DPMDataMatrix" | "EAN13" | "EAN2" | "EAN5" | "EAN8" | "GS1DataBarExpanded" | "GS1DataBarExpandedStacked" | "GS1DataBarLimited" | "GS1DataBarOmnidirectional" | "GS1DataBarStacked" | "GTIN12" | "GTIN13" | "GTIN14" | "GTIN8" | "IntelligentMail" | "Interleaved2of5" | "ITF14" | "MaxiCode" | "MICR" | "MicroPDF" | "MSI" | "PatchCode" | "PDF417" | "Pharmacode" | "PostNet" | "PZN" | "QRCode" | "RoyalMail" | "RoyalMailKIX" | "Trioptic" | "UPCA" | "UPCE" | "UPU")`
>
> Barcode format to generate. Defaults to QRCode.
>
> **async** `boolean`
>
> Enable background processing; returns jobId for status checks. Defaults to false.
>
> **value** `string` *required*
>
> The string value to be encoded into the barcode.
>
> **inline** `boolean`
>
> Return results within response (true) or return URL (false). Defaults to false.
>
> **encrypt** `boolean`
>
> Enable encryption for the output file.
>
> **callback** `string`
>
> Webhook URL to receive results when async operation completes.
>
> **expiration** `integer`
>
> Output link expiration time in minutes. Defaults to 60.
>
> **profiles.Angle** `integer ("0" | "90" | "180" | "270")`
>
> Rotation angle in degrees. Defaults to 0.
>
> **decorationImage** `string`
>
> Image URL for logo insertion within QR codes.
>
> **outputDataFormat** `string`
>
> Set to 'base64' for base64-encoded output.
>
> **profiles.CaptionFont** `string`
>
> Caption text font and size. Defaults to 'Arial, 12'.
>
> **profiles.NarrowBarWidth** `integer`
>
> Narrow bar width in pixels. Defaults to 3.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Upload File from Base64
>
> **Slug:** `PDF_CO_PDFCO_POST_FILE_UPLOAD_BASE64`
>
> Upload base64-encoded source data to create a temporary PDF.co file for downstream processing, with an optional custom expiration time. This action is unavailable for managed calls.
>
> #### Input Parameters
>
> **file** `string` *required*
>
> Base64-encoded file bytes with data URI prefix. Must include format like 'data:image/gif;base64,R0lGODlh...' or 'data:text/plain;base64,SGVsbG8gV29ybGQh...'
>
> **name** `string`
>
> Custom file name for the output. If not provided, a default name will be used.
>
> **expiration** `integer`
>
> Link expiration time in minutes. Default is 60 minutes. Maximum varies by subscription plan. The temporary file is automatically deleted after expiration.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Delete PDF Pages
>
> **Slug:** `PDF_CO_PDF_DELETE_PAGES`
>
> Delete selected pages from a PDF using your own PDF.co API key. Managed connections are not supported.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> URL or base64-encoded content of the source PDF.
>
> **name** `string`
>
> Optional name for the resulting PDF file.
>
> **pages** `string` *required*
>
> Comma-separated list of page indices or ranges to delete (1-based). E.g., '1,3-5' to delete pages 1, 3, 4, and 5.
>
> **password** `string`
>
> Password for protected PDF file.
>
> **profiles** `string`
>
> Optional JSON string for advanced configuration.
>
> **async\_job** `boolean`
>
> Process request asynchronously. If true, returns a job ID instead of immediate URL.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Extract PDF Attachments
>
> **Slug:** `PDF_CO_PDF_EXTRACT_ATTACHMENTS`
>
> Extract embedded attachments from a PDF at a URL. This action requires your own PDF.co connection and is unavailable for managed calls.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> URL of the input PDF file to process.
>
> **inline** `boolean`
>
> If true, returns attachment data inline; otherwise returns URLs.
>
> **callback** `string`
>
> Webhook URL for receiving async results.
>
> **password** `string`
>
> Password for protected PDF file (if applicable).
>
> **async\_job** `boolean`
>
> Run processing asynchronously. If true, returns a jobId for async processing.
>
> **expiration** `integer`
>
> Set the expiration time for the output link in minutes. Default is 60.
>
> **httppassword** `string`
>
> HTTP authentication password for accessing the source URL.
>
> **httpusername** `string`
>
> HTTP authentication username for accessing the source URL.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Find Text in PDF
>
> **Slug:** `PDF_CO_PDF_FIND`
>
> Tool to find text in a PDF document. Use when you need to locate keywords or regex patterns and get their page positions.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Publicly accessible URL of the PDF file to search.
>
> **pages** `string`
>
> Comma-separated page ranges to search, e.g., '1-3,5'.
>
> **password** `string`
>
> Password for protected PDF, if applicable.
>
> **profiles** `string`
>
> Advanced JSON configuration for PDF processing.
>
> **regexSearch** `boolean`
>
> Whether to treat searchString as a regular expression (default: false).
>
> **searchString** `string` *required*
>
> Keyword or regex pattern to find in the document.
>
> **caseSensitive** `boolean`
>
> Whether the search is case-sensitive (default: false).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Find Tables in PDF
>
> **Slug:** `PDF_CO_PDF_FIND_TABLE`
>
> Detect tables in a PDF. Table page, bounds, and column positions can be returned inline, or the result can be provided via a temporary URL.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> URL of the source PDF file.
>
> **pages** `string`
>
> Comma-separated zero-based page indices or ranges to process, such as '0,1,2-' or '!0'.
>
> **inline** `boolean`
>
> Return table data directly in the response.
>
> **password** `string`
>
> Password for a protected PDF file.
>
> **profiles** `string`
>
> Advanced PDF.co settings as a JSON string or object.
>
> **httppassword** `string`
>
> HTTP authentication password for the source URL.
>
> **httpusername** `string`
>
> HTTP authentication username for the source URL.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] PDF Forms Info Reader
>
> **Slug:** `PDF_CO_PDF_FORMS_INFO_READER`
>
> Tool to extract form field information from a PDF. Use when you need to retrieve names, types, and values of form fields. Returns field names, types (CheckBox, EditBox, RadioButton, ComboBox), values, and position coordinates.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Publicly accessible URL of the PDF file containing form fields.
>
> **async** `boolean`
>
> If true, runs the job asynchronously and returns a jobId for status checking.
>
> **password** `string`
>
> Password for encrypted PDF, if applicable.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert CSV or Excel to PDF
>
> **Slug:** `PDF_CO_PDF_FROM_CSV`
>
> Convert CSV or spreadsheet pages to PDF with page-range and autosize controls.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Public URL of the source CSV, XLS, or XLSX file to convert.
>
> **name** `string`
>
> File name for the generated PDF.
>
> **pages** `string`
>
> Zero-based page indices or ranges to convert, such as '0,2-4'.
>
> **autosize** `boolean`
>
> Whether to adjust output page dimensions to the worksheet content.
>
> **profiles** `string`
>
> Advanced PDF.co profile settings as a JSON string or JSON object.
>
> **expiration** `integer`
>
> Number of minutes before the temporary output link expires.
>
> **httppassword** `string`
>
> HTTP password when the source URL requires authentication.
>
> **httpusername** `string`
>
> HTTP username when the source URL requires authentication.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert Text to PDF
>
> **Slug:** `PDF_CO_PDF_FROM_DOCUMENT_TXT`
>
> Tool to convert a plain text (.txt) file to PDF. Use when you have a public URL to a text file; raw inline text is not accepted by the endpoint.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Direct public URL to the source text (.txt) file. The endpoint only accepts a downloadable URL; raw/inline text is not supported and will return HTTP 400 'Invalid input parameters'. Upload the text first (e.g. via PDF.co file upload) and pass the resulting URL here.
>
> **name** `string` *required*
>
> Name of the resulting PDF file (e.g., 'result.pdf').
>
> **profiles** `string`
>
> Optional JSON-formatted string with advanced API options.
>
> **async\_job** `boolean`
>
> Run processing asynchronously; if true, returns a jobId for status checking.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert Email to PDF
>
> **Slug:** `PDF_CO_PDF_FROM_EMAIL`
>
> Convert standalone email files (.eml or .msg) at a URL to PDF. This action requires your own PDF.co connection and is unavailable for managed calls.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Direct URL to the input EML or MSG file. Must be a publicly reachable URL; local file paths and raw content strings are not accepted.
>
> **name** `string`
>
> Optional name for the resulting PDF file.
>
> **profiles** `string`
>
> Advanced configuration as a JSON-formatted string (must be a string, not an object). Only profile keys documented by PDF.co for the email-to-PDF endpoint are accepted; unsupported keys return a 444 'Profiles parsing error'. See samples at [https://docs.pdf.co/api-reference/profiles](https://docs.pdf.co/api-reference/profiles). Leave unset unless you have a valid profile.
>
> **async\_job** `boolean`
>
> Run processing asynchronously; if true, returns a jobId for status checking.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert HTML to PDF
>
> **Slug:** `PDF_CO_PDF_FROM_HTML`
>
> Convert a webpage or HTML resource at a URL to a PDF. This action requires your own PDF.co connection and is unavailable for managed calls.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> The HTML page or resource URL to convert into PDF. Must be a reachable HTTP(S) URL; raw HTML strings and local file paths are not accepted. Upload local HTML files first to obtain a URL.
>
> **name** `string`
>
> Desired output filename for the PDF result.
>
> **async** `boolean`
>
> Run conversion as background job; returns jobId when true.
>
> **footer** `string`
>
> HTML snippet for page footers applied to each page.
>
> **header** `string`
>
> HTML snippet for page headers applied to each page.
>
> **margins** `string`
>
> Custom page margins in '\{top} \{right} \{bottom} \{left}' format (units: px, mm, cm, in).
>
> **callback** `string`
>
> Webhook URL to receive asynchronous results when async=true.
>
> **profiles** `string`
>
> Advanced conversion profiles/settings as JSON string.
>
> **mediaType** `string`
>
> CSS media type: 'print', 'screen', or 'none'.
>
> **paperSize** `string`
>
> Paper size: standard like 'Letter', 'Legal', 'A4'–'A6', or custom '200px 300px', '8in 10in'.
>
> **expiration** `integer`
>
> Expiration time in minutes for the output file link.
>
> **orientation** `string`
>
> Document orientation: 'Portrait' or 'Landscape'.
>
> **printBackground** `boolean`
>
> Include background graphics (colors/images) if true.
>
> **DoNotWaitFullLoad** `boolean`
>
> If true, speeds up conversion by not waiting for full page load.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert Images to PDF
>
> **Slug:** `PDF_CO_PDF_FROM_IMAGE`
>
> Convert one or more JPG, PNG, or TIFF images into a PDF.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Public URL of an input JPG, PNG, or TIFF image. Separate multiple image URLs with commas.
>
> **name** `string`
>
> File name for the generated PDF.
>
> **pages** `string`
>
> Zero-based page indices or ranges to process, such as '0,1,2-' or '!0'.
>
> **profiles** `string`
>
> Advanced PDF.co conversion settings as a JSON-formatted string.
>
> **expiration** `integer`
>
> Lifetime of the temporary output link in minutes.
>
> **httppassword** `string`
>
> HTTP authentication password for accessing the source URL.
>
> **httpusername** `string`
>
> HTTP authentication username for accessing the source URL.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert Webpage URL to PDF
>
> **Slug:** `PDF_CO_PDF_FROM_URL`
>
> Synchronously convert a webpage URL with timeout and legacy-renderer controls.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Public webpage URL to convert to PDF.
>
> **name** `string`
>
> File name for the generated PDF.
>
> **footer** `string`
>
> HTML inserted in the footer of every output page.
>
> **header** `string`
>
> HTML inserted in the header of every output page.
>
> **margins** `string`
>
> Page margins as one value or as top, right, bottom, and left values using px, mm, cm, or in units.
>
> **profiles** `string`
>
> Advanced PDF.co conversion settings as a JSON-formatted string.
>
> **mediaType** `string ("print" | "screen" | "none")`
>
> CSS media type used to render the webpage.
>
> **paperSize** `string`
>
> Standard paper size such as Letter or A4, or a custom width and height such as '200mm 300mm'.
>
> **expiration** `integer`
>
> Number of minutes before the temporary output link expires.
>
> **orientation** `string ("Portrait" | "Landscape")`
>
> Portrait or landscape page orientation.
>
> **renderTimeout** `integer`
>
> Maximum webpage rendering time in milliseconds, up to 177000.
>
> **legacyRendition** `boolean`
>
> Whether to render with PDF.co's legacy Chromium version.
>
> **printBackground** `boolean`
>
> Whether to include webpage background colors and images.
>
> **DoNotWaitFullLoad** `boolean`
>
> Whether to begin conversion after minimal loading instead of waiting for the full page load.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] PDF Info Reader
>
> **Slug:** `PDF_CO_PDF_INFO_READER`
>
> Tool to retrieve detailed information and metadata of a PDF. Use when you need page count, author, encryption details, and other document properties.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> URL to the source PDF file
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Merge PDFs
>
> **Slug:** `PDF_CO_PDF_MERGE`
>
> Tool to merge multiple PDF files into one document. Use when you need to combine several PDF URLs into a single PDF file.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **name** `string`
>
> Optional name for the resulting PDF file (must end with .pdf)
>
> **urls** `string` *required*
>
> Comma-separated string of PDF URLs or a list of PDF URLs to merge. Each URL must point to a publicly accessible or presigned PDF file.
>
> **profiles** `string`
>
> (Advanced) Custom JSON profiles for processing.
>
> **run\_async** `boolean`
>
> Run the merge asynchronously; if true returns a jobId for status checking.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Optimize PDF (Retired; Use PDF Compress)
>
> **Slug:** `PDF_CO_PDF_OPTIMIZE`
>
> Optimize a PDF at a URL using PDF.co's legacy optimizer, producing an optimized PDF. DEPRECATED: The optimizer is retired; use PDF\_CO\_PDF\_COMPRESS for new calls. This action is unavailable for managed calls.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> URL of the source PDF file to optimize.
>
> **name** `string`
>
> File name for the generated PDF.
>
> **password** `string`
>
> Password for a protected source PDF.
>
> **profiles** `string`
>
> PDF.co optimization profile settings as a profile string or object.
>
> **expiration** `integer`
>
> Number of minutes before the temporary output link expires.
>
> **httppassword** `string`
>
> HTTP authentication password for accessing the source URL.
>
> **httpusername** `string`
>
> HTTP authentication username for accessing the source URL.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Replace PDF Text with Image
>
> **Slug:** `PDF_CO_PDF_REPLACE_TEXT_WITH_IMAGE`
>
> Replace matching text in a PDF with an image and return the edited PDF.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> URL of the source PDF file.
>
> **name** `string`
>
> File name for the generated PDF.
>
> **pages** `string`
>
> Comma-separated zero-based page indices or ranges to process, such as '0,1,2-' or '!0'.
>
> **regex** `boolean`
>
> Whether searchString is interpreted as a regular expression.
>
> **password** `string`
>
> Password for a protected PDF file.
>
> **profiles** `string`
>
> Advanced PDF.co settings as a JSON string or object.
>
> **expiration** `integer`
>
> Number of minutes before the temporary output link expires.
>
> **httppassword** `string`
>
> HTTP authentication password for the source URL.
>
> **httpusername** `string`
>
> HTTP authentication username for the source URL.
>
> **replaceImage** `string` *required*
>
> Image URL or data URI to insert in place of the matched text.
>
> **searchString** `string` *required*
>
> Text or regular expression to replace.
>
> **caseSensitive** `boolean`
>
> Whether text matching is case-sensitive.
>
> **replacementLimit** `integer`
>
> Maximum replacements per search item; zero replaces every occurrence.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Rotate PDF Pages
>
> **Slug:** `PDF_CO_PDF_ROTATE`
>
> Tool to rotate selected pages in a PDF. Use when you need to adjust the orientation of specific pages in an online PDF file before further processing.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> URL of the source PDF file to rotate
>
> **name** `string`
>
> Optional filename for the resulting PDF (should end with .pdf)
>
> **angle** `integer ("90" | "180" | "270")` *required*
>
> Rotation angle in degrees; must be one of 90, 180, or 270
>
> **pages** `string` *required*
>
> Comma-separated list of page indices or ranges to rotate (e.g., '0,2-5')
>
> **password** `string`
>
> Password for encrypted PDFs, if required
>
> **run\_async** `boolean`
>
> Run the operation asynchronously; if true, returns a jobId for status checking
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search and Delete Text in PDF
>
> **Slug:** `PDF_CO_PDF_SEARCH_AND_DELETE_TEXT`
>
> Search for and delete text in a PDF by keyword or regex. Managed calls support literal search only; regex search requires your own PDF.co connection.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> URL or base64 content of the source PDF file.
>
> **name** `string`
>
> Desired output filename for the PDF result.
>
> **async** `boolean`
>
> Run operation asynchronously. Returns jobId if true.
>
> **pages** `string`
>
> Comma-separated list of page indices or ranges to process (0-based), e.g., '0,2-5'.
>
> **regex** `boolean`
>
> Treat searchString as regular expression.
>
> **password** `string`
>
> Password for protected PDF if required.
>
> **searchString** `string` *required*
>
> Text string or regex pattern to search and delete.
>
> **caseSensitive** `boolean`
>
> Enable case-sensitive matching. Default is true.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Search and Replace Text in PDF
>
> **Slug:** `PDF_CO_PDF_SEARCH_AND_REPLACE_TEXT`
>
> Tool to search for and replace text in a PDF document. Use when you need to update specific text instances within an existing PDF file (e.g., changing invoice numbers).
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Publicly accessible URL of the source PDF file.
>
> **name** `string`
>
> Optional name for the resulting PDF file.
>
> **async** `boolean`
>
> Set to true to run process asynchronously (returns jobId).
>
> **password** `string`
>
> Password for protected PDF, if required.
>
> **regexSearch** `boolean`
>
> Enable regular expression search if true.
>
> **searchString** `string` *required*
>
> Text to search for in the document.
>
> **replaceString** `string` *required*
>
> Text to replace each found occurrence with.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Add PDF Password and Security
>
> **Slug:** `PDF_CO_PDF_SECURITY_ADD`
>
> Create a secured PDF copy with passwords and permission restrictions.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> URL of the source PDF file to secure.
>
> **name** `string`
>
> File name for the generated PDF.
>
> **profiles** `object`
>
> Advanced PDF.co profile settings.
>
> **expiration** `integer`
>
> Number of minutes before the temporary output link expires.
>
> **printQuality** `string ("LowResolution" | "HighResolution")`
>
> Printing quality allowed for the secured PDF.
>
> **userPassword** `string`
>
> Password required to view or print the PDF; this password alone cannot change document restrictions.
>
> **ownerPassword** `string`
>
> Owner password used to encrypt the PDF and change document restrictions; it is required when modifying any allow\* restriction.
>
> **allowFillForms** `boolean`
>
> Whether to allow filling interactive form and signature fields; ownerPassword is required to modify this restriction.
>
> **allowPrintDocument** `boolean`
>
> Whether to allow printing; ownerPassword is required to modify this restriction.
>
> **allowModifyDocument** `boolean`
>
> Whether to allow document modification; ownerPassword is required to modify this restriction.
>
> **encryptionAlgorithm** `string ("RC4_40bit" | "RC4_128bit" | "AES_128bit" | "AES_256bit")`
>
> Encryption algorithm for the secured PDF.
>
> **allowAssemblyDocument** `boolean`
>
> Whether to allow document assembly; ownerPassword is required to modify this restriction.
>
> **allowContentExtraction** `boolean`
>
> Whether to allow copying PDF content; ownerPassword is required to modify this restriction.
>
> **allowModifyAnnotations** `boolean`
>
> Whether to allow interaction with annotations and forms; ownerPassword is required to modify this restriction.
>
> **allowAccessibilitySupport** `boolean`
>
> Whether to allow content extraction for accessibility; ownerPassword is required to modify this restriction.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Remove PDF Security
>
> **Slug:** `PDF_CO_PDF_SECURITY_REMOVE`
>
> Remove password protection and usage restrictions from a PDF copy.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> URL of the source password-protected PDF file.
>
> **name** `string`
>
> File name for the generated unprotected PDF.
>
> **password** `string`
>
> Password for the source PDF file.
>
> **profiles** `object`
>
> Advanced PDF.co profile settings.
>
> **expiration** `integer`
>
> Number of minutes before the temporary output link expires.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Split PDF
>
> **Slug:** `PDF_CO_PDF_SPLIT`
>
> Tool to split a PDF into multiple files by page ranges. Use when you need to extract specific pages or page ranges from a PDF.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string`
>
> Public URL of the PDF file to split.
>
> **file** `object`
>
> PDF file to upload for splitting instead of using a URL.
>
> **name** `string`
>
> Base name for output files; each part receives a suffix.
>
> **pages** `string`
>
> Comma-separated or dash page ranges to split, e.g. '1-2,4'. 1-based indexing; omit to split all pages.
>
> **inline** `boolean`
>
> Return split documents inline (base64) instead of URLs.
>
> **callback** `string`
>
> Webhook URL for async notifications; only used when run\_async is True.
>
> **password** `string`
>
> Owner password for encrypted PDF files, if any.
>
> **profiles** `object`
>
> Advanced processing profiles as JSON-formatted dict.
>
> **run\_async** `boolean`
>
> Run processing asynchronously; returns jobId instead of immediate results.
>
> **expiration** `integer`
>
> Minutes before temporary output links expire; default is service default.
>
> **httppassword** `string`
>
> HTTP basic auth password if the source URL is protected.
>
> **httpusername** `string`
>
> HTTP basic auth username if the source URL is protected.
>
> **DataEncryptionIV** `string`
>
> Base64-encoded IV for output data encryption.
>
> **outputDataFormat** `string`
>
> Set to 'base64' to return split PDFs as base64 strings.
>
> **DataEncryptionKey** `string`
>
> Base64-encoded key for output data encryption.
>
> **DataEncryptionAlgorithm** `string`
>
> Algorithm for user-controlled output encryption (AES128, AES192, AES256).
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert PDF to CSV
>
> **Slug:** `PDF_CO_PDF_TO_CSV`
>
> Tool to convert PDF or scanned images to CSV format. Use when you need to extract tabular data from a PDF into CSV format.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Link to the PDF file to be converted.
>
> **lang** `string`
>
> Language for OCR text recognition (e.g., 'eng', 'deu').
>
> **name** `string`
>
> Optional name for the output CSV file (must end with .csv).
>
> **pages** `string`
>
> Comma-separated page indices or ranges to convert (e.g., '1,3-5').
>
> **inline** `boolean`
>
> If true, returns CSV data inline; otherwise returns a URL to the CSV.
>
> **encrypt** `boolean`
>
> If true, encrypts the output CSV file.
>
> **password** `string`
>
> Password for protected PDF files, if required.
>
> **profiles** `string`
>
> Advanced conversion settings in JSON format.
>
> **run\_async** `boolean`
>
> Run job asynchronously; returns jobId for status checking.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert PDF to HTML
>
> **Slug:** `PDF_CO_PDF_TO_HTML`
>
> Tool to convert PDF documents to HTML. Use when you need an HTML rendition of a PDF or scanned image.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string`
>
> URL to the source PDF file. Must be a publicly accessible HTTP/HTTPS URL (without authentication) or a file previously uploaded to PDF.co storage. Local file paths (file:// URLs) are not supported - use the PDF\_CO\_FILE\_UPLOAD action first to upload local files to PDF.co, then use the returned URL here.
>
> **file** `string`
>
> Binary content of the PDF file to upload as an alternative to 'url'.
>
> **name** `string`
>
> Desired name for the resulting HTML file (e.g., 'result.html').
>
> **pages** `string`
>
> Comma-separated page indices or ranges to convert (e.g., '0,2-4').
>
> **inline** `boolean`
>
> If true, returns raw HTML in the 'body' field instead of a URL link.
>
> **encrypt** `boolean`
>
> Whether to encrypt the output HTML file.
>
> **password** `string`
>
> Password for protected PDF files, if required.
>
> **profiles** `string`
>
> Additional conversion profiles as a JSON string.
>
> **run\_async** `boolean`
>
> Set to true to run the conversion asynchronously.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert PDF to Image
>
> **Slug:** `PDF_CO_PDF_TO_IMAGE`
>
> Convert PDF pages to PNG, JPG, or TIFF images for previews using a connected PDF.co account. This action is unavailable for managed calls.
>
> #### Input Parameters
>
> **dpi** `integer`
>
> Resolution in DPI for the output images (1-300).
>
> **url** `string` *required*
>
> Link to the source PDF file.
>
> **async** `boolean`
>
> Run processing asynchronously. Returns jobId when true.
>
> **pages** `string`
>
> Comma-separated list of page indices or ranges to convert. For example: '1,3-5' to convert pages 1, 3, 4, and 5.
>
> **password** `string`
>
> Password for protected PDF files, if required.
>
> **profiles** `string`
>
> Custom JSON profiles for advanced conversion options.
>
> **imageFormat** `string ("PNG" | "JPG" | "TIFF")`
>
> Output image format: PNG (default), JPG, or TIFF.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert PDF to JSON
>
> **Slug:** `PDF_CO_PDF_TO_JSON`
>
> Convert PDF or scanned images to a structured JSON representation using a connected PDF.co account. This action is unavailable for managed calls.
>
> #### Input Parameters
>
> **url** `string`
>
> Link to the PDF file to be converted.
>
> **file** `string`
>
> Binary content of the PDF file to convert.
>
> **name** `string`
>
> Optional name for the output JSON file (should end with .json).
>
> **async** `boolean`
>
> If true, runs the job asynchronously; returns jobId for status checking.
>
> **pages** `string`
>
> Comma-separated page indices or ranges to convert (e.g., '1,3-5').
>
> **inline** `boolean`
>
> If true, returns JSON data inline; otherwise returns a URL.
>
> **password** `string`
>
> Password for protected PDF files, if required.
>
> **profiles** `string`
>
> Advanced conversion configuration in JSON format.
>
> **searchString** `string`
>
> Optional text to search for in the PDF before conversion.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert PDF to Text
>
> **Slug:** `PDF_CO_PDF_TO_TEXT`
>
> Tool to convert PDF or scanned images to plain text. Use when you need raw text output preserving layout.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> URL to the source PDF or image file. Must be a publicly accessible HTTP/HTTPS URL (without authentication) or a file previously uploaded to PDF.co storage. Local file paths (file:// URLs) are not supported - use the PDF\_CO\_FILE\_UPLOAD action first to upload local files to PDF.co, then use the returned URL here.
>
> **lang** `string`
>
> OCR language(s) code, e.g. 'eng', or 'eng+deu'.
>
> **name** `string`
>
> Desired name for the output file (e.g. 'result.txt').
>
> **rect** `string`
>
> Extraction rectangle in format '\{x} \{y} \{width} \{height}'.
>
> **pages** `string`
>
> Comma-separated page indices or ranges to process (e.g. '0,2-4').
>
> **inline** `boolean`
>
> Return text inline in response instead of URL.
>
> **unwrap** `boolean`
>
> Unwrap lines into a single line within table cells (only when lineGrouping='1').
>
> **callback** `string`
>
> Webhook URL to receive callback when async=true.
>
> **password** `string`
>
> Password for protected PDF files.
>
> **run\_async** `boolean`
>
> Run process asynchronously; returns jobId if true.
>
> **expiration** `integer`
>
> Expiration time in minutes for the output file link.
>
> **httppassword** `string`
>
> HTTP auth password for source URL.
>
> **httpusername** `string`
>
> HTTP auth username for source URL.
>
> **lineGrouping** `string`
>
> Line grouping mode: '1', '2', or '3'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert PDF to TIFF
>
> **Slug:** `PDF_CO_PDF_TO_TIFF`
>
> Render PDF pages as TIFF with crop, OCR, and inline controls. Source HTTP authentication is available for non-managed calls.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> URL of the source PDF file.
>
> **lang** `string`
>
> OCR language code or combined language codes, such as 'eng+deu'.
>
> **name** `string`
>
> File name for the generated TIFF output.
>
> **rect** `string`
>
> Crop rectangle as x, y, width, and height coordinates.
>
> **pages** `string`
>
> Comma-separated zero-based page indices or ranges to render, such as '0,1,2-' or '!0'.
>
> **inline** `boolean`
>
> Return generated TIFF data inside the response.
>
> **password** `string`
>
> Password for a protected PDF file.
>
> **profiles** `string`
>
> Advanced PDF.co rendering settings as a string or object.
>
> **expiration** `integer`
>
> Lifetime of the temporary output links in minutes.
>
> **httppassword** `string`
>
> HTTP authentication password for the source URL.
>
> **httpusername** `string`
>
> HTTP authentication username for the source URL.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert PDF to WEBP
>
> **Slug:** `PDF_CO_PDF_TO_WEBP`
>
> Convert selected pages of a PDF into WEBP images.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Public URL of the source PDF file.
>
> **lang** `string`
>
> OCR language code or combined codes such as 'eng+deu'.
>
> **name** `string`
>
> File name for the generated WEBP output.
>
> **rect** `string`
>
> Crop rectangle in 'x y width height' PDF coordinates.
>
> **pages** `string`
>
> Zero-based page indices or ranges to convert, such as '0,2-5,7-'. Omit to convert all pages.
>
> **inline** `boolean`
>
> Whether to return generated WEBP data inline instead of output URLs.
>
> **password** `string`
>
> Password for an encrypted source PDF.
>
> **profiles** `string`
>
> Advanced PDF.co rendering settings as an object or profile string.
>
> **expiration** `integer`
>
> Number of minutes before temporary output links expire.
>
> **httppassword** `string`
>
> HTTP authentication password required to access the source URL.
>
> **httpusername** `string`
>
> HTTP authentication username required to access the source URL.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert PDF to XLS
>
> **Slug:** `PDF_CO_PDF_TO_XLS`
>
> Tool to convert PDF or scanned images to XLS format. Use when you need to extract tabular data into an Excel spreadsheet.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Link to the PDF file to be converted.
>
> **name** `string`
>
> Optional name for the output XLS file (must end with .xls).
>
> **pages** `string`
>
> Comma-separated page indices or ranges to convert (e.g., '1,3-5').
>
> **password** `string`
>
> Password for protected PDF files, if required.
>
> **profiles** `string`
>
> Advanced conversion settings in JSON format.
>
> **run\_async** `boolean`
>
> Run job asynchronously; returns jobId for status checking.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert PDF to XLSX
>
> **Slug:** `PDF_CO_PDF_TO_XLSX`
>
> Tool to convert PDF or scanned images to XLSX (Excel) format. Use when you need structured spreadsheet output from a PDF.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Link to the PDF file to be converted.
>
> **name** `string`
>
> Optional name for the output XLSX file (must end with .xlsx).
>
> **async** `boolean`
>
> Run job asynchronously; returns processId for status checking.
>
> **pages** `string`
>
> Comma-separated page indices or ranges to convert (e.g., '1,3-5').
>
> **inline** `boolean`
>
> If true, returns XLSX data inline; otherwise returns a URL to the XLSX.
>
> **encrypt** `boolean`
>
> If true, encrypts the output XLSX file.
>
> **password** `string`
>
> Password for protected PDF files, if required.
>
> **profiles** `string`
>
> Advanced conversion settings in JSON format.
>
> **expiration** `integer`
>
> Expiration time for the output link in minutes (default is 60).
>
> **optimization** `string`
>
> Optimization mode, e.g., 'ocr'.
>
> **columns0Based** `boolean`
>
> Set to true if column indices in profiles are zero-based.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert PDF to XML
>
> **Slug:** `PDF_CO_PDF_TO_XML`
>
> Tool to convert PDF or scanned images to XML format. Use when you need to extract structured data from PDF into XML.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Link to the PDF file to be converted.
>
> **pages** `string`
>
> Comma-separated page indices or ranges to convert (e.g., '1,3-5').
>
> **password** `string`
>
> Password for protected PDF files, if required.
>
> **profiles** `string`
>
> Advanced conversion settings in JSON format.
>
> **run\_async** `boolean`
>
> Run job asynchronously; returns jobId for status checking.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not

> [accordion] Convert Excel to PDF
>
> **Slug:** `PDF_CO_XLS_TO_PDF`
>
> Convert a selected Excel worksheet or CSV to PDF, optionally inline.
>
> **Instant:** Supported on the latest version.
>
> **Instant pricing:** Est. \$0.006 per 10 API credits; credits vary by operation and pages.
>
> #### Input Parameters
>
> **url** `string` *required*
>
> Public URL of the source XLS, XLSX, or CSV file.
>
> **name** `string`
>
> File name for the generated PDF.
>
> **inline** `boolean`
>
> Whether to return the generated PDF content in the response.
>
> **profiles** `string`
>
> Advanced PDF.co profile settings as a JSON string or JSON object.
>
> **expiration** `integer`
>
> Number of minutes before the temporary output link expires.
>
> **httppassword** `string`
>
> HTTP password when the source URL requires authentication.
>
> **httpusername** `string`
>
> HTTP username when the source URL requires authentication.
>
> **worksheetIndex** `string`
>
> Zero-based index of the worksheet to convert, provided as a string; the first worksheet is '0'.
>
> #### Output
>
> **data** `string` *required*
>
> Data from the action execution
>
> **error** `string`
>
> Error if any occurred during the execution of the action
>
> **successful** `boolean` *required*
>
> Whether or not the action execution was successful or not
