Skip to content

Face Client API

by azure.com

API keyHTTPSCloud Platforms
Open documentation ↗

Overview

An API for face detection, verification, and identification.

Face Client is a cloud platforms API from azure.com. Requests are authenticated with an API key. It is served over HTTPS. Its OpenAPI description documents 63 endpoints.

At a glance

Authentication
API key
HTTPS
Yes
CORS
Unknown
Base URL
https://azure.local
Version
1.0
Endpoints
63
Spec updated
2019-09-09

Make a first request

Replace the placeholders; the documentation says exactly where credentials go.

cURL
curl -X GET "https://azure.local/facelists" \
  -H "Accept: application/json" \
  -H "X-API-Key: YOUR_API_KEY"
JavaScript
const response = await fetch("https://azure.local/facelists", {
  method: "GET",
  headers: {
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
  },
});
const data = await response.json();
console.log(data);
Python
import requests

response = requests.request(
    "GET",
    "https://azure.local/facelists",
    headers={
    "Accept": "application/json",
    "X-API-Key": "YOUR_API_KEY",
    },
    timeout=30,
)
print(response.json())

Endpoints

MethodPathWhat it does
POST/detectDetect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes.<br />
GET/facelistsList face lists’ faceListId, name, userData and recognitionModel. <br />
GET/facelists/{faceListId}Retrieve a face list’s faceListId, name, userData, recognitionModel and faces in the face list.
PUT/facelists/{faceListId}Create an empty face list with user-specified faceListId, name, an optional userData and recognitionModel. Up to 64 face lists are allowed in one subscription.
PATCH/facelists/{faceListId}Update information of a face list.
DELETE/facelists/{faceListId}Delete a specified face list.
POST/facelists/{faceListId}/persistedfacesAdd a face to a specified face list, up to 1,000 faces.
DELETE/facelists/{faceListId}/persistedfaces/{persistedFaceId}Delete a face from a face list by specified faceListId and persistedFaceId.
POST/findsimilarsGiven query face's faceId, to search the similar-looking faces from a faceId array, a face list or a large face list. faceId array contains the faces created by
POST/groupDivide candidate faces into groups based on face similarity.<br />
POST/identify1-to-many identification to find the closest matches of the specific query person face from a person group or large person group.
GET/largefacelistsList large face lists’ information of largeFaceListId, name, userData and recognitionModel. <br />
GET/largefacelists/{largeFaceListId}Retrieve a large face list’s largeFaceListId, name, userData and recognitionModel.
PUT/largefacelists/{largeFaceListId}Create an empty large face list with user-specified largeFaceListId, name, an optional userData and recognitionModel.
PATCH/largefacelists/{largeFaceListId}Update information of a large face list.
DELETE/largefacelists/{largeFaceListId}Delete a specified large face list.
GET/largefacelists/{largeFaceListId}/persistedfacesList all faces in a large face list, and retrieve face information (including userData and persistedFaceIds of registered faces of the face).
POST/largefacelists/{largeFaceListId}/persistedfacesAdd a face to a specified large face list, up to 1,000,000 faces.
GET/largefacelists/{largeFaceListId}/persistedfaces/{persistedFaceId}Retrieve information about a persisted face (specified by persistedFaceId and its belonging largeFaceListId).
PATCH/largefacelists/{largeFaceListId}/persistedfaces/{persistedFaceId}Update a persisted face's userData field.
DELETE/largefacelists/{largeFaceListId}/persistedfaces/{persistedFaceId}Delete a face from a large face list by specified largeFaceListId and persistedFaceId.
POST/largefacelists/{largeFaceListId}/trainQueue a large face list training task, the training task may not be started immediately.
GET/largefacelists/{largeFaceListId}/trainingRetrieve the training status of a large face list (completed or ongoing).
GET/largepersongroupsList all existing large person groups’ largePersonGroupId, name, userData and recognitionModel.<br />
GET/largepersongroups/{largePersonGroupId}Retrieve the information of a large person group, including its name, userData and recognitionModel. This API returns large person group information only, use [
PUT/largepersongroups/{largePersonGroupId}Create a new large person group with user-specified largePersonGroupId, name, an optional userData and recognitionModel.
PATCH/largepersongroups/{largePersonGroupId}Update an existing large person group's display name and userData. The properties which does not appear in request body will not be updated.
DELETE/largepersongroups/{largePersonGroupId}Delete an existing large person group. Persisted face features of all people in the large person group will also be deleted.
GET/largepersongroups/{largePersonGroupId}/personsList all persons in a large person group, and retrieve person information (including personId, name, userData and persistedFaceIds of registered faces of the pe
POST/largepersongroups/{largePersonGroupId}/personsCreate a new person in a specified large person group.
GET/largepersongroups/{largePersonGroupId}/persons/{personId}Retrieve a person's name and userData, and the persisted faceIds representing the registered person face feature.
PATCH/largepersongroups/{largePersonGroupId}/persons/{personId}Update name or userData of a person.
DELETE/largepersongroups/{largePersonGroupId}/persons/{personId}Delete an existing person from a large person group. The persistedFaceId, userData, person name and face feature in the person entry will all be deleted.
POST/largepersongroups/{largePersonGroupId}/persons/{personId}/persistedfacesAdd a face to a person into a large person group for face identification or verification. To deal with an image contains multiple faces, input face can be speci
GET/largepersongroups/{largePersonGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}Retrieve information about a persisted face (specified by persistedFaceId, personId and its belonging largePersonGroupId).
PATCH/largepersongroups/{largePersonGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}Update a person persisted face's userData field.
DELETE/largepersongroups/{largePersonGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}Delete a face from a person in a large person group by specified largePersonGroupId, personId and persistedFaceId.
POST/largepersongroups/{largePersonGroupId}/trainQueue a large person group training task, the training task may not be started immediately.
GET/largepersongroups/{largePersonGroupId}/trainingRetrieve the training status of a large person group (completed or ongoing).
GET/operations/{operationId}Retrieve the status of a take/apply snapshot operation.
GET/persongroupsList person groups’ personGroupId, name, userData and recognitionModel.<br />
GET/persongroups/{personGroupId}Retrieve person group name, userData and recognitionModel. To get person information under this personGroup, use [PersonGroup Person - List](/docs/services/5638
PUT/persongroups/{personGroupId}Create a new person group with specified personGroupId, name, user-provided userData and recognitionModel.
PATCH/persongroups/{personGroupId}Update an existing person group's display name and userData. The properties which does not appear in request body will not be updated.
DELETE/persongroups/{personGroupId}Delete an existing person group. Persisted face features of all people in the person group will also be deleted.
GET/persongroups/{personGroupId}/personsList all persons in a person group, and retrieve person information (including personId, name, userData and persistedFaceIds of registered faces of the person).
POST/persongroups/{personGroupId}/personsCreate a new person in a specified person group.
GET/persongroups/{personGroupId}/persons/{personId}Retrieve a person's information, including registered persisted faces, name and userData.
PATCH/persongroups/{personGroupId}/persons/{personId}Update name or userData of a person.
DELETE/persongroups/{personGroupId}/persons/{personId}Delete an existing person from a person group. The persistedFaceId, userData, person name and face feature in the person entry will all be deleted.
POST/persongroups/{personGroupId}/persons/{personId}/persistedfacesAdd a face to a person into a person group for face identification or verification. To deal with an image contains multiple faces, input face can be specified a
GET/persongroups/{personGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}Retrieve information about a persisted face (specified by persistedFaceId, personId and its belonging personGroupId).
PATCH/persongroups/{personGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}Add a face to a person into a person group for face identification or verification. To deal with an image contains multiple faces, input face can be specified a
DELETE/persongroups/{personGroupId}/persons/{personId}/persistedfaces/{persistedFaceId}Delete a face from a person in a person group by specified personGroupId, personId and persistedFaceId.
POST/persongroups/{personGroupId}/trainQueue a person group training task, the training task may not be started immediately.
GET/persongroups/{personGroupId}/trainingRetrieve the training status of a person group (completed or ongoing).
GET/snapshotsList all accessible snapshots with related information, including snapshots that were taken by the user, or snapshots to be applied to the user (subscription id
POST/snapshotsSubmit an operation to take a snapshot of face list, large face list, person group or large person group, with user-specified snapshot type, source object id, a
GET/snapshots/{snapshotId}Retrieve information about a snapshot. Snapshot is only accessible to the source subscription who took it, and target subscriptions included in the applyScope i
PATCH/snapshots/{snapshotId}Update the information of a snapshot. Only the source subscription who took the snapshot can update the snapshot.
DELETE/snapshots/{snapshotId}Delete an existing snapshot according to the snapshotId. All object data and information in the snapshot will also be deleted. Only the source subscription who
POST/snapshots/{snapshotId}/applySubmit an operation to apply a snapshot to current subscription. For each snapshot, only subscriptions included in the applyScope of Snapshot - Take can apply i
POST/verifyVerify whether two faces belong to a same person or whether one face belongs to a person.

Questions

Does the Face Client API need an API key?

Yes. The Face Client API uses API key authentication; the documentation explains how to get credentials.

Does the Face Client API support HTTPS?

Yes, the Face Client API is served over HTTPS.

How many endpoints does the Face Client API have?

Its OpenAPI description lists 63 endpoints in version 1.0. All of them are shown on this page.

What are alternatives to the Face Client API?

Other Cloud Platforms APIs include Remote Settings PROD, Linode API, DigitalOcean API, Vercel API, Platform API.

Compare alternatives →

Remote Settings PROD

Cloud Platforms

Firefox is a free web browser backed by Mozilla, a non-profit dedicated to internet health and privacy.

No auth19 endpoints

Linode API

Cloud Platforms

## Introduction The Linode API provides the ability to programmatically manage the full range of Linode products and services. This reference is designed to assist application developers and system administrators. Each endpoint includes descriptions, request syntax, and examples using standard HTTP requests. Response data is returned in JSON format. This document was generated from our OpenAPI Specification. See the <a target="_top" href="https://www.openapis.org">OpenAPI website</a> for more information. <a target="_top" href="/docs/api/openapi.yaml">Download the Linode OpenAPI Specification</a>. ## Changelog <a target="_top" href="/docs/products/tools/api/release-notes/">View our Changelog</a> to see release notes on all changes made to our API. ## Access and Authentication Some endpoints are publicly accessible without requiring authentication. All endpoints affecting your Account, however, require either a Personal Access Token or OAuth authentication (when using third-party applications). ### Personal Access Token The easiest way to access the API is with a Personal Access Token (PAT) generated from the <a target="_top" href="https://cloud.linode.com/profile/tokens">Linode Cloud Manager</a> or the [Create Personal Access Token](/docs/api/profile/#personal-access-token-create) endpoint. All scopes for the OAuth security model ([defined below](/docs/api/profile/#oauth)) apply to this security model as well. #### Authentication | Security Scheme Type: | HTTP | |-----------------------|------| | **HTTP Authorization Scheme** | bearer | ### OAuth If you only need to access the Linode API for personal use, we recommend that you create a [personal access token](/docs/api/#personal-access-token). If you're designing an application that can authenticate with an arbitrary Linode user, then you should use the OAuth 2.0 workflows presented in this section. For a more detailed example of an OAuth 2.0 implementation, see our guide on [How to Create an OAuth App with the Linode Python API Library](/docs/products/tools/api/guides/create-an-oauth-app-with-the-python-api-library/#oauth-2-authentication-exchange). Before you implement OAuth in your application, you first need to create an OAuth client. You can do this [with the Linode API](/docs/api/account/#oauth-client-create) or [via the Cloud Manager](https://cloud.linode.com/profile/clients): - When creating the client, you'll supply a `label` and a `redirect_uri` (referred to as the Callback URL in the Cloud Manager). - The response from this endpoint will give you a `client_id` and a `secret`. - Clients can be public or private, and are private by default. You can choose to make the client public when it is created. - A private client is used with applications which can securely store the client secret (that is, the secret returned to you when you first created the client). For example, an application running on a secured server that only the developer has access to would use a private OAuth client. This is also called a confidential client in some OAuth documentation. - A public client is used with applications where the client secret is not guaranteed to be secure. For example, a native app running on a user's computer may not be able to keep the client secret safe, as a user could potentially inspect the source of the application. So, native apps or apps that run in a user's browser should use a public client. - Public and private clients follow different workflows, as described below. #### OAuth Workflow The OAuth workflow is a series of exchanges between your third-party app and Linode. The workflow is used to authenticate a user before an application can start making API calls on the user's behalf. Notes: - With respect to the diagram in [section 1.2 of RFC 6749](https://tools.ietf.org/html/rfc6749#section-1.2), login.linode.com (referred to in this section as the *login server*) is the Resource Owner and the Authorization Server; api.linode.com (referred to here as the *api se

Bearer token350 endpoints

DigitalOcean API

Cloud Platforms

# Introduction The DigitalOcean API allows you to manage Droplets and resources within the DigitalOcean cloud in a simple, programmatic way using conventional HTTP requests. All of the functionality that you are familiar with in the DigitalOcean control panel is also available through the API, allowing you to script the complex actions that your situation requires. The API documentation will start with a general overview about the design and technology that has been implemented, followed by reference information about specific endpoints. ## Requests Any tool that is fluent in HTTP can communicate with the API simply by requesting the correct URI. Requests should be made using the HTTPS protocol so that traffic is encrypted. The interface responds to different methods depending on the action required. |Method|Usage| |--- |--- | |GET|For simple retrieval of information about your account, Droplets, or environment, you should use the GET method. The information you request will be returned to you as a JSON object. The attributes defined by the JSON object can be used to form additional requests. Any request using the GET method is read-only and will not affect any of the objects you are querying.| |DELETE|To destroy a resource and remove it from your account and environment, the DELETE method should be used. This will remove the specified object if it is found. If it is not found, the operation will return a response indicating that the object was not found. This idempotency means that you do not have to check for a resource's availability prior to issuing a delete command, the final state will be the same regardless of its existence.| |PUT|To update the information about a resource in your account, the PUT method is available. Like the DELETE Method, the PUT method is idempotent. It sets the state of the target using the provided values, regardless of their current values. Requests using the PUT method do not need to check the current attributes of the object.| |PATCH|Some resources support partial modification. In these cases, the PATCH method is available. Unlike PUT which generally requires a complete representation of a resource, a PATCH request is is a set of instructions on how to modify a resource updating only specific attributes.| |POST|To create a new object, your request should specify the POST method. The POST request includes all of the attributes necessary to create a new object. When you wish to create a new object, send a POST request to the target endpoint.| |HEAD|Finally, to retrieve metadata information, you should use the HEAD method to get the headers. This returns only the header of what would be returned with an associated GET request. Response headers contain some useful information about your API access and the results that are available for your request. For instance, the headers contain your current rate-limit value and the amount of time available until the limit resets. It also contains metrics about the total number of objects found, pagination information, and the total content length.| ## HTTP Statuses Along with the HTTP methods that the API responds to, it will also return standard HTTP statuses, including error codes. In the event of a problem, the status will contain the error code, while the body of the response will usually contain additional information about the problem that was encountered. In general, if the status returned is in the 200 range, it indicates that the request was fulfilled successfully and that no error was encountered. Return codes in the 400 range typically indicate that there was an issue with the request that was sent. Among other things, this could mean that you did not authenticate correctly, that you are requesting an action that you do not have authorization for, that the object you are requesting does not exist, or that your request is malformed. If you receive a status in the 500 range, this generally indicates a server-side problem. This means that we are having

Bearer token290 endpoints

Vercel API

Cloud Platforms

Vercel combines the best developer experience with an obsessive focus on end-user performance. Our platform enables frontend teams to do their best work.

Bearer token112 endpoints

Platform API

Cloud Platforms

The [REST API specification](https://www.ably.io/documentation/rest-api) for Ably.

HTTP Basic22 endpoints

Azure Data Lake Storage

Cloud Platforms

Azure Data Lake Storage provides storage for Hadoop and other big data workloads.

No auth10 endpoints

Listed from APIs.guru (CC0).