FaceRect API Documentation

ProcessImageFile

processFile

Returns a JSON object that contains detected faces for the uploaded image (visual demo: http://apicloud.me/apis/facerect/demo/)


/process-file.json

Usage and SDK Samples

curl -X POST -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/facerect/process-file.json?feauters="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProcessImageFileApi;

import java.io.File;
import java.util.*;

public class ProcessImageFileApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        ProcessImageFileApi apiInstance = new ProcessImageFileApi();
        File image = /path/to/file.txt; // File | Image you would like to find faces on. For supported image files and limitations please refer to the documentation: http://apicloud.me/apis/facerect/docs
        String apiecoKey = apiecoKey_example; // String | 
        Boolean feauters = true; // Boolean | Specifies if you need to find face features (eyes, nose and mouth). If set to "true", the API will search for face features within faces detected (for frontal faces only). Default value is "false". For more information please refer to the documentation:
        try {
            process result = apiInstance.processFile(image, apiecoKey, feauters);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessImageFileApi#processFile");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProcessImageFileApi;

public class ProcessImageFileApiExample {

    public static void main(String[] args) {
        ProcessImageFileApi apiInstance = new ProcessImageFileApi();
        File image = /path/to/file.txt; // File | Image you would like to find faces on. For supported image files and limitations please refer to the documentation: http://apicloud.me/apis/facerect/docs
        String apiecoKey = apiecoKey_example; // String | 
        Boolean feauters = true; // Boolean | Specifies if you need to find face features (eyes, nose and mouth). If set to "true", the API will search for face features within faces detected (for frontal faces only). Default value is "false". For more information please refer to the documentation:
        try {
            process result = apiInstance.processFile(image, apiecoKey, feauters);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessImageFileApi#processFile");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

File *image = /path/to/file.txt; // Image you would like to find faces on. For supported image files and limitations please refer to the documentation: http://apicloud.me/apis/facerect/docs
String *apiecoKey = apiecoKey_example; //  (optional)
Boolean *feauters = true; // Specifies if you need to find face features (eyes, nose and mouth). If set to "true", the API will search for face features within faces detected (for frontal faces only). Default value is "false". For more information please refer to the documentation: (optional)

ProcessImageFileApi *apiInstance = [[ProcessImageFileApi alloc] init];

//  





[apiInstance processFileWith:image
    apiecoKey:apiecoKey
    feauters:feauters
              completionHandler: ^(process output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var FaceRectApiDocumentation_ = require('face_rect_api_documentation__');
var defaultClient = FaceRectApiDocumentation_.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new FaceRectApiDocumentation_.ProcessImageFileApi()

var image = /path/to/file.txt; // {File} Image you would like to find faces on. For supported image files and limitations please refer to the documentation: http://apicloud.me/apis/facerect/docs

var opts = { 
  'apiecoKey': apiecoKey_example, // {String} 
  'feauters': true // {Boolean} Specifies if you need to find face features (eyes, nose and mouth). If set to "true", the API will search for face features within faces detected (for frontal faces only). Default value is "false". For more information please refer to the documentation:
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.processFile(image, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class processFileExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new ProcessImageFileApi();
            var image = new File(); // File | Image you would like to find faces on. For supported image files and limitations please refer to the documentation: http://apicloud.me/apis/facerect/docs
            var apiecoKey = apiecoKey_example;  // String |  (optional) 
            var feauters = true;  // Boolean | Specifies if you need to find face features (eyes, nose and mouth). If set to "true", the API will search for face features within faces detected (for frontal faces only). Default value is "false". For more information please refer to the documentation: (optional) 

            try
            {
                //  





                process result = apiInstance.processFile(image, apiecoKey, feauters);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessImageFileApi.processFile: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\ProcessImageFileApi();
$image = /path/to/file.txt; // File | Image you would like to find faces on. For supported image files and limitations please refer to the documentation: http://apicloud.me/apis/facerect/docs
$apiecoKey = apiecoKey_example; // String | 
$feauters = true; // Boolean | Specifies if you need to find face features (eyes, nose and mouth). If set to "true", the API will search for face features within faces detected (for frontal faces only). Default value is "false". For more information please refer to the documentation:

try {
    $result = $api_instance->processFile($image, $apiecoKey, $feauters);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessImageFileApi->processFile: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProcessImageFileApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProcessImageFileApi->new();
my $image = /path/to/file.txt; # File | Image you would like to find faces on. For supported image files and limitations please refer to the documentation: http://apicloud.me/apis/facerect/docs
my $apiecoKey = apiecoKey_example; # String | 
my $feauters = true; # Boolean | Specifies if you need to find face features (eyes, nose and mouth). If set to "true", the API will search for face features within faces detected (for frontal faces only). Default value is "false". For more information please refer to the documentation:

eval { 
    my $result = $api_instance->processFile(image => $image, apiecoKey => $apiecoKey, feauters => $feauters);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProcessImageFileApi->processFile: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProcessImageFileApi()
image = /path/to/file.txt # File | Image you would like to find faces on. For supported image files and limitations please refer to the documentation: http://apicloud.me/apis/facerect/docs
apiecoKey = apiecoKey_example # String |  (optional)
feauters = true # Boolean | Specifies if you need to find face features (eyes, nose and mouth). If set to "true", the API will search for face features within faces detected (for frontal faces only). Default value is "false". For more information please refer to the documentation: (optional)

try: 
    #  





    api_response = api_instance.process_file(image, apiecoKey=apiecoKey, feauters=feauters)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessImageFileApi->processFile: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key
String
Form parameters
Name Description
image*
File
Image you would like to find faces on. For supported image files and limitations please refer to the documentation: http://apicloud.me/apis/facerect/docs
Required
Query parameters
Name Description
feauters
Boolean
Specifies if you need to find face features (eyes, nose and mouth). If set to "true", the API will search for face features within faces detected (for frontal faces only). Default value is "false". For more information please refer to the documentation:

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input


ProcessImageUrl

processURL

Returns a JSON object that contains detected faces for the image specified by URL (visual demo: http://apicloud.me/apis/facerect/demo/)


/process-url.json

Usage and SDK Samples

curl -X GET -H "apieco-key: [[apiKey]]" "https://api.apieco.ir/facerect/process-url.json?url=&feauters="
import io.swagger.client.*;
import io.swagger.client.auth.*;
import io.swagger.client.model.*;
import io.swagger.client.api.ProcessImageUrlApi;

import java.io.File;
import java.util.*;

public class ProcessImageUrlApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        
        // Configure API key authorization: apieco-key
        ApiKeyAuth apieco-key = (ApiKeyAuth) defaultClient.getAuthentication("apieco-key");
        apieco-key.setApiKey("YOUR API KEY");
        // Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
        //apieco-key.setApiKeyPrefix("Token");

        ProcessImageUrlApi apiInstance = new ProcessImageUrlApi();
        String url = url_example; // String | URL of the image you would like to find faces on. For supported image files and limitations please refer to the documentation:
        String apiecoKey = apiecoKey_example; // String | 
        Boolean feauters = true; // Boolean | Specifies if you need to find face features (eyes, nose and mouth). If set to "true", the API will search for face features within faces detected (for frontal faces only). Default value is "false". For more information please refer to the documentation:
        try {
            process result = apiInstance.processURL(url, apiecoKey, feauters);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessImageUrlApi#processURL");
            e.printStackTrace();
        }
    }
}
import io.swagger.client.api.ProcessImageUrlApi;

public class ProcessImageUrlApiExample {

    public static void main(String[] args) {
        ProcessImageUrlApi apiInstance = new ProcessImageUrlApi();
        String url = url_example; // String | URL of the image you would like to find faces on. For supported image files and limitations please refer to the documentation:
        String apiecoKey = apiecoKey_example; // String | 
        Boolean feauters = true; // Boolean | Specifies if you need to find face features (eyes, nose and mouth). If set to "true", the API will search for face features within faces detected (for frontal faces only). Default value is "false". For more information please refer to the documentation:
        try {
            process result = apiInstance.processURL(url, apiecoKey, feauters);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling ProcessImageUrlApi#processURL");
            e.printStackTrace();
        }
    }
}
Configuration *apiConfig = [Configuration sharedConfig];

// Configure API key authorization: (authentication scheme: apieco-key)
[apiConfig setApiKey:@"YOUR_API_KEY" forApiKeyIdentifier:@"apieco-key"];
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
//[apiConfig setApiKeyPrefix:@"Bearer" forApiKeyIdentifier:@"apieco-key"];

String *url = url_example; // URL of the image you would like to find faces on. For supported image files and limitations please refer to the documentation:
String *apiecoKey = apiecoKey_example; //  (optional)
Boolean *feauters = true; // Specifies if you need to find face features (eyes, nose and mouth). If set to "true", the API will search for face features within faces detected (for frontal faces only). Default value is "false". For more information please refer to the documentation: (optional)

ProcessImageUrlApi *apiInstance = [[ProcessImageUrlApi alloc] init];

//  





[apiInstance processURLWith:url
    apiecoKey:apiecoKey
    feauters:feauters
              completionHandler: ^(process output, NSError* error) {
                            if (output) {
                                NSLog(@"%@", output);
                            }
                            if (error) {
                                NSLog(@"Error: %@", error);
                            }
                        }];
var FaceRectApiDocumentation_ = require('face_rect_api_documentation__');
var defaultClient = FaceRectApiDocumentation_.ApiClient.instance;

// Configure API key authorization: apieco-key
var apieco-key = defaultClient.authentications['apieco-key'];
apieco-key.apiKey = "YOUR API KEY"
// Uncomment the following line to set a prefix for the API key, e.g. "Token" (defaults to null)
//apieco-key.apiKeyPrefix['apieco-key'] = "Token"

var api = new FaceRectApiDocumentation_.ProcessImageUrlApi()

var url = url_example; // {String} URL of the image you would like to find faces on. For supported image files and limitations please refer to the documentation:

var opts = { 
  'apiecoKey': apiecoKey_example, // {String} 
  'feauters': true // {Boolean} Specifies if you need to find face features (eyes, nose and mouth). If set to "true", the API will search for face features within faces detected (for frontal faces only). Default value is "false". For more information please refer to the documentation:
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.processURL(url, opts, callback);
using System;
using System.Diagnostics;
using IO.Swagger.Api;
using IO.Swagger.Client;
using IO.Swagger.Model;

namespace Example
{
    public class processURLExample
    {
        public void main()
        {
            
            // Configure API key authorization: apieco-key
            Configuration.Default.ApiKey.Add("apieco-key", "YOUR_API_KEY");
            // Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
            // Configuration.Default.ApiKeyPrefix.Add("apieco-key", "Bearer");

            var apiInstance = new ProcessImageUrlApi();
            var url = url_example;  // String | URL of the image you would like to find faces on. For supported image files and limitations please refer to the documentation:
            var apiecoKey = apiecoKey_example;  // String |  (optional) 
            var feauters = true;  // Boolean | Specifies if you need to find face features (eyes, nose and mouth). If set to "true", the API will search for face features within faces detected (for frontal faces only). Default value is "false". For more information please refer to the documentation: (optional) 

            try
            {
                //  





                process result = apiInstance.processURL(url, apiecoKey, feauters);
                Debug.WriteLine(result);
            }
            catch (Exception e)
            {
                Debug.Print("Exception when calling ProcessImageUrlApi.processURL: " + e.Message );
            }
        }
    }
}
<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure API key authorization: apieco-key
Swagger\Client\Configuration::getDefaultConfiguration()->setApiKey('apieco-key', 'YOUR_API_KEY');
// Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
// Swagger\Client\Configuration::getDefaultConfiguration()->setApiKeyPrefix('apieco-key', 'Bearer');

$api_instance = new Swagger\Client\Api\ProcessImageUrlApi();
$url = url_example; // String | URL of the image you would like to find faces on. For supported image files and limitations please refer to the documentation:
$apiecoKey = apiecoKey_example; // String | 
$feauters = true; // Boolean | Specifies if you need to find face features (eyes, nose and mouth). If set to "true", the API will search for face features within faces detected (for frontal faces only). Default value is "false". For more information please refer to the documentation:

try {
    $result = $api_instance->processURL($url, $apiecoKey, $feauters);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ProcessImageUrlApi->processURL: ', $e->getMessage(), PHP_EOL;
}
?>
use Data::Dumper;
use WWW::SwaggerClient::Configuration;
use WWW::SwaggerClient::ProcessImageUrlApi;

# Configure API key authorization: apieco-key
$WWW::SwaggerClient::Configuration::api_key->{'apieco-key'} = 'YOUR_API_KEY';
# uncomment below to setup prefix (e.g. Bearer) for API key, if needed
#$WWW::SwaggerClient::Configuration::api_key_prefix->{'apieco-key'} = "Bearer";

my $api_instance = WWW::SwaggerClient::ProcessImageUrlApi->new();
my $url = url_example; # String | URL of the image you would like to find faces on. For supported image files and limitations please refer to the documentation:
my $apiecoKey = apiecoKey_example; # String | 
my $feauters = true; # Boolean | Specifies if you need to find face features (eyes, nose and mouth). If set to "true", the API will search for face features within faces detected (for frontal faces only). Default value is "false". For more information please refer to the documentation:

eval { 
    my $result = $api_instance->processURL(url => $url, apiecoKey => $apiecoKey, feauters => $feauters);
    print Dumper($result);
};
if ($@) {
    warn "Exception when calling ProcessImageUrlApi->processURL: $@\n";
}
from __future__ import print_statement
import time
import swagger_client
from swagger_client.rest import ApiException
from pprint import pprint

# Configure API key authorization: apieco-key
swagger_client.configuration.api_key['apieco-key'] = 'YOUR_API_KEY'
# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# swagger_client.configuration.api_key_prefix['apieco-key'] = 'Bearer'

# create an instance of the API class
api_instance = swagger_client.ProcessImageUrlApi()
url = url_example # String | URL of the image you would like to find faces on. For supported image files and limitations please refer to the documentation:
apiecoKey = apiecoKey_example # String |  (optional)
feauters = true # Boolean | Specifies if you need to find face features (eyes, nose and mouth). If set to "true", the API will search for face features within faces detected (for frontal faces only). Default value is "false". For more information please refer to the documentation: (optional)

try: 
    #  





    api_response = api_instance.process_url(url, apiecoKey=apiecoKey, feauters=feauters)
    pprint(api_response)
except ApiException as e:
    print("Exception when calling ProcessImageUrlApi->processURL: %s\n" % e)

Parameters

Header parameters
Name Description
apieco-key
String
Query parameters
Name Description
url*
String
URL of the image you would like to find faces on. For supported image files and limitations please refer to the documentation:
Required
feauters
Boolean
Specifies if you need to find face features (eyes, nose and mouth). If set to "true", the API will search for face features within faces detected (for frontal faces only). Default value is "false". For more information please refer to the documentation:

Responses

Status: 200 - Succesfull

Status: 401 - wrong code

Status: 405 - Invalid input