Quickstart

Get started with OCR Omega in under 5 minutes. This guide will walk you through creating an account, getting your API key, and making your first OCR request.

Prerequisites

  • Node.js 18+ or Python 3.8+
  • A document to process (PDF, PNG, or JPG)

Step 1: Create an Account

Sign up for a free account at app.ocr-omega.com/signup. You'll get 1,000 free pages per month.

Step 2: Get Your API Key

  1. Log in to your dashboard
  2. Navigate to Settings → API Keys
  3. Click Create New Key
  4. Copy your API key (keep it secure!)

Security Warning

Never commit your API key to version control. Use environment variables instead.

Step 3: Make Your First Request

bash
curl -X POST https://api.ocr-omega.com/v1/ocr \
  -H "X-API-Key: your_api_key_here" \
  -F "file=@document.pdf"

Step 4: Parse the Response

The API returns a JSON response with the extracted text and metadata:

json
{
  "jobId": "job_abc123",
  "status": "completed",
  "pageCount": 1,
  "results": [
    {
      "page": 1,
      "text": "INVOICE #12345\nDate: 2024-01-15\nTotal: $1,234.56",
      "confidence": 0.98,
      "provider": "tesseract",
      "blocks": [
        {
          "text": "INVOICE #12345",
          "boundingBox": [[0.1, 0.05], [0.4, 0.05], [0.4, 0.1], [0.1, 0.1]],
          "confidence": 0.99
        }
      ]
    }
  ]
}

Next Steps

IntroductionAuthentication