Face Detector API
Face Detector API analyzes images to detect human faces and returns bounding box coordinates for each detected face.
The Face Detector API provides reliable and fast access to face detector data through a simple REST interface. Built for developers who need consistent, high-quality results with minimal setup time.
To use Face Detector, you need an API key. You can get one by creating a free account and visiting your dashboard.
POST Endpoint
https://api.apiverve.com/v1/facedetectCode Examples
Here are examples of how to call the Face Detector API in different programming languages:
curl -X POST \
"https://api.apiverve.com/v1/facedetect" \
-H "X-API-Key: your_api_key_here" \
-H "Content-Type: application/json" \
-d '{
"url": "https://example.com/group-photo.jpg",
"confidence": 0.5
}'const response = await fetch('https://api.apiverve.com/v1/facedetect', {
method: 'POST',
headers: {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
},
body: JSON.stringify({
"url": "https://example.com/group-photo.jpg",
"confidence": 0.5
})
});
const data = await response.json();
console.log(data);import requests
headers = {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
payload = {
"url": "https://example.com/group-photo.jpg",
"confidence": 0.5
}
response = requests.post('https://api.apiverve.com/v1/facedetect', headers=headers, json=payload)
data = response.json()
print(data)const https = require('https');
const url = require('url');
const options = {
method: 'POST',
headers: {
'X-API-Key': 'your_api_key_here',
'Content-Type': 'application/json'
}
};
const postData = JSON.stringify({
"url": "https://example.com/group-photo.jpg",
"confidence": 0.5
});
const req = https.request('https://api.apiverve.com/v1/facedetect', options, (res) => {
let data = '';
res.on('data', (chunk) => data += chunk);
res.on('end', () => console.log(JSON.parse(data)));
});
req.write(postData);
req.end();<?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_CUSTOMREQUEST, 'POST');
curl_setopt($ch, CURLOPT_HTTPHEADER, [
'X-API-Key: your_api_key_here',
'Content-Type: application/json'
]);
curl_setopt($ch, CURLOPT_POSTFIELDS, json_encode({
'url': 'https://example.com/group-photo.jpg',
'confidence': 0.5
}));
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
print_r($data);
?>package main
import (
"fmt"
"io"
"net/http"
"bytes"
"encoding/json"
)
func main() {
payload := map[string]interface{}{
"url": "https://example.com/group-photo.jpg",
"confidence": "0.5"
}
jsonPayload, _ := json.Marshal(payload)
req, _ := http.NewRequest("POST", "https://api.apiverve.com/v1/facedetect", bytes.NewBuffer(jsonPayload))
req.Header.Set("X-API-Key", "your_api_key_here")
req.Header.Set("Content-Type", "application/json")
client := &http.Client{}
resp, err := client.Do(req)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}require 'net/http'
require 'json'
uri = URI('https://api.apiverve.com/v1/facedetect')
http = Net::HTTP.new(uri.host, uri.port)
http.use_ssl = true
payload = {
"url": "https://example.com/group-photo.jpg",
"confidence": 0.5
}
request = Net::HTTP::Post.new(uri)
request['X-API-Key'] = 'your_api_key_here'
request['Content-Type'] = 'application/json'
request.body = payload.to_json
response = http.request(request)
puts JSON.pretty_generate(JSON.parse(response.body))using System;
using System.Net.Http;
using System.Text;
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");
var jsonContent = @"{
""url"": ""https://example.com/group-photo.jpg"",
""confidence"": 0.5
}";
var content = new StringContent(jsonContent, Encoding.UTF8, "application/json");
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 requires authentication via API key. Include your API key in the request header:
X-API-Key: your_api_key_hereInteractive API Playground
Test the Face Detector API directly in your browser with live requests and responses.
Parameters
The Face Detector API supports multiple query options. Use one of the following:
Option 1: Detect Faces from Upload
| Parameter | Type | Required | Description | Default | Example |
|---|---|---|---|---|---|
image | string | required | Image file upload (JPG, PNG, GIF, WebP supported, max 10MB) | - | - |
confidence | number | optional | Minimum confidence threshold for face detection (0.1 to 1.0) Range: 0.1 - 1 |
Option 2: Detect Faces from URL
| Parameter | Type | Required | Description | Default | Example |
|---|---|---|---|---|---|
url | string | required | URL of the image to analyze (JPG, PNG, GIF, WebP supported) | - | |
confidence | number | optional | Minimum confidence threshold for face detection (0.1 to 1.0) Range: 0.1 - 1 |
Response
The Face Detector API returns responses in JSON, XML, YAML, and CSV formats:
Example Responses
{
"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,
"averageConfidence": 0.9627,
"imageCoverage": 10.23
},
"code": 200
}<?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>
<averageConfidence>0.9627</averageConfidence>
<imageCoverage>10.23</imageCoverage>
</data>
<code>200</code>
</response>
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
averageConfidence: 0.9627
imageCoverage: 10.23
code: 200
| key | value |
|---|---|
| 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 |
| averageConfidence | 0.9627 |
| imageCoverage | 10.23 |
Response Structure
All API responses follow a consistent structure with the following fields:
| Field | Type | Description | Example |
|---|---|---|---|
status | string | Indicates whether the request was successful ("ok") or failed ("error") | ok |
error | string | null | Contains error message if status is "error", otherwise null | null |
data | object | null | Contains the API response data if successful, otherwise null | {...} |
Learn more about response formats →
Response Data Fields
When the request is successful, the data object contains the following fields:
| Field | Type | Sample Value | Description |
|---|---|---|---|
| [ ] Array items: | array[3] | Array of detected faces with bounding boxes and confidence scores | |
â”” x | number | X coordinate of face bounding box top-left corner | |
â”” y | number | Y coordinate of face bounding box top-left corner | |
â”” width | number | Width of face bounding box in pixels | |
â”” height | number | Height of face bounding box in pixels | |
â”” confidence | number | Confidence score for face detection (0.0 to 1.0) | |
faceCountPremium | number | Total number of faces detected in the image | |
hasFaces | boolean | Whether any faces were detected in the image | |
imageWidthPremium | number | Width of the analyzed image in pixels | |
imageHeightPremium | number | Height of the analyzed image in pixels | |
averageConfidencePremium | number | Average confidence score across all detected faces | |
imageCoveragePremium | number | Percentage of image area covered by detected faces |
Headers
Required and optional headers for Face Detector API requests:
| Header Name | Required | Example Value | Description |
|---|---|---|---|
X-API-Key | required | your_api_key_here | Your APIVerve API key. Found in your dashboard under API Keys. |
Accept | optional | application/json | Specify response format: application/json (default), application/xml, or application/yaml |
User-Agent | optional | MyApp/1.0 | Identifies your application for analytics and debugging purposes |
X-Request-ID | optional | req_123456789 | Custom request identifier for tracking and debugging requests |
Cache-Control | optional | no-cache | Control caching behavior for the request and response |
GraphQL AccessALPHA
Access Face Detector through GraphQL to combine it with other API calls in a single request. Query only the face detector data you need with precise field selection, and orchestrate complex data fetching workflows.
Credit Cost: Each API called in your GraphQL query consumes its standard credit cost.
POST https://api.apiverve.com/v1/graphqlquery {
facedetect(
input: {
url: "https://example.com/group-photo.jpg"
confidence: 0.5
}
) {
faces
faceCount
hasFaces
imageWidth
imageHeight
averageConfidence
imageCoverage
}
}Note: Authentication is handled via the x-api-key header in your GraphQL request, not as a query parameter.
CORS Support
The Face Detector API supports Cross-Origin Resource Sharing (CORS) with wildcard configuration, allowing you to call Face Detector directly from browser-based applications without proxy servers.
| CORS Header | Value | Description |
|---|---|---|
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 call Face Detector directly from JavaScript running in the browser without encountering CORS errors. No proxy server or additional configuration needed.
Rate Limiting
Face Detector API requests are subject to rate limiting based on your subscription plan. These limits ensure fair usage and maintain service quality for all Face Detector users.
| Plan | Rate Limit | Description |
|---|---|---|
| Free | 5 requests/min | Hard rate limit enforced - exceeding will return 429 errors |
| Starter | No Limit | Production ready - standard traffic priority |
| Pro | No Limit | Production ready - preferred traffic priority |
| Mega | No Limit | Production ready - highest traffic priority |
Learn more about rate limiting →
Rate Limit Headers
When rate limits apply, each Face Detector response includes headers to help you track your usage:
| Header | Description |
|---|---|
X-RateLimit-Limit | Maximum number of requests allowed per time window |
X-RateLimit-Remaining | Number of requests remaining in the current window |
X-RateLimit-Reset | Unix timestamp when the rate limit window resets |
Handling Rate Limits
Free Plan: When you exceed your rate limit, Face Detector 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 for Face Detector:
- Monitor the rate limit headers to track your Face Detector usage (Free plan only)
- Cache face detector responses where appropriate to reduce API calls
- Upgrade to Pro or Mega for guaranteed no-throttle Face Detector performance
Note: Face Detector rate limits are separate from credit consumption. You may have credits remaining but still hit rate limits when using Face Detector on Free tier.
Error Codes
The Face Detector API uses standard HTTP status codes to indicate success or failure:
| Code | Message | Description | Solution |
|---|---|---|---|
200 | OK | Request successful, data returned | No action needed - request was successful |
400 | Bad Request | Invalid request parameters or malformed request | Check required parameters and ensure values match expected formats |
401 | Unauthorized | Missing or invalid API key | Include x-api-key header with valid API key from dashboard |
403 | Forbidden | API key lacks permission or insufficient credits | Check credit balance in dashboard or upgrade plan |
429 | Too Many Requests | Rate limit exceeded (Free: 5 req/min) | Implement request throttling or upgrade to paid plan |
500 | Internal Server Error | Server error occurred | Retry request after a few seconds, contact support if persists |
503 | Service Unavailable | API temporarily unavailable | Wait and retry, check status page for maintenance updates |
Learn more about error handling →
Need help? Contact support with your X-Request-ID for assistance.
Integrate Face Detector with SDKs
Get started quickly with official Face Detector SDKs for your preferred language. Each library handles authentication, request formatting, and error handling automatically.
Available for Node.js, Python, C#/.NET, and Android/Java. All SDKs are open source and regularly updated.
Integrate Face Detector with No-Code API Tools
Connect the Face Detector API to your favorite automation platform without writing code. Build workflows that leverage face detector data across thousands of apps.





All platforms use your same API key to access Face Detector. Visit our integrations hub for step-by-step setup guides.
Frequently Asked Questions
How do I get an API key for Face Detector?
How many credits does Face Detector cost?
Each successful Face Detector API call consumes credits based on plan tier. Check the pricing section above for the exact credit cost. Failed requests and errors don't consume credits, so you only pay for successful face detector lookups.
Can I use Face Detector in production?
The free plan is for testing and development only. For production use of Face Detector, 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 from a browser?
What happens if I exceed my Face Detector credit limit?
When you reach your monthly credit limit, Face Detector 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.



