Developer API

Document workflows,
built into your product.

Automate conversion, compression, page organization and PDF security with one consistent Business API.

GET STARTED

Quickstart

Every request starts a secure asynchronous job. Upload a document, poll the job status, then download the finished result before its expiry time.

1Create jobSend file and tool options

2ProcessPoll until status is complete

3DownloadUse the signed result URL

Base URLhttps://api.pdfprime.dev/v1Your production key and enabled tools are supplied during Business API onboarding.

SECURITY

Authentication

Your PDFPrime administrator issues a unique key from Admin → API access. The full secret is displayed once. Send it as a Bearer token, keep it on your server, and never expose it in browser code, mobile bundles or public repositories.

Request header

Authorization: Bearer pdfp_live_your_api_key
Accept: application/json

Protect production keysContact support immediately if a key is exposed. We can revoke it and issue a replacement.

POST

/jobs

Create a new document-processing job using multipart form data.

FieldTypeDescription

filebinary

Source PDF, Office document or image.

toolstring

Tool identifier such as compress or merge.

optionsJSON

Optional tool-specific settings.

cURL

curl -X POST "https://api.pdfprime.dev/v1/jobs" \
  -H "Authorization: Bearer pdfp_live_your_api_key" \
  -F "tool=compress" \
  -F "file=@proposal.pdf" \
  -F 'options={"level":"recommended"}'

202 Accepted

{
  "id": "job_01JZ8P7B4A",
  "status": "processing",
  "tool": "compress",
  "expires_at": "2026-07-21T13:30:00Z"
}

GET

/jobs/{job_id}

Poll until status is complete or failed. Completed jobs include a short-lived signed download URL.

uploadedprocessingcompletefailed

Complete job

{
  "id": "job_01JZ8P7B4A",
  "status": "complete",
  "output": {
    "filename": "proposal-compressed.pdf",
    "size": 184220,
    "download_url": "https://api.pdfprime.dev/v1/jobs/.../download"
  }
}

CAPABILITIES

Supported tools

Business access can be scoped to the tools your application needs.

Merge PDFmerge

Split PDFsplit

Compress PDFcompress

PDF to JPGpdf-to-jpg

JPG to PDFjpg-to-pdf

Word to PDFword-to-pdf

Excel to PDFexcel-to-pdf

PowerPoint to PDFppt-to-pdf

Rotate PDFrotate

Watermark PDFwatermark

Protect PDFprotect

Unlock PDFunlock

Extract PDF Pagesextract-pages

Delete PDF Pagesdelete-pages

Reorder PDF Pagesreorder-pages

RESPONSES

Error handling

400invalid_requestA required file, tool or option is invalid.

401unauthorizedThe API key is missing, invalid or revoked.

413file_too_largeThe upload exceeds your contracted file limit.

429rate_limit_exceededRetry after the response’s Retry-After interval.

500processing_failedInclude the job ID when contacting support.

BUSINESS PRICING

Limits and volume discounts

Business API limits are sized around monthly document volume, peak throughput, average file size and support level. Higher committed usage receives custom volume pricing.

Monthly volume

Pricing aligned to expected document tasks.

Peak throughput

Limits designed for your traffic.

File profile

Upload size and retention matched to your workflow.

BUSINESS API

Tell us what you’re building.

We’ll recommend the right limits and prepare volume pricing.

Get volume pricing