API Reference

The LimAI API provides programmatic access to document processing, classification, splitting, and data management.

Base URL

https://app.limai.io/api/v1

Authentication

All endpoints require a Bearer token:

Authorization: Bearer YOUR_API_TOKEN

Endpoints

Document Processing

Upload and extract structured data from documents.

• Get Upload URL — Get a presigned URL to upload a file
• Process File — Extract data synchronously
• Process File Async — Extract data asynchronously
• Process Files Async — Bulk async extraction
• Submit Corrections — Submit corrections for extracted data
• Get File Data — Get extracted data for a file
• Get Files Data — Get extracted data for multiple files
• Access Link — Get a temporary access link for a file
• Get All Data — Get all extracted data for a model or deployment

Classification

Classify documents by type.

• Get Upload URL — Get a presigned URL for classification
• Classify — Classify a document synchronously
• Classify Async — Classify a document asynchronously

Splitting

Split multi-document files into individual documents.

• Get Upload URL — Get a presigned URL for splitting
• Split — Split a document synchronously
• Split Async — Split a document asynchronously
• Get Split — Get split status and results
• Get Splits — List all splits for a splitter

Deployments

Manage models and production deployments — configuration, documents, examples, and accuracy.

• Configuration — Get or update deployment configuration
• Documents — List and manage deployment documents
• Document Detail — Get document details, pages, and content
• Examples — Manage extraction examples
• Corrections — View corrections and patterns
• Accuracy — Get accuracy metrics for a model or deployment
• Tables — Manage deployment tables

Projects

Manage projects and their resources.

• Schema — Get project schema
• Deployments — List and create project deployments
• Buckets — List and create project buckets
• Benchmarks — List and create benchmarks

Buckets

File storage and management.

• Get Bucket — Get bucket details
• Update Bucket — Update bucket configuration
• Delete Bucket — Delete a bucket
• Upload — Get upload URL for a bucket
• Files — List and manage bucket files
• Download — Download a file from a bucket
• Send To — Send a file to a deployment for processing

Tables & Rows

Manage extraction tables, columns, and data rows.

• Tables — List and manage tables
• Columns — List and manage columns
• Rows — Create, list, and delete rows
• Extractions — Get extracted data by table

Benchmarks

Measure extraction accuracy.

• Run Benchmark — Execute a benchmark
• Get Results — Get benchmark execution results
• Files — List benchmark files
• Cells — Get cell-level comparison data
• Metrics — Get accuracy metrics

Queue

Monitor and manage processing jobs.

• Job Status — Check job processing status
• Cancel Job — Cancel a queued job

Webhooks

Receive real-time notifications for processing events.

• Setup — Configure webhook endpoints
• Management API — Create, verify, and monitor webhook subscriptions
• Document Extracted — Event fired when extraction completes
• Document Reviewed — Event fired when data is reviewed