Contract source
11 endpoints and 28 API job contracts from apps/api/src/schemas/jobs.ts#createJobSchema, apps/api/src/services/jobs.ts#apiContractForJob, apps/api/src/app.ts#/v1/developer.
Developer API
PDF automation API for developers.
This page is generated from backend API and billing contracts. It shows current local contract coverage, SDK/example boundaries, and launch gates without claiming production API availability.
API billing catalog
1000 requests/minute local contract limit with 25 key slots.
Launch gate
Production launch claim blocked pending retained API, worker, metering, and observability evidence.
import { ClearPDF } from "@clearpdf/sdk-typescript";
const clearpdf = new ClearPDF({ apiKey: process.env.CLEARPDF_API_KEY });
const job = await clearpdf.client.jobs.create({
jobType: "ocr_pdf",
processingMode: "api",
inputFileIds: ["file_example_source"],
settings: { languages: ["eng"], deskew: true },
idempotencyKey: "example-ocr-001"
});
console.log(job.status);Server-side SDK examples only
API keys must remain on servers. The backend contract marks browser execution as disabled and keeps launch status at Not Live.
Backend contract
Endpoint catalog
POST/v1/uploads/signed-urlCreate a short-lived direct upload URL for a source file.
POST/v1/uploads/{uploadId}/completeConfirm uploaded file metadata before processing.
POST/v1/jobsStart an async PDF, OCR, conversion, extraction, or AI job.
GET/v1/jobs/{jobId}Read status, progress, expiry, and failure details.
POST/v1/jobs/{jobId}/cancelCancel a queued or running job.
GET/v1/jobs/{jobId}/resultRequest a signed result URL after the job succeeds.
GET/v1/billing/catalogRead server-owned billing catalog and API pricing metadata.
GET/v1/api-keysList stored API-key metadata without returning secret material.
POST/v1/webhooksRegister an endpoint URL and subscribed job lifecycle events.
POST/v1/webhooks/sign-testGenerate signed test headers for local webhook verification.
POST/v1/webhooks/deliveries/{deliveryId}/replayReset a replay-window-valid dead-lettered webhook delivery for worker redelivery.
Job contracts
Featured automation jobs
Compress Pdf
pdf-worker; pdf; local contract only
Ocr Pdf
ocr-worker; pdf; local contract only
Searchable Pdf
ocr-worker; pdf; local contract only
Pdf To Word
conversion-worker; office; local contract only
Pdf To Excel
conversion-worker; office; local contract only
Pdf To Powerpoint
conversion-worker; office; local contract only
Generated artifacts
`pnpm generate:api-contracts` writes `docs/developers/developer-api-contracts.json` and `docs/developers/openapi.local.json`.
SDK status
pnpm generate:sdk-contracts, pnpm ci:sdk-contract-drift, pnpm audit:sdk-package-readiness, and pnpm test:sdk-runtime are wired locally. Production launch claims remain blocked until retained npm/PyPI owner approval artifact, retained production API launch evidence, retained package registry publication artifact exist.
Evidence boundary
Current API evidence is backend-generated and local. It does not prove live customer traffic, deployed worker capacity, payment processing, partner approval, or webhook deliverability SLA.