Skip to main content
PDF.co logo
  • 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

Slug: PDF_CO_ACCOUNT_BALANCE_INFOGet the PDF.co account balance and remaining credits using your own API key. Managed connections are not supported.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_BARCODE_GENERATEGenerate 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

string
Filename for the generated barcode (extension added automatically).
string
required
Barcode type (e.g., Code128, QRCode, Code39, PDF417).
string
required
Data/content to encode in the barcode.
boolean
Process request asynchronously.
integer
Margin (white border) size around barcode in pixels.
boolean
Display human-readable text below the barcode.
string
Font name for human-readable text (e.g., ‘Arial’).
integer
Font size (points) for human-readable text.
string
Barcode background color (hex or rgba).
string
Barcode foreground color (hex e.g., ‘#000000’ or rgba string).
integer
Image resolution in DPI.
number
Aspect ratio (width/height) for 2D barcodes.
string
Password to protect PDF if output format is ‘pdf’.
integer
Width of the barcode image in pixels.
string
Output image format (‘png’, ‘jpg’, ‘pdf’).
integer
Height of the barcode image in pixels.
boolean
Treat barcode value as case-sensitive.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_CONVERT_EXCEL_TO_CSVConvert 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

string
required
Link to source XLS or XLSX file to be converted to CSV
string
Desired name for the output CSV file
string
Pages to convert (e.g., ‘0-2,4’), default is all pages
boolean
If true, returns CSV data inline; otherwise returns URL to CSV
string
Password for a protected Excel file, if applicable
string
Conversion profiles in JSON format, see PDF.co docs for structure

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_CONVERT_EXCEL_TO_HTMLTool 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

string
required
URL to the source Excel file (xls, xlsx, or csv).
string
Name for the resulting HTML file (e.g., ‘report.html’).
boolean
Set to true to run the conversion asynchronously.
string
Conversion profiles as a JSON string.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_CONVERT_EXCEL_TO_JSONTool 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

string
required
Public URL of the source Excel/CSV file.
string
Desired name for the generated JSON file.
string
Comma-separated page indices or ranges to process, e.g., ‘1,3-5’.
string
Password for password-protected files.
string
Custom processing profiles in JSON format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_CONVERT_EXCEL_TO_TEXTTool 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

string
required
Link to the source Excel file (xls, xlsx, or csv).
string
Optional name for the output file.
string
Comma-separated list of sheet indices to convert, e.g., ‘0,2’.
boolean
Set to true to return data inline in response instead of URL.
boolean
Set to true to encrypt the resulting file.
string
Password for password-protected Excel files.
string
Conversion profiles in JSON format.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_CONVERT_EXCEL_TO_XMLConvert 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

string
required
URL to the source file (xls, xlsx or csv).
string
Output file name.
boolean
Set true to run asynchronously, returning a jobId.
boolean
Set true to return XML inline, otherwise returns file URL.
string
Callback URL for async mode, used when async is true.
object
Profiles settings.
integer
Link expiration time in minutes.
string
HTTP auth password for source URL.
string
HTTP auth user name for source URL.
string
Worksheet index as a string (0-based, e.g. ‘0’ for the first worksheet).
string
Initialization vector for decryption.
string
Initialization vector for encryption.
string
Decryption key.
string
Encryption key.
string ("AES128" | "AES192" | "AES256")
Decryption algorithm (AES128, AES192, AES256).
string ("AES128" | "AES192" | "AES256")
Encryption algorithm (AES128, AES192, AES256).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_DOCUMENT_PARSERParse 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

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.
string
Raw PDF file bytes to upload directly. Required if not providing a URL.
string
Custom name for the output/result file.
string
Comma-separated page indices or ranges to process (e.g., ‘0,2-4’). If not specified, all pages are processed.
boolean
Return parsed results inline in the response body instead of generating a file URL.
string
Password for protected PDF files.
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}})”}}}
boolean
Run parsing asynchronously and return a result URL instead of inline data.
string
Output format for parsed data: JSON, CSV, or XML. Default is JSON.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_FILE_UPLOADUpload 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

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.
object
File to upload to PDF.co. Either ‘file’ or ‘url’ must be provided, but not both.
string
Optional custom filename to assign on PDF.co (defaults to the file’s original name).
boolean
Whether to execute the upload asynchronously (defaults to false).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_GET_PRESIGNED_UPLOAD_URLGenerate URLs for directly uploading a named file to PDF.co. This action requires a non-managed connection.

Input Parameters

string
Name to assign to the uploaded file, including its extension.
string
Timeout for the output links in seconds.
string
MIME type that must be used as Content-Type when uploading to the returned presigned URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_JOB_CHECKCheck the status and result of an asynchronous PDF.co job using your own API key. Managed connections are not supported.

Input Parameters

boolean
Set true to forcibly check long-running jobs. When true, returns ‘unknown’ for invalid job IDs instead of ‘working’.
string
required
The unique identifier of the asynchronous job to check status for

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_ADDAdd 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

string
required
Link to the source PDF file
string
Desired name for the result PDF file
string
Comma-separated page indices (e.g., ‘0,2-4’) to process; defaults to all pages
array
required
List of objects to add (text, image, barcode, link, document, etc.). See API docs for structure.
string
Password for protected PDF, if needed
boolean
Run the process asynchronously; if true, returns a jobId for status checking

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_AUTO_ROTATEAutomatically 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

string
required
URL of the source PDF file to auto-rotate.
string
OCR language code, or two language codes joined with ’+’. When omitted, PDF.co uses its default language.
string
File name for the generated PDF.
object
Advanced PDF.co processing profile settings.
string
HTTP authentication password for accessing the source URL.
string
HTTP authentication username for accessing the source URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_CHANGE_TEXT_SEARCHABLEMake 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

string
required
Public URL of the source PDF file.
string
Comma-separated rectangle coordinates ‘left,top,width,height’ to limit OCR.
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.
boolean
Whether to return the processed PDF data inline (base64) or as a URL. Set to true for inline response, false for URL.
string
Language code for OCR (default: eng).
string
Password for encrypted PDF, if applicable.
string
JSON string with advanced OCR profiles and configurations.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_COMPRESSCompress 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

string
required
URL of the source PDF file to compress.
string
File name for the generated PDF.
object
Partial advanced compression configuration.
string
Password for opening a protected source PDF.
integer
Number of minutes before the temporary output link expires.
integer
JPEG quality for color and grayscale images from 1 to 100.
string ("low" | "medium" | "high" | "aggressive")
Ready-to-use PDF compression preset.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_CONVERT_TO_TEXT_SIMPLEExtract 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

string
required
URL of the source PDF file.
string
File name for the generated text output.
string
Comma-separated zero-based page indices or ranges to process, such as ‘0,1,2-’ or ‘!0’.
boolean
Return extracted text in the response instead of an output URL.
string
Password for a protected PDF file.
string
HTTP authentication password for the source URL.
string
HTTP authentication username for the source URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDFCO_POST_BARCODE_GENERATEGenerate 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

string
Output filename for the generated barcode image.
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.
boolean
Enable background processing; returns jobId for status checks. Defaults to false.
string
required
The string value to be encoded into the barcode.
boolean
Return results within response (true) or return URL (false). Defaults to false.
boolean
Enable encryption for the output file.
string
Webhook URL to receive results when async operation completes.
integer
Output link expiration time in minutes. Defaults to 60.
integer ("0" | "90" | "180" | "270")
Rotation angle in degrees. Defaults to 0.
string
Image URL for logo insertion within QR codes.
string
Set to ‘base64’ for base64-encoded output.
string
Caption text font and size. Defaults to ‘Arial, 12’.
integer
Narrow bar width in pixels. Defaults to 3.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDFCO_POST_FILE_UPLOAD_BASE64Upload 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

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…’
string
Custom file name for the output. If not provided, a default name will be used.
integer
Link expiration time in minutes. Default is 60 minutes. Maximum varies by subscription plan. The temporary file is automatically deleted after expiration.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_DELETE_PAGESDelete selected pages from a PDF using your own PDF.co API key. Managed connections are not supported.

Input Parameters

string
required
URL or base64-encoded content of the source PDF.
string
Optional name for the resulting PDF file.
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.
string
Password for protected PDF file.
string
Optional JSON string for advanced configuration.
boolean
Process request asynchronously. If true, returns a job ID instead of immediate URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_EXTRACT_ATTACHMENTSExtract embedded attachments from a PDF at a URL. This action requires your own PDF.co connection and is unavailable for managed calls.

Input Parameters

string
required
URL of the input PDF file to process.
boolean
If true, returns attachment data inline; otherwise returns URLs.
string
Webhook URL for receiving async results.
string
Password for protected PDF file (if applicable).
boolean
Run processing asynchronously. If true, returns a jobId for async processing.
integer
Set the expiration time for the output link in minutes. Default is 60.
string
HTTP authentication password for accessing the source URL.
string
HTTP authentication username for accessing the source URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_FINDTool 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

string
required
Publicly accessible URL of the PDF file to search.
string
Comma-separated page ranges to search, e.g., ‘1-3,5’.
string
Password for protected PDF, if applicable.
string
Advanced JSON configuration for PDF processing.
Whether to treat searchString as a regular expression (default: false).
string
required
Keyword or regex pattern to find in the document.
boolean
Whether the search is case-sensitive (default: false).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_FIND_TABLEDetect 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

string
required
URL of the source PDF file.
string
Comma-separated zero-based page indices or ranges to process, such as ‘0,1,2-’ or ‘!0’.
boolean
Return table data directly in the response.
string
Password for a protected PDF file.
string
Advanced PDF.co settings as a JSON string or object.
string
HTTP authentication password for the source URL.
string
HTTP authentication username for the source URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_FORMS_INFO_READERTool 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

string
required
Publicly accessible URL of the PDF file containing form fields.
boolean
If true, runs the job asynchronously and returns a jobId for status checking.
string
Password for encrypted PDF, if applicable.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_FROM_CSVConvert 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

string
required
Public URL of the source CSV, XLS, or XLSX file to convert.
string
File name for the generated PDF.
string
Zero-based page indices or ranges to convert, such as ‘0,2-4’.
boolean
Whether to adjust output page dimensions to the worksheet content.
string
Advanced PDF.co profile settings as a JSON string or JSON object.
integer
Number of minutes before the temporary output link expires.
string
HTTP password when the source URL requires authentication.
string
HTTP username when the source URL requires authentication.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_FROM_DOCUMENT_TXTTool 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

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.
string
required
Name of the resulting PDF file (e.g., ‘result.pdf’).
string
Optional JSON-formatted string with advanced API options.
boolean
Run processing asynchronously; if true, returns a jobId for status checking.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_FROM_EMAILConvert 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

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.
string
Optional name for the resulting PDF file.
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. Leave unset unless you have a valid profile.
boolean
Run processing asynchronously; if true, returns a jobId for status checking.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_FROM_HTMLConvert 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

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.
string
Desired output filename for the PDF result.
boolean
Run conversion as background job; returns jobId when true.
HTML snippet for page footers applied to each page.
string
HTML snippet for page headers applied to each page.
string
Custom page margins in ‘{top} {right} {bottom} {left}’ format (units: px, mm, cm, in).
string
Webhook URL to receive asynchronous results when async=true.
string
Advanced conversion profiles/settings as JSON string.
string
CSS media type: ‘print’, ‘screen’, or ‘none’.
string
Paper size: standard like ‘Letter’, ‘Legal’, ‘A4’–‘A6’, or custom ‘200px 300px’, ‘8in 10in’.
integer
Expiration time in minutes for the output file link.
string
Document orientation: ‘Portrait’ or ‘Landscape’.
boolean
Include background graphics (colors/images) if true.
boolean
If true, speeds up conversion by not waiting for full page load.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_FROM_IMAGEConvert 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

string
required
Public URL of an input JPG, PNG, or TIFF image. Separate multiple image URLs with commas.
string
File name for the generated PDF.
string
Zero-based page indices or ranges to process, such as ‘0,1,2-’ or ‘!0’.
string
Advanced PDF.co conversion settings as a JSON-formatted string.
integer
Lifetime of the temporary output link in minutes.
string
HTTP authentication password for accessing the source URL.
string
HTTP authentication username for accessing the source URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_FROM_URLSynchronously 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

string
required
Public webpage URL to convert to PDF.
string
File name for the generated PDF.
HTML inserted in the footer of every output page.
string
HTML inserted in the header of every output page.
string
Page margins as one value or as top, right, bottom, and left values using px, mm, cm, or in units.
string
Advanced PDF.co conversion settings as a JSON-formatted string.
string ("print" | "screen" | "none")
CSS media type used to render the webpage.
string
Standard paper size such as Letter or A4, or a custom width and height such as ‘200mm 300mm’.
integer
Number of minutes before the temporary output link expires.
string ("Portrait" | "Landscape")
Portrait or landscape page orientation.
integer
Maximum webpage rendering time in milliseconds, up to 177000.
boolean
Whether to render with PDF.co’s legacy Chromium version.
boolean
Whether to include webpage background colors and images.
boolean
Whether to begin conversion after minimal loading instead of waiting for the full page load.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_INFO_READERTool 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

string
required
URL to the source PDF file

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_MERGETool 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

string
Optional name for the resulting PDF file (must end with .pdf)
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.
string
(Advanced) Custom JSON profiles for processing.
boolean
Run the merge asynchronously; if true returns a jobId for status checking.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_OPTIMIZEOptimize 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

string
required
URL of the source PDF file to optimize.
string
File name for the generated PDF.
string
Password for a protected source PDF.
string
PDF.co optimization profile settings as a profile string or object.
integer
Number of minutes before the temporary output link expires.
string
HTTP authentication password for accessing the source URL.
string
HTTP authentication username for accessing the source URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_REPLACE_TEXT_WITH_IMAGEReplace 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

string
required
URL of the source PDF file.
string
File name for the generated PDF.
string
Comma-separated zero-based page indices or ranges to process, such as ‘0,1,2-’ or ‘!0’.
boolean
Whether searchString is interpreted as a regular expression.
string
Password for a protected PDF file.
string
Advanced PDF.co settings as a JSON string or object.
integer
Number of minutes before the temporary output link expires.
string
HTTP authentication password for the source URL.
string
HTTP authentication username for the source URL.
string
required
Image URL or data URI to insert in place of the matched text.
string
required
Text or regular expression to replace.
boolean
Whether text matching is case-sensitive.
integer
Maximum replacements per search item; zero replaces every occurrence.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_ROTATETool 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

string
required
URL of the source PDF file to rotate
string
Optional filename for the resulting PDF (should end with .pdf)
integer ("90" | "180" | "270")
required
Rotation angle in degrees; must be one of 90, 180, or 270
string
required
Comma-separated list of page indices or ranges to rotate (e.g., ‘0,2-5’)
string
Password for encrypted PDFs, if required
boolean
Run the operation asynchronously; if true, returns a jobId for status checking

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_SEARCH_AND_DELETE_TEXTSearch 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

string
required
URL or base64 content of the source PDF file.
string
Desired output filename for the PDF result.
boolean
Run operation asynchronously. Returns jobId if true.
string
Comma-separated list of page indices or ranges to process (0-based), e.g., ‘0,2-5’.
boolean
Treat searchString as regular expression.
string
Password for protected PDF if required.
string
required
Text string or regex pattern to search and delete.
boolean
Enable case-sensitive matching. Default is true.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_SEARCH_AND_REPLACE_TEXTTool 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

string
required
Publicly accessible URL of the source PDF file.
string
Optional name for the resulting PDF file.
boolean
Set to true to run process asynchronously (returns jobId).
string
Password for protected PDF, if required.
boolean
Enable regular expression search if true.
string
required
Text to search for in the document.
string
required
Text to replace each found occurrence with.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_SECURITY_ADDCreate 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

string
required
URL of the source PDF file to secure.
string
File name for the generated PDF.
object
Advanced PDF.co profile settings.
integer
Number of minutes before the temporary output link expires.
string ("LowResolution" | "HighResolution")
Printing quality allowed for the secured PDF.
string
Password required to view or print the PDF; this password alone cannot change document restrictions.
string
Owner password used to encrypt the PDF and change document restrictions; it is required when modifying any allow* restriction.
boolean
Whether to allow filling interactive form and signature fields; ownerPassword is required to modify this restriction.
boolean
Whether to allow printing; ownerPassword is required to modify this restriction.
boolean
Whether to allow document modification; ownerPassword is required to modify this restriction.
string ("RC4_40bit" | "RC4_128bit" | "AES_128bit" | "AES_256bit")
Encryption algorithm for the secured PDF.
boolean
Whether to allow document assembly; ownerPassword is required to modify this restriction.
boolean
Whether to allow copying PDF content; ownerPassword is required to modify this restriction.
boolean
Whether to allow interaction with annotations and forms; ownerPassword is required to modify this restriction.
boolean
Whether to allow content extraction for accessibility; ownerPassword is required to modify this restriction.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_SECURITY_REMOVERemove 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

string
required
URL of the source password-protected PDF file.
string
File name for the generated unprotected PDF.
string
Password for the source PDF file.
object
Advanced PDF.co profile settings.
integer
Number of minutes before the temporary output link expires.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_SPLITTool 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

string
Public URL of the PDF file to split.
object
PDF file to upload for splitting instead of using a URL.
string
Base name for output files; each part receives a suffix.
string
Comma-separated or dash page ranges to split, e.g. ‘1-2,4’. 1-based indexing; omit to split all pages.
boolean
Return split documents inline (base64) instead of URLs.
string
Webhook URL for async notifications; only used when run_async is True.
string
Owner password for encrypted PDF files, if any.
object
Advanced processing profiles as JSON-formatted dict.
boolean
Run processing asynchronously; returns jobId instead of immediate results.
integer
Minutes before temporary output links expire; default is service default.
string
HTTP basic auth password if the source URL is protected.
string
HTTP basic auth username if the source URL is protected.
string
Base64-encoded IV for output data encryption.
string
Set to ‘base64’ to return split PDFs as base64 strings.
string
Base64-encoded key for output data encryption.
string
Algorithm for user-controlled output encryption (AES128, AES192, AES256).

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_TO_CSVTool 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

string
required
Link to the PDF file to be converted.
string
Language for OCR text recognition (e.g., ‘eng’, ‘deu’).
string
Optional name for the output CSV file (must end with .csv).
string
Comma-separated page indices or ranges to convert (e.g., ‘1,3-5’).
boolean
If true, returns CSV data inline; otherwise returns a URL to the CSV.
boolean
If true, encrypts the output CSV file.
string
Password for protected PDF files, if required.
string
Advanced conversion settings in JSON format.
boolean
Run job asynchronously; returns jobId for status checking.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_TO_HTMLTool 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

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.
string
Binary content of the PDF file to upload as an alternative to ‘url’.
string
Desired name for the resulting HTML file (e.g., ‘result.html’).
string
Comma-separated page indices or ranges to convert (e.g., ‘0,2-4’).
boolean
If true, returns raw HTML in the ‘body’ field instead of a URL link.
boolean
Whether to encrypt the output HTML file.
string
Password for protected PDF files, if required.
string
Additional conversion profiles as a JSON string.
boolean
Set to true to run the conversion asynchronously.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_TO_IMAGEConvert 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

integer
Resolution in DPI for the output images (1-300).
string
required
Link to the source PDF file.
boolean
Run processing asynchronously. Returns jobId when true.
string
Comma-separated list of page indices or ranges to convert. For example: ‘1,3-5’ to convert pages 1, 3, 4, and 5.
string
Password for protected PDF files, if required.
string
Custom JSON profiles for advanced conversion options.
string ("PNG" | "JPG" | "TIFF")
Output image format: PNG (default), JPG, or TIFF.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_TO_JSONConvert PDF or scanned images to a structured JSON representation using a connected PDF.co account. This action is unavailable for managed calls.

Input Parameters

string
Link to the PDF file to be converted.
string
Binary content of the PDF file to convert.
string
Optional name for the output JSON file (should end with .json).
boolean
If true, runs the job asynchronously; returns jobId for status checking.
string
Comma-separated page indices or ranges to convert (e.g., ‘1,3-5’).
boolean
If true, returns JSON data inline; otherwise returns a URL.
string
Password for protected PDF files, if required.
string
Advanced conversion configuration in JSON format.
string
Optional text to search for in the PDF before conversion.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_TO_TEXTTool 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

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.
string
OCR language(s) code, e.g. ‘eng’, or ‘eng+deu’.
string
Desired name for the output file (e.g. ‘result.txt’).
string
Extraction rectangle in format ‘{x} {y} {width} {height}’.
string
Comma-separated page indices or ranges to process (e.g. ‘0,2-4’).
boolean
Return text inline in response instead of URL.
boolean
Unwrap lines into a single line within table cells (only when lineGrouping=‘1’).
string
Webhook URL to receive callback when async=true.
string
Password for protected PDF files.
boolean
Run process asynchronously; returns jobId if true.
integer
Expiration time in minutes for the output file link.
string
HTTP auth password for source URL.
string
HTTP auth username for source URL.
string
Line grouping mode: ‘1’, ‘2’, or ‘3’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_TO_TIFFRender 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

string
required
URL of the source PDF file.
string
OCR language code or combined language codes, such as ‘eng+deu’.
string
File name for the generated TIFF output.
string
Crop rectangle as x, y, width, and height coordinates.
string
Comma-separated zero-based page indices or ranges to render, such as ‘0,1,2-’ or ‘!0’.
boolean
Return generated TIFF data inside the response.
string
Password for a protected PDF file.
string
Advanced PDF.co rendering settings as a string or object.
integer
Lifetime of the temporary output links in minutes.
string
HTTP authentication password for the source URL.
string
HTTP authentication username for the source URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_TO_WEBPConvert 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

string
required
Public URL of the source PDF file.
string
OCR language code or combined codes such as ‘eng+deu’.
string
File name for the generated WEBP output.
string
Crop rectangle in ‘x y width height’ PDF coordinates.
string
Zero-based page indices or ranges to convert, such as ‘0,2-5,7-’. Omit to convert all pages.
boolean
Whether to return generated WEBP data inline instead of output URLs.
string
Password for an encrypted source PDF.
string
Advanced PDF.co rendering settings as an object or profile string.
integer
Number of minutes before temporary output links expire.
string
HTTP authentication password required to access the source URL.
string
HTTP authentication username required to access the source URL.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_TO_XLSTool 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

string
required
Link to the PDF file to be converted.
string
Optional name for the output XLS file (must end with .xls).
string
Comma-separated page indices or ranges to convert (e.g., ‘1,3-5’).
string
Password for protected PDF files, if required.
string
Advanced conversion settings in JSON format.
boolean
Run job asynchronously; returns jobId for status checking.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_TO_XLSXTool 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

string
required
Link to the PDF file to be converted.
string
Optional name for the output XLSX file (must end with .xlsx).
boolean
Run job asynchronously; returns processId for status checking.
string
Comma-separated page indices or ranges to convert (e.g., ‘1,3-5’).
boolean
If true, returns XLSX data inline; otherwise returns a URL to the XLSX.
boolean
If true, encrypts the output XLSX file.
string
Password for protected PDF files, if required.
string
Advanced conversion settings in JSON format.
integer
Expiration time for the output link in minutes (default is 60).
string
Optimization mode, e.g., ‘ocr’.
boolean
Set to true if column indices in profiles are zero-based.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_PDF_TO_XMLTool 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

string
required
Link to the PDF file to be converted.
string
Comma-separated page indices or ranges to convert (e.g., ‘1,3-5’).
string
Password for protected PDF files, if required.
string
Advanced conversion settings in JSON format.
boolean
Run job asynchronously; returns jobId for status checking.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not
Slug: PDF_CO_XLS_TO_PDFConvert 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

string
required
Public URL of the source XLS, XLSX, or CSV file.
string
File name for the generated PDF.
boolean
Whether to return the generated PDF content in the response.
string
Advanced PDF.co profile settings as a JSON string or JSON object.
integer
Number of minutes before the temporary output link expires.
string
HTTP password when the source URL requires authentication.
string
HTTP username when the source URL requires authentication.
string
Zero-based index of the worksheet to convert, provided as a string; the first worksheet is ‘0’.

Output

string
required
Data from the action execution
string
Error if any occurred during the execution of the action
boolean
required
Whether or not the action execution was successful or not