Get Started

Quickstart

Quickstart

Get your api key at deepread.tech

Set your API key

Every example on this site reads your key from the DEEPREAD_API_KEY environment variable, so you never have to paste it into a file you might commit:

export DEEPREAD_API_KEY="sk_live_your_key_here"

Keep the key server-side. It carries your full account permissions — anything that can read it can spend your quota. Call DeepRead from your backend, never from browser code, and never commit it to source control.

Send a processing request

cURL Example
curl -X POST https://api.deepread.tech/v1/process \
-H "X-API-Key: $DEEPREAD_API_KEY" \
-F "file=@invoice.pdf" \
-F "pipeline=extract" \
-F 'schema={"type":"object","properties":{"invoice_number":{"type":"string","description":"The invoice number"},"total_amount":{"type":"number","description":"The total amount due"}}}'

Check the results

You can track all your jobs in the Dashboard Jobs page, or use the API directly.

The API will return a job ID. On the Standard and Enterprise plans, configure a webhook URL to receive notifications when the job completes (on Free, webhook_url is refused with 402; poll instead):

cURL Example
curl -X POST https://api.deepread.tech/v1/process \
-H "X-API-Key: $DEEPREAD_API_KEY" \
-F "file=@invoice.pdf" \
-F 'schema={"type":"object","properties":{"total":{"type":"number"}}}' \
-F "webhook_url=https://your-app.com/webhooks/deepread"

Alternatively, you can check job status manually using GET /v1/jobs/{job_id}:

cURL Example
curl -X GET https://api.deepread.tech/v1/jobs/550e8400-e29b-41d4-a716-446655440000 \
-H "X-API-Key: $DEEPREAD_API_KEY"

Response:

{
  "id": "550e8400-e29b-41d4-a716-446655440000",
  "status": "completed",
  "schema_version": "dp02",
  "pipeline": "extract",
  "product": "extract",
  "document": {
    "page_count": 1,
    "content": {
      "format": "markdown",
      "text": "# INVOICE #INV-12345\n\n**Total:** $1,250.00\n..."
    }
  },
  "extraction": {
    "fields": [
      {
        "key": "invoice_number",
        "value": "INV-12345",
        "needs_review": false,
        "location": { "page": 1 }
      },
      {
        "key": "total_amount",
        "value": 1250.0,
        "needs_review": false,
        "location": { "page": 1 }
      }
    ]
  },
  "review": {
    "review_rate": 0.0
  }
}