Face Detector APIFace Detector API API

OnlineCredit Usage:5 per call
avg: 1487ms|p50: 1353ms|p75: 1576ms|p90: 1844ms|p99: 2379ms

Face Detector API analyzes images to detect human faces and returns bounding box coordinates for each detected face.

The Face Detector API API provides reliable and fast access to face detector api data through a simple REST interface. Built for developers who need consistent, high-quality results with minimal setup time.

To use Face Detector API, you need an API key. You can get one by creating a free account and visiting your dashboard.

POST Endpoint

URL
https://api.apiverve.com/v1/facedetect

Code Examples

Here are examples of how to call the Face Detector API API in different programming languages:

cURL Request
curl -X POST \
  "https://api.apiverve.com/v1/facedetect?url=value&confidence=value" \
  -H "X-API-Key: your_api_key_here" \
  -F "image=@/path/to/image.jpg"
JavaScript (Fetch API)
const formData = new FormData();
formData.append('image', fileInput.files[0]);

const response = await fetch('https://api.apiverve.com/v1/facedetect?url=value&confidence=value', {
  method: 'POST',
  headers: {
    'X-API-Key': 'your_api_key_here'
  },
  body: formData
});

const data = await response.json();
console.log(data);
Python (Requests)
import requests

headers = {
    'X-API-Key': 'your_api_key_here'
}

files = {
    'image': open('/path/to/image.jpg', 'rb')
}

response = requests.post('https://api.apiverve.com/v1/facedetect', headers=headers, files=files)

data = response.json()
print(data)
Node.js (Native HTTPS)
const fs = require('fs');
const FormData = require('form-data');

const form = new FormData();
form.append('image', fs.createReadStream('/path/to/image.jpg'));

fetch('https://api.apiverve.com/v1/facedetect', {
  method: 'POST',
  headers: {
    'X-API-Key': 'your_api_key_here',
    ...form.getHeaders()
  },
  body: form
})
.then(res => res.json())
.then(data => console.log(data));
PHP (cURL)
<?php

$ch = curl_init();

curl_setopt($ch, CURLOPT_URL, 'https://api.apiverve.com/v1/facedetect');
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, [
    'X-API-Key: your_api_key_here'
]);

$postFields = [
    'image' => new CURLFile('/path/to/image.jpg')
];

curl_setopt($ch, CURLOPT_POSTFIELDS, $postFields);

$response = curl_exec($ch);
curl_close($ch);

$data = json_decode($response, true);
print_r($data);

?>
Go (net/http)
package main

import (
    "bytes"
    "fmt"
    "io"
    "mime/multipart"
    "net/http"
    "os"
)

func main() {
    file, _ := os.Open("/path/to/image.jpg")
    defer file.Close()

    body := &bytes.Buffer{}
    writer := multipart.NewWriter(body)
    part, _ := writer.CreateFormFile("image", "image.jpg")
    io.Copy(part, file)
    writer.Close()

    req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/facedetect", body)
    req.Header.Set("X-API-Key", "your_api_key_here")
    req.Header.Set("Content-Type", writer.FormDataContentType())

    client := &http.Client{}
    resp, err := client.Do(req)
    if err != nil {
        panic(err)
    }
    defer resp.Body.Close()

    respBody, _ := io.ReadAll(resp.Body)
    fmt.Println(string(respBody))
}
Ruby (Net::HTTP)
require 'net/http'
require 'uri'
require 'json'

uri = URI('https://api.apiverve.com/v1/facedetect')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true

request = Net::HTTP::Post::Multipart.new(
  uri.path,
  'image' => UploadIO.new(File.open('/path/to/image.jpg'), 'image/jpeg', 'image.jpg')
)

request['X-API-Key'] = 'your_api_key_here'

response = http.request(request)
puts JSON.pretty_generate(JSON.parse(response.body))
C# (HttpClient)
using System;
using System.IO;
using System.Net.Http;
using System.Threading.Tasks;

class Program
{
    static async Task Main(string[] args)
    {
        using var client = new HttpClient();
        client.DefaultRequestHeaders.Add("X-API-Key", "your_api_key_here");

        using var content = new MultipartFormDataContent();
        using var fileStream = File.OpenRead("/path/to/image.jpg");
        content.Add(new StreamContent(fileStream), "image", "image.jpg");

        var response = await client.PostAsync("https://api.apiverve.com/v1/facedetect", content);
        response.EnsureSuccessStatusCode();

        var responseBody = await response.Content.ReadAsStringAsync();
        Console.WriteLine(responseBody);
    }
}

Authentication

The Face Detector API API requires authentication via API key. Include your API key in the request header:

Required Header
X-API-Key: your_api_key_here

Interactive API Playground

Test the Face Detector API API directly in your browser with live requests and responses.

File Upload Required

The Face Detector API API requires file upload via multipart/form-data. Do not use Content-Type: application/json for Face Detector API. Parameters are sent as query string, not form fields.
PropertyValue
Field Nameimage
Accepted Types.jpg, .jpeg, .png, .gif, .webp
Max File Size10MB
File Upload Example (cURL)
curl -X POST "https://api.apiverve.com/v1/facedetect?url=value&confidence=value" \
  -H "X-API-Key: your_api_key_here" \
  -F "image=@/path/to/your/file"
File Upload Example (JavaScript)
const formData = new FormData();
formData.append('image', fileInput.files[0]);

const response = await fetch('https://api.apiverve.com/v1/facedetect?url=value&confidence=value', {
  method: 'POST',
  headers: {
    'X-API-Key': 'your_api_key_here'
  },
  body: formData
});

const data = await response.json();
console.log(data);

Parameters

The following parameters are available for the Face Detector API API:

Detect Faces

ParameterTypeRequiredDescriptionDefaultExample
urlstringNoURL of the image to analyze (JPG, PNG, GIF, WebP supported)-https://example.com/group-photo.jpg
imagestringNoBase64-encoded image data (alternative to url parameter)--
confidencenumberNoMinimum confidence threshold for face detection (0.1 to 1.0, default: 0.5)-0.5

Response

The Face Detector API API returns responses in JSON, XML, YAML, and CSV formats:

Example Responses

JSON Response
200 OK
{
  "status": "ok",
  "error": null,
  "data": {
    "faces": [
      {
        "x": 142,
        "y": 85,
        "width": 98,
        "height": 112,
        "confidence": 0.9847
      },
      {
        "x": 312,
        "y": 92,
        "width": 87,
        "height": 103,
        "confidence": 0.9623
      },
      {
        "x": 478,
        "y": 78,
        "width": 95,
        "height": 118,
        "confidence": 0.9412
      }
    ],
    "faceCount": 3,
    "hasFaces": true,
    "imageWidth": 640,
    "imageHeight": 480
  },
  "code": 200
}
XML Response
200 OK
<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <error xsi:nil="true" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"/>
  <data>
    <faces>
      <face>
        <x>142</x>
        <y>85</y>
        <width>98</width>
        <height>112</height>
        <confidence>0.9847</confidence>
      </face>
      <face>
        <x>312</x>
        <y>92</y>
        <width>87</width>
        <height>103</height>
        <confidence>0.9623</confidence>
      </face>
      <face>
        <x>478</x>
        <y>78</y>
        <width>95</width>
        <height>118</height>
        <confidence>0.9412</confidence>
      </face>
    </faces>
    <faceCount>3</faceCount>
    <hasFaces>true</hasFaces>
    <imageWidth>640</imageWidth>
    <imageHeight>480</imageHeight>
  </data>
  <code>200</code>
</response>
YAML Response
200 OK
status: ok
error: null
data:
  faces:
    - x: 142
      'y': 85
      width: 98
      height: 112
      confidence: 0.9847
    - x: 312
      'y': 92
      width: 87
      height: 103
      confidence: 0.9623
    - x: 478
      'y': 78
      width: 95
      height: 118
      confidence: 0.9412
  faceCount: 3
  hasFaces: true
  imageWidth: 640
  imageHeight: 480
code: 200
CSV Response
200 OK
keyvalue
faces[{x:142,y:85,width:98,height:112,confidence:0.9847},{x:312,y:92,width:87,height:103,confidence:0.9623},{x:478,y:78,width:95,height:118,confidence:0.9412}]
faceCount3
hasFacestrue
imageWidth640
imageHeight480

Response Structure

All API responses follow a consistent structure with the following fields:

FieldTypeDescriptionExample
statusstringIndicates whether the request was successful ("ok") or failed ("error")ok
errorstring | nullContains error message if status is "error", otherwise nullnull
dataobject | nullContains the API response data if successful, otherwise null{...}

Response Data Fields

When the request is successful, the data object contains the following fields:

FieldTypeSample Value
[ ] Array items:array[3]Array of objects
â”” xnumber142
â”” ynumber85
â”” widthnumber98
â”” heightnumber112
â”” confidencenumber0.9847
faceCountnumber3
hasFacesbooleantrue
imageWidthnumber640
imageHeightnumber480

Headers

Required and optional headers for API requests:

Header NameRequiredExample ValueDescription
X-API-KeyYesyour_api_key_hereYour APIVerve API key. Found in your dashboard under API Keys.
AcceptNoapplication/jsonSpecify response format: application/json (default), application/xml, or application/yaml
User-AgentNoMyApp/1.0Identifies your application for analytics and debugging purposes
X-Request-IDNoreq_123456789Custom request identifier for tracking and debugging requests
Cache-ControlNono-cacheControl caching behavior for the request and response

CORS Support

The Face Detector API API supports Cross-Origin Resource Sharing (CORS) with wildcard configuration, allowing you to call Face Detector API directly from browser-based applications without proxy servers.

CORS HeaderValueDescription
Access-Control-Allow-Origin*Accepts requests from any origin
Access-Control-Allow-Methods*Accepts any HTTP method
Access-Control-Allow-Headers*Accepts any request headers

Browser Usage: You can make direct API calls from JavaScript running in the browser without encountering CORS errors. No additional configuration needed.

Rate Limiting

APIVerve implements rate limiting to ensure fair usage and maintain service quality across all users. Rate limits vary by subscription plan and are applied per API key.

PlanRate LimitDescription
Free5 requests/minHard rate limit enforced - exceeding will return 429 errors
StarterNo LimitProduction ready - no rate limiting or throttling
ProNo LimitProduction ready - no rate limiting or throttling
MegaNo LimitProduction ready - no rate limiting or throttling

Rate Limit Headers

When rate limits apply, each API response includes headers to help you track your usage:

HeaderDescription
X-RateLimit-LimitMaximum number of requests allowed per time window
X-RateLimit-RemainingNumber of requests remaining in the current window
X-RateLimit-ResetUnix timestamp when the rate limit window resets

Handling Rate Limits

Free Plan: When you exceed your rate limit, Face Detector API returns a 429 Too Many Requests status code. Your application should implement appropriate backoff logic to handle this gracefully.

Paid Plans: No rate limiting or throttling applied. All paid plans (Starter, Pro, Mega) are production-ready.

Best Practices:

  • Monitor the rate limit headers to track your usage (Free plan only)
  • Implement caching where appropriate to reduce API calls
  • Upgrade to Pro or Mega for guaranteed no-throttle performance

Note: Rate limits are separate from credit consumption. You may have credits remaining but still hit rate limits on Free tier.

Client Libraries

To get started with minimal code, most of our APIs are available through client libraries and clients:

NPMPyPINuGetSwagger

Error Codes

The Face Detector API API uses standard HTTP status codes to indicate success or failure:

CodeMessageDescriptionSolution
200OKRequest successful, data returnedNo action needed - request was successful
400Bad RequestInvalid request parameters or malformed requestCheck required parameters and ensure values match expected formats
401UnauthorizedMissing or invalid API keyInclude x-api-key header with valid API key from dashboard
403ForbiddenAPI key lacks permission or insufficient creditsCheck credit balance in dashboard or upgrade plan
429Too Many RequestsRate limit exceeded (Free: 5 req/min)Implement request throttling or upgrade to paid plan
500Internal Server ErrorServer error occurredRetry request after a few seconds, contact support if persists
503Service UnavailableAPI temporarily unavailableWait and retry, check status page for maintenance updates

Need help? Contact support with your X-Request-ID for assistance.

Integrate Face Detector API with No-Code Tools

Connect the Face Detector API API to your favorite automation platform without writing code. Build workflows that leverage face detector api data across thousands of apps.

All platforms use your same API key to access Face Detector API. Visit our integrations hub for step-by-step setup guides.

Frequently Asked Questions

How do I get an API key?
Sign up for a free account at dashboard.apiverve.com. Your API key will be automatically generated and available in your dashboard. The free plan includes 1,000 credits plus a 500 credit bonus.
What are credits and how do they work?

Credits are your API usage currency. Each successful API call consumes credits based on the API's complexity. Most APIs cost 1 credit per call, while more complex APIs may cost 2-5 credits. Failed requests and errors don't consume credits. Check the API details above to see the credit cost for this specific API.

Can I use Face Detector API in production?

The free plan is for testing and development only. For production use of Face Detector API, upgrade to a paid plan (Starter, Pro, or Mega) which includes commercial use rights, no attribution requirements, and guaranteed uptime SLAs. All paid plans are production-ready.

Can I use Face Detector API from a browser?
Yes! The Face Detector API API supports CORS with wildcard configuration, so you can call it directly from browser-based JavaScript without needing a proxy server. See the CORS section above for details.
What happens if I exceed my credit limit?

When you reach your monthly credit limit, API requests will return an error until you upgrade your plan or wait for the next billing cycle. You'll receive notifications at 80% and 95% usage to give you time to upgrade if needed.

What's Next?

Continue your journey with these recommended resources

Was this page helpful?