API Reference - Parseloom

Authentication

All API requests require an API key sent in the Authorization header as a Bearer token.

Authorization: Bearer sk_live_your_api_key_here

API keys are available in your account dashboard under Settings > API Keys. Generate a separate key per integration for easier revocation. Test keys (sk_test_) are rate-limited to 10 req/min and extractions do not count against your monthly page quota.

POST /v1/extract

Submit a document for extraction. Returns a JSON object with extracted fields.

Request

Content-Type: multipart/form-data

curl -X POST https://api.parseloom.com/v1/extract \
  -H "Authorization: Bearer sk_live_..." \
  -F "[email protected]" \
  -F "template=invoice_standard"

Parameter	Type	Required	Description
`file`	file	Yes	PDF, TIFF, PNG, or JPEG. Max 20 MB per file.
`template`	string	Yes	Template ID or slug. Use `invoice_standard`, `bol_standard`, or a custom template ID.
`webhook_url`	string	No	POST destination for async delivery. If omitted, response is synchronous (max 30s).

Response

{
  "extraction_id": "ext_9f2a4d8c",
  "status": "complete",
  "template": "invoice_standard",
  "pages_processed": 2,
  "fields": {
    "vendor_name": "Acme Supplies LLC",
    "invoice_number": "INV-20260601-00441",
    "invoice_date": "2026-06-01",
    "due_date": "2026-06-30",
    "subtotal": 3900.00,
    "tax_amount": 282.00,
    "total_amount": 4182.00,
    "line_items": [
      { "description": "Office furniture", "qty": 4, "unit_price": 975.00 }
    ]
  },
  "confidence": {
    "overall": 0.97,
    "low_confidence_fields": []
  }
}

Webhooks

Webhooks deliver extraction results to your endpoint as soon as processing completes. Use them for batch processing or when document size exceeds the 30-second sync window.

Parseloom signs each webhook payload with a shared secret. Verify the X-Parseloom-Signature header against an HMAC-SHA256 of the raw body using your webhook secret.

POST https://your-endpoint.com/parseloom-hook
Content-Type: application/json
X-Parseloom-Signature: sha256=abc123...

{
  "event": "extraction.complete",
  "extraction_id": "ext_9f2a4d8c",
  "fields": { ... }
}

Field schemas

You can override the field output schema per request, or set a default schema per template. Schema fields define the name, type, and required status of each extracted field.

{
  "schema": [
    { "name": "vendor_name",   "type": "text",       "required": true },
    { "name": "invoice_date",  "type": "date",        "required": true },
    { "name": "total_amount",  "type": "currency",    "required": true },
    { "name": "line_items",    "type": "table",
      "columns": ["description", "qty", "unit_price"]
    }
  ]
}

Templates API

List, create, and manage your extraction templates via API. All template operations require a Professional or Scale plan.

Method	Endpoint	Description
GET	`/v1/templates`	List all templates in your account
GET	`/v1/templates/:id`	Get a single template with field definitions
POST	`/v1/templates`	Create a new template (requires training examples)
PATCH	`/v1/templates/:id`	Update template name or field schema
DELETE	`/v1/templates/:id`	Archive a template (extractions continue for 30 days)

Errors

The API uses standard HTTP status codes. Error responses include a machine-readable code and a human-readable message.

Code	HTTP	Meaning
`auth_invalid`	401	Missing or invalid API key
`template_not_found`	404	Template ID does not exist in your account
`file_unreadable`	422	File is corrupt, password-protected, or unsupported format
`extraction_failed`	422	Extraction ran but returned no fields - page not billed
`quota_exceeded`	429	Monthly page quota reached for your plan
`rate_limited`	429	Per-minute request rate exceeded

Rate limits

Limits apply per API key. Burst allowance: 2x the per-minute limit for up to 10 seconds.

Plan	Requests/min	Pages/month
Starter	10	100
Professional	60	5,000
Scale	300	Unlimited
Test key	10	Not counted