API Documentation

Developer Reference Docs

Standard REST API references, authentication headers, request bodies, and code snippets for automated document manipulation.

REST endpoints

Authentication

Authenticate your API requests by including your secret API token in the Authorization header. Make sure to keep your tokens secure; never publish keys in public git repositories or client-side code.

Authorization: Bearer hp_live_xxxxxxxxxxxxxxxxxxxxxxxx

POST

/api/tools/merge

Combines multiple PDF files into a single document in chronological order.

curl -X POST "https://heypdf.vercel.app/api/tools/merge" \
  -H "Authorization: Bearer hp_live_xxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "fileKeys": [
      "user_uploads/file_1.pdf",
      "user_uploads/file_2.pdf"
    ]
  }'

Request Payload

{
  "fileKeys": [
    "user_uploads/file_1.pdf",
    "user_uploads/file_2.pdf"
  ]
}

Response Payload

{
  "success": true,
  "downloadUrl": "https://heypdf.vercel.app/api/download/merged_92837.pdf",
  "outputSize": 2049182
}

POST

/api/tools/compress

Reduces the file size of a PDF document by optimizing images and internal streams.

curl -X POST "https://heypdf.vercel.app/api/tools/compress" \
  -H "Authorization: Bearer hp_live_xxxxxxxxxxxxxxxxxxxxxxxx" \
  -H "Content-Type: application/json" \
  -d '{
    "fileKey": "user_uploads/report.pdf",
    "level": "medium" // options: low, medium, extreme
  }'

Request Payload

{
  "fileKey": "user_uploads/report.pdf",
  "level": "medium" // options: low, medium, extreme
}

Response Payload

{
  "success": true,
  "downloadUrl": "https://heypdf.vercel.app/api/download/report_compressed.pdf",
  "outputSize": 859203,
  "originalSize": 3120492,
  "savings": "72.4%"
}