Face Detector API

Overview

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/facedetect

Example

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)

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

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

Authentication

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

X-API-Key: your_api_key_here

Learn more about authentication →

Interactive 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:

Response

The Face Detector API returns responses in JSON, XML, YAML, and CSV formats. The JSON response is shown in the Example section above; alternative formats below.

Other Response Formats

<?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

Response Structure

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

Learn more about response formats →

Response Data Fields

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

Headers

Only X-API-Key is required. Optional headers include Accept for response format negotiation (JSON, XML, or YAML), User-Agent, and X-Request-ID for request tracing. See all request headers →

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/graphql

query {
  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 accepts cross-origin requests from any origin, so it can be called directly from browser-based applications without a proxy. See CORS support →

Rate Limiting

Face Detector requests are throttled per minute on the Free plan and unthrottled on paid plans. Exceeding the limit returns 429 Too Many Requests; rate-limit usage is reported in the X-RateLimit-Limit, X-RateLimit-Remaining, and X-RateLimit-Reset response headers. See per-plan limits and best practices →

Error Codes

The Face Detector API uses standard HTTP status codes — 200 on success, 400 for invalid parameters, 401 for missing or invalid keys, 403 for insufficient credits, 429 for rate-limit exhaustion, and 500/503 for server-side issues. Each error response includes an X-Request-ID header you can quote when contacting support. See full error handling guide →

SDKs for Face Detector

Official Face Detector packages on npm, PyPI, NuGet, and JitPack — plus a Postman collection and an OpenAPI spec. See the SDK guide →

JitPack

No-Code Integrations

Face Detector works with Zapier, Make, Pipedream, n8n, and Power Automate using the same API key. See setup guides →

Zapier

Make

Pipedream

n8n

Power Automate

Frequently Asked Questions

People who used this also used...

Based on your interest in Face Detector, you might also like these APIs:

WebP Converter

WebP Converter transforms WebP images to classic formats like PNG and JPG, or converts other formats to WebP for better compression. Essential for handling modern web images.

5 credits per call

SVG Converter

SVG Converter transforms vector SVG files into raster image formats. Convert SVG logos, icons, and illustrations to PNG, JPG, or WebP for use in applications that don't support vector graphics.

5 credits per call

QR Code Reader

QR Code Reader is a powerful tool that extracts text and data from QR codes in images. Simply provide an image URL or upload an image containing a QR code to decode its contents.

5 credits per call