API Reference

Overview

The LumiParser is organized around REST. All requests should be made using HTTPS. JSON is returned by all API responses, including errors.

Base URL

https://api.lumiparser.com/v1

Endpoints

Authentication

Learn how to authenticate your API requests using API keys.

Parsing

Upload and parse documents. Get structured data back in JSON.

Batch Processing

Submit multiple documents in a single API call.

Webhooks

Receive real-time notifications when parsing is complete.

Export

Export extracted data to CSV, JSON, or Excel formats.

Error Codes

Reference for all API error codes and how to handle them.

Need an API key?

Generate API keys in your dashboard under Settings → API Keys.

Was this helpful?