API Reference

Dropie API Documentation

Build powerful integrations with our RESTful API. Process documents, manage workflows, and extract data programmatically.

Quick Start

Get started with the Dropie API in minutes. Here's a simple example to process your first document:

curl -X POST https://api.dropie.io/v1/documents \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: multipart/form-data" \
  -F "file=@invoice.pdf" \
  -F "workflow_id=invoice_processing"

Authentication

The Dropie API uses API keys to authenticate requests. You can view and manage your API keys in your dashboard.

⚠️ Important: Keep your API keys secure and never expose them in client-side code.

Using Your API Key

Include your API key in the Authorization header of every request:

Authorization: Bearer YOUR_API_KEY

Base URL

All API requests should be made to:

https://api.dropie.io/v1

API Endpoints

POST/api/v1/documents

Upload and process a document

GET/api/v1/documents/:id

Retrieve document details and extracted data

GET/api/v1/documents

List all documents with filtering options

DELETE/api/v1/documents/:id

Delete a document and its data

POST/api/v1/workflows

Create a new automated workflow

POST/api/v1/extract

Extract data from a document

Example: Upload and Process Document

Request

POST /api/v1/documents
Content-Type: multipart/form-data

{
  "file": <binary>,
  "workflow_id": "invoice_processing",
  "metadata": {
    "source": "email",
    "priority": "high"
  }
}

Response

{
  "id": "doc_1234567890",
  "status": "processing",
  "created_at": "2025-01-15T10:30:00Z",
  "workflow_id": "invoice_processing",
  "extracted_data": {
    "invoice_number": "INV-2025-001",
    "date": "2025-01-15",
    "total": 1500.00,
    "vendor": "Acme Corp"
  },
  "confidence_scores": {
    "invoice_number": 0.98,
    "date": 0.99,
    "total": 0.97,
    "vendor": 0.95
  }
}

Rate Limits

API rate limits vary by plan to ensure fair usage and platform stability.

Plan	Requests/Hour	Documents/Day
Free Trial	100	50
Starter	1,000	500
Professional	10,000	5,000
Enterprise	Custom	Unlimited

Rate limit information is included in response headers: X-RateLimit-Limit,X-RateLimit-Remaining, X-RateLimit-Reset

SDKs & Libraries

Use our official SDKs for faster integration and better developer experience.

🟢Node.js

Available

🐍Python

Available

☕Java

Coming Soon

🐹Go

Coming Soon

🔷.NET

Planned

💎Ruby

Planned

Error Handling

The API uses standard HTTP response codes to indicate success or failure.

200Success

201Created

400Bad Request - Invalid parameters

401Unauthorized - Invalid API key

429Too Many Requests - Rate limit exceeded

500Internal Server Error

Need API Support?

Our developer support team is here to help you integrate Dropie into your applications.