API Documentation

Authentication

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

x-api-key: your_api_key_here

You can generate API keys from your dashboard.

Endpoints

{
  "imageUrl": "https://example.com/document.jpg",
  "confidenceThreshold": 0.1
}

{
  "success": true,
  "result": {
    "detections": [
      {
        "bbox": {
          "x1": 321.23,
          "y1": 373.39,
          "x2": 647.21,
          "y2": 501.68
        },
        "confidence": 0.192,
        "class": 0,
        "class_name": "signature"
      }
    ],
    "count": 1,
    "confidenceThreshold": 0.1
  },
  "creditsRemaining": 9999,
  "detectionId": "clxxxx..."
}

Error Codes

Code Examples

JavaScript / Node.js

const response = await fetch('https://signature-detector.com/api/detect', {
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'x-api-key': 'your_api_key_here'
  },
  body: JSON.stringify({
    imageUrl: 'https://example.com/document.jpg',
    confidenceThreshold: 0.1
  })
});

const data = await response.json();
console.log('Signatures found:', data.result.count);

Python

import requests

response = requests.post(
    'https://signature-detector.com/api/detect',
    headers={
        'Content-Type': 'application/json',
        'x-api-key': 'your_api_key_here'
    },
    json={
        'imageUrl': 'https://example.com/document.jpg',
        'confidenceThreshold': 0.1
    }
)

data = response.json()
print(f"Signatures found: {data['result']['count']}")

cURL

curl -X POST https://signature-detector.com/api/detect \
  -H "Content-Type: application/json" \
  -H "x-api-key: your_api_key_here" \
  -d '{
    "imageUrl": "https://example.com/document.jpg",
    "confidenceThreshold": 0.1
  }'

Rate Limits & Pricing