API Reference

Technical documentation for Mail Sorter API integration

API access is available on Enterprise plans only. Contact sales@themailsorter.com to enable API access for your account.

Authentication

All API requests require authentication using an API key. Include your API key in the request header:

bash
curl -H "Authorization: Bearer YOUR_API_KEY" \
  https://api.themailsorter.com/v1/documents

Upload Document

Upload a PDF document for processing:

http
POST /v1/documents/upload

Content-Type: multipart/form-data

{
  "file": (binary PDF data)
}

Response:

json
{
  "document_id": "doc_abc123",
  "status": "processing",
  "created_at": "2025-10-03T10:30:00Z"
}

Get Document Status

Check the processing status of a document:

http
GET /v1/documents/{document_id}

Response:

json
{
  "document_id": "doc_abc123",
  "status": "completed",
  "sender": "Acme Corporation",
  "category": "bill",
  "summary": "Monthly invoice for $49.99",
  "extracted_text": "Full OCR text...",
  "created_at": "2025-10-03T10:30:00Z",
  "processed_at": "2025-10-03T10:30:45Z"
}

List Documents

Retrieve a paginated list of all documents:

http
GET /v1/documents?limit=20&offset=0

Rate Limits

  • Upload: 100 requests per hour
  • Query: 1,000 requests per hour
  • Contact enterprise@themailsorter.com for higher rate limits
Previous
FAQ