API Documentation

The ManifestLens API lets you extract structured data from freight and logistics documents using a simple REST endpoint. You can get plain text or structured JSON output.

Authentication

Authenticate all API requests by including your API key in the Authorization header as a Bearer token.

curl https://api.manifestlens.com/v1/ocr \
  -H "Authorization: Bearer ml_live_xxxxxxxxxxxxxxxxxxxxxxxxxxxx"

You can create and manage API keys from your dashboard.

OCR Endpoint

Submit a document file and receive extracted text in your desired format.

Request

Send a multipart/form-data request with the following fields:

Supported file types

Example — plain text

curl -X POST https://api.manifestlens.com/v1/ocr \
  -H "Authorization: Bearer ml_live_xxxxxxxxxxxx" \
  -F "file=@invoice.pdf"

Example — JSON output

curl -X POST https://api.manifestlens.com/v1/ocr \
  -H "Authorization: Bearer ml_live_xxxxxxxxxxxx" \
  -F "file=@receipt.jpg" \
  -F "format=json"

Example — JavaScript/TypeScript

const form = new FormData()
form.append('file', fileBlob, 'document.pdf')
form.append('format', 'json')

const response = await fetch('https://api.manifestlens.com/v1/ocr', {
  method: 'POST',
  headers: {
    Authorization: 'Bearer ' + process.env.OMNIOCR_API_KEY,
  },
  body: form,
})

const result = await response.json()
console.log(result.data.full_text)

Response format

All successful responses return HTTP 200 with a JSON body.

Text format response

{
  "success": true,
  "data": {
    "text": "INVOICE\nDate: 2024-01-15\nAmount: $1,234.00\n..."
  },
  "meta": {
    "fileName": "invoice.pdf",
    "fileSize": 142308,
    "mimeType": "application/pdf",
    "format": "text",
    "processingTimeMs": 847
  }
}

JSON format response

{
  "success": true,
  "data": {
    "full_text": "INVOICE\nDate: 2024-01-15\n...",
    "blocks": [
      { "type": "header", "content": "INVOICE" },
      { "type": "field",  "content": "Date: 2024-01-15" },
      { "type": "field",  "content": "Amount: $1,234.00" }
    ],
    "metadata": {
      "title": "Invoice",
      "date": "2024-01-15",
      "total": "$1,234.00"
    }
  },
  "meta": {
    "fileName": "invoice.pdf",
    "fileSize": 142308,
    "mimeType": "application/pdf",
    "format": "json",
    "processingTimeMs": 1243
  }
}

Error codes

Errors return a non-2xx HTTP status code with a JSON error body:

{
  "error": "Invalid or revoked API key"
}