Documentation

API Documentation

Integrate signature detection into your applications with our simple REST API.

Authentication
Secure your API requests with an API key.

All API requests require authentication using an API key. Include your API key in the request header x-api-key.

Header
x-api-key: your_api_key_here

Endpoints

/api/detect
POST
Detect signatures in an image. Costs 1 credit per request.

Request Body

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

Parameters

imageUrlstringrequiredURL of the image to analyze

Response

{
  "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..."
}

Code Examples

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'
  })
});

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