AI Image Face Detection
2000 atoms
AI tier
About
This Utility API uses AI to detect faces and identify key facial features within images.
This API can analyse visual data to locate faces, enabling applications across diverse domains. This API is ideal for applications such as photo organization, security systems, and user authentication, providing a quick and reliable solution for detecting faces in visual content.
Note: In order to test the API on API Playground, just click on "Show optional inputs" and enter the Authentication token for the provider before clicking on Send request. The output response structure and the result of the AI utility APIs depend on the service provider and it may vary depending on which service provider is selected.
Endpoint Selector
Input
API Playground
Documentation
input file: output json
POST
https://api.apyhub.com/ai/image/detect/face/file
Request example
Method:
POST
Content Type:
multipart/form-data
Request Body
Attribute | Type | Mandatory | Description |
---|---|---|---|
file | file | Yes | the source image file in any of supported formats (jpeg ,jpg , png , gif , bmp ) |
requested_service | String | yes | the name of service provider for example azure ,google |
azure_key | String | yes (if azure is selected in requested_service) | service key provided by azure |
azure_endpoint | String | yes (if azure is selected in requested_service) | the endpoint provided by azure |
google_key | String | yes (if google is selected in requested_service) | service key provided by google |
Sample Response
A successful request returns the face detection response in the output parameter specified. If the request fails, the response contains an error code and a message to help determine what went wrong.
HTTP Response Codes
The method may return one of the following HTTP status codes:
Status Code | Description |
---|---|
200 | The request was successful. |
400 | Invalid input - the file is corrupt or the supported inputs are not provided. |
401 | Required authentication information is either missing or not valid for the resource. |
500 | If any unexpected error occurs while processing the request. |
Authentication
All requests to ApyHub services need to be authenticated, currently we support
tokens
or basic authentication
mechanisms.
You can generate and view your existing credentials from workspace settings (on the left side of the navbar) and go to applications.Points to note:
- Credential secrets are generated on the fly and are not stored in plain text, so on generating a credential please save the secrets somewhere safe.
- Use the
apy-token
as the header parameter to pass the token. - Use the
Authorization
header to send the basic authentication credentials.
Error codes
To search for a specific error code, enter the code in the search box below. Alternatively, you can click on the button to view a complete list of all error codes.