Convert PDF and scanned images into JSON representation with text, fonts, images, vectors, and formatting preserved using the /pdf/convert/to/json2 endpoint.
Ref: https://developer.pdf.co/api/pdf-to-json/basic.md
Parametersurlrequiredlangnamerectpagesunwrapapi_keypasswordprofilesexpirationhttppasswordhttpusername+1 more
Convert PDF and scanned images into CSV representation with layout, columns, rows, and tables.
Ref: https://developer.pdf.co/api/pdf-to-csv.md
Parametersurlrequiredlangnamerectpagesunwrapapi_keypasswordprofilesexpirationhttppasswordhttpusername+1 more
Convert PDF and scanned images to text with layout preserved.
Ref: https://developer.pdf.co/api/pdf-to-text/basic.md
Parametersurlrequiredlangnamerectpagesunwrapapi_keypasswordprofilesexpirationhttppasswordhttpusername+1 more
Convert PDF and scanned images to XLS (Excel 97-2003) format.
Ref: https://developer.pdf.co/api/pdf-to-excel/xls.md
Parametersurlrequiredlangnamerectpagesunwrapapi_keypasswordprofilesexpirationhttppasswordhttpusername+1 more
Convert PDF and scanned images to XLSX (Excel 2007+) format.
Ref: https://developer.pdf.co/api/pdf-to-excel/xlsx.md
Parametersurlrequiredlangnamerectpagesunwrapapi_keypasswordprofilesexpirationhttppasswordhttpusername+1 more
Convert PDF and scanned images to XML format.
Ref: https://developer.pdf.co/api/pdf-to-xml.md
Parametersurlrequiredlangnamerectpagesunwrapapi_keypasswordprofilesexpirationhttppasswordhttpusername+1 more
Convert PDF and scanned images to HTML format.
Ref: https://developer.pdf.co/api/pdf-to-html.md
Parametersurlrequiredlangnamerectpagesunwrapapi_keypasswordprofilesexpirationhttppasswordhttpusername+1 more
Convert PDF and scanned images to various image formats (JPG, PNG, WebP, TIFF).
Ref:
- https://developer.pdf.co/api/pdf-to-image/jpg.md
- https://developer.pdf.co/api/pdf-to-image/png.md
- https://developer.pdf.co/api/pdf-to-image/webp.md
- https://developer.pdf.co/api/pdf-to-image/tiff.md
Parametersurlrequiredlangnamerecttypepagesunwrapapi_keypasswordprofilesexpirationhttppassword+2 more
document_to_pdf
Document To Pdf
Convert various document types (DOC, DOCX, RTF, TXT, XLS, XLSX, CSV, HTML, JPG, PNG, TIFF, WEBP) into PDF.
Ref: https://developer.pdf.co/api/pdf-from-document/doc.md
Parametersurlrequirednamepagesapi_keyautosizeprofilesexpirationhttppasswordhttpusername
Convert CSV or spreadsheet files (XLS, XLSX) to PDF.
Ref: https://developer.pdf.co/api/pdf-from-document/csv.md
Parametersurlrequirednamepagesapi_keyautosizeprofilesexpirationhttppasswordhttpusername
Convert various image formats (JPG, PNG, TIFF) to PDF.
Ref: https://developer.pdf.co/api/pdf-from-image.md
```
Parametersurlrequirednamepagesapi_keyprofilesexpirationhttppasswordhttpusername
webpage_to_pdf
Webpage To Pdf
Convert external webpage URL to PDF.
Ref: https://developer.pdf.co/api/pdf-from-url.md
The header and footer parameters can contain valid HTML markup with the following classes used to inject printing values into them:
- date: formatted print date
- title: document title
- url: document location
- pageNumber: current page number
- totalPages: total pages in the document
- img: tag is supported in both the header and footer parameter, provided that the src attribute is specified as a base64-encoded string.
For example, the following markup will generate Page N of NN page numbering:
```html
<span style='font-size:10px'>Page <span class='pageNumber'></span> of <span class='totalPages'></span>.</span>
Parametersurlrequirednamefooterheaderapi_keymarginsprofilesmediaTypepaperSizeexpirationorientationhttppassword+3 more
Convert HTML to PDF.
Ref: https://developer.pdf.co/api/pdf-from-html/convert.md
The header and footer parameters can contain valid HTML markup with the following classes used to inject printing values into them:
- date: formatted print date
- title: document title
- url: document location
- pageNumber: current page number
- totalPages: total pages in the document
- img: tag is supported in both the header and footer parameter, provided that the src attribute is specified as a base64-encoded string.
For example, the following markup will generate Page N of NN page numbering:
```html
<span style='font-size:10px'>Page <span class='pageNumber'></span> of <span class='totalPages'></span>.</span>
Parametershtmlrequirednamefooterheaderapi_keymarginsprofilesmediaTypepaperSizeexpirationorientationhttppassword+3 more
Convert email to PDF.
Ref: https://developer.pdf.co/api/pdf-from-email.md
Parametersurlrequiredapi_keymarginsprofilespaperSizeexpirationorientationembedAttachmentsconvertAttachments
Convert Excel(XLS, XLSX) to CSV.
Retiring on January 5, 2027: the underlying PDF.co API endpoint is being discontinued. The tool keeps working until that date and will be removed afterwards.
Ref: https://developer.pdf.co/api/convert-from-excel/csv.md
Parametersurlrequirednameapi_keyprofilesexpirationhttppasswordhttpusernameworksheetIndex
excel_to_json
Excel To Json
Convert Excel(XLS, XLSX) to JSON.
Retiring on January 5, 2027: the underlying PDF.co API endpoint is being discontinued. The tool keeps working until that date and will be removed afterwards.
Ref: https://developer.pdf.co/api/convert-from-excel/json.md
Parametersurlrequirednameapi_keyprofilesexpirationhttppasswordhttpusernameworksheetIndex
excel_to_html
Excel To Html
Convert Excel(XLS, XLSX) to HTML.
Retiring on January 5, 2027: the underlying PDF.co API endpoint is being discontinued. The tool keeps working until that date and will be removed afterwards.
Ref: https://developer.pdf.co/api/convert-from-excel/html.md
Parametersurlrequirednameapi_keyprofilesexpirationhttppasswordhttpusernameworksheetIndex
Convert Excel(XLS, XLSX) to TXT.
Retiring on January 5, 2027: the underlying PDF.co API endpoint is being discontinued. The tool keeps working until that date and will be removed afterwards.
Ref: https://developer.pdf.co/api/convert-from-excel/text.md
Parametersurlrequirednameapi_keyprofilesexpirationhttppasswordhttpusernameworksheetIndex
Convert Excel(XLS, XLSX) to XML.
Retiring on January 5, 2027: the underlying PDF.co API endpoint is being discontinued. The tool keeps working until that date and will be removed afterwards.
Ref: https://developer.pdf.co/api/convert-from-excel/xml.md
Parametersurlrequirednameapi_keyprofilesexpirationhttppasswordhttpusernameworksheetIndex
Convert Excel(XLS, XLSX) to PDF.
Ref: https://developer.pdf.co/api/convert-from-excel/pdf.md
Parametersurlrequirednameapi_keyprofilesexpirationhttppasswordhttpusernameworksheetIndex
get_job_check
Get Job Check
Check the status and results of a job
Status can be:
- working: background job is currently in work or does not exist.
- success: background job was successfully finished.
- failed: background job failed for some reason (see message for more details).
- aborted: background job was aborted.
- unknown: unknown background job id. Available only when force is set to true for input request.
Parametersjob_idrequiredapi_key
wait_job_completion
Wait Job Completion
Wait for a job to complete
Parametersjob_idrequiredapi_keytimeoutinterval
Upload a file to the PDF.co API
Parametersapi_keyfile_pathrequired
Merge PDF from two or more PDF, DOC, XLS, images, even ZIP with documents and images into a new PDF.
Ref: https://developer.pdf.co/api/merge/various-files.md
Parametersurlrequirednameapi_keyprofilesexpirationhttppasswordhttpusername
Split a PDF into multiple PDF files using page indexes or page ranges.
Ref: https://developer.pdf.co/api/pdf-split/by-pages.md
Parametersurlrequirednamepagesrequiredapi_keypasswordprofilesexpirationhttppasswordhttpusername
read_pdf_forms_info
Read Pdf Forms Info
Extracts information about fillable PDF fields from an input PDF file.
Ref: https://developer.pdf.co/api/forms/info-reader.md
Parametersurlrequiredapi_keypasswordprofilesexpirationhttppasswordhttpusername
Fill existing form fields in a PDF document.
Example fields format:
[
{
"fieldName": "field_name_from_form_info",
"pages": "1",
"text": "Value to fill"
}
]
Use 'read_pdf_forms_info' first to get the fieldName values of the form.
Ref: https://developer.pdf.co/api/pdf-add.md
Parametersurlrequirednamefieldsrequiredapi_keyprofilesexpirationhttppasswordhttpusername
create_fillable_forms
Create Fillable Forms
Create new fillable form elements in a PDF document.
Example annotations format:
[
{
"text": "prefilled text",
"x": 10,
"y": 30,
"size": 12,
"pages": "0-",
"type": "TextField",
"id": "textfield1"
},
{
"x": 100,
"y": 150,
"size": 12,
"pages": "0-",
"type": "Checkbox",
"id": "checkbox1"
}
]
Ref: https://developer.pdf.co/api/pdf-add.md
Parametersurlrequirednameapi_keyprofilesexpirationannotationsrequiredhttppasswordhttpusername
Find text in PDF and get coordinates. Supports regular expressions.
Ref: https://developer.pdf.co/api/pdf-find/basic.md
Parametersurlrequiredpagesapi_keypasswordprofilesexpirationregexSearchhttppasswordhttpusernamesearchStringrequiredwordMatchingMode
Find tables in PDF and get their coordinates.
Ref: https://developer.pdf.co/api/pdf-find/table.md
Parametersurlrequiredpagesapi_keypasswordprofilesexpirationhttppasswordhttpusername
pdf_make_searchable
Pdf Make Searchable
Convert scanned PDF documents or image files into a text-searchable PDF.
Runs OCR and adds an invisible text layer that can be used for text search.
Ref: https://developer.pdf.co/api/pdf-change-text-searchable/searchable.md
Parametersurlrequiredlangnamepagesapi_keypasswordprofilesexpirationhttppasswordhttpusername
pdf_make_unsearchable
Pdf Make Unsearchable
Make existing PDF document non-searchable by removing the text layer from it.
Ref: https://developer.pdf.co/api/pdf-change-text-searchable/unsearchable.md
Parametersurlrequirednamepagesapi_keypasswordprofilesexpirationhttppasswordhttpusername
pdf_add_password
Pdf Add Password
Add password protection to a PDF file.
Ref: https://developer.pdf.co/api/pdf-password/add.md
Parametersurlrequirednameapi_keypasswordprofilesexpirationhttppasswordhttpusernameprint_qualityuser_passwordowner_passwordrequiredallow_fill_forms+7 more
pdf_remove_password
Pdf Remove Password
Remove password protection from a PDF file.
Ref: https://developer.pdf.co/api/pdf-password/remove.md
Parametersurlrequirednameapi_keypasswordprofilesexpirationhttppasswordhttpusername
pdf_info_reader
Pdf Info Reader
Get detailed information about a PDF document - number of pages, metadata, security, form fields, and more.
Ref: https://developer.pdf.co/api/pdf-info-reader.md
Parametersurlrequiredapi_keypasswordprofilesexpirationhttppasswordhttpusername
ai_invoice_parser
Ai Invoice Parser
AI Invoice Parser: Extracts data from invoices using AI.
Ref: https://developer.pdf.co/api/ai-invoice-parser.md
Parametersurlrequiredapi_key
pdf_add_annotations_images_fields
Pdf Add Annotations Images Fields
Add text, images, forms, other PDFs, fill forms, links to external sites and external PDF files. You can update or modify PDF and scanned PDF files.
This tool supports three main ways to add content:
1. **annotations**: Add text, links, shapes, etc.
Properties: text, x, y, size, pages, color, link, fontName, fontItalic, fontBold, fontStrikeout, fontUnderline
2. **images**: Add images or other PDF content
Properties: url, x, y, width, height, pages
3. **fields**: Fill existing form fields
Properties: fieldName, pages, text, fontName, size, fontBold, fontItalic, fontStrikeout, fontUnderline
Example annotations:
[{"text": "Sample Text - Click here to test link", "x": 250, "y": 240, "size": 24, "pages": "0-", "color": "CCBBAA", "link": "https://pdf.co/", "fontName": "Comic Sans MS", "fontItalic": true, "fontBold": true, "fontStrikeout": false, "fontUnderline": true}]
Example images:
[{"url": "https://pdfco-test-files.s3.us-west-2.amazonaws.com/pdf-edit/logo.png", "x": 270, "y": 150, "width": 159, "height": 43, "pages": "0"}]
Example fields:
[{"fieldName": "topmostSubform[0].Page1[0].YourSocial_ReadOrderControl[0].f1_05[0]", "pages": "1", "text": "Joan B.", "fontName": "Arial", "size": 6, "fontBold": true, "fontItalic": true, "fontStrikeout": true, "fontUnderline": true}]
Ref: https://developer.pdf.co/api/pdf-add.md
Parametersurlrequirednamefieldsimagesapi_keyencryptflattenpasswordprofilesexpirationannotationshttppassword+1 more