Server Configuration
Describes the environment variables required to run the server.
| Name | Required | Description | Default |
|---|---|---|---|
| X_API_KEY | Yes | Your PDF.co API key, obtained from the PDF.co dashboard |
Schema
Prompts
Interactive templates invoked by user choice
| Name | Description |
|---|---|
No prompts | |
Resources
Contextual data attached and managed by the client
| Name | Description |
|---|---|
No resources | |
Tools
Functions exposed to the LLM to take actions
| Name | Description |
|---|---|
| pdf_to_json | 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-reference/pdf-to-json/basic.md |
| pdf_to_csv | Convert PDF and scanned images into CSV representation with layout, columns, rows, and tables.
Ref: https://developer.pdf.co/api-reference/pdf-to-csv.md |
| pdf_to_text | Convert PDF and scanned images to text with layout preserved.
Ref: https://developer.pdf.co/api-reference/pdf-to-text/basic.md |
| pdf_to_xls | Convert PDF and scanned images to XLS (Excel 97-2003) format.
Ref: https://developer.pdf.co/api-reference/pdf-to-excel/xls.md |
| pdf_to_xlsx | Convert PDF and scanned images to XLSX (Excel 2007+) format.
Ref: https://developer.pdf.co/api-reference/pdf-to-excel/xlsx.md |
| pdf_to_xml | Convert PDF and scanned images to XML format.
Ref: https://developer.pdf.co/api-reference/pdf-to-xml.md |
| pdf_to_html | Convert PDF and scanned images to HTML format.
Ref: https://developer.pdf.co/api-reference/pdf-to-html.md |
| pdf_to_image | Convert PDF and scanned images to various image formats (JPG, PNG, WebP, TIFF).
Ref:
- https://developer.pdf.co/api-reference/pdf-to-image/jpg.md
- https://developer.pdf.co/api-reference/pdf-to-image/png.md
- https://developer.pdf.co/api-reference/pdf-to-image/webp.md
- https://developer.pdf.co/api-reference/pdf-to-image/tiff.md |
| 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-reference/pdf-from-document/doc.md |
| csv_to_pdf | Convert CSV or spreadsheet files (XLS, XLSX) to PDF.
Ref: https://developer.pdf.co/api-reference/pdf-from-document/csv.md |
| image_to_pdf | Convert various image formats (JPG, PNG, TIFF) to PDF.
Ref: https://developer.pdf.co/api-reference/pdf-from-image.md
``` |
| webpage_to_pdf | Convert external webpage URL to PDF.
Ref: https://developer.pdf.co/api-reference/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> |
| html_to_pdf | Convert HTML to PDF.
Ref: https://developer.pdf.co/api-reference/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> |
| email_to_pdf | Convert email to PDF.
Ref: https://developer.pdf.co/api-reference/pdf-from-email.md |
| excel_to_csv | Convert Excel(XLS, XLSX) to CSV.
Ref: https://developer.pdf.co/api-reference/convert-from-excel/csv.md |
| excel_to_json | Convert Excel(XLS, XLSX) to JSON.
Ref: https://developer.pdf.co/api-reference/convert-from-excel/json.md |
| excel_to_html | Convert Excel(XLS, XLSX) to HTML.
Ref: https://developer.pdf.co/api-reference/convert-from-excel/html.md |
| excel_to_txt | Convert Excel(XLS, XLSX) to TXT.
Ref: https://developer.pdf.co/api-reference/convert-from-excel/text.md |
| excel_to_xml | Convert Excel(XLS, XLSX) to XML.
Ref: https://developer.pdf.co/api-reference/convert-from-excel/xml.md |
| excel_to_pdf | Convert Excel(XLS, XLSX) to PDF.
Ref: https://developer.pdf.co/api-reference/convert-from-excel/pdf.md |
| 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. |
| wait_job_completion | Wait for a job to complete |
| upload_file | Upload a file to the PDF.co API |
| pdf_merge | 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-reference/merge/various-files.md |
| pdf_split | Split a PDF into multiple PDF files using page indexes or page ranges.
Ref: https://developer.pdf.co/api-reference/pdf-split/by-pages.md |
| read_pdf_forms_info | Extracts information about fillable PDF fields from an input PDF file.
Ref: https://developer.pdf.co/api-reference/forms/info-reader.md |
| fill_forms | 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-reference/pdf-add#create-fillable-pdf-forms.md |
| 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-reference/pdf-add#create-fillable-pdf-forms.md |
| find_text | Find text in PDF and get coordinates. Supports regular expressions.
Ref: https://developer.pdf.co/api-reference/pdf-find/basic.md |
| find_table | Find tables in PDF and get their coordinates.
Ref: https://developer.pdf.co/api-reference/pdf-find/table.md |
| 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-reference/pdf-change-text-searchable/searchable.md |
| pdf_make_unsearchable | Make existing PDF document non-searchable by removing the text layer from it.
Ref: https://developer.pdf.co/api-reference/pdf-change-text-searchable/unsearchable.md |
| pdf_add_password | Add password protection to a PDF file.
Ref: https://developer.pdf.co/api-reference/pdf-password/add.md |
| pdf_remove_password | Remove password protection from a PDF file.
Ref: https://developer.pdf.co/api-reference/pdf-password/remove.md |
| 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-reference/pdf-info-reader.md |
| ai_invoice_parser | AI Invoice Parser: Extracts data from invoices using AI.
Ref: https://developer.pdf.co/api-reference/ai-invoice-parser.md |
| extract_attachments | Extracts attachments from a source PDF file.
Ref: https://developer.pdf.co/api-reference/pdf-extract-attachments.md |
| 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-reference/pdf-add.md |