Face API - v1.0

This API is currently available in:

  • Australia East - australiaeast.api.cognitive.microsoft.com
  • Brazil South - brazilsouth.api.cognitive.microsoft.com
  • Canada Central - canadacentral.api.cognitive.microsoft.com
  • Central India - centralindia.api.cognitive.microsoft.com
  • Central US - centralus.api.cognitive.microsoft.com
  • East Asia - eastasia.api.cognitive.microsoft.com
  • East US - eastus.api.cognitive.microsoft.com
  • East US 2 - eastus2.api.cognitive.microsoft.com
  • France Central - francecentral.api.cognitive.microsoft.com
  • Japan East - japaneast.api.cognitive.microsoft.com
  • Japan West - japanwest.api.cognitive.microsoft.com
  • Korea Central - koreacentral.api.cognitive.microsoft.com
  • North Central US - northcentralus.api.cognitive.microsoft.com
  • North Europe - northeurope.api.cognitive.microsoft.com
  • South Africa North - southafricanorth.api.cognitive.microsoft.com
  • South Central US - southcentralus.api.cognitive.microsoft.com
  • Southeast Asia - southeastasia.api.cognitive.microsoft.com
  • UK South - uksouth.api.cognitive.microsoft.com
  • West Central US - westcentralus.api.cognitive.microsoft.com
  • West Europe - westeurope.api.cognitive.microsoft.com
  • West US - westus.api.cognitive.microsoft.com
  • West US 2 - westus2.api.cognitive.microsoft.com
  • UAE North - uaenorth.api.cognitive.microsoft.com

LargeFaceList - List Face

List faces' persistedFaceId and userData in a specified large face list.

  • Faces are stored in alphabetical order of persistedFaceId created in LargeFaceList Face - Add.
  • "start" parameter (string, optional) is a persistedFaceId value that returned entries have larger ids by string comparison. "start" set to empty to indicate return from the first item.
  • "top" parameter (int, optional) specifies the number of entries to return. A maximal of 1000 entries can be returned in one call. To fetch more, you can specify "start" with the last returned entry’s persistedFaceId of the current call.
For example, total 5 persons with their face: "face1", ..., "face5".
"start=&top=" will return all 5 persons.
"start=&top=2" will return "face1", "face2".
"start=face2&top=3" will return "face3", "face4", "face5".

Http Method

GET

Select the testing console in the region where you created your resource:

West US West US 2 East US East US 2 West Central US South Central US West Europe North Europe Southeast Asia East Asia Australia East Brazil South Canada Central Central India UK South Japan East Central US France Central Korea Central Japan West North Central US South Africa North UAE North Norway East West US 3 Jio India West

Request URL

Request parameters

string

Valid character is letter in lower case or digit or '-' or '_', maximum length is 64.

(optional)
string

List large face list faces from the least persistedFaceId greater than the "start". It contains no more than 64 characters. Default is empty.

(optional)
string

The number of large face list faces to list, ranging in [1, 1000]. Default is 1000.

Request headers

string
Subscription key which provides access to this API. Found in your Cognitive Services accounts.

Request body

Response 200

A successful call returns an array of persisted faces and their information (persistedFaceId and userData).

JSON fields in response body:

Fields Type Description
persistedFaceId String persistedFaceId of the existing persisted face, created in LargeFaceList Face - Add.
userData String User-provided data attached to this persisted face. 

[
    {
        "persistedFaceId": "8a887ac2-53fd-4f55-9024-1ec77eecd08e",
        "userData": "User-provided data attached to the large face list face."
    },
    {
        "persistedFaceId": "f92f6f1b-3258-4444-8fa2-c2df505cc7ac",
        "userData": "User-provided data attached to the large face list face."
    }
]

Response 400

Error code and message returned in JSON:

Error Code Error Message Description
BadArgument 'start' is too long.
BadArgument 'top' is invalid. 

{
    "error": {
        "code": "BadArgument",
        "message": "'top' is invalid."
    }
}

Response 401

Error code and message returned in JSON:

Error Code Error Message Description
Unspecified Access denied due to invalid subscription key. Make sure you are subscribed to an API you are trying to call and provide the right key. 

{
    "error": {
        "code": "Unspecified",
        "message": "Access denied due to invalid subscription key. Make sure you are subscribed to an API you are trying to call and provide the right key."
    }
}

Response 403

{
    "error": {
        "code": "QuotaExceeded",
        "message": "Large Face List number reached limit."
    }
}

Response 404

Error code and message returned in JSON:

Error Code Error Message Description
LargeFaceListNotFound Large face list is not found.
LargeFaceListNotFound Large face list ID is invalid. 

{
    "error": {
        "code": "LargeFaceListNotFound",
        "message": "Large face list is not found."
    }
}

Response 429

{
    "error": {
        "statusCode": 429,
        "message": "Rate limit is exceeded. Try again in 26 seconds."
    }
}

Code samples

@ECHO OFF

curl -v -X GET "https://brazilsouth.api.cognitive.microsoft.com/face/v1.0/largefacelists/{largeFaceListId}/persistedfaces?start={string}&top=1000"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 

using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            // Request parameters
            queryString["start"] = "{string}";
            queryString["top"] = "1000";
            var uri = "https://brazilsouth.api.cognitive.microsoft.com/face/v1.0/largefacelists/{largeFaceListId}/persistedfaces?" + queryString;

            var response = await client.GetAsync(uri);
        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://brazilsouth.api.cognitive.microsoft.com/face/v1.0/largefacelists/{largeFaceListId}/persistedfaces");

            builder.setParameter("start", "{string}");
            builder.setParameter("top", "1000");

            URI uri = builder.build();
            HttpGet request = new HttpGet(uri);
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}


<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
            "start": "{string}",
            "top": "1000",
        };
      
        $.ajax({
            url: "https://brazilsouth.api.cognitive.microsoft.com/face/v1.0/largefacelists/{largeFaceListId}/persistedfaces?" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "GET",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>

#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://brazilsouth.api.cognitive.microsoft.com/face/v1.0/largefacelists/{largeFaceListId}/persistedfaces";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                         @"start={string}",
                         @"top=1000",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"GET"];
    // Request headers
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}

<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://brazilsouth.api.cognitive.microsoft.com/face/v1.0/largefacelists/{largeFaceListId}/persistedfaces');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
    'start' => '{string}',
    'top' => '1000',
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_GET);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
    # Request parameters
    'start': '{string}',
    'top': '1000',
})

try:
    conn = httplib.HTTPSConnection('brazilsouth.api.cognitive.microsoft.com')
    conn.request("GET", "/face/v1.0/largefacelists/{largeFaceListId}/persistedfaces?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
    # Request parameters
    'start': '{string}',
    'top': '1000',
})

try:
    conn = http.client.HTTPSConnection('brazilsouth.api.cognitive.microsoft.com')
    conn.request("GET", "/face/v1.0/largefacelists/{largeFaceListId}/persistedfaces?%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://brazilsouth.api.cognitive.microsoft.com/face/v1.0/largefacelists/{largeFaceListId}/persistedfaces')
uri.query = URI.encode_www_form({
    # Request parameters
    'start' => '{string}',
    'top' => '1000'
})

request = Net::HTTP::Get.new(uri.request_uri)
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body