REST API v1 Specification

PDF OCR API Documentation

Integrate high-speed multi-language OCR conversion endpoints directly into your backend services.

API Authentication Header

Include your API Key in the HTTP Request Headers with every request:

X-API-KEY: your_generated_api_key_here
POST /api/v1/ocr/upload

Uploads a PDF file and enqueues an asynchronous OCR job.

cURL Request Example:

curl -X POST "https://pdftotext.pngstock.in/api/v1/ocr/upload" \
  -H "X-API-KEY: your_api_key" \
  -F "pdf_file=@document.pdf" \
  -F "ocr_language=eng"

JSON Response (200 OK):

{
  "status": "success",
  "job_code": "job_66b5c1a2e3f4",
  "message": "OCR job enqueued successfully.",
  "status_url": "https://pdftotext.pngstock.in/api/v1/ocr/status/job_66b5c1a2e3f4"
}
GET /api/v1/ocr/status/{jobCode}

Check job processing progress and completion status.

GET /api/v1/ocr/result/{jobCode}

Fetch extracted combined text, word count, confidence score, and page breakdown.