Skip to main content

API Reference

The Lido Data Extraction API provides a simple, RESTful interface for extracting structured data from documents and images. Our API is designed to be developer-friendly with consistent patterns and comprehensive error handling.

Base URL​

All API requests should be made to:

https://sheets.lido.app/api/v1/

Authentication​

The Lido API uses API key authentication. Include your API key in the Authorization header of every request:

Authorization: Bearer YOUR_API_KEY

Getting Your API Key​

  1. Sign up for Lido - Create your account at sheets.lido.app
  2. Access API Settings - Go to sheets.lido.app/settings/api-keys
  3. Generate API Key - Create and manage your API keys from the settings page

Each key is tied to your account and usage limits.

Rate Limits​

To ensure optimal performance for all users, we implement rate limiting on our endpoints:

  • File Upload Endpoint: 5 requests per 30 seconds
  • Job Status & Usage Endpoints: 5 requests per 5 seconds

Rate limit headers are included in every response to help you manage your request frequency.

Response Format​

All API responses are returned in JSON format. Successful responses will include the requested data, while errors will include descriptive error messages and appropriate HTTP status codes.

Endpoints Overview​

Data Extraction​

Job Management​

Workflow​

The typical API workflow follows these steps:

  1. Upload Document - Send your file using the Extract File Data endpoint
  2. Receive Job ID - Get a unique identifier for tracking your extraction job
  3. Poll for Results - Use the Job Result endpoint to check processing status
  4. Retrieve Data - Once complete, receive your structured data
Processing Times

Most documents are processed within 10-30 seconds, depending on file size and complexity.

Error Handling​

The API uses conventional HTTP response codes to indicate the success or failure of requests:

  • 200 OK - Request succeeded
  • 400 Bad Request - Invalid request parameters
  • 401 Unauthorized - Invalid API key
  • 429 Too Many Requests - Rate limit exceeded
  • 500 Internal Server Error - Server error

Error responses include detailed messages to help you troubleshoot issues quickly.