PDF.co
PYPI · PDFCO-MCP
Official PDF.co MCP server: convert, merge, split, OCR, search and fill PDFs through the PDF.co API
Available components
Last scanned (21 hours ago)
Scores higher than 56% of PyPI servers
Category Documents and Files
How this component scores in each security and reliability category. Every signal is checked automatically from public evidence about the published package, including repeated runs of it in an isolated sandbox, and we only credit what we can confirm. How we score → Why this is hard to score →
Supply Chain Security50
- Malware scan not yet available for this package.Unverified
- No known CVEs affecting this package version or its production dependencies.Pass
- Runs hatchling.build at install time, a recognised build step with no custom scripting around it. View diagnostics → Pass
- 2 of 40 dependencies flagged as unhealthy. View diagnostics → Partial
Provenance & Transparency32
- Source repository is publicly reachable at the declared URL. View diagnostics → Pass
- Provenance check failed: no build-provenance attestation is published. See how to fix → View diagnostics → Fail
- Licence could not be checked: the licence is shipped as a file inside the package, not declared as a standard (SPDX) licence identifier, so we cannot tell whether it is OSI-approved.Unverified
- Actively maintained (last published 13 days ago).Pass
- Disclosure check failed: no security disclosure policy was found in the source repository. See how to fix → Fail
Schema Quality & AI Usability56
- AI-judged instruction clarity (good).Pass
- Context-footprint check failed: tool/resource definitions use about 13622 tokens (~358/item across 38 items; 38 tools + 0 resources), over budget; trim descriptions and params. See how to fix → Fail
- Usage-examples check failed: none of the tools include examples. See how to fix → Fail
Stability & Change Management43
- Stability observed for 13 of 30 days with no destabilising changes; credit accrues until the full window elapses.Partial
Tool Coverage100
- 100% of tools have a non-trivial description (not blank, and not just the tool's name).Pass
- 100% of tool parameters carry a description.Pass
- Structured output schemas are declared (100% of tools); any adoption earns full credit.Pass
Tool Safety75
- No prompt-injection markers were found in the server instructions, tool names or descriptions we captured.Pass
- 0 of 2 tool(s) whose name or description implies an irreversible operation declare an MCP destructiveHint annotation; "pdf_merge" implies "merge" and declares no destructiveHint at all, which the MCP spec reads as destructive by default. See how to fix → Fail
- An AI judge read all 38 captured unit(s) of tool text and found none that tries to manipulate the model reading it.Pass
Capabilities100
- Implements a current MCP spec version (2026-07-28).Pass
Every change we have recorded for this component, newest first. Security-relevant changes are always shown. ▲ marks a change for the better, ▼ a change for the worse; unmarked changes are neutral.
- 4 Nov 26 0
- Provenance: unverified → fail ▼ security
- 3 Nov 26 +6
- Provenance: fail → unverified ▼ security
- Stability: unverified → 0.40 ▲ functional
- 31 Oct 26 −15
- Malware scan: pass → unverified ▼ security
- 30 Oct 26 +15
- Malware scan: unverified → pass ▲ security
- 29 Oct 26 −15
- Malware scan: pass → unverified ▼ security
- 23 Oct 26 +15
- Malware scan: unverified → pass ▲ security
- 22 Oct 26 48
First indexed and scored.
Diagnostic detail from the automated scan of this channel: what the scanner observed at each step, so you can see exactly where a check passed or failed. It is informational only and never changes the trust score.
Captured 4 Nov 2026 · Analysed pypi/pdfco-mcp@0.0.11
Provenance No attestation
The registry publishes no build provenance for this version, so there is nothing to verify.
| Result | No attestation |
|---|---|
| Ecosystem | pypi |
| Reason | No attestation published |
Background: How many MCP packages publish verified provenance →
Install scripts 1 script
| Hook | Tier | Command |
|---|---|---|
| build_backend | allowlisted | hatchling.build |
Background: Why install scripts are a supply-chain risk →
Dependencies 40 packages
| Packages resolved | 40 |
|---|---|
| Stale | 1 |
| No linked repository | 1 |
| Tree resolution | Complete |
Background: SBOMs and build attestations, explained →
The tools this component advertises to a client, with an estimated token cost for each. Expand a tool to see its parameters and schema. The per-tool counts are indicative and are not scored directly; the schema's total context footprint is one signal in Schema Quality & AI Usability. A tool's description is untrusted text the model reads on every call, which is what makes this list a security surface and not just an inventory: how tool poisoning works →
ai_invoice_parser Ai Invoice Parser ~104
AI Invoice Parser: Extracts data from invoices using AI. Ref: https://developer.pdf.co/api/ai-invoice-parser.md
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| url | string | yes | URL to the source PDF file. Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-In Files Storage. Use 'upload_file' tool to upload local files. |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
create_fillable_forms Create Fillable Forms ~390
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
| Name | Type | Req | Description |
|---|---|---|---|
| annotations | array | yes | List of form annotations to create. Each annotation can be a textfield or checkbox with properties like 'x', 'y', 'size', 'pages', 'type', and 'id'. |
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| expiration | – | – | Lifetime of the output link in minutes; the output file is deleted afterwards. API default is 60; the maximum depends on the plan. (Optional) |
| httppassword | string | – | HTTP auth password if required to access source url. (Optional) |
| httpusername | string | – | HTTP auth user name if required to access source url. (Optional) |
| name | string | – | File name for the generated output. (Optional) |
| profiles | string | – | Extra engine options for this endpoint as a JSON object encoded in a string. The options differ per endpoint; see https://developer.pdf.co/api/profiles. (Optional) |
| url | string | yes | URL to the source PDF file. Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-In Files Storage. Use 'upload_file' tool to upload local files. |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
csv_to_pdf Csv To Pdf ~339
Convert CSV or spreadsheet files (XLS, XLSX) to PDF. Ref: https://developer.pdf.co/api/pdf-from-document/csv.md
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| autosize | boolean | – | Controls automatic page sizing. If true, page dimensions adjust to content. If false, uses worksheet’s page setup. (Optional) |
| expiration | – | – | Lifetime of the output link in minutes; the output file is deleted afterwards. API default is 60; the maximum depends on the plan. (Optional) |
| httppassword | string | – | HTTP auth password if required to access source url. (Optional) |
| httpusername | string | – | HTTP auth user name if required to access source url. (Optional) |
| name | string | – | File name for the generated output. (Optional) |
| pages | string | – | Comma-separated page indices (e.g., '0, 1, 2-' or '1, 3-7'). Use '!' for inverted page numbers (e.g., '!0' for last page). Processes all pages if None. (Optional) |
| profiles | string | – | Extra engine options for this endpoint as a JSON object encoded in a string. The options differ per endpoint; see https://developer.pdf.co/api/profiles. (Optional) |
| url | string | yes | URL to the source file (CSV, XLS, XLSX). Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-In Files Storage. Use 'upload_file' tool to upload local files. |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
document_to_pdf Document To Pdf ~365
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
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| autosize | boolean | – | Controls automatic page sizing. If true, page dimensions adjust to content. If false, uses worksheet’s page setup. (Optional) |
| expiration | – | – | Lifetime of the output link in minutes; the output file is deleted afterwards. API default is 60; the maximum depends on the plan. (Optional) |
| httppassword | string | – | HTTP auth password if required to access source url. (Optional) |
| httpusername | string | – | HTTP auth user name if required to access source url. (Optional) |
| name | string | – | File name for the generated output. (Optional) |
| pages | string | – | Comma-separated page indices (e.g., '0, 1, 2-' or '1, 3-7'). Use '!' for inverted page numbers (e.g., '!0' for last page). Processes all pages if None. (Optional) |
| profiles | string | – | Extra engine options for this endpoint as a JSON object encoded in a string. The options differ per endpoint; see https://developer.pdf.co/api/profiles. (Optional) |
| url | string | yes | URL to the source file (DOC, DOCX, RTF, TXT, XPS). Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-In Files Storage. Use 'upload_file' tool to upload local files. |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
email_to_pdf Email To Pdf ~515
Convert email to PDF. Ref: https://developer.pdf.co/api/pdf-from-email.md
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| convertAttachments | boolean | – | Set to false if you don’t want to convert attachments from the original email and want to embed them as original files (as embedded PDF attachments). Converts attachments that are supported by the PD… |
| embedAttachments | boolean | – | Set to true to automatically embeds all attachments from original input email MSG or EML files into the final output PDF. Set it to false if you don’t want to embed attachments so it will convert onl… |
| expiration | – | – | Lifetime of the output link in minutes; the output file is deleted afterwards. API default is 60; the maximum depends on the plan. (Optional) |
| margins | string | – | Set to CSS style margins like 10px, 5mm, 5in for all sides or 5px 5px 5px 5px (the order of margins is top, right, bottom, left). (Optional) |
| orientation | string | – | Set to Portrait or Landscape. Portrait is set by default. (Optional) |
| paperSize | string | – | A4 is set by default. Can be Letter, Legal, Tabloid, Ledger, A0, A1, A2, A3, A4, A5, A6 or a custom size. Custom size can be set in px (pixels), mm or in (inches) with width and height separated by s… |
| profiles | string | – | Extra engine options for this endpoint as a JSON object encoded in a string. The options differ per endpoint; see https://developer.pdf.co/api/profiles. (Optional) |
| url | string | yes | URL to the source file (MSG, EML). Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-In Files Storage. Use 'upload_file' tool to upload local files. |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
excel_to_csv Excel To Csv ~294
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
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| expiration | – | – | Lifetime of the output link in minutes; the output file is deleted afterwards. API default is 60; the maximum depends on the plan. (Optional) |
| httppassword | string | – | HTTP auth password if required to access source url. (Optional) |
| httpusername | string | – | HTTP auth user name if required to access source url. (Optional) |
| name | string | – | File name for the generated output. (Optional) |
| profiles | string | – | Extra engine options for this endpoint as a JSON object encoded in a string. The options differ per endpoint; see https://developer.pdf.co/api/profiles. (Optional) |
| url | string | yes | URL to the source file (XLS, XLSX). Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-In Files Storage. Use 'upload_file' tool to upload local files. |
| worksheetIndex | string | – | Index of the worksheet to convert. (Optional) |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
excel_to_html Excel To Html ~293
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
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| expiration | – | – | Lifetime of the output link in minutes; the output file is deleted afterwards. API default is 60; the maximum depends on the plan. (Optional) |
| httppassword | string | – | HTTP auth password if required to access source url. (Optional) |
| httpusername | string | – | HTTP auth user name if required to access source url. (Optional) |
| name | string | – | File name for the generated output. (Optional) |
| profiles | string | – | Extra engine options for this endpoint as a JSON object encoded in a string. The options differ per endpoint; see https://developer.pdf.co/api/profiles. (Optional) |
| url | string | yes | URL to the source file (XLS, XLSX). Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-In Files Storage. Use 'upload_file' tool to upload local files. |
| worksheetIndex | string | – | Index of the worksheet to convert. (Optional) |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
excel_to_json Excel To Json ~293
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
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| expiration | – | – | Lifetime of the output link in minutes; the output file is deleted afterwards. API default is 60; the maximum depends on the plan. (Optional) |
| httppassword | string | – | HTTP auth password if required to access source url. (Optional) |
| httpusername | string | – | HTTP auth user name if required to access source url. (Optional) |
| name | string | – | File name for the generated output. (Optional) |
| profiles | string | – | Extra engine options for this endpoint as a JSON object encoded in a string. The options differ per endpoint; see https://developer.pdf.co/api/profiles. (Optional) |
| url | string | yes | URL to the source file (XLS, XLSX). Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-In Files Storage. Use 'upload_file' tool to upload local files. |
| worksheetIndex | string | – | Index of the worksheet to convert. (Optional) |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
excel_to_pdf Excel To Pdf ~259
Convert Excel(XLS, XLSX) to PDF. Ref: https://developer.pdf.co/api/convert-from-excel/pdf.md
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| expiration | – | – | Lifetime of the output link in minutes; the output file is deleted afterwards. API default is 60; the maximum depends on the plan. (Optional) |
| httppassword | string | – | HTTP auth password if required to access source url. (Optional) |
| httpusername | string | – | HTTP auth user name if required to access source url. (Optional) |
| name | string | – | File name for the generated output. (Optional) |
| profiles | string | – | Extra engine options for this endpoint as a JSON object encoded in a string. The options differ per endpoint; see https://developer.pdf.co/api/profiles. (Optional) |
| url | string | yes | URL to the source file (XLS, XLSX). Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-In Files Storage. Use 'upload_file' tool to upload local files. |
| worksheetIndex | string | – | Index of the worksheet to convert. (Optional) |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
excel_to_txt Excel To Txt ~293
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
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| expiration | – | – | Lifetime of the output link in minutes; the output file is deleted afterwards. API default is 60; the maximum depends on the plan. (Optional) |
| httppassword | string | – | HTTP auth password if required to access source url. (Optional) |
| httpusername | string | – | HTTP auth user name if required to access source url. (Optional) |
| name | string | – | File name for the generated output. (Optional) |
| profiles | string | – | Extra engine options for this endpoint as a JSON object encoded in a string. The options differ per endpoint; see https://developer.pdf.co/api/profiles. (Optional) |
| url | string | yes | URL to the source file (XLS, XLSX). Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-In Files Storage. Use 'upload_file' tool to upload local files. |
| worksheetIndex | string | – | Index of the worksheet to convert. (Optional) |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
excel_to_xml Excel To Xml ~293
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
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| expiration | – | – | Lifetime of the output link in minutes; the output file is deleted afterwards. API default is 60; the maximum depends on the plan. (Optional) |
| httppassword | string | – | HTTP auth password if required to access source url. (Optional) |
| httpusername | string | – | HTTP auth user name if required to access source url. (Optional) |
| name | string | – | File name for the generated output. (Optional) |
| profiles | string | – | Extra engine options for this endpoint as a JSON object encoded in a string. The options differ per endpoint; see https://developer.pdf.co/api/profiles. (Optional) |
| url | string | yes | URL to the source file (XLS, XLSX). Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-In Files Storage. Use 'upload_file' tool to upload local files. |
| worksheetIndex | string | – | Index of the worksheet to convert. (Optional) |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
extract_attachments Extract Attachments ~204
Extracts attachments from a source PDF file. Ref: https://developer.pdf.co/api/pdf-extract-attachments.md
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| expiration | – | – | Lifetime of the output link in minutes; the output file is deleted afterwards. API default is 60; the maximum depends on the plan. (Optional) |
| httppassword | string | – | HTTP auth password if required to access source url. (Optional) |
| httpusername | string | – | HTTP auth user name if required to access source url. (Optional) |
| password | string | – | Password of PDF file. (Optional) |
| profiles | string | – | Extra engine options for this endpoint as a JSON object encoded in a string. The options differ per endpoint; see https://developer.pdf.co/api/profiles. (Optional) |
| url | string | yes | URL to the source PDF file. |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
fill_forms Fill Forms ~317
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
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| expiration | – | – | Lifetime of the output link in minutes; the output file is deleted afterwards. API default is 60; the maximum depends on the plan. (Optional) |
| fields | array | yes | List of fields to fill. Each field is a dict with 'fieldName', 'pages', and 'text' properties. |
| httppassword | string | – | HTTP auth password if required to access source url. (Optional) |
| httpusername | string | – | HTTP auth user name if required to access source url. (Optional) |
| name | string | – | File name for the generated output. (Optional) |
| profiles | string | – | Extra engine options for this endpoint as a JSON object encoded in a string. The options differ per endpoint; see https://developer.pdf.co/api/profiles. (Optional) |
| url | string | yes | URL to the source PDF file. Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-In Files Storage. Use 'upload_file' tool to upload local files. |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
find_table Find Table ~279
Find tables in PDF and get their coordinates. Ref: https://developer.pdf.co/api/pdf-find/table.md
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| expiration | – | – | Lifetime of the output link in minutes; the output file is deleted afterwards. API default is 60; the maximum depends on the plan. (Optional) |
| httppassword | string | – | HTTP auth password if required to access source url. (Optional) |
| httpusername | string | – | HTTP auth user name if required to access source url. (Optional) |
| pages | string | – | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'. The first-page index is 0. (Optional) |
| password | string | – | Password of the PDF file. (Optional) |
| profiles | string | – | Extra engine options for this endpoint as a JSON object encoded in a string. The options differ per endpoint; see https://developer.pdf.co/api/profiles. (Optional) |
| url | string | yes | URL to the source PDF file. Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-In Files Storage. Use 'upload_file' tool to upload local files. |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
find_text Find Text ~351
Find text in PDF and get coordinates. Supports regular expressions. Ref: https://developer.pdf.co/api/pdf-find/basic.md
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| expiration | – | – | Lifetime of the output link in minutes; the output file is deleted afterwards. API default is 60; the maximum depends on the plan. (Optional) |
| httppassword | string | – | HTTP auth password if required to access source url. (Optional) |
| httpusername | string | – | HTTP auth user name if required to access source url. (Optional) |
| pages | string | – | Comma-separated list of page indices (or ranges) to process. Leave empty for all pages. Example: '0,2-5,7-'. The first-page index is 0. (Optional) |
| password | string | – | Password of the PDF file. (Optional) |
| profiles | string | – | Extra engine options for this endpoint as a JSON object encoded in a string. The options differ per endpoint; see https://developer.pdf.co/api/profiles. (Optional) |
| regexSearch | boolean | – | Set to True to enable regular expressions in the search string. (Optional) |
| searchString | string | yes | Text to search. Can support regular expressions if regexSearch is set to True. |
| url | string | yes | URL to the source PDF file. Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-In Files Storage. Use 'upload_file' tool to upload local files. |
| wordMatchingMode | string | – | Values can be either SmartMatch, ExactMatch, or None. (Optional) |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
get_job_check Get Job Check ~134
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.
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| job_id | string | yes | The ID of the job to get the status of |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
html_to_pdf Html To Pdf ~723
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>
| Name | Type | Req | Description |
|---|---|---|---|
| DoNotWaitFullLoad | boolean | – | false by default. Set to true to skip waiting for full load (like full video load etc. that may affect the total conversion time). (Optional) |
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| expiration | – | – | Lifetime of the output link in minutes; the output file is deleted afterwards. API default is 60; the maximum depends on the plan. (Optional) |
| footer | string | – | User definable HTML for the footer to be applied on every page footer. (Optional) |
| header | string | – | User definable HTML for the header to be applied on every page header. (Optional) |
| html | string | yes | Input HTML code to be converted. To convert the link to a PDF use the /pdf/convert/from/url endpoint instead. If it is a local file, just pass the file content as a string. |
| httppassword | string | – | HTTP auth password if required to access source url. (Optional) |
| httpusername | string | – | HTTP auth user name if required to access source url. (Optional) |
| margins | string | – | Set to CSS style margins like 10px, 5mm, 5in for all sides or 5px 5px 5px 5px (the order of margins is top, right, bottom, left). (Optional) |
| mediaType | string | – | Uses print by default. Set to screen to convert HTML as it appears in a browser or print to convert as it appears for printing or none to set none as mediaType for CSS styles. (Optional) |
| name | string | – | File name for the generated output. (Optional) |
| orientation | string | – | Set to Portrait or Landscape. Portrait is set by default. (Optional) |
| paperSize | string | – | A4 is set by default. Can be Letter, Legal, Tabloid, Ledger, A0, A1, A2, A3, A4, A5, A6 or a custom size. Custom size can be set in px (pixels), mm or in (inches) with width and height separated by s… |
| printBackground | boolean | – | true by default. Set to false to disable printing of background. (Optional) |
| profiles | string | – | Extra engine options for this endpoint as a JSON object encoded in a string. The options differ per endpoint; see https://developer.pdf.co/api/profiles. (Optional) |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
image_to_pdf Image To Pdf ~320
Convert various image formats (JPG, PNG, TIFF) to PDF. Ref: https://developer.pdf.co/api/pdf-from-image.md ```
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| expiration | – | – | Lifetime of the output link in minutes; the output file is deleted afterwards. API default is 60; the maximum depends on the plan. (Optional) |
| httppassword | string | – | HTTP auth password if required to access source url. (Optional) |
| httpusername | string | – | HTTP auth user name if required to access source url. (Optional) |
| name | string | – | File name for the generated output. (Optional) |
| pages | string | – | Comma-separated page indices (e.g., '0, 1, 2-' or '1, 3-7'). Use '!' for inverted page numbers (e.g., '!0' for last page). Processes all pages if None. (Optional) |
| profiles | string | – | Extra engine options for this endpoint as a JSON object encoded in a string. The options differ per endpoint; see https://developer.pdf.co/api/profiles. (Optional) |
| url | string | yes | URL to the source file (JPG, PNG, TIFF). Multiple files are supported (by providing a comma-separated list of URLs). Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-I… |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
pdf_add_annotations_images_fields Pdf Add Annotations Images Fields ~940
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
| Name | Type | Req | Description |
|---|---|---|---|
| annotations | array | – | Array of annotation objects to add text, links, shapes, etc. Each object can have: 'text' (string), 'x' (number), 'y' (number), 'size' (number), 'pages' (string), 'color' (string hex), 'link' (string… |
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| encrypt | boolean | – | Encrypt output file. (Optional) |
| expiration | integer | – | Set the expiration time for the output link in minutes. After this specified duration, any generated output file(s) will be automatically deleted. (Optional) |
| fields | array | – | Array of form field objects to fill PDF form fields. Each object can have: 'fieldName' (string), 'pages' (string), 'text' (string), 'fontName' (string), 'size' (number), 'fontBold' (boolean), 'fontIt… |
| flatten | boolean | – | Flatten filled form fields and annotations into PDF content. Set to true to disable editing of filled form fields in the output PDF. (Optional) |
| httppassword | string | – | HTTP auth password if required to access source url. (Optional) |
| httpusername | string | – | HTTP auth user name if required to access source url. (Optional) |
| images | array | – | Array of image objects to add images to PDF. Each object can have: 'url' (string), 'x' (number), 'y' (number), 'width' (number), 'height' (number), 'pages' (string). (Optional) |
| name | string | – | File name for the generated output. (Optional) |
| password | string | – | Password for the PDF file. (Optional) |
| profiles | string | – | Extra engine options for this endpoint as a JSON object encoded in a string. The options differ per endpoint; see https://developer.pdf.co/api/profiles. (Optional) |
| url | string | yes | URL to the source PDF file. Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-In Files Storage. Use 'upload_file' tool to upload local files. |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
pdf_add_password Pdf Add Password ~491
Add password protection to a PDF file. Ref: https://developer.pdf.co/api/pdf-password/add.md
| Name | Type | Req | Description |
|---|---|---|---|
| allow_accessibility_support | boolean | – | Allow or prohibit content extraction for accessibility needs. |
| allow_assembly_document | boolean | – | Allow or prohibit assembling the document. |
| allow_content_extraction | boolean | – | Allow or prohibit copying content from PDF document. |
| allow_fill_forms | boolean | – | Allow or prohibit the filling of interactive form fields (including signature fields) in the PDF documents. |
| allow_modify_annotations | boolean | – | Allow or prohibit interacting with text annotations and forms in PDF document. |
| allow_modify_document | boolean | – | Allow or prohibit modification of PDF document. |
| allow_print_document | boolean | – | Allow or prohibit printing PDF document. |
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| encryption_algorithm | string | – | Encryption algorithm. Valid values: RC4_40bit, RC4_128bit, AES_128bit, AES_256bit. AES_128bit or higher is recommended. |
| expiration | – | – | Lifetime of the output link in minutes; the output file is deleted afterwards. API default is 60; the maximum depends on the plan. (Optional) |
| httppassword | string | – | HTTP auth password if required to access source url. (Optional) |
| httpusername | string | – | HTTP auth user name if required to access source url. (Optional) |
| name | string | – | File name for the generated output. (Optional) |
| owner_password | string | yes | The main owner password that is used for document encryption and for setting/removing restrictions. |
| password | string | – | Password of the PDF file if it's already password-protected. (Optional) |
| print_quality | string | – | Allowed printing quality. Valid values: HighResolution, LowResolution. |
| profiles | string | – | Extra engine options for this endpoint as a JSON object encoded in a string. The options differ per endpoint; see https://developer.pdf.co/api/profiles. (Optional) |
| url | string | yes | URL to the source PDF file. Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-In Files Storage. Use 'upload_file' tool to upload local files. |
| user_password | string | – | The optional user password will be asked for viewing and printing document. |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
pdf_info_reader Pdf Info Reader ~244
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
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| expiration | – | – | Lifetime of the output link in minutes; the output file is deleted afterwards. API default is 60; the maximum depends on the plan. (Optional) |
| httppassword | string | – | HTTP auth password if required to access source url. (Optional) |
| httpusername | string | – | HTTP auth user name if required to access source url. (Optional) |
| password | string | – | Password of the PDF file. (Optional) |
| profiles | string | – | Extra engine options for this endpoint as a JSON object encoded in a string. The options differ per endpoint; see https://developer.pdf.co/api/profiles. (Optional) |
| url | string | yes | URL to the source PDF file. Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-In Files Storage. Use 'upload_file' tool to upload local files. |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
pdf_make_searchable Pdf Make Searchable ~366
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
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| expiration | – | – | Lifetime of the output link in minutes; the output file is deleted afterwards. API default is 60; the maximum depends on the plan. (Optional) |
| httppassword | string | – | HTTP auth password if required to access source url. (Optional) |
| httpusername | string | – | HTTP auth user name if required to access source url. (Optional) |
| lang | string | – | Language for OCR for scanned documents. Default is 'eng'. See PDF.co docs for supported languages. (Optional, Default: 'eng') |
| name | string | – | File name for the generated output. (Optional) |
| pages | string | – | Comma-separated page indices (e.g., '0, 1, 2-' or '1, 3-7'). Use '!' for inverted page numbers (e.g., '!0' for last page). Processes all pages if None. (Optional) |
| password | string | – | Password of the PDF file. (Optional) |
| profiles | string | – | Extra engine options for this endpoint as a JSON object encoded in a string. The options differ per endpoint; see https://developer.pdf.co/api/profiles. (Optional) |
| url | string | yes | URL to the source file. Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-In Files Storage. Use 'upload_file' tool to upload local files. |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
pdf_make_unsearchable Pdf Make Unsearchable ~319
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
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| expiration | – | – | Lifetime of the output link in minutes; the output file is deleted afterwards. API default is 60; the maximum depends on the plan. (Optional) |
| httppassword | string | – | HTTP auth password if required to access source url. (Optional) |
| httpusername | string | – | HTTP auth user name if required to access source url. (Optional) |
| name | string | – | File name for the generated output. (Optional) |
| pages | string | – | Comma-separated page indices (e.g., '0, 1, 2-' or '1, 3-7'). Use '!' for inverted page numbers (e.g., '!0' for last page). Processes all pages if None. (Optional) |
| password | string | – | Password of the PDF file. (Optional) |
| profiles | string | – | Extra engine options for this endpoint as a JSON object encoded in a string. The options differ per endpoint; see https://developer.pdf.co/api/profiles. (Optional) |
| url | string | yes | URL to the source file. Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-In Files Storage. Use 'upload_file' tool to upload local files. |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
pdf_merge Pdf Merge ~279
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
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| expiration | – | – | Lifetime of the output link in minutes; the output file is deleted afterwards. API default is 60; the maximum depends on the plan. (Optional) |
| httppassword | string | – | HTTP auth password if required to access source url. (Optional) |
| httpusername | string | – | HTTP auth user name if required to access source url. (Optional) |
| name | string | – | File name for the generated output. (Optional) |
| profiles | string | – | Extra engine options for this endpoint as a JSON object encoded in a string. The options differ per endpoint; see https://developer.pdf.co/api/profiles. (Optional) |
| url | string | yes | URLs to the source files as a comma-separated list. Supports PDF, DOC, DOCX, RTF, TXT, XLS, XLSX, CSV, images, and more. Supports publicly accessible links including Google Drive, Dropbox, PDF.co Bui… |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
pdf_remove_password Pdf Remove Password ~249
Remove password protection from a PDF file. Ref: https://developer.pdf.co/api/pdf-password/remove.md
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| expiration | – | – | Lifetime of the output link in minutes; the output file is deleted afterwards. API default is 60; the maximum depends on the plan. (Optional) |
| httppassword | string | – | HTTP auth password if required to access source url. (Optional) |
| httpusername | string | – | HTTP auth user name if required to access source url. (Optional) |
| name | string | – | File name for the generated output. (Optional) |
| password | string | – | Password of the PDF file to be removed. (Optional) |
| profiles | string | – | Extra engine options for this endpoint as a JSON object encoded in a string. The options differ per endpoint; see https://developer.pdf.co/api/profiles. (Optional) |
| url | string | yes | URL to the source PDF file. Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-In Files Storage. Use 'upload_file' tool to upload local files. |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
pdf_split Pdf Split ~317
Split a PDF into multiple PDF files using page indexes or page ranges. Ref: https://developer.pdf.co/api/pdf-split/by-pages.md
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| expiration | – | – | Lifetime of the output link in minutes; the output file is deleted afterwards. API default is 60; the maximum depends on the plan. (Optional) |
| httppassword | string | – | HTTP auth password if required to access source url. (Optional) |
| httpusername | string | – | HTTP auth user name if required to access source url. (Optional) |
| name | string | – | Base file name for the generated output files. (Optional) |
| pages | string | yes | Comma-separated indices of pages (or page ranges) that you want to use. The first-page index is 1. For example: '1,3,5-7' or '1-2,4-'. Use '*' to split every page into separate files. |
| password | string | – | Password of the PDF file. (Optional) |
| profiles | string | – | Extra engine options for this endpoint as a JSON object encoded in a string. The options differ per endpoint; see https://developer.pdf.co/api/profiles. (Optional) |
| url | string | yes | URL to the source PDF file. Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-In Files Storage. Use 'upload_file' tool to upload local files. |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
pdf_to_csv Pdf To Csv ~438
Convert PDF and scanned images into CSV representation with layout, columns, rows, and tables. Ref: https://developer.pdf.co/api/pdf-to-csv.md
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| expiration | – | – | Lifetime of the output link in minutes; the output file is deleted afterwards. API default is 60; the maximum depends on the plan. (Optional) |
| httppassword | string | – | HTTP auth password if required to access source url. (Optional) |
| httpusername | string | – | HTTP auth user name if required to access source url. (Optional) |
| lang | string | – | Language for OCR for scanned documents. Default is 'eng'. See PDF.co docs for supported languages. (Optional, Default: 'eng') |
| line_grouping | string | – | Enables line grouping within table cells when set to '1'. (Optional) |
| name | string | – | File name for the generated output. (Optional) |
| pages | string | – | Comma-separated page indices (e.g., '0, 1, 2-' or '1, 3-7'). Use '!' for inverted page numbers (e.g., '!0' for last page). Processes all pages if None. (Optional) |
| password | string | – | Password of the PDF file. (Optional) |
| profiles | string | – | Extra engine options for this endpoint as a JSON object encoded in a string. The options differ per endpoint; see https://developer.pdf.co/api/profiles. (Optional) |
| rect | string | – | Defines coordinates for extraction (e.g., '51.8,114.8,235.5,204.0'). (Optional) |
| unwrap | boolean | – | Unwrap lines into a single line within table cells when lineGrouping is enabled. Must be true or false. (Optional) |
| url | string | yes | URL to the source file. Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-In Files Storage. Use 'upload_file' tool to upload local files. |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
pdf_to_html Pdf To Html ~428
Convert PDF and scanned images to HTML format. Ref: https://developer.pdf.co/api/pdf-to-html.md
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| expiration | – | – | Lifetime of the output link in minutes; the output file is deleted afterwards. API default is 60; the maximum depends on the plan. (Optional) |
| httppassword | string | – | HTTP auth password if required to access source url. (Optional) |
| httpusername | string | – | HTTP auth user name if required to access source url. (Optional) |
| lang | string | – | Language for OCR for scanned documents. Default is 'eng'. See PDF.co docs for supported languages. (Optional, Default: 'eng') |
| line_grouping | string | – | Enables line grouping within table cells when set to '1'. (Optional) |
| name | string | – | File name for the generated output. (Optional) |
| pages | string | – | Comma-separated page indices (e.g., '0, 1, 2-' or '1, 3-7'). Use '!' for inverted page numbers (e.g., '!0' for last page). Processes all pages if None. (Optional) |
| password | string | – | Password of the PDF file. (Optional) |
| profiles | string | – | Extra engine options for this endpoint as a JSON object encoded in a string. The options differ per endpoint; see https://developer.pdf.co/api/profiles. (Optional) |
| rect | string | – | Defines coordinates for extraction (e.g., '51.8,114.8,235.5,204.0'). (Optional) |
| unwrap | boolean | – | Unwrap lines into a single line within table cells when lineGrouping is enabled. Must be true or false. (Optional) |
| url | string | yes | URL to the source file. Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-In Files Storage. Use 'upload_file' tool to upload local files. |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
pdf_to_image Pdf To Image ~510
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
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| expiration | – | – | Lifetime of the output link in minutes; the output file is deleted afterwards. API default is 60; the maximum depends on the plan. (Optional) |
| httppassword | string | – | HTTP auth password if required to access source url. (Optional) |
| httpusername | string | – | HTTP auth user name if required to access source url. (Optional) |
| lang | string | – | Language for OCR for scanned documents. Default is 'eng'. See PDF.co docs for supported languages. (Optional, Default: 'eng') |
| line_grouping | string | – | Enables line grouping within table cells when set to '1'. (Optional) |
| name | string | – | File name for the generated output. (Optional) |
| pages | string | – | Comma-separated page indices (e.g., '0, 1, 2-' or '1, 3-7'). Use '!' for inverted page numbers (e.g., '!0' for last page). Processes all pages if None. (Optional) |
| password | string | – | Password of the PDF file. (Optional) |
| profiles | string | – | Extra engine options for this endpoint as a JSON object encoded in a string. The options differ per endpoint; see https://developer.pdf.co/api/profiles. (Optional) |
| rect | string | – | Defines coordinates for extraction (e.g., '51.8,114.8,235.5,204.0'). (Optional) |
| type | string | – | Type of image to convert to. (jpg, png, webp, tiff) (Optional) |
| unwrap | boolean | – | Unwrap lines into a single line within table cells when lineGrouping is enabled. Must be true or false. (Optional) |
| url | string | yes | URL to the source file. Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-In Files Storage. Use 'upload_file' tool to upload local files. |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
pdf_to_json Pdf To Json ~451
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
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| expiration | – | – | Lifetime of the output link in minutes; the output file is deleted afterwards. API default is 60; the maximum depends on the plan. (Optional) |
| httppassword | string | – | HTTP auth password if required to access source url. (Optional) |
| httpusername | string | – | HTTP auth user name if required to access source url. (Optional) |
| lang | string | – | Language for OCR for scanned documents. Default is 'eng'. See PDF.co docs for supported languages. (Optional, Default: 'eng') |
| line_grouping | string | – | Enables line grouping within table cells when set to '1'. (Optional) |
| name | string | – | File name for the generated output. (Optional) |
| pages | string | – | Comma-separated page indices (e.g., '0, 1, 2-' or '1, 3-7'). Use '!' for inverted page numbers (e.g., '!0' for last page). Processes all pages if None. (Optional) |
| password | string | – | Password of the PDF file. (Optional) |
| profiles | string | – | Extra engine options for this endpoint as a JSON object encoded in a string. The options differ per endpoint; see https://developer.pdf.co/api/profiles. (Optional) |
| rect | string | – | Defines coordinates for extraction (e.g., '51.8,114.8,235.5,204.0'). (Optional) |
| unwrap | boolean | – | Unwrap lines into a single line within table cells when lineGrouping is enabled. Must be true or false. (Optional) |
| url | string | yes | URL to the source file. Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-In Files Storage. Use 'upload_file' tool to upload local files. |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
pdf_to_text Pdf To Text ~431
Convert PDF and scanned images to text with layout preserved. Ref: https://developer.pdf.co/api/pdf-to-text/basic.md
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| expiration | – | – | Lifetime of the output link in minutes; the output file is deleted afterwards. API default is 60; the maximum depends on the plan. (Optional) |
| httppassword | string | – | HTTP auth password if required to access source url. (Optional) |
| httpusername | string | – | HTTP auth user name if required to access source url. (Optional) |
| lang | string | – | Language for OCR for scanned documents. Default is 'eng'. See PDF.co docs for supported languages. (Optional, Default: 'eng') |
| line_grouping | string | – | Enables line grouping within table cells when set to '1'. (Optional) |
| name | string | – | File name for the generated output. (Optional) |
| pages | string | – | Comma-separated page indices (e.g., '0, 1, 2-' or '1, 3-7'). Use '!' for inverted page numbers (e.g., '!0' for last page). Processes all pages if None. (Optional) |
| password | string | – | Password of the PDF file. (Optional) |
| profiles | string | – | Extra engine options for this endpoint as a JSON object encoded in a string. The options differ per endpoint; see https://developer.pdf.co/api/profiles. (Optional) |
| rect | string | – | Defines coordinates for extraction (e.g., '51.8,114.8,235.5,204.0'). (Optional) |
| unwrap | boolean | – | Unwrap lines into a single line within table cells when lineGrouping is enabled. Must be true or false. (Optional) |
| url | string | yes | URL to the source file. Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-In Files Storage. Use 'upload_file' tool to upload local files. |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
pdf_to_xls Pdf To Xls ~440
Convert PDF and scanned images to XLS (Excel 97-2003) format. Ref: https://developer.pdf.co/api/pdf-to-excel/xls.md
| Name | Type | Req | Description |
|---|---|---|---|
| api_key | string | – | PDF.co API key. If not provided, will use X_API_KEY environment variable. (Optional) |
| expiration | – | – | Lifetime of the output link in minutes; the output file is deleted afterwards. API default is 60; the maximum depends on the plan. (Optional) |
| httppassword | string | – | HTTP auth password if required to access source url. (Optional) |
| httpusername | string | – | HTTP auth user name if required to access source url. (Optional) |
| lang | string | – | Language for OCR for scanned documents. Default is 'eng'. See PDF.co docs for supported languages. (Optional, Default: 'eng') |
| line_grouping | string | – | Enables line grouping within table cells when set to '1'. (Optional) |
| name | string | – | File name for the generated output. (Optional) |
| pages | string | – | Comma-separated page indices (e.g., '0, 1, 2-' or '1, 3-7'). Use '!' for inverted page numbers (e.g., '!0' for last page). Processes all pages if None. (Optional) |
| password | string | – | Password of the PDF file. (Optional) |
| profiles | string | – | Extra engine options for this endpoint as a JSON object encoded in a string. The options differ per endpoint; see https://developer.pdf.co/api/profiles. (Optional) |
| rect | string | – | Defines coordinates for extraction (e.g., '51.8,114.8,235.5,204.0'). (Optional) |
| unwrap | boolean | – | Unwrap lines into a single line within table cells when lineGrouping is enabled. Must be true or false. (Optional) |
| url | string | yes | URL to the source file. Supports publicly accessible links including Google Drive, Dropbox, PDF.co Built-In Files Storage. Use 'upload_file' tool to upload local files. |
| Name | Type | Req | Description |
|---|---|---|---|
| content | – | yes | – |
| credits_remaining | – | – | – |
| credits_used | – | – | – |
| status | string | yes | – |
| tips | – | – | – |
No examples provided.
How do I install the PDF.co MCP server?
PDF.co runs locally as a PyPI package, launched with uvx pdfco-mcp. Ready-made configuration for Claude, Cursor, VS Code, Codex and 5 more is on this page, copied from each client's own documentation.
pypi · pdfco-mcp
claude mcp add pdfdotco-pdfco-mcp -- uvx pdfco-mcp
What is the PDF.co MCP server?
PDF.co is an MCP server listed in the public MCP registry as io.github.pdfdotco/pdfco-mcp. Official PDF.co MCP server: convert, merge, split, OCR, search and fill PDFs through the PDF.co API. This page covers its PyPI package (pdfco-mcp).
Is the PDF.co MCP server safe to use?
PDF.co scores 54 out of 100 on VerifyMCP. We found no known CVEs affecting it as of 4 November 2026. That is a record of what we were able to check automatically, not an endorsement. The category breakdown on this page shows every signal behind the number, including the ones we could not confirm.
What tools does the PDF.co MCP server expose?
PDF.co exposes 38 tools: pdf_to_json, pdf_to_csv, pdf_to_text, pdf_to_xls, pdf_to_xlsx, and 33 more. Their descriptions and schemas cost roughly 13,622 tokens of context every time the server is loaded.
Is the PDF.co MCP server still maintained?
PDF.co is still listed as active in the MCP registry. We last reached this channel on 4 November 2026. Those dates come from our own scans of the registry and the channel itself, not from anything the publisher announced.