Security audit
Security checks across malware telemetry and agentic risk
This is an instruction-only OCR API integration that sends chosen documents to DeepRead, with no hidden execution or local persistence found.
Install only if you are comfortable sending selected documents to DeepRead and, if configured, to your webhook endpoint. Keep DEEPREAD_API_KEY out of files and chats, secure webhook receivers, and treat preview URLs as private bearer links because anyone with the link may be able to view document previews or extracted results.
**Option A: With Webhook (Recommended)** ```bash # Upload PDF with webhook notification curl -X POST https://api.deepread.tech/v1/process \ -H "X-API-Key: $DEEPREAD_API_KEY" \ -F "file=@document.pdf" \ -F "webhook_url=https://your-app.com/webhooks/deepread"
**Option A: With Webhook (Recommended)** ```bash # Upload PDF with webhook notification curl -X POST https://api.deepread.tech/v1/process \ -H "X-API-Key: $DEEPREAD_API_KEY" \ -F "file=@document.pdf" \ -F "webhook_url=https://your-app.com/webhooks/deepread"
**Option B: Poll for Results** ```bash # Upload PDF without webhook curl -X POST https://api.deepread.tech/v1/process \ -H "X-API-Key: $DEEPREAD_API_KEY" \ -F "file=@document.pdf"
} # Poll until completed curl https://api.deepread.tech/v1/jobs/550e8400-e29b-41d4-a716-446655440000 \ -H "X-API-Key: $DEEPREAD_API_KEY" ```
```bash # With webhook (recommended) curl -X POST https://api.deepread.tech/v1/process \ -H "X-API-Key: $DEEPREAD_API_KEY" \ -F "file=@invoice.pdf" \ -F "webhook_url=https://your-app.com/webhook"
-F "webhook_url=https://your-app.com/webhook" # OR poll for completion curl -X POST https://api.deepread.tech/v1/process \ -H "X-API-Key: $DEEPREAD_API_KEY" \ -F "file=@invoice.pdf"
-F "file=@invoice.pdf" # Then poll curl https://api.deepread.tech/v1/jobs/JOB_ID \ -H "X-API-Key: $DEEPREAD_API_KEY" ```
Extract specific fields with confidence scoring:
```bash
curl -X POST https://api.deepread.tech/v1/process \
-H "X-API-Key: $DEEPREAD_API_KEY" \
-F "file=@invoice.pdf" \
-F 'schema={Extract arrays and nested objects:
```bash
curl -X POST https://api.deepread.tech/v1/process \
-H "X-API-Key: $DEEPREAD_API_KEY" \
-F "file=@invoice.pdf" \
-F 'schema={Get per-page OCR results with quality flags: ```bash curl -X POST https://api.deepread.tech/v1/process \ -H "X-API-Key: $DEEPREAD_API_KEY" \ -F "file=@contract.pdf" \ -F "include_pages=true"
```bash # List your blueprints curl https://api.deepread.tech/v1/blueprints \ -H "X-API-Key: $DEEPREAD_API_KEY" # Use blueprint instead of inline schema
-H "X-API-Key: $DEEPREAD_API_KEY" # Use blueprint instead of inline schema curl -X POST https://api.deepread.tech/v1/process \ -H "X-API-Key: $DEEPREAD_API_KEY" \ -F "file=@invoice.pdf" \ -F "blueprint_id=660e8400-e29b-41d4-a716-446655440001"
```bash
# Create a blueprint from training data
curl -X POST https://api.deepread.tech/v1/optimize \
-H "X-API-Key: $DEEPREAD_API_KEY" \
-H "Content-Type: application/json" \
-d '{# Returns: {"job_id": "...", "blueprint_id": "...", "status": "pending"}
# Check optimization status
curl https://api.deepread.tech/v1/blueprints/jobs/JOB_ID \
-H "X-API-Key: $DEEPREAD_API_KEY"
# Use blueprint (once completed)-H "X-API-Key: $DEEPREAD_API_KEY" # Use blueprint (once completed) curl -X POST https://api.deepread.tech/v1/process \ -H "X-API-Key: $DEEPREAD_API_KEY" \ -F "file=@invoice.pdf" \ -F "blueprint_id=BLUEPRINT_ID"
Get notified when processing completes instead of polling: ```bash curl -X POST https://api.deepread.tech/v1/process \ -H "X-API-Key: $DEEPREAD_API_KEY" \ -F "file=@invoice.pdf" \ -F "webhook_url=https://your-app.com/webhooks/deepread"
```bash # Request preview URL curl -X POST https://api.deepread.tech/v1/process \ -H "X-API-Key: $DEEPREAD_API_KEY" \ -F "file=@document.pdf" \ -F "include_images=true"
**Public Preview Endpoint:** ```bash # No authentication required curl https://api.deepread.tech/v1/preview/Xy9aB12 ``` ## Rate Limits & Pricing
**✅ Recommended: Webhook notifications** ```bash curl -X POST https://api.deepread.tech/v1/process \ -H "X-API-Key: $DEEPREAD_API_KEY" \ -F "file=@document.pdf" \ -F "webhook_url=https://your-app.com/webhook"
def wait_for_result(job_id, api_key):
while True:
response = requests.get(
f"https://api.deepread.tech/v1/jobs/{job_id}",
headers={"X-API-Key": api_key}
)
result = response.json()- **`hil_flag: true`** = Uncertain extraction → Routed to human review **How HIL works:** 1. Fields extracted with high confidence are auto-approved 2. Uncertain fields are flagged with `hil_flag: true` and a `reason` 3. Only flagged fields need human review (typically 5-10% of total fields) 4. Review flagged fields in **DeepRead Preview** (`preview.deepread.tech`) — a dedicated HIL review interface where reviewers can see the original document side-by-side with extracted data, correct flagged fields, and approve results
65/65 vendors flagged this skill as clean.
No suspicious patterns detected.