ScoutExtract Docs

Quick Start

Get structured data from any document in under 5 minutes.

1. Get an API Key

curl -X POST https://api.ramlabs.dev/v1/auth/register \
  -H "Content-Type: application/json" \
  -d '{"email": "you@example.com"}'

Save the key from the response — it cannot be retrieved again.

2. Make Your First Extraction

curl -X POST https://api.ramlabs.dev/v1/extract \
  -H "Authorization: Bearer rex_your_api_key" \
  -H "Content-Type: application/json" \
  -d '{
    "document": "Invoice #1234\nDate: 2024-01-15\nVendor: Acme Corp\nTotal: $1,500.00",
    "schema": "invoice"
  }'

3. Get Structured JSON Back

{
  "data": {
    "invoice_number": "1234",
    "invoice_date": "2024-01-15",
    "vendor_name": "Acme Corp",
    "total_amount": 1500.00,
    "currency": "USD"
  },
  "confidence": {
    "invoice_number": 0.98,
    "invoice_date": 0.99,
    "vendor_name": 0.97,
    "total_amount": 0.99,
    "currency": 0.85
  }
}

Document Types

  • Text: Plain text in the document field
  • PDF: Base64-encoded PDF with "documentType": "pdf"
  • Image: Base64-encoded image with "documentType": "image"
  • Pre-built Templates

    TemplateDescription
    invoiceInvoices with line items, totals, vendor/customer info
    receiptRetail receipts with items, totals, payment method
    resumeResumes/CVs with experience, education, skills
    contractContracts with parties, terms, obligations