REST API v1.0

DeveloperAPI Documentation

Integrate Ademero's AI-powered document intelligence into your applications. Complete API reference, SDKs, and code examples.

API Status & Performance

99.9%

Uptime

127ms

Avg Response

2.5M+

API Calls/Day

15K+

Active Developers

Quick Start Guides

Get up and running with Ademero API in minutes

Authentication Setup

Set up API keys and authentication

5 minutes
4 steps

First Document Upload

Upload and process your first document

10 minutes
6 steps

Webhook Integration

Receive real-time processing updates

15 minutes
8 steps

Workflow Automation

Automate document processing workflows

20 minutes
10 steps

Official SDKs

Use our official libraries for faster integration

Python SDK

v2.1.0

Official Python library for Ademero API

15.2K
Python

Installation

pip install ademero-python

Example Usage

from ademero import Client

client = Client(api_key="your_api_key")# Upload and process document
document = client.documents.upload("invoice.pdf")print(f"Document ID: {document.id}")# Wait for processing
analysis = client.documents.wait_for_analysis(document.id)
print(f"Extracted data: {analysis.extracted_data}")

Node.js SDK

v1.8.2

Official Node.js/TypeScript library

8.7K
JavaScript

Installation

npm install @ademero/node-sdk

Example Usage

import { Ademero } from '@ademero/node-sdk';

const client = new Ademero({
  apiKey: process.env.ADEMERO_API_KEY
});

// Upload document
const document = await client.documents.upload({
  file: fs.createReadStream('invoice.pdf'),
  options: { extractData: true }
});

// Get analysis
const analysis = await client.documents.getAnalysis(document.id);
console.log('Extracted data:', analysis.extractedData);

PHP SDK

v1.5.1

Official PHP library for Laravel and other frameworks

4.3K
PHP

Installation

composer require ademero/php-sdk

Example Usage

<?php
use Ademero\Client;

$client = new Client(['api_key' => 'your_api_key']);

// Upload document
$document = $client->documents()->upload('invoice.pdf');
echo "Document ID: " . $document->getId();// Get analysis
$analysis = $client->documents()->getAnalysis($document->getId());
print_r($analysis->getExtractedData());

API Reference

Complete documentation of all available endpoints

GET/api/v1/documents
Auth Required
1000/hour

Retrieve a list of documents with optional filtering and pagination

Request Example

curl -X GET "https://api.ademero.com/v1/documents?limit=20&page=1" \-H "Authorization: Bearer YOUR_API_KEY" \-H "Content-Type: application/json"

Response Example

{
  "data": [{
      "id": "doc_123456","filename": "invoice_2024_001.pdf","status": "processed","created_at": "2024-01-15T10:30:00Z","size": 2048576,"pages": 3,"confidence": 98.5}
  ],
  "pagination": {"page": 1,"limit": 20,"total": 150,"has_more": true}
}
DocumentsRate limit: 1000/hour
POST/api/v1/documents/upload
Auth Required
100/hour

Upload and process a new document for AI analysis

Request Example

curl -X POST "https://api.ademero.com/v1/documents/upload" \-H "Authorization: Bearer YOUR_API_KEY" \-F "file=@document.pdf" \-F "options={\"extract_data\":true,\"ocr\":true}"

Response Example

{
  "id": "doc_789012","status": "processing","upload_url": "https://upload.ademero.com/...","estimated_completion": "2024-01-15T10:35:00Z","webhook_url": "https://your-site.com/webhooks/ademero"}
DocumentsRate limit: 100/hour
GET/api/v1/documents/{id}/analysis
Auth Required
2000/hour

Get AI analysis results for a specific document

Response Example

{
  "document_id": "doc_123456","analysis": {"document_type": "invoice","confidence": 99.2,"extracted_data": {"vendor_name": "Acme Corporation","invoice_number": "INV-2024-001","total_amount": 1250.00,"currency": "USD","due_date": "2024-02-15"},
    "entities": [{
        "type": "amount","value": "1250.00","confidence": 98.8,"bbox": [100, 200, 180, 220]}
    ]
  }
}
AI AnalysisRate limit: 2000/hour
POST/api/v1/workflows/execute
Auth Required
500/hour

Execute a predefined workflow on documents

Request Example

curl -X POST "https://api.ademero.com/v1/workflows/execute" \-H "Authorization: Bearer YOUR_API_KEY" \-H "Content-Type: application/json" \-d '{
    "workflow_id": "wf_invoice_processing","document_ids": ["doc_123456", "doc_789012"],"parameters": {"auto_approve_threshold": 95}
  }'

Response Example

{
  "execution_id": "exec_345678","status": "running","workflow_id": "wf_invoice_processing","documents_processed": 0,"total_documents": 2,"estimated_completion": "2024-01-15T10:40:00Z"}
WorkflowsRate limit: 500/hour
GET/api/v1/users/me
Auth Required
1000/hour

Get current user information and permissions

Response Example

{
  "id": "user_123","email": "john.doe@company.com","name": "John Doe","role": "admin","permissions": ["documents:read","documents:write","workflows:execute","analytics:view"],
  "organization": {"id": "org_456","name": "Acme Corporation","plan": "enterprise"}
}
UsersRate limit: 1000/hour
GET/api/v1/analytics/usage
Auth Required
100/hour

Get API usage statistics and billing information

Response Example

{
  "period": "2024-01","usage": {"documents_processed": 1250,"api_calls": 15670,"storage_used_mb": 5120,"ai_analysis_minutes": 45.5},
  "limits": {"documents_per_month": 5000,"api_calls_per_hour": 2000,"storage_limit_gb": 100},
  "billing": {"current_charges": 425.00,"next_billing_date": "2024-02-01"}
}
AnalyticsRate limit: 100/hour

Need Developer Support?

Our developer success team is here to help you integrate and scale