API Documentation
Welcome to the PDFjin API. Our powerful, high-performance API allows you to automate PDF workflows with just a few lines of code. Everything you can do on our website is available via our REST API.
Interactive Health Check
# Check if the API is online
curl https://pdfjin-api-pdgjin-uc.a.run.app/
Authentication
For the Developer plan, include your secret API key in the Authorization header as a
Bearer token.
Authorization: Bearer pdfjin_dev_secret_key_2026
Base URL
All API requests should be made to our primary endpoint:
https://pdfjin-api-pdgjin-uc.a.run.appPOST Merge PDF
Combine multiple PDF files into a single document.
/merge-pdfRequest Parameters
| Name | Type | Description |
|---|---|---|
| files | UploadFile[] | Multiple PDF files to merge (multipart/form-data). |
Example Request
curl -X POST "https://pdfjin-api-pdgjin-uc.a.run.app/merge-pdf" \
-F "files=@document1.pdf" \
-F "files=@document2.pdf" \
--output merged.pdf
POST PDF to Excel
Extract tabular data from PDF files directly into Excel format (.xlsx).
/pdf-to-excel
Example Request
curl -X POST "https://pdfjin-api-pdgjin-uc.a.run.app/pdf-to-excel" \
-F "files=@report.pdf" \
--output data.xlsx
POST Edit & Sign PDF
Programmatically add text, shapes, or signature images to any page.
/edit-pdfForm Data
| Name | Type | Description |
|---|---|---|
| files | UploadFile | The PDF file to edit. |
| edits | JSON String | Array of edit objects (text, shape, image). |
Example JSON for 'edits'
[
{
"type": "image",
"page": 0,
"x": 400,
"y": 600,
"width": 150,
"height": 50,
"image": "data:image/png;base64,iVBORw0KG..."
},
{
"type": "text",
"page": 0,
"x": 100,
"y": 100,
"text": "Signed via PDFjin",
"size": 12,
"color": "#6c63ff"
}
]
POST Protect PDF
Encrypt a PDF with a user/owner password.
/protect-pdfForm Data
| Name | Type | Description |
|---|---|---|
| password | string | The password to set for the PDF. |