PDF Smart Routing

{
  "request_id": "req_abc123",
  "status": "succeeded",
  "extracted_text": "Invoice #4521\n\n---\n\nThank you for your business.",
  "pdf_classification": {
    "total_pages": 2,
    "digital_pages": 1,
    "scanned_pages": 1,
    "mixed_pages": 0,
    "primary_type": "mixed"
  }
}

# Progress (job_id, status, total_pages, pages_completed, current_page_type,
# estimated_seconds_remaining, progress_pct)
curl https://api.open-ocr.com/v1/ocr/jobs/job_abc123/status \
  -H "Authorization: Bearer sk-ocr-your-api-key"

# Result (job_id, request_id, status, engine, total_pages, extracted_text, error,
# plus pages / pages_total / warnings). While the job runs it answers HTTP 202 with
# {"error":{"code":"processing","message":"Job is still processing. ..."}}.
curl https://api.open-ocr.com/v1/ocr/jobs/job_abc123/result \
  -H "Authorization: Bearer sk-ocr-your-api-key"

# 1. Submit the PDF asynchronously, for the first 60 pages
curl -X POST https://api.open-ocr.com/v1/ocr \
  -H "Authorization: Bearer sk-ocr-your-api-key" \
  -H "Idempotency-Key: $(uuidgen)" \
  -H "Content-Type: application/json" \
  -d '{
    "engine": "mistral-mistral-ocr-4-1",
    "mode": "async",
    "page_count": 60,
    "input": { "type": "url", "url": "https://example.com/annual-report.pdf" }
  }'

# 202 Accepted
# { "request_id": "req_abc123", "status": "processing", "poll_url": "/v1/ocr/req_abc123" }

# 2. Poll until status is neither "queued" nor "processing"
#    (terminal: succeeded, partial, failed, rejected; for partial read extracted_text_preview)
curl https://api.open-ocr.com/v1/ocr/req_abc123 \
  -H "Authorization: Bearer sk-ocr-your-api-key"

import time
import base64
import uuid
import requests

API_KEY = "sk-ocr-your-api-key"
BASE_URL = "https://api.open-ocr.com"

headers = {
    "Authorization": f"Bearer {API_KEY}",
    "Content-Type": "application/json",
    "Idempotency-Key": str(uuid.uuid4()),  # required on POST /v1/ocr; new UUID per logical request
}

with open("large-document.pdf", "rb") as f:
    pdf_b64 = base64.b64encode(f.read()).decode()

# Submit asynchronously. page_count is required to process more than page 1.
resp = requests.post(f"{BASE_URL}/v1/ocr", headers=headers, json={
    "engine": "mistral-mistral-ocr-4-1",
    "mode": "async",
    "page_count": 60,
    "input": {"type": "base64", "data_base64": pdf_b64, "mime_type": "application/pdf"},
})
resp.raise_for_status()
poll_url = resp.json()["poll_url"]  # e.g. "/v1/ocr/req_abc123"

while True:
    poll = requests.get(f"{BASE_URL}{poll_url}", headers=headers)
    poll.raise_for_status()  # an HTTP error body has no "status"; do not keep polling on it
    result = poll.json()
    # queued and processing are the only non-terminal statuses. GET returns succeeded, partial,
    # failed or rejected as terminal.
    if result["status"] not in ("queued", "processing"):
        break
    time.sleep(3)

if result["status"] == "partial":
    # Only extracted_text_preview is stored for a partial result (extracted_text is null).
    print("WARNING: partial result:", result.get("warning"))
    text = result["extracted_text_preview"]
elif result["status"] != "succeeded":
    raise RuntimeError(f"OCR ended as {result['status']}: {result.get('provider_error')}")
else:
    text = result["extracted_text"]

print(text)

const API_KEY = "sk-ocr-your-api-key";
const BASE_URL = "https://api.open-ocr.com";

async function ocrPdf(pdfBase64: string): Promise<string> {
  const headers = {
    Authorization: `Bearer ${API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": crypto.randomUUID(), // required on POST /v1/ocr
  };

  // Submit asynchronously. page_count is required to process more than page 1.
  const submitRes = await fetch(`${BASE_URL}/v1/ocr`, {
    method: "POST",
    headers,
    body: JSON.stringify({
      engine: "mistral-mistral-ocr-4-1",
      mode: "async",
      page_count: 60,
      input: { type: "base64", data_base64: pdfBase64, mime_type: "application/pdf" },
    }),
  });
  // Async needs OCR history enabled; otherwise this is a 400 history_disabled with no poll_url.
  if (!submitRes.ok) throw new Error(`submit failed: ${submitRes.status} ${await submitRes.text()}`);
  const { poll_url } = await submitRes.json();

  while (true) {
    await new Promise((r) => setTimeout(r, 3000));
    const res = await fetch(`${BASE_URL}${poll_url}`, { headers });
    if (!res.ok) throw new Error(`poll failed: ${res.status} ${await res.text()}`);
    const result = await res.json();
    // queued and processing are the only non-terminal statuses.
    if (result.status === "queued" || result.status === "processing") continue;
    if (result.status === "partial") {
      // Only extracted_text_preview is stored for a partial result (extracted_text is null).
      console.warn("partial result:", result.warning);
      return result.extracted_text_preview as string;
    }
    if (result.status !== "succeeded") {
      throw new Error(`OCR ended as ${result.status}: ${result.provider_error ?? ""}`);
    }
    return result.extracted_text as string;
  }
}

{
  "request_id": "req_abc123",
  "status": "succeeded",
  "extracted_text": "Page 1 content\n\n---\n\nPage 2 content",
  "stopped_at_page": 3,
  "stop_reason": "credit_exhaustion",
  "remaining_pages": 17,
  "affordable_pages": 3
}