Face Detector API analyzes images to detect human faces and returns bounding box coordinates for each detected face.
Try it — live request, no key required
No key required to try it. Get a key to use it in your app.
{
"status": "ok",
"error": null,
"data": {
// Face Detector response payload
}
}
About the Face Detector API
Face Detector API uses advanced computer vision algorithms to identify human faces in images. It returns the precise coordinates (x, y, width, height) and confidence scores for each detected face, making it ideal for applications like photo organization, face cropping, presence detection, and privacy masking.
Ways to call it
One endpoint, many ways in — REST with JSON, XML, YAML and CSV, plus GraphQL and an MCP interface for AI agents.
- JSON
- Default REST response
- XML
- Markup format
- YAML
- Human-readable
- CSV
- Tabular export
- GraphQL
- Query language
- MCP
- For AI agents
What does the Face Detector API do?
How do I authenticate Face Detector API requests?
How much does the Face Detector API cost?
How fast is the Face Detector API?
What response formats does the Face Detector API support?
What HTTP method does the Face Detector API use?
Request parameters — POST /v1/facedetect
Sent as JSON in the request body. Premium parameters are accepted on every plan but only take effect on plans that include them. Anything not listed here is dropped rather than passed through.
Required
| Parameter | Type | Example | Description |
|---|---|---|---|
imageRequired | string | Image file upload (JPG, PNG, GIF, WebP supported, max 10MB) |
Optional
| Parameter | Type | Example | Description |
|---|---|---|---|
confidenceOptional | number | Minimum confidence threshold for face detection (0.1 to 1.0) default 0.5 · range 0.1-1 |
curl -X POST "https://api.apiverve.com/v1/facedetect" \
-H "x-api-key: YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{"confidence":0.5}'Authentication
Send your key in the x-api-key header. That is the only auth step — no token exchange, and no per-endpoint scope to configure.
| Header | When | Value |
|---|---|---|
x-api-keyRequired | Every request | Your API key. Header names are case-insensitive, so X-API-Key is the same header. |
AuthorizationAlternate | Instead of the above | Bearer <key> — for clients that only expose bearer auth. Resolves to the same account and the same billing. |
content-typeRequired | POST body | application/json |
A 401 means the key is missing, invalid or expired. A 403 means the key is valid but not permitted here — blocked by a key restriction or an IP allow-list. Running out of credits is a 429.
Response — POST /v1/facedetect
Every APIVerve endpoint returns the same three top-level keys, so one response handler covers your whole integration: status, error and data. Only data changes shape.
{
"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
}
Response fields
Paths are relative to data. Premium fields are absent rather than zeroed on plans that do not include them, so check for presence instead of comparing to 0.
| Field | Type | Example | Description |
|---|---|---|---|
facesPremium | array[3] | Array of detected faces with bounding boxes and confidence scores | |
xPremium | number | 142 | X coordinate of face bounding box top-left corner |
yPremium | number | 85 | Y coordinate of face bounding box top-left corner |
widthPremium | number | 98 | Width of face bounding box in pixels |
heightPremium | number | 112 | Height of face bounding box in pixels |
confidencePremium | number | 0.9847 | Confidence score for face detection (0.0 to 1.0) |
faceCountPremium | number | 3 | Total number of faces detected in the image |
hasFaces | boolean | true | Whether any faces were detected in the image |
imageWidthPremium | number | 640 | Width of the analyzed image in pixels |
imageHeightPremium | number | 480 | Height of the analyzed image in pixels |
averageConfidencePremium | number | 0.9627 | Average confidence score across all detected faces |
imageCoveragePremium | number | 10.23 | Percentage of image area covered by detected faces |
Response headers
Every response carries your balance, so your own code always knows where it stands without polling anything. All four are exposed to browsers through CORS.
| Header | What it carries |
|---|---|
x-api-remaining-credits | Credits left in the current cycle |
x-api-credits-used | Credits spent in the current cycle |
x-api-max-credits | The allowance for the cycle |
x-api-version | Version of the endpoint that answered |
Errors
Read the HTTP status first, then error for the specific reason. The body names the parameter that has to change.
| Status | Meaning | What to do |
|---|---|---|
400 | Input was rejected | Read error; it names the parameter that has to change. |
401 | Key missing or invalid | Check the header name and the key value. |
403 | Key valid, but not permitted here | A key restriction or an IP allow-list — never a bad key. |
429 | Rate limited, or out of credits | Read error to tell them apart, then back off or top up. |
What a call costs — 10 credits per call
Credits are shared across every APIVerve API — one balance, one key, one bill. Failed requests never count against it, so a rejected input costs nothing.
| Plan | Per month | Credits | Face Detector calls | Per 1,000 calls |
|---|---|---|---|---|
| Free | Free | 200 | 20 | Free |
| Starter | $29.99 | 200,000 | 20,000 | $1.50 |
| Pro | $99.99 | 1,000,000 | 100,000 | $1.00 |
| Mega | $299.99 | 4,000,000 | 400,000 | $0.75 |
Calls are what the credits buy at this API's rate — spend them here, on any of the other APIs, or across both. Nothing is reserved per endpoint.
Call it from cURL — POST /v1/facedetect
No SDK to install — this is a plain HTTPS call to /v1/facedetect with your key in the x-api-key header. Swap in a real key and it runs as-is.
curl "https://api.apiverve.com/v1/facedetect" \
-H "x-api-key: YOUR_API_KEY"Resources
Also published for
Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.
Call it from Node.js — POST /v1/facedetect
Install the Node.js SDK, then call the Face Detector API with your key. The client wraps the same HTTPS request, so anything it returns is what the endpoint returns.
npm install @apiverve/facedetectconst res = await fetch("https://api.apiverve.com/v1/facedetect", {
headers: { "x-api-key": "YOUR_API_KEY" },
});
const { data } = await res.json();
console.log(data);Resources
Also published for
Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.
Call it from Python — POST /v1/facedetect
No SDK to install — this is a plain HTTPS call to /v1/facedetect with your key in the x-api-key header. Swap in a real key and it runs as-is.
import requests
res = requests.get(
"https://api.apiverve.com/v1/facedetect",
headers={"x-api-key": "YOUR_API_KEY"},
)
print(res.json()["data"])Resources
Also published for
Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.
Call it from C# / .NET — POST /v1/facedetect
Install the C# / .NET SDK, then call the Face Detector API with your key. The client wraps the same HTTPS request, so anything it returns is what the endpoint returns.
dotnet add package APIVerve.API.FaceDetectorusing var client = new HttpClient();
client.DefaultRequestHeaders.Add("x-api-key", "YOUR_API_KEY");
var json = await client.GetStringAsync("https://api.apiverve.com/v1/facedetect");
Console.WriteLine(json);Resources
Also published for
Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.
Call it from Go — POST /v1/facedetect
No SDK to install — this is a plain HTTPS call to /v1/facedetect with your key in the x-api-key header. Swap in a real key and it runs as-is.
req, _ := http.NewRequest("GET", "https://api.apiverve.com/v1/facedetect", nil)
req.Header.Set("x-api-key", "YOUR_API_KEY")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))Resources
Also published for
Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.
Call it from PHP — POST /v1/facedetect
No SDK to install — this is a plain HTTPS call to /v1/facedetect with your key in the x-api-key header. Swap in a real key and it runs as-is.
$ch = curl_init("https://api.apiverve.com/v1/facedetect");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
curl_setopt($ch, CURLOPT_HTTPHEADER, ["x-api-key: YOUR_API_KEY"]);
$response = curl_exec($ch);
echo $response;Resources
Also published for
Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.
Call it from Ruby — POST /v1/facedetect
No SDK to install — this is a plain HTTPS call to /v1/facedetect with your key in the x-api-key header. Swap in a real key and it runs as-is.
require "net/http"
uri = URI("https://api.apiverve.com/v1/facedetect")
req = Net::HTTP::Get.new(uri)
req["x-api-key"] = "YOUR_API_KEY"
res = Net::HTTP.start(uri.hostname, uri.port, use_ssl: true) { |h| h.request(req) }
puts res.bodyResources
Also published for
Only the languages APIVerve ships a client for are listed — the rest call the endpoint directly over HTTPS.
Zero-code embed — one snippet, no backend
Drop an interactive Face Detector form onto any page. The widget calls the API for you, so no key ever appears in your markup and there is nothing to deploy.
Changelog — Face Detector API
Every change to this endpoint, newest first. Breaking changes ship as a new version and the previous one keeps serving — response fields are added, never removed or retyped in place, so an integration written against v1 keeps working.
Entries are picked up from dated catalog snapshots, so the first one appears after the next snapshot that moves something. A period where nothing changed produces no entry — silence is a valid changelog for the Face Detector API.
Images
- Face Detector
- HEIC Converter
- Image Converter
- NSFW Image Detector
- QR Code Reader
- SVG Converter
- WebP Converter
Related articles
All articles →
QR Codes Are Back (And This Time It's Different)Remember when QR codes were a punchline? Now they're everywhere. Here's why this time it stuck.Read
QR Codes: More Useful Than You ThinkURLs, WiFi passwords, contact cards, payment links—QR codes do more than you'd expect. Here's how to generate and read them programmatically.Read
Content Moderation: Protect Your Platform From UGCUser-generated content is a liability until it's moderated. NSFW detection, profanity filtering, spam detection—here's how to automate it.Read