Developer portal

SmartVax OCR sandbox quickstart

Use the SmartVax sandbox to validate OCR intake, async completion, and webhook handling before promotion to production.

OCR sandboxSingle + batch intakePollingWebhooksUsage monitoring

1Sign in to the branded sandbox portal.

2Generate the sandbox API key and copy it into your client or test script.

3Send a single OCR request or a batch submission.

What evaluators can test

Sandbox capabilities

Generate a sandbox key when you are ready to test

New branded sandboxes start with no active key. Generate the first key in the sandbox portal, save it immediately, and rotate it later if needed.

Run single-document OCR tests

Upload one PDF or image to validate payload shape, normalized OCR output, manual-review flags, and polling behavior.

Send asynchronous batches

Group multiple documents under one batch id so integrators can validate queued processing, partial failures, and batched completion tracking.

Choose polling or webhooks

Use the document and batch read endpoints for polling, or save the built-in SmartVax test receiver or a custom callback URL for terminal completion webhooks.

Inspect success and failure responses

The sandbox portal exposes recent runs, final OCR responses, webhook delivery outcomes, and the remaining demo usage cap.

Sandbox flow

How onboarding works

Step 1

Sign in to the branded sandbox portal.

Step 2

Generate the sandbox API key and copy it into your client or test script.

Step 3

Send a single OCR request or a batch submission.

Step 4

Poll the returned document or batch id, or enable the SmartVax test receiver or your own webhook callback.

Step 5

Inspect normalized JSON, manual-review flags, failures, and delivery outcomes in the portal.

Completion model

Polling and webhooks use the same OCR result surface

Single-document reads

Poll `GET /api/partner/v1/documents/[id]` until the OCR job reaches a terminal state.

Batch reads

Poll `GET /api/partner/v1/document-batches/[id]` for grouped processing progress and per-document outcomes.

Webhook callbacks

Use the sandbox portal to enable a callback URL and validate terminal `document.completed` and `batch.completed` events.

Response inspection

The sandbox portal shows recent successes, manual-review flags, failures, and webhook delivery results.

Single OCR intake

POST `/api/partner/v1/documents`

curl -X POST "https://smartvaxai.com/api/partner/v1/documents" \
  -H "x-api-key: YOUR_SANDBOX_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "childExternalId": "demo-student-001",
    "externalDocumentId": "demo-ocr-0001",
    "fileName": "pediatrician-record.pdf",
    "mimeType": "application/pdf",
    "documentType": "provider_record",
    "contentBase64": "BASE64_ENCODED_PDF"
  }'

Batch OCR intake

POST `/api/partner/v1/document-batches`

curl -X POST "https://smartvaxai.com/api/partner/v1/document-batches" \
  -H "x-api-key: YOUR_SANDBOX_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "externalBatchId": "demo-batch-20260402",
    "label": "Sandbox onboarding batch",
    "documents": [
      {
        "childExternalId": "demo-student-001",
        "externalDocumentId": "demo-ocr-0001",
        "fileName": "pediatrician-record.pdf",
        "mimeType": "application/pdf",
        "documentType": "provider_record",
        "contentBase64": "BASE64_ENCODED_PDF"
      }
    ]
  }'