Cloudmersive Face API

Face operations of the Cloudmersive Image Recognition and Processing API — 9 operation(s) served from https://api.cloudmersive.com and authenticated with the Apikey header. One Cloudmersive API key grants access to every API in the portfolio.

Operations 9

POST /image/face/locate Detect and find faces in an image #
POST /image/face/locate-with-landmarks Detect and find faces and landmarks eyes and nose and mouth in image #
POST /image/face/compare-and-match Compare and match faces #
POST /image/face/crop/first Crop image to face with square crop #
POST /image/face/blur Blur faces in an image for privacy/anonymization #
POST /image/face/blur/round Blur faces in an image with an oval blur for privacy/anonymization #
POST /image/face/crop/first/round Crop image to face with round crop #
POST /image/face/detect-age Detect the age of people in an image #
POST /image/face/detect-gender Detect the gender of people in an image #

Work with this as data

Every API here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for apis

7 MCP tools reach this
  • find_apisBrowse and filter every API in the catalog.
  • get_api_artifactsOne API's artifacts, grouped by type.
  • get_openapiThe primary OpenAPI for this API.
  • find_similar_apisAPIs that look like this one.
  • apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
  • resolveTurn a domain, URL or GitHub org into the provider it belongs to.
  • find_cohortsEvery scored population of providers in the catalog.
All 92 tools →

Call it yourself

curl for this page
This API
curl "https://apis.io/api/v1/apis/cloudmersive:cloudmersive-face-api"
All apis
curl "https://apis.io/api/v1/apis?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

A second provider on the same verified email joins the account you already have.

OpenAPI Specification

cloudmersive-face-api-openapi.yml Raw ↑
openapi: 3.2.0
info:
  version: v1
  title: imageapi Face API
  description: Image Recognition and Processing APIs let you use Artificial Intelligence and Machine Learning to recognize and process images, and also perform useful image modification operations.
servers:
- url: http://localhost
tags:
- name: Face
paths:
  /image/face/locate:
    post:
      tags:
      - Face
      summary: Detect and find faces in an image
      description: Locate the positions of all faces in an image
      operationId: Face_Locate
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FaceLocateResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/FaceLocateResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/FaceLocateResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/FaceLocateResponse'
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                imageFile:
                  type: string
                  description: Image file to perform the operation on.  Common file formats such as PNG, JPEG are supported.
                  format: binary
              required:
              - imageFile
  /image/face/locate-with-landmarks:
    post:
      tags:
      - Face
      summary: Detect and find faces and landmarks eyes and nose and mouth in image
      description: Locate the positions of all faces in an image, along with the eyes, eye brows, nose and mouth components of each
      operationId: Face_LocateWithLandmarks
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FaceLocateWithLandmarksResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/FaceLocateWithLandmarksResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/FaceLocateWithLandmarksResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/FaceLocateWithLandmarksResponse'
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                imageFile:
                  type: string
                  description: Image file to perform the operation on.  Common file formats such as PNG, JPEG are supported.
                  format: binary
              required:
              - imageFile
  /image/face/compare-and-match:
    post:
      tags:
      - Face
      summary: Compare and match faces
      description: Find the faces in an input image, and compare against a reference image to determine if there is a match against the face in the reference image. The reference image (second parameter) should contain exactly one face.
      operationId: Face_Compare
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/FaceCompareResponse'
            text/json:
              schema:
                $ref: '#/components/schemas/FaceCompareResponse'
            application/xml:
              schema:
                $ref: '#/components/schemas/FaceCompareResponse'
            text/xml:
              schema:
                $ref: '#/components/schemas/FaceCompareResponse'
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                inputImage:
                  type: string
                  description: Image file to perform the operation on; this image can contain one or more faces which will be matched against face provided in the second image.  Common file formats such as PNG, JPEG are supported.
                  format: binary
                matchFace:
                  type: string
                  description: Image of a single face to compare and match against.
                  format: binary
              required:
              - inputImage
              - matchFace
  /image/face/crop/first:
    post:
      tags:
      - Face
      summary: Crop image to face with square crop
      description: Crop an image to the face (rectangular crop). If there is more than one face present, choose the first one.
      operationId: Face_CropFirst
      responses:
        '200':
          description: OK
          content:
            application/octet-stream:
              schema:
                format: byte
                type: string
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                imageFile:
                  type: string
                  description: Image file to perform the operation on.  Common file formats such as PNG, JPEG are supported.
                  format: binary
              required:
              - imageFile
  /image/face/blur:
    post:
      tags:
      - Face
      summary: Blur faces in an image for privacy/anonymization
      description: 'Detect all faces in an image and apply a Gaussian blur to each face region. The blur radius can be configured via the BlurRadius header (default: 10).'
      operationId: Face_BlurFaces
      parameters:
      - name: BlurRadius
        in: header
        description: Optional; the radius of the blur effect applied to detected face regions, in pixels.  Default is 20.
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/octet-stream:
              schema:
                format: byte
                type: string
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                imageFile:
                  type: string
                  description: Image file to perform the operation on.  Common file formats such as PNG, JPEG are supported.
                  format: binary
              required:
              - imageFile
  /image/face/blur/round:
    post:
      tags:
      - Face
      summary: Blur faces in an image with an oval blur for privacy/anonymization
      description: 'Detect all faces in an image and apply a Gaussian blur to an oval region matching each face. The blur radius can be configured via the BlurRadius header (default: 20).'
      operationId: Face_BlurFacesRound
      parameters:
      - name: BlurRadius
        in: header
        description: Optional; the radius of the blur effect applied to detected face regions, in pixels.  Default is 20.
        required: false
        schema:
          type: integer
      responses:
        '200':
          description: OK
          content:
            application/octet-stream:
              schema:
                format: byte
                type: string
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                imageFile:
                  type: string
                  description: Image file to perform the operation on.  Common file formats such as PNG, JPEG are supported.
                  format: binary
              required:
              - imageFile
  /image/face/crop/first/round:
    post:
      tags:
      - Face
      summary: Crop image to face with round crop
      description: Crop an image to the face (circular/round crop). If there is more than one face present, choose the first one.
      operationId: Face_CropFirstRound
      responses:
        '200':
          description: OK
          content:
            application/octet-stream:
              schema:
                format: byte
                type: string
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                imageFile:
                  type: string
                  description: Image file to perform the operation on.  Common file formats such as PNG, JPEG are supported.
                  format: binary
              required:
              - imageFile
  /image/face/detect-age:
    post:
      tags:
      - Face
      summary: Detect the age of people in an image
      description: Identify the age, position, and size of human faces in an image, along with a recognition confidence level. People in the image do NOT need to be facing the camera; they can be facing away, edge-on, etc. Input image should be a PNG or JPG. Consumes 20 API calls.
      operationId: Face_DetectAge
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgeDetectionResult'
            text/json:
              schema:
                $ref: '#/components/schemas/AgeDetectionResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/AgeDetectionResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/AgeDetectionResult'
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                imageFile:
                  type: string
                  description: Image file to perform the operation on.  Common file formats such as PNG, JPEG are supported.
                  format: binary
              required:
              - imageFile
  /image/face/detect-gender:
    post:
      tags:
      - Face
      summary: Detect the gender of people in an image
      description: Identify the gender, position, and size of human faces in an image, along with a recognition confidence level. People in the image should be facing the camera. Input image should be a PNG or JPG. Consumes 20 API calls.
      operationId: Face_DetectGender
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AgeDetectionResult'
            text/json:
              schema:
                $ref: '#/components/schemas/AgeDetectionResult'
            application/xml:
              schema:
                $ref: '#/components/schemas/AgeDetectionResult'
            text/xml:
              schema:
                $ref: '#/components/schemas/AgeDetectionResult'
      security:
      - Apikey: []
      requestBody:
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                imageFile:
                  type: string
                  description: Image file to perform the operation on.  Common file formats such as PNG, JPEG are supported.
                  format: binary
              required:
              - imageFile
components:
  schemas:
    FacePoint:
      description: Point location within a face
      type: object
      properties:
        X:
          format: int32
          description: X location, where 0 is the left-most pixel
          type: integer
        Y:
          format: int32
          description: Y location, where 0 is the top-most pixel
          type: integer
    FaceWithLandmarks:
      description: Location of one face in an image
      type: object
      properties:
        LeftX:
          format: int32
          description: X coordinate of the left side of the face
          type: integer
        TopY:
          format: int32
          description: Y coordinate of the top side of the face
          type: integer
        RightX:
          format: int32
          description: X coordinate of the right side of the face
          type: integer
        BottomY:
          format: int32
          description: Y coordinate of the bottom side of the face
          type: integer
        LeftEyebrow:
          description: Point locations of the left eyebrow (the eyebrow cloesest to the left side of the picture)
          type: array
          items:
            $ref: '#/components/schemas/FacePoint'
        RightEyebrow:
          description: Point locations of the right eyebrow (the eyebrow cloesest to the right side of the picture)
          type: array
          items:
            $ref: '#/components/schemas/FacePoint'
        LeftEye:
          description: Point locations of the left eye (the eye closest to the left side of the picture)
          type: array
          items:
            $ref: '#/components/schemas/FacePoint'
        RightEye:
          description: Point locations of the right eye (the eye closest to the right side of the picture)
          type: array
          items:
            $ref: '#/components/schemas/FacePoint'
        BottomAndSidesOfFace:
          description: Point locations of the bottom and sides of the face (cheeks and chin)
          type: array
          items:
            $ref: '#/components/schemas/FacePoint'
        NoseBridge:
          description: Point locations of the nose bridge (the vertical portion of the nose)
          type: array
          items:
            $ref: '#/components/schemas/FacePoint'
        NoseBottom:
          description: Point locations of the bottom (nostrils) of the nose
          type: array
          items:
            $ref: '#/components/schemas/FacePoint'
        LipsInnerOutline:
          description: Point locations of the inner outline of the lips
          type: array
          items:
            $ref: '#/components/schemas/FacePoint'
        LipsOuterOutline:
          description: Point locations of the outer outline of the lips
          type: array
          items:
            $ref: '#/components/schemas/FacePoint'
    AgeDetectionResult:
      description: Result from classifying the Age and Gender of people in an image
      type: object
      properties:
        Successful:
          description: True if the operation was successful, false otherwise
          type: boolean
        PeopleWithAge:
          description: People in the image annotated with age and gender information
          type: array
          items:
            $ref: '#/components/schemas/PersonWithAge'
        PeopleIdentified:
          format: int32
          description: Number of people identified in the image with an age
          type: integer
    FaceMatch:
      description: Location of one face in an image, along with match results
      type: object
      properties:
        LeftX:
          format: int32
          description: X coordinate of the left side of the face
          type: integer
        TopY:
          format: int32
          description: Y coordinate of the top side of the face
          type: integer
        RightX:
          format: int32
          description: X coordinate of the right side of the face
          type: integer
        BottomY:
          format: int32
          description: Y coordinate of the bottom side of the face
          type: integer
        HighConfidenceMatch:
          description: True if there is a high confidence match, false otherwise
          type: boolean
        MatchScore:
          format: double
          description: Match score from 0.0 to 1.0 with higher scores indicating a greater match; scores above 0.7 indicate a match
          type: number
    FaceLocateResponse:
      description: Results of locating faces in an image
      type: object
      properties:
        Successful:
          description: True if the operation was successful, false otherwise
          type: boolean
        Faces:
          description: Array of faces found in the image
          type: array
          items:
            $ref: '#/components/schemas/Face'
        FaceCount:
          format: int32
          description: Number of faces found in the image
          type: integer
        ErrorDetails:
          description: Details of any errors that occurred
          type: string
    FaceLocateWithLandmarksResponse:
      description: Results of locating faces in an image
      type: object
      properties:
        Successful:
          description: True if the operation was successful, false otherwise
          type: boolean
        Faces:
          description: Array of faces found in the image
          type: array
          items:
            $ref: '#/components/schemas/FaceWithLandmarks'
        FaceCount:
          format: int32
          description: Number of faces found in the image
          type: integer
        ErrorDetails:
          description: Details of any errors that occurred
          type: string
    Face:
      description: Location of one face in an image
      type: object
      properties:
        LeftX:
          format: int32
          description: X coordinate of the left side of the face
          type: integer
        TopY:
          format: int32
          description: Y coordinate of the top side of the face
          type: integer
        RightX:
          format: int32
          description: X coordinate of the right side of the face
          type: integer
        BottomY:
          format: int32
          description: Y coordinate of the bottom side of the face
          type: integer
    PersonWithAge:
      description: A person identified in an image age classification operation
      type: object
      properties:
        FaceLocation:
          $ref: '#/components/schemas/Face'
          description: Location and other information about the person's face corresponding to this age classification
        AgeClassificationConfidence:
          format: double
          description: Confidence level of age classification; possible values are between 0.0 and 1.0; higher is better, with values > 0.50 being high confidence results
          type: number
        AgeClass:
          description: The person's age range classification result in years; possible values are "0-2", "4-6", "8-13", "15-20", "25-32", "38-43", "48-53", "60+"
          type: string
        Age:
          format: double
          description: The specific estimated age of the person
          type: number
        GenderClassification:
          description: Gender estimation classification as Female or Male
          type: string
        GenderFemaleConfidence:
          format: double
          description: Confidence level of classification as female; possible values are between 0.0 and 1.0
          type: number
        GenderMaleConfidence:
          format: double
          description: Confidence level of classification as male; possible values are between 0.0 and 1.0
          type: number
    FaceCompareResponse:
      description: Results of comparing/matching faces in an image
      type: object
      properties:
        Successful:
          description: True if the operation was successful, false otherwise
          type: boolean
        Faces:
          description: Array of faces found in the input image
          type: array
          items:
            $ref: '#/components/schemas/FaceMatch'
        FaceCount:
          format: int32
          description: Number of faces found in the image
          type: integer
        ErrorDetails:
          description: Details of any errors that occurred
          type: string
  securitySchemes:
    Apikey:
      type: apiKey
      description: API Key Authentication
      name: Apikey
      in: header
x-provenance:
  method: harvested
  publisher: Cloudmersive
  source: https://api.cloudmersive.com/image/docs/v1/swagger
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)