id
stringlengths
53
86
api_name
stringlengths
2
76
api_description
stringlengths
1
500
api_score
float64
0
10
endpoint_name
stringlengths
1
190
endpoint_description
stringlengths
0
500
response_status_code
int64
100
505
response_summary
stringlengths
1
68
response_json
stringlengths
6
50k
response_json_schema
stringlengths
14
150k
975b58f7-85ea-4e68-b0ce-868ac028542a/f3351362-cc43-4a44-b8e3-6c0d6e818919/0/0
Woosmap
Location-based Search Platform
7
updateStores
Used to update assets in batch. storeId must exists when using PUT method, if one asset does not exists, the batch will be refused.
401
null
{"detail": "Incorrect authentication credentials. Please check or use a valid API Key"}
{"title": "Error401", "type": "object", "description": "Authentication credentials are incorrect", "properties": {"detail": {"description": "Details for the credentials error", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/f3351362-cc43-4a44-b8e3-6c0d6e818919/1/0
Woosmap
Location-based Search Platform
7
updateStores
Used to update assets in batch. storeId must exists when using PUT method, if one asset does not exists, the batch will be refused.
400
null
{"status": "error", "value": "The request is invalid, the data is not a valid JSON."}
{"title": "Error400", "type": "object", "description": "The request is invalid", "properties": {"status": {"type": "string", "description": "the status of the request"}, "value": {"description": "the value of request", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/f3351362-cc43-4a44-b8e3-6c0d6e818919/2/0
Woosmap
Location-based Search Platform
7
updateStores
Used to update assets in batch. storeId must exists when using PUT method, if one asset does not exists, the batch will be refused.
403
null
{"detail": "This Woosmap API is not enabled for this project."}
{"title": "Error403", "type": "object", "description": "API Request is authenticated but API Key don't have permission to access the resources", "properties": {"detail": {"description": "Details for the forbidden error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/f3351362-cc43-4a44-b8e3-6c0d6e818919/3/0
Woosmap
Location-based Search Platform
7
updateStores
Used to update assets in batch. storeId must exists when using PUT method, if one asset does not exists, the batch will be refused.
200
null
{"status": "success", "value": "1 stores"}
{"title": "Success", "type": "object", "description": "Message returned to a success request", "properties": {"status": {"type": "string", "description": "the status of the request"}, "value": {"description": "the value of request", "oneOf": [{"type": "string"}, {"type": "integer"}]}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/c69e7900-ffff-49e5-89a6-80ee311ccbb5/0/0
Woosmap
Location-based Search Platform
7
createStores
Used to batch create Assets to a specific project identified with the private_key parameter.
400
null
{"status": "error", "value": "The request is invalid, the data is not a valid JSON."}
{"title": "Error400", "type": "object", "description": "The request is invalid", "properties": {"status": {"type": "string", "description": "the status of the request"}, "value": {"description": "the value of request", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/c69e7900-ffff-49e5-89a6-80ee311ccbb5/1/0
Woosmap
Location-based Search Platform
7
createStores
Used to batch create Assets to a specific project identified with the private_key parameter.
200
null
{"status": "success", "value": "2 stores"}
{"title": "Success", "type": "object", "description": "Message returned to a success request", "properties": {"status": {"type": "string", "description": "the status of the request"}, "value": {"description": "the value of request", "oneOf": [{"type": "string"}, {"type": "integer"}]}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/c69e7900-ffff-49e5-89a6-80ee311ccbb5/2/0
Woosmap
Location-based Search Platform
7
createStores
Used to batch create Assets to a specific project identified with the private_key parameter.
403
null
{"detail": "This Woosmap API is not enabled for this project."}
{"title": "Error403", "type": "object", "description": "API Request is authenticated but API Key don't have permission to access the resources", "properties": {"detail": {"description": "Details for the forbidden error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/c69e7900-ffff-49e5-89a6-80ee311ccbb5/3/0
Woosmap
Location-based Search Platform
7
createStores
Used to batch create Assets to a specific project identified with the private_key parameter.
401
null
{"detail": "Incorrect authentication credentials. Please check or use a valid API Key"}
{"title": "Error401", "type": "object", "description": "Authentication credentials are incorrect", "properties": {"detail": {"description": "Details for the credentials error", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/76c6ffc3-1046-4221-9b26-b9f77421f725/0/0
Woosmap
Location-based Search Platform
7
localitiesAutocomplete
Autocomplete on worldwide suggestions for a for text-based geographic searches. It can match on full words as well as substrings. You can therefore send queries as the user types, to provide on-the-fly city names, postal codes or suburb name suggestions.
200
null
{"localities": [{"public_id": "Ch6qA8cLmvyvEEoFy6nYeFcEdNU=", "description": "London, City of London, United Kingdom", "name": "London", "type": "locality", "location": {"lat": 51.50732, "lng": -0.12764746}, "matched_substrings": {"name": [{"offset": 0, "length": 4}], "admin_1": [{"offset": 8, "length": 4}], "descripti...
{"title": "LocalitiesAutocompleteCollectionResponse", "type": "object", "description": "Localities Collection Response containing Localities", "properties": {"localities": {"type": "array", "items": {"title": "LocalitiesAutocompleteResponse", "type": "object", "description": "Attributes describing a locality. Not all a...
975b58f7-85ea-4e68-b0ce-868ac028542a/76c6ffc3-1046-4221-9b26-b9f77421f725/1/0
Woosmap
Location-based Search Platform
7
localitiesAutocomplete
Autocomplete on worldwide suggestions for a for text-based geographic searches. It can match on full words as well as substrings. You can therefore send queries as the user types, to provide on-the-fly city names, postal codes or suburb name suggestions.
429
null
{"detail": "The rate limit for this endpoint has been exceeded"}
{"title": "Error429", "type": "object", "description": "Over Query Limit. Check the API Documentation for available QPS.", "properties": {"detail": {"description": "Details for the Over Query Limit error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/76c6ffc3-1046-4221-9b26-b9f77421f725/2/0
Woosmap
Location-based Search Platform
7
localitiesAutocomplete
Autocomplete on worldwide suggestions for a for text-based geographic searches. It can match on full words as well as substrings. You can therefore send queries as the user types, to provide on-the-fly city names, postal codes or suburb name suggestions.
403
null
{"detail": "This Woosmap API is not enabled for this project."}
{"title": "Error403", "type": "object", "description": "API Request is authenticated but API Key don't have permission to access the resources", "properties": {"detail": {"description": "Details for the forbidden error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/76c6ffc3-1046-4221-9b26-b9f77421f725/3/0
Woosmap
Location-based Search Platform
7
localitiesAutocomplete
Autocomplete on worldwide suggestions for a for text-based geographic searches. It can match on full words as well as substrings. You can therefore send queries as the user types, to provide on-the-fly city names, postal codes or suburb name suggestions.
401
null
{"detail": "Incorrect authentication credentials. Please check or use a valid API Key"}
{"title": "Error401", "type": "object", "description": "Authentication credentials are incorrect", "properties": {"detail": {"description": "Details for the credentials error", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/4ec9ab59-bcb2-4974-a64e-c0dadc58b390/0/0
Woosmap
Location-based Search Platform
7
localitiesDetails
Provides details of an autocomplete suggestion (using the suggestion’s public_id).
200
null
{"result": {"formatted_address": "House Of Commons, House Of Commons Palace Of Westminster, Parliament Square, London, SW1A 0AA", "types": ["address"], "public_id": "MVZWBfGZQnAQn9JtE9CJZjgeB4Q=", "geometry": {"location": {"lat": 51.49984, "lng": -0.1246375}, "accuracy": "ROOFTOP"}, "address_components": [{"types": ["c...
{"title": "LocalitiesDetailsResponse", "type": "object", "description": "Localities Details Root Node Response", "properties": {"result": {"description": "The Root Node for Localities Details", "type": "object", "anyOf": [{"title": "LocalitiesDetailsAddressResponse", "type": "object", "description": "Attributes describ...
975b58f7-85ea-4e68-b0ce-868ac028542a/4ec9ab59-bcb2-4974-a64e-c0dadc58b390/0/1
Woosmap
Location-based Search Platform
7
localitiesDetails
Provides details of an autocomplete suggestion (using the suggestion’s public_id).
200
null
{"result": {"formatted_address": "SW1A 0AA, City of London", "types": ["postal_code"], "public_id": "QaCU+fBtigK65ztSrqHqUoUDwZw=", "name": "SW1A 0AA", "geometry": {"location": {"lat": 51.49984, "lng": -0.124663}}, "address_components": [{"types": ["country", "administrative_area_level_0"], "long_name": "United Kingdom...
{"title": "LocalitiesDetailsResponse", "type": "object", "description": "Localities Details Root Node Response", "properties": {"result": {"description": "The Root Node for Localities Details", "type": "object", "anyOf": [{"title": "LocalitiesDetailsAddressResponse", "type": "object", "description": "Attributes describ...
975b58f7-85ea-4e68-b0ce-868ac028542a/4ec9ab59-bcb2-4974-a64e-c0dadc58b390/1/0
Woosmap
Location-based Search Platform
7
localitiesDetails
Provides details of an autocomplete suggestion (using the suggestion’s public_id).
403
null
{"detail": "This Woosmap API is not enabled for this project."}
{"title": "Error403", "type": "object", "description": "API Request is authenticated but API Key don't have permission to access the resources", "properties": {"detail": {"description": "Details for the forbidden error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/4ec9ab59-bcb2-4974-a64e-c0dadc58b390/2/0
Woosmap
Location-based Search Platform
7
localitiesDetails
Provides details of an autocomplete suggestion (using the suggestion’s public_id).
401
null
{"detail": "Incorrect authentication credentials. Please check or use a valid API Key"}
{"title": "Error401", "type": "object", "description": "Authentication credentials are incorrect", "properties": {"detail": {"description": "Details for the credentials error", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/4ec9ab59-bcb2-4974-a64e-c0dadc58b390/3/0
Woosmap
Location-based Search Platform
7
localitiesDetails
Provides details of an autocomplete suggestion (using the suggestion’s public_id).
429
null
{"detail": "The rate limit for this endpoint has been exceeded"}
{"title": "Error429", "type": "object", "description": "Over Query Limit. Check the API Documentation for available QPS.", "properties": {"detail": {"description": "Details for the Over Query Limit error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/e75d39bb-4f44-407a-abf9-1e04b6879915/0/0
Woosmap
Location-based Search Platform
7
addressAutocomplete
Autocomplete on worldwide suggestions for a for text-based geographic searches. It can match on full words as well as substrings.
200
null
{"predictions": [{"public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0", "description": "London, England, United Kingdom", "matched_substring": {"description": [{"offset": 0, "length": 4}]}, "type": "locality"}, {"public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwNDE5Nzgz", "description": "Londonderry, Northern Ireland, United Ki...
{"title": "AddressAutocompleteCollectionResponse", "type": "object", "description": "Address Collection Response containing Localities", "properties": {"predictions": {"type": "array", "items": {"title": "AddressAutocompleteResponse", "type": "object", "description": "Attributes describing an Address.", "properties": {...
975b58f7-85ea-4e68-b0ce-868ac028542a/e75d39bb-4f44-407a-abf9-1e04b6879915/1/0
Woosmap
Location-based Search Platform
7
addressAutocomplete
Autocomplete on worldwide suggestions for a for text-based geographic searches. It can match on full words as well as substrings.
429
null
{"detail": "The rate limit for this endpoint has been exceeded"}
{"title": "Error429", "type": "object", "description": "Over Query Limit. Check the API Documentation for available QPS.", "properties": {"detail": {"description": "Details for the Over Query Limit error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/e75d39bb-4f44-407a-abf9-1e04b6879915/2/0
Woosmap
Location-based Search Platform
7
addressAutocomplete
Autocomplete on worldwide suggestions for a for text-based geographic searches. It can match on full words as well as substrings.
403
null
{"detail": "This Woosmap API is not enabled for this project."}
{"title": "Error403", "type": "object", "description": "API Request is authenticated but API Key don't have permission to access the resources", "properties": {"detail": {"description": "Details for the forbidden error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/e75d39bb-4f44-407a-abf9-1e04b6879915/3/0
Woosmap
Location-based Search Platform
7
addressAutocomplete
Autocomplete on worldwide suggestions for a for text-based geographic searches. It can match on full words as well as substrings.
401
null
{"detail": "Incorrect authentication credentials. Please check or use a valid API Key"}
{"title": "Error401", "type": "object", "description": "Authentication credentials are incorrect", "properties": {"detail": {"description": "Details for the credentials error", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/e8ca5bc2-5347-4343-9ed3-474cbb2a6d23/0/0
Woosmap
Location-based Search Platform
7
getMerchantsBrand
Retrieve clean names and logos in response to a dirty transactions POST.
403
null
{"detail": "This Woosmap API is not enabled for this project."}
{"title": "Error403", "type": "object", "description": "API Request is authenticated but API Key don't have permission to access the resources", "properties": {"detail": {"description": "Details for the forbidden error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/e8ca5bc2-5347-4343-9ed3-474cbb2a6d23/1/0
Woosmap
Location-based Search Platform
7
getMerchantsBrand
Retrieve clean names and logos in response to a dirty transactions POST.
400
null
{"status": "error", "value": "The request is invalid, the data is not a valid JSON."}
{"title": "Error400", "type": "object", "description": "The request is invalid", "properties": {"status": {"type": "string", "description": "the status of the request"}, "value": {"description": "the value of request", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/e8ca5bc2-5347-4343-9ed3-474cbb2a6d23/2/0
Woosmap
Location-based Search Platform
7
getMerchantsBrand
Retrieve clean names and logos in response to a dirty transactions POST.
429
null
{"detail": "The rate limit for this endpoint has been exceeded"}
{"title": "Error429", "type": "object", "description": "Over Query Limit. Check the API Documentation for available QPS.", "properties": {"detail": {"description": "Details for the Over Query Limit error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/e8ca5bc2-5347-4343-9ed3-474cbb2a6d23/3/0
Woosmap
Location-based Search Platform
7
getMerchantsBrand
Retrieve clean names and logos in response to a dirty transactions POST.
200
null
{"merchants": [{"dirty_name": "MCDO UK 2231 EP", "clean_name": "McDonald's", "status": "OK", "logo": "956bcb3591a8976ff94871a59b09eecc", "logo_url": "https://api.woosmap.com/merchants/logos/956bcb3591a8976ff94871a59b09eecc.png", "country": "GB"}, {"dirty_name": "Zara Fashion Retail, S.A.", "clean_name": "Zara", "status...
{"title": "MerchantsBrandResponse", "type": "object", "description": "Attributes describing a Merchant Brand response", "properties": {"merchants": {"description": "The list of cleaned transactions", "type": "array", "items": {"title": "MerchantsBrandClean", "type": "object", "description": "Attributes describing each ...
975b58f7-85ea-4e68-b0ce-868ac028542a/e8ca5bc2-5347-4343-9ed3-474cbb2a6d23/4/0
Woosmap
Location-based Search Platform
7
getMerchantsBrand
Retrieve clean names and logos in response to a dirty transactions POST.
401
null
{"detail": "Incorrect authentication credentials. Please check or use a valid API Key"}
{"title": "Error401", "type": "object", "description": "Authentication credentials are incorrect", "properties": {"detail": {"description": "Details for the credentials error", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/8686ac07-1fb5-4883-a980-d5ba1e626590/0/0
Woosmap
Location-based Search Platform
7
addressDetails
Provides details of an address autocomplete suggestion (using the suggestion’s public_id).
401
null
{"detail": "Incorrect authentication credentials. Please check or use a valid API Key"}
{"title": "Error401", "type": "object", "description": "Authentication credentials are incorrect", "properties": {"detail": {"description": "Details for the credentials error", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/8686ac07-1fb5-4883-a980-d5ba1e626590/1/0
Woosmap
Location-based Search Platform
7
addressDetails
Provides details of an address autocomplete suggestion (using the suggestion’s public_id).
429
null
{"detail": "The rate limit for this endpoint has been exceeded"}
{"title": "Error429", "type": "object", "description": "Over Query Limit. Check the API Documentation for available QPS.", "properties": {"detail": {"description": "Details for the Over Query Limit error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/8686ac07-1fb5-4883-a980-d5ba1e626590/2/0
Woosmap
Location-based Search Platform
7
addressDetails
Provides details of an address autocomplete suggestion (using the suggestion’s public_id).
200
null
{"result": {"formatted_address": "London, England, United Kingdom", "types": ["locality"], "public_id": "aGVyZTpjbTpuYW1lZHBsYWNlOjIwMzM3NDU0", "address_components": [{"types": ["country"], "long_name": "United Kingdom", "short_name": "GBR"}, {"types": ["state"], "long_name": "England", "short_name": "England"}, {"type...
{"title": "AddressDetailsResponse", "type": "object", "description": "Address Details Response", "properties": {"status": {"title": "AddressStatus", "type": "string", "description": "Returns more info on if the request was successful or not, valid responses.\n * `OK` indicates the response contains a valid result.\n ...
975b58f7-85ea-4e68-b0ce-868ac028542a/8686ac07-1fb5-4883-a980-d5ba1e626590/3/0
Woosmap
Location-based Search Platform
7
addressDetails
Provides details of an address autocomplete suggestion (using the suggestion’s public_id).
403
null
{"detail": "This Woosmap API is not enabled for this project."}
{"title": "Error403", "type": "object", "description": "API Request is authenticated but API Key don't have permission to access the resources", "properties": {"detail": {"description": "Details for the forbidden error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/cfe0468a-d564-4797-823c-00526f62f43d/0/0
Woosmap
Location-based Search Platform
7
getMerchantsPlace
Retrieve clean names, logos and Google Place ID of given dirty merchants name.
429
null
{"detail": "The rate limit for this endpoint has been exceeded"}
{"title": "Error429", "type": "object", "description": "Over Query Limit. Check the API Documentation for available QPS.", "properties": {"detail": {"description": "Details for the Over Query Limit error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/cfe0468a-d564-4797-823c-00526f62f43d/1/0
Woosmap
Location-based Search Platform
7
getMerchantsPlace
Retrieve clean names, logos and Google Place ID of given dirty merchants name.
200
null
{"merchants": [{"dirty_name": "MCDO UK 2231 EP", "clean_name": "McDonald's", "status": "OK", "logo": "956bcb3591a8976ff94871a59b09eecc", "logo_url": "https://api.woosmap.com/merchants/logos/956bcb3591a8976ff94871a59b09eecc.png", "country": "GB", "merchant_id": "234482729011", "place_id": "ChIJGS7Sga0cdkgR46nd-S661TM"},...
{"title": "MerchantsPlaceResponse", "type": "object", "description": "Attributes describing a Merchant Place Response", "properties": {"merchants": {"description": "The list of cleaned transactions", "type": "array", "items": {"title": "MerchantsPlaceClean", "description": "Attributes describing each Merchant Brand cle...
975b58f7-85ea-4e68-b0ce-868ac028542a/cfe0468a-d564-4797-823c-00526f62f43d/2/0
Woosmap
Location-based Search Platform
7
getMerchantsPlace
Retrieve clean names, logos and Google Place ID of given dirty merchants name.
403
null
{"detail": "This Woosmap API is not enabled for this project."}
{"title": "Error403", "type": "object", "description": "API Request is authenticated but API Key don't have permission to access the resources", "properties": {"detail": {"description": "Details for the forbidden error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/cfe0468a-d564-4797-823c-00526f62f43d/3/0
Woosmap
Location-based Search Platform
7
getMerchantsPlace
Retrieve clean names, logos and Google Place ID of given dirty merchants name.
400
null
{"status": "error", "value": "The request is invalid, the data is not a valid JSON."}
{"title": "Error400", "type": "object", "description": "The request is invalid", "properties": {"status": {"type": "string", "description": "the status of the request"}, "value": {"description": "the value of request", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/cfe0468a-d564-4797-823c-00526f62f43d/4/0
Woosmap
Location-based Search Platform
7
getMerchantsPlace
Retrieve clean names, logos and Google Place ID of given dirty merchants name.
401
null
{"detail": "Incorrect authentication credentials. Please check or use a valid API Key"}
{"title": "Error401", "type": "object", "description": "Authentication credentials are incorrect", "properties": {"detail": {"description": "Details for the credentials error", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/96fc9f20-e55d-40a9-b4f4-fed1923de661/0/0
Woosmap
Location-based Search Platform
7
getDistanceMatrix
Get distances and durations for a matrix of origins and destinations, based on the recommended route between start and end points for a specified travel mode.
401
null
{"detail": "Incorrect authentication credentials. Please check or use a valid API Key"}
{"title": "Error401", "type": "object", "description": "Authentication credentials are incorrect", "properties": {"detail": {"description": "Details for the credentials error", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/96fc9f20-e55d-40a9-b4f4-fed1923de661/1/0
Woosmap
Location-based Search Platform
7
getDistanceMatrix
Get distances and durations for a matrix of origins and destinations, based on the recommended route between start and end points for a specified travel mode.
429
null
{"detail": "The rate limit for this endpoint has been exceeded"}
{"title": "Error429", "type": "object", "description": "Over Query Limit. Check the API Documentation for available QPS.", "properties": {"detail": {"description": "Details for the Over Query Limit error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/96fc9f20-e55d-40a9-b4f4-fed1923de661/2/0
Woosmap
Location-based Search Platform
7
getDistanceMatrix
Get distances and durations for a matrix of origins and destinations, based on the recommended route between start and end points for a specified travel mode.
403
null
{"detail": "This Woosmap API is not enabled for this project."}
{"title": "Error403", "type": "object", "description": "API Request is authenticated but API Key don't have permission to access the resources", "properties": {"detail": {"description": "Details for the forbidden error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/96fc9f20-e55d-40a9-b4f4-fed1923de661/3/0
Woosmap
Location-based Search Platform
7
getDistanceMatrix
Get distances and durations for a matrix of origins and destinations, based on the recommended route between start and end points for a specified travel mode.
200
null
{"status": "OK", "rows": [{"elements": [{"status": "OK", "duration": {"value": 866, "text": "14 mins"}, "distance": {"value": 10613, "text": "10.6 km"}}, {"status": "OK", "duration": {"value": 935, "text": "16 mins"}, "distance": {"value": 10287, "text": "10.3 km"}}]}]}
{"title": "DistanceMatrixResponse", "type": "object", "description": "Attributes describing an distance Matrix response.", "properties": {"status": {"title": "DistanceStatus", "type": "string", "description": "Returns more info on if the request was successful or not.\n * `OK` indicates the response contains a valid r...
975b58f7-85ea-4e68-b0ce-868ac028542a/1c5ac99f-3b82-4ddc-b491-411e98abfaee/0/0
Woosmap
Location-based Search Platform
7
getRoute
Get distance, duration and path (as a polyline) for a pair of origin and destination, based on the recommended route between those two points for a specified travel mode.
200
null
{"status": "OK", "routes": [{"overview_polyline": {"points": "iohhH_gtMA?a@ME?I?GAOEKCQEUGCAIE}@c@UKIEmAm@UOs@]e@U[O[OA?OKiAk@WIAGAECCCAE@C@CIGIaAm@YIQKe@_@m@i@UWq@s@{@kAe@m@_@o@u@oAo@iA_@u@[w@Yw@So@Y}@[y@MYO[Ua@{AmC]k@UYMQ]e@Wa@m@cAU_@S]Oa@Wm@Wo@Wo@]o@_AaBm@eAKSCCQ]EEYi@IKeAoBiCgF[s@Og@_@sA@CBC?E?EAEAECACAC?CW]_BK_@Sk...
{"title": "DistanceRouteResponse", "type": "object", "description": "Attributes describing a distance route response.", "properties": {"status": {"title": "DistanceStatus", "type": "string", "description": "Returns more info on if the request was successful or not.\n * `OK` indicates the response contains a valid resu...
975b58f7-85ea-4e68-b0ce-868ac028542a/1c5ac99f-3b82-4ddc-b491-411e98abfaee/1/0
Woosmap
Location-based Search Platform
7
getRoute
Get distance, duration and path (as a polyline) for a pair of origin and destination, based on the recommended route between those two points for a specified travel mode.
429
null
{"detail": "The rate limit for this endpoint has been exceeded"}
{"title": "Error429", "type": "object", "description": "Over Query Limit. Check the API Documentation for available QPS.", "properties": {"detail": {"description": "Details for the Over Query Limit error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/1c5ac99f-3b82-4ddc-b491-411e98abfaee/2/0
Woosmap
Location-based Search Platform
7
getRoute
Get distance, duration and path (as a polyline) for a pair of origin and destination, based on the recommended route between those two points for a specified travel mode.
403
null
{"detail": "This Woosmap API is not enabled for this project."}
{"title": "Error403", "type": "object", "description": "API Request is authenticated but API Key don't have permission to access the resources", "properties": {"detail": {"description": "Details for the forbidden error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/1c5ac99f-3b82-4ddc-b491-411e98abfaee/3/0
Woosmap
Location-based Search Platform
7
getRoute
Get distance, duration and path (as a polyline) for a pair of origin and destination, based on the recommended route between those two points for a specified travel mode.
401
null
{"detail": "Incorrect authentication credentials. Please check or use a valid API Key"}
{"title": "Error401", "type": "object", "description": "Authentication credentials are incorrect", "properties": {"detail": {"description": "Details for the credentials error", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/af49988f-db6d-46ef-81c1-ca1ffa159db9/0/0
Woosmap
Location-based Search Platform
7
postDistanceMatrix
Get distances and durations for a matrix of origins and destinations, based on the recommended route between start and end points for a specified travel mode. If the URL size is too short for your origins and destinations, you should request the server using this POST method and passing arguments as json.
403
null
{"detail": "This Woosmap API is not enabled for this project."}
{"title": "Error403", "type": "object", "description": "API Request is authenticated but API Key don't have permission to access the resources", "properties": {"detail": {"description": "Details for the forbidden error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/af49988f-db6d-46ef-81c1-ca1ffa159db9/1/0
Woosmap
Location-based Search Platform
7
postDistanceMatrix
Get distances and durations for a matrix of origins and destinations, based on the recommended route between start and end points for a specified travel mode. If the URL size is too short for your origins and destinations, you should request the server using this POST method and passing arguments as json.
401
null
{"detail": "Incorrect authentication credentials. Please check or use a valid API Key"}
{"title": "Error401", "type": "object", "description": "Authentication credentials are incorrect", "properties": {"detail": {"description": "Details for the credentials error", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/af49988f-db6d-46ef-81c1-ca1ffa159db9/2/0
Woosmap
Location-based Search Platform
7
postDistanceMatrix
Get distances and durations for a matrix of origins and destinations, based on the recommended route between start and end points for a specified travel mode. If the URL size is too short for your origins and destinations, you should request the server using this POST method and passing arguments as json.
429
null
{"detail": "The rate limit for this endpoint has been exceeded"}
{"title": "Error429", "type": "object", "description": "Over Query Limit. Check the API Documentation for available QPS.", "properties": {"detail": {"description": "Details for the Over Query Limit error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/af49988f-db6d-46ef-81c1-ca1ffa159db9/3/0
Woosmap
Location-based Search Platform
7
postDistanceMatrix
Get distances and durations for a matrix of origins and destinations, based on the recommended route between start and end points for a specified travel mode. If the URL size is too short for your origins and destinations, you should request the server using this POST method and passing arguments as json.
200
null
{"status": "OK", "rows": [{"elements": [{"status": "OK", "duration": {"value": 866, "text": "14 mins"}, "distance": {"value": 10613, "text": "10.6 km"}}, {"status": "OK", "duration": {"value": 935, "text": "16 mins"}, "distance": {"value": 10287, "text": "10.3 km"}}]}]}
{"title": "DistanceMatrixResponse", "type": "object", "description": "Attributes describing an distance Matrix response.", "properties": {"status": {"title": "DistanceStatus", "type": "string", "description": "Returns more info on if the request was successful or not.\n * `OK` indicates the response contains a valid r...
975b58f7-85ea-4e68-b0ce-868ac028542a/af49988f-db6d-46ef-81c1-ca1ffa159db9/4/0
Woosmap
Location-based Search Platform
7
postDistanceMatrix
Get distances and durations for a matrix of origins and destinations, based on the recommended route between start and end points for a specified travel mode. If the URL size is too short for your origins and destinations, you should request the server using this POST method and passing arguments as json.
400
null
{"status": "error", "value": "The request is invalid, the data is not a valid JSON."}
{"title": "Error400", "type": "object", "description": "The request is invalid", "properties": {"status": {"type": "string", "description": "the status of the request"}, "value": {"description": "the value of request", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/2de36abe-2813-41e6-9b55-791b25efe460/0/0
Woosmap
Location-based Search Platform
7
getStoresFromGeolocationPosition
Retrieve the stores nearby an ip location. Stores are returned only if a relevant ip location is found - for an accuracy of 20km or less.
200
null
{"country_code": "US", "country_name": "United States", "continent": "North America", "latitude": 38.7304, "longitude": -77.0634, "accuracy": 5, "viewport": {"northeast": {"lat": 38.77531576420598, "lng": -77.00582296106178}, "southwest": {"lat": 38.68548423579403, "lng": -77.12097703893822}}, "city": "Alexandria", "re...
{"title": "GeolocationStoresResponse", "description": "A successful geolocation request will return a JSON-formatted response defining a location and radius.", "type": "object", "properties": {"stores": {"title": "AssetFeatureCollectionResponse", "type": "object", "description": "Assets Collection Response as a GeoJSon...
975b58f7-85ea-4e68-b0ce-868ac028542a/2de36abe-2813-41e6-9b55-791b25efe460/1/0
Woosmap
Location-based Search Platform
7
getStoresFromGeolocationPosition
Retrieve the stores nearby an ip location. Stores are returned only if a relevant ip location is found - for an accuracy of 20km or less.
401
null
{"detail": "Incorrect authentication credentials. Please check or use a valid API Key"}
{"title": "Error401", "type": "object", "description": "Authentication credentials are incorrect", "properties": {"detail": {"description": "Details for the credentials error", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/2de36abe-2813-41e6-9b55-791b25efe460/2/0
Woosmap
Location-based Search Platform
7
getStoresFromGeolocationPosition
Retrieve the stores nearby an ip location. Stores are returned only if a relevant ip location is found - for an accuracy of 20km or less.
403
null
{"detail": "This Woosmap API is not enabled for this project."}
{"title": "Error403", "type": "object", "description": "API Request is authenticated but API Key don't have permission to access the resources", "properties": {"detail": {"description": "Details for the forbidden error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/2de36abe-2813-41e6-9b55-791b25efe460/3/0
Woosmap
Location-based Search Platform
7
getStoresFromGeolocationPosition
Retrieve the stores nearby an ip location. Stores are returned only if a relevant ip location is found - for an accuracy of 20km or less.
429
null
{"detail": "The rate limit for this endpoint has been exceeded"}
{"title": "Error429", "type": "object", "description": "Over Query Limit. Check the API Documentation for available QPS.", "properties": {"detail": {"description": "Details for the Over Query Limit error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/bd13f92b-e1d5-4121-9f08-e95aa812f928/0/0
Woosmap
Location-based Search Platform
7
getGeolocationPosition
The /position returns JSON location of your users thanks to IP address of their devices.
403
null
{"detail": "This Woosmap API is not enabled for this project."}
{"title": "Error403", "type": "object", "description": "API Request is authenticated but API Key don't have permission to access the resources", "properties": {"detail": {"description": "Details for the forbidden error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/bd13f92b-e1d5-4121-9f08-e95aa812f928/1/0
Woosmap
Location-based Search Platform
7
getGeolocationPosition
The /position returns JSON location of your users thanks to IP address of their devices.
429
null
{"detail": "The rate limit for this endpoint has been exceeded"}
{"title": "Error429", "type": "object", "description": "Over Query Limit. Check the API Documentation for available QPS.", "properties": {"detail": {"description": "Details for the Over Query Limit error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/bd13f92b-e1d5-4121-9f08-e95aa812f928/2/0
Woosmap
Location-based Search Platform
7
getGeolocationPosition
The /position returns JSON location of your users thanks to IP address of their devices.
401
null
{"detail": "Incorrect authentication credentials. Please check or use a valid API Key"}
{"title": "Error401", "type": "object", "description": "Authentication credentials are incorrect", "properties": {"detail": {"description": "Details for the credentials error", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/bd13f92b-e1d5-4121-9f08-e95aa812f928/3/0
Woosmap
Location-based Search Platform
7
getGeolocationPosition
The /position returns JSON location of your users thanks to IP address of their devices.
200
null
{"country_code": "US", "country_name": "United States", "continent": "North America", "latitude": 38.7304, "longitude": -77.0634, "accuracy": 5, "viewport": {"northeast": {"lat": 38.77531576420598, "lng": -77.00582296106178}, "southwest": {"lat": 38.68548423579403, "lng": -77.12097703893822}}, "city": "Alexandria", "re...
{"title": "GeolocationResponse", "type": "object", "description": "A successful geolocation request will return a JSON-formatted response defining a location and radius.", "properties": {"viewport": {"title": "Bounds", "type": "object", "description": "A rectangle in geographical coordinates from points at the southwes...
975b58f7-85ea-4e68-b0ce-868ac028542a/86abfb72-2f3f-4596-bdd6-d202544d28af/0/0
Woosmap
Location-based Search Platform
7
storeAutocomplete
Autocomplete on localizedNames with highlighted results on asset name. Use the field localized in your query parameter to search for localized names.
403
null
{"detail": "This Woosmap API is not enabled for this project."}
{"title": "Error403", "type": "object", "description": "API Request is authenticated but API Key don't have permission to access the resources", "properties": {"detail": {"description": "Details for the forbidden error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/86abfb72-2f3f-4596-bdd6-d202544d28af/1/0
Woosmap
Location-based Search Platform
7
storeAutocomplete
Autocomplete on localizedNames with highlighted results on asset name. Use the field localized in your query parameter to search for localized names.
401
null
{"detail": "Incorrect authentication credentials. Please check or use a valid API Key"}
{"title": "Error401", "type": "object", "description": "Authentication credentials are incorrect", "properties": {"detail": {"description": "Details for the credentials error", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/86abfb72-2f3f-4596-bdd6-d202544d28af/2/0
Woosmap
Location-based Search Platform
7
storeAutocomplete
Autocomplete on localizedNames with highlighted results on asset name. Use the field localized in your query parameter to search for localized names.
429
null
{"detail": "The rate limit for this endpoint has been exceeded"}
{"title": "Error429", "type": "object", "description": "Over Query Limit. Check the API Documentation for available QPS.", "properties": {"detail": {"description": "Details for the Over Query Limit error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/86abfb72-2f3f-4596-bdd6-d202544d28af/3/0
Woosmap
Location-based Search Platform
7
storeAutocomplete
Autocomplete on localizedNames with highlighted results on asset name. Use the field localized in your query parameter to search for localized names.
200
null
{"predictions": [{"store_id": "2670", "name": "Sun Street", "types": ["Coffee shop"], "matched_substrings": [{"offset": 4, "length": 6}], "highlighted": "Sun <b>Street</b>"}, {"store_id": "16069", "name": "7th Street", "types": ["Coffee shop"], "matched_substrings": [{"offset": 4, "length": 6}], "highlighted": "7th <b>...
{"title": "AssetAutocompleteResponse", "type": "object", "description": "Asset Autocomplete Response with highlighted results on asset name.", "properties": {"predictions": {"description": "A list of predictions based on similarity in all the `localizedNames` passed in query (or similarity to `store_name` if no `locali...
975b58f7-85ea-4e68-b0ce-868ac028542a/7b0b1424-f712-4bf7-ac45-c68f828226c4/0/0
Woosmap
Location-based Search Platform
7
storeSearch
Used to retrieve assets from query
200
null
{"type": "FeatureCollection", "features": [{"type": "Feature", "properties": {"store_id": "2354", "name": "Berkeley Street/Berkeley Square", "contact": {"phone": "02076295779", "website": "https://www.starbucks.com/store-locator/store/2354/berkeley-street-berkeley-square-27-berkeley-st-berkeley-square-london-eng-w-1-x-...
{"title": "AssetFeatureCollectionResponse", "type": "object", "description": "Assets Collection Response as a GeoJSon FeatureCollection with Asset properties", "properties": {"type": {"description": "the Geojson Type (only 'FeatureCollection')", "type": "string", "enum": ["FeatureCollection"]}, "features": {"descriptio...
975b58f7-85ea-4e68-b0ce-868ac028542a/7b0b1424-f712-4bf7-ac45-c68f828226c4/1/0
Woosmap
Location-based Search Platform
7
storeSearch
Used to retrieve assets from query
401
null
{"detail": "Incorrect authentication credentials. Please check or use a valid API Key"}
{"title": "Error401", "type": "object", "description": "Authentication credentials are incorrect", "properties": {"detail": {"description": "Details for the credentials error", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/7b0b1424-f712-4bf7-ac45-c68f828226c4/2/0
Woosmap
Location-based Search Platform
7
storeSearch
Used to retrieve assets from query
403
null
{"detail": "This Woosmap API is not enabled for this project."}
{"title": "Error403", "type": "object", "description": "API Request is authenticated but API Key don't have permission to access the resources", "properties": {"detail": {"description": "Details for the forbidden error message", "type": "string"}}}
975b58f7-85ea-4e68-b0ce-868ac028542a/7b0b1424-f712-4bf7-ac45-c68f828226c4/3/0
Woosmap
Location-based Search Platform
7
storeSearch
Used to retrieve assets from query
429
null
{"detail": "The rate limit for this endpoint has been exceeded"}
{"title": "Error429", "type": "object", "description": "Over Query Limit. Check the API Documentation for available QPS.", "properties": {"detail": {"description": "Details for the Over Query Limit error message", "type": "string"}}}
85ac8588-c1bb-4cde-af5c-befac19a670b/b5983572-b378-44b1-9091-e8739f248b72/0/0
HONG KONG ID Card OCR
Extraction of information including name, gender, English name, identity card number, name code, head portrait, etc. from Hong Kong Identity Card images.
6.6
HONG KONG ID Card OCR
Support jpg, png, bmp, pdf, tiff, single-frame gif and other formats, the image size does not exceed 10M.
200
Response
{"code": "200", "status": "SUCCESS", "date": "11/22/2023 11:41:32 PM", "result": {"rotated_image_height": 491, "image_angle": 0, "rotated_image_width": 781, "item_list": [{"value": "/9j/4AAQSkZJRgABAQAAAQABAAD/2wBDAAIBAQEBAQIBAQECAgICAgQDAgICAgUEBAMEBgUGBgYFBgYGBwkIBgcJBwYGCAsICQoKCgoKBggLDAsKDAkKCgr/2wBDAQICAgICAgUDAw...
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"code": {"type": "string"}, "status": {"type": "string"}, "date": {"type": "string"}, "result": {"type": "object", "properties": {"rotated_image_height": {"type": "integer"}, "image_angle": {"type": "integer"}, "rotated_image_width": {"type"...
e3c4b6b4-8516-4595-8c86-f9b5b0050e1f/27f05bbb-4e87-4597-bcf5-b61c5262bacb/0/0
VIN Recognition
Quickly extract VINs from images, barcodes, and QR codes while returning vehicle make, model, and year. View documents
9.5
Vin Recognition
Support JPEG,PNG8,PNG24,GIF,BMP,WEBP,RAW,ICO. The larger the image file, the higher the recognition accuracy but slower the speed, the smaller the file, the faster the speed but the lower the recognition accuracy. Therefore, we recommend that the maximum image file size should not exceed 4MB, and the optimal size is 10...
200
New Example
{"service": "vinocr", "version": "3.0", "date": "06/13/2023 10:42:34 PM", "status": "SUCCESS", "vin_captured": "JH2PC35051M200020", "vindecode": {"status": "SUCCESS", "make": "HONDA", "model": "CBR600", "year": 2001}, "left": 235, "top": 136, "width": 359, "height": 181}
{"type": "object", "properties": {"service": {"type": "string"}, "version": {"type": "string"}, "date": {"type": "string"}, "status": {"type": "string"}, "vin_captured": {"type": "string"}, "vindecode": {"type": "object", "properties": {"status": {"type": "string"}, "make": {"type": "string"}, "model": {"type": "string...
31944dac-5835-421b-86a3-700b7f9c340b/b266a3c0-ca1e-4fdf-9e7c-5e5edccb3fba/0/0
Wine Recognition
This ready-to-use API provides recognition of labels on wine bottles covering more than 400 000 different labels. The results contain information about the brand of wine and its type. [](https://api4.ai/apis/wine-rec?utm_source=wine_rec_rapidapi&utm_medium=endpoints...
9.4
Analyse image and return results
Performs actual image analysis and responds with results. Image must be a regular JPEG or PNG image (with or without transparency) or PDF file. Usually such images have extensions: .jpg, .jpeg, .png, .pdf. In case of PDF each page will be converted to PNG image and processed separately. The service checks input file by...
200
Successful detection
{"results": [{"status": {"code": "ok", "message": "Success"}, "name": "image.jpg", "md5": "6ea449c4645b8811eef1342040725687", "width": 1024, "height": 768, "entities": [{"kind": "classes", "name": "wine-image-classes", "classes": {"buitenverwachting 1769 vintage 2000": 0.6465678215026855, "buitenverwachting 1769 vintag...
{"type": "object", "properties": {"results": {"type": "array", "items": {"type": "object", "properties": {"status": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}}, "name": {"type": "string"}, "md5": {"type": "string"}, "entities": {"type": "array", "items": {"type": "objec...
31944dac-5835-421b-86a3-700b7f9c340b/b266a3c0-ca1e-4fdf-9e7c-5e5edccb3fba/0/1
Wine Recognition
This ready-to-use API provides recognition of labels on wine bottles covering more than 400 000 different labels. The results contain information about the brand of wine and its type. [](https://api4.ai/apis/wine-rec?utm_source=wine_rec_rapidapi&utm_medium=endpoints...
9.4
Analyse image and return results
Performs actual image analysis and responds with results. Image must be a regular JPEG or PNG image (with or without transparency) or PDF file. Usually such images have extensions: .jpg, .jpeg, .png, .pdf. In case of PDF each page will be converted to PNG image and processed separately. The service checks input file by...
200
Unsupported media type
{"results": [{"status": {"code": "failure", "message": "Unsupported media type. Expected one of ['image/jpeg', 'image/png']. Got 'text/plain'."}, "name": "file.txt", "md5": "d41d8cd98f00b204e9800998ecf8427e", "entities": []}]}
{"type": "object", "properties": {"results": {"type": "array", "items": {"type": "object", "properties": {"status": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}}, "name": {"type": "string"}, "md5": {"type": "string"}, "entities": {"type": "array", "items": {"type": "objec...
31944dac-5835-421b-86a3-700b7f9c340b/b266a3c0-ca1e-4fdf-9e7c-5e5edccb3fba/1/0
Wine Recognition
This ready-to-use API provides recognition of labels on wine bottles covering more than 400 000 different labels. The results contain information about the brand of wine and its type. [](https://api4.ai/apis/wine-rec?utm_source=wine_rec_rapidapi&utm_medium=endpoints...
9.4
Analyse image and return results
Performs actual image analysis and responds with results. Image must be a regular JPEG or PNG image (with or without transparency) or PDF file. Usually such images have extensions: .jpg, .jpeg, .png, .pdf. In case of PDF each page will be converted to PNG image and processed separately. The service checks input file by...
422
Missing image/url
{"detail": "Missing image or url field."}
{"type": "object", "properties": {"detail": {"type": "string"}}}
7ae93f98-0a38-4c69-baa9-6cc9ecc0211b/064fa25f-dffc-49aa-b82e-a9665da175a5/0/0
Promity Face Detection
API for face detection in images in real time
6.9
Face Detection by file
Endpoint for face detection. Send us image, we return position of detected faces. Check out our tutorials for example of usage in Python.
200
New Example
{"detections": [{"crop": {"x1": 0.49029475450515747, "y1": 0.5199255347251892, "x2": 0.5589765906333923, "y2": 0.38276559114456177, "score": 0.9992923736572266}}, {"crop": {"x1": 0.11643223464488983, "y1": 0.5169875025749207, "x2": 0.18099753558635712, "y2": 0.39529597759246826, "score": 0.998594343662262}}, {"crop": {...
{"type": "object", "properties": {"detections": {"type": "array", "items": {"type": "object", "properties": {"crop": {"type": "object", "properties": {"x1": {"type": "number"}, "y1": {"type": "number"}, "x2": {"type": "number"}, "y2": {"type": "number"}, "score": {"type": "number"}}}}}}}}
7ae93f98-0a38-4c69-baa9-6cc9ecc0211b/6d3af90d-9e06-45a4-9f5d-3c292e7e8b8d/0/0
Promity Face Detection
API for face detection in images in real time
6.9
Face Detection by URL
Endpoint for face detection. Send us link to image, we return position of detected faces. Check out our tutorials for example of usage in Python.
200
New Example
{"detections": [{"crop": {"x1": 0.49029475450515747, "y1": 0.5199255347251892, "x2": 0.5589765906333923, "y2": 0.38276559114456177, "score": 0.9992923736572266}}, {"crop": {"x1": 0.11643223464488983, "y1": 0.5169875025749207, "x2": 0.18099753558635712, "y2": 0.39529597759246826, "score": 0.998594343662262}}, {"crop": {...
{"type": "object", "properties": {"detections": {"type": "array", "items": {"type": "object", "properties": {"crop": {"type": "object", "properties": {"x1": {"type": "number"}, "y1": {"type": "number"}, "x2": {"type": "number"}, "y2": {"type": "number"}, "score": {"type": "number"}}}}}}}}
fd62d11a-c37a-4532-b95b-d05341f7f3b1/d6f5434c-861c-4d6a-89b9-dcde37a391bc/0/0
NSFW Image Detection
First Class NSFW. Detect explicit content from a public image url. Returns adult, spoof, medical, violence scores.
null
NSFW
Detect explicit content from a public image url
200
Example_1
{"adult": "VERY_LIKELY", "spoof": "VERY_UNLIKELY", "medical": "POSSIBLE", "violence": "UNLIKELY", "racy": "VERY_LIKELY"}
{"type": "object", "properties": {"adult": {"type": "enum"}, "spoof": {"type": "enum"}, "medical": {"type": "enum"}, "violence": {"type": "enum"}, "racy": {"type": "enum"}}}
7afc6650-c85a-4a57-9c8a-112c12597150/82486d58-c75a-4adf-9540-9b7a80a8da20/0/0
Face Detection
This ready-to-use API provides a pack of options in human face detection: face and landmarks detection, face re-identification of an already detected face. [](https://api4.ai/apis/face-analysis?utm_source=face_analyzer_rapidapi&utm_medium=endpoints&utm_campaign...
9.1
Analyse image and return results
Performs actual image analysis and responds with results. Image must be a regular JPEG or PNG image (with or without transparency) or PDF file. Usually such images have extensions: .jpg, .jpeg, .png, .pdf. In case of PDF each page will be converted to PNG image and processed separately. The service checks input file by...
200
Successful detection
{"results": [{"status": {"code": "ok", "message": "Success"}, "name": "face.jpg", "md5": "39cefc732e7e0c2b1b5f6a783dc87141", "width": 1024, "height": 768, "entities": [{"kind": "objects", "name": "face-detector", "objects": [{"box": [0.5379649347853466, 0.2885976606043589, 0.19544756039146483, 0.2706363619501567], "ent...
{"type": "object", "properties": {"results": {"type": "array", "items": {"type": "object", "properties": {"status": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}}, "name": {"type": "string"}, "md5": {"type": "string"}, "entities": {"type": "array", "items": {"type": "objec...
7afc6650-c85a-4a57-9c8a-112c12597150/82486d58-c75a-4adf-9540-9b7a80a8da20/0/1
Face Detection
This ready-to-use API provides a pack of options in human face detection: face and landmarks detection, face re-identification of an already detected face. [](https://api4.ai/apis/face-analysis?utm_source=face_analyzer_rapidapi&utm_medium=endpoints&utm_campaign...
9.1
Analyse image and return results
Performs actual image analysis and responds with results. Image must be a regular JPEG or PNG image (with or without transparency) or PDF file. Usually such images have extensions: .jpg, .jpeg, .png, .pdf. In case of PDF each page will be converted to PNG image and processed separately. The service checks input file by...
200
Unsupported media type
{"results": [{"status": {"code": "failure", "message": "Unsupported media type. Expected one of ['image/jpeg', 'image/png']. Got 'text/plain'."}, "name": "file.txt", "md5": "d41d8cd98f00b204e9800998ecf8427e", "entities": []}]}
{"type": "object", "properties": {"results": {"type": "array", "items": {"type": "object", "properties": {"status": {"type": "object", "properties": {"code": {"type": "string"}, "message": {"type": "string"}}}, "name": {"type": "string"}, "md5": {"type": "string"}, "entities": {"type": "array", "items": {"type": "objec...
7afc6650-c85a-4a57-9c8a-112c12597150/82486d58-c75a-4adf-9540-9b7a80a8da20/2/0
Face Detection
This ready-to-use API provides a pack of options in human face detection: face and landmarks detection, face re-identification of an already detected face. [](https://api4.ai/apis/face-analysis?utm_source=face_analyzer_rapidapi&utm_medium=endpoints&utm_campaign...
9.1
Analyse image and return results
Performs actual image analysis and responds with results. Image must be a regular JPEG or PNG image (with or without transparency) or PDF file. Usually such images have extensions: .jpg, .jpeg, .png, .pdf. In case of PDF each page will be converted to PNG image and processed separately. The service checks input file by...
422
Missing image/url
{"detail": "Missing image or url field."}
{"type": "object", "properties": {"detail": {"type": "string"}}}
c3ed5d1d-7b60-4186-bb8f-306de255a74d/f5dc2b1a-a34f-49f0-8e52-c005f5045556/0/0
Cloudlabs Face Detection
An API used to quickly detect faces from an image file. Can detect up to 20 faces at a time.
6.2
faceDetection (by Image Url)
This endpoint is used to detect faces via image URL
200
Response
{"status": "success", "count": 3, "faces": [{"bounding": {"startX": 48, "startY": 34, "endX": 145, "endY": 148}, "confidence": 0.63460493}, {"bounding": {"startX": 293, "startY": 2, "endX": 380, "endY": 104}, "confidence": 0.70063585}, {"bounding": {"startX": 540, "startY": 42, "endX": 613, "endY": 126}, "confidence": ...
{"type": "object", "properties": {"status": {"type": "string"}, "count": {"type": "integer"}, "faces": {"type": "array", "items": {"type": "object", "properties": {"bounding": {"type": "object", "properties": {"startX": {"type": "integer"}, "startY": {"type": "integer"}, "endX": {"type": "integer"}, "endY": {"type": "i...
c3ed5d1d-7b60-4186-bb8f-306de255a74d/df32a508-257c-406a-8c67-6895a7352da9/0/0
Cloudlabs Face Detection
An API used to quickly detect faces from an image file. Can detect up to 20 faces at a time.
6.2
faceDetection (by Image Upload)
This endpoint is used to detect faces via image upload
200
Response
{"status": "success", "count": 3, "faces": [{"bounding": {"startX": 48, "startY": 34, "endX": 145, "endY": 148}, "confidence": 0.63460493}, {"bounding": {"startX": 293, "startY": 2, "endX": 380, "endY": 104}, "confidence": 0.70063585}, {"bounding": {"startX": 540, "startY": 42, "endX": 613, "endY": 126}, "confidence": ...
{"type": "object", "properties": {"status": {"type": "string"}, "count": {"type": "integer"}, "faces": {"type": "array", "items": {"type": "object", "properties": {"bounding": {"type": "object", "properties": {"startX": {"type": "integer"}, "startY": {"type": "integer"}, "endX": {"type": "integer"}, "endY": {"type": "i...
b47643a4-9808-4ae9-97fb-8cdc25e03370/dc1ab12b-a01e-46c4-91f9-8f78410bb893/0/0
Face Recognition
A comprehensive solution for face recognition and analysis, integrated with a dedicated database. It accurately identifies the location of human faces, provides recognized unique identifiers (UIDs), incorporates liveness detection, determines age and gender, analyzes facial expressions (emotions), and includes facemask...
9.4
Update Face 2
Update a Face to database enter the face id as x-face-uid in the header (case sensitive) same as "regular" Register Face endpoint above but using JSON body of image urls as input
200
Success Example
{"status": "success", "message": "john_doe face_uid updated successfully", "time_ms": 211.28, "image_file_names": ["WhatsApp Image 2022-08-12 at 14.11.10 (1).jpeg", "IMG_2911.JPG"]}
{"type": "object", "properties": {"status": {"type": "string"}, "message": {"type": "string"}, "time_ms": {"type": "number"}, "image_file_names": {"type": "array", "items": {"type": "string"}}}}
b47643a4-9808-4ae9-97fb-8cdc25e03370/022798d4-b5af-4dca-a2d4-1f4ede925475/0/0
Face Recognition
A comprehensive solution for face recognition and analysis, integrated with a dedicated database. It accurately identifies the location of human faces, provides recognized unique identifiers (UIDs), incorporates liveness detection, determines age and gender, analyzes facial expressions (emotions), and includes facemask...
9.4
Recognize 2
Recognize & analyze one or multiple faces inside one image min face dimension is 200x200px, use Super-resolution option to up-size the image input same as "regular" Recognize endpoint above but using JSON body of image urls as input
200
Success Example
{"status": "success", "image_file_name": "testing_image.jpeg", "recognition_result": [{"recognition_uidresult": "john_doe", "recognition_confidence": 0.8358, "recognition_otheruids": [], "bbox": {"x1": 0.60241, "y1": 0.02606, "x2": 0.9006, "y2": 0.39088}, "liveness": {"is_real_face": true, "liveness_probability": 0.918...
{"type": "object", "properties": {"status": {"type": "string"}, "image_file_name": {"type": "string"}, "recognition_result": {"type": "array", "items": {"type": "object", "properties": {"recognition_uidresult": {"type": "string"}, "recognition_confidence": {"type": "number"}, "recognition_otheruids": {"type": "array"},...
b47643a4-9808-4ae9-97fb-8cdc25e03370/6363f182-4502-4339-a508-6f4abe829af5/0/0
Face Recognition
A comprehensive solution for face recognition and analysis, integrated with a dedicated database. It accurately identifies the location of human faces, provides recognized unique identifiers (UIDs), incorporates liveness detection, determines age and gender, analyzes facial expressions (emotions), and includes facemask...
9.4
Recognize
Recognize & analyze one or multiple faces inside one image min face dimension is 200x200px, use Super-resolution option to up-size the image input Recognition Result : recognition_uidresult = closest possible uid recognition_confidence = confidence level of the recognition recognition_otheruids = other closest possible...
200
Success Example
{"status": "success", "image_file_name": "testing_image.jpeg", "recognition_result": [{"recognition_uidresult": "john_doe", "recognition_confidence": 0.8358, "recognition_otheruids": [], "bbox": {"x1": 0.60241, "y1": 0.02606, "x2": 0.9006, "y2": 0.39088}, "liveness": {"is_real_face": true, "liveness_probability": 0.918...
{"type": "object", "properties": {"status": {"type": "string"}, "image_file_name": {"type": "string"}, "recognition_result": {"type": "array", "items": {"type": "object", "properties": {"recognition_uidresult": {"type": "string"}, "recognition_confidence": {"type": "number"}, "recognition_otheruids": {"type": "array"},...
b47643a4-9808-4ae9-97fb-8cdc25e03370/0c1d0262-c447-4b73-8eed-cd18b87adc1d/0/0
Face Recognition
A comprehensive solution for face recognition and analysis, integrated with a dedicated database. It accurately identifies the location of human faces, provides recognized unique identifiers (UIDs), incorporates liveness detection, determines age and gender, analyzes facial expressions (emotions), and includes facemask...
9.4
Update Face
Update a Face to database enter the face id as x-face-uid in the header
200
Success Example
{"status": "success", "message": "john_doe face_uid updated successfully", "time_ms": 211.28, "image_file_names": ["WhatsApp Image 2022-08-12 at 14.11.10 (1).jpeg", "IMG_2911.JPG"]}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"status": {"type": "string"}, "message": {"type": "string"}, "time_ms": {"type": "number"}, "image_file_names": {"type": "array", "items": {"type": "string"}}}, "required": ["image_file_names", "message", "status", "time_ms"]}
b47643a4-9808-4ae9-97fb-8cdc25e03370/ea2af151-5937-461c-8e78-53edc3094854/0/0
Face Recognition
A comprehensive solution for face recognition and analysis, integrated with a dedicated database. It accurately identifies the location of human faces, provides recognized unique identifiers (UIDs), incorporates liveness detection, determines age and gender, analyzes facial expressions (emotions), and includes facemask...
9.4
Register Face
Register a Face to database enter the face id as x-face-uid in the header (case sensitive) input the face image in "face_image" form, if you have more than one image for one UID, upload the additional image as additional_face_image_0, additional_face_image_1, additional_face_image_2. You have maximum 3 additional im...
200
Success Example
{"status": "success", "message": "john_doe registered successfully", "time_ms": 583.42, "image_file_names": ["WhatsApp Image 2022-08-12 at 14.11.10 (1).jpeg"]}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"status": {"type": "string"}, "message": {"type": "string"}, "time_ms": {"type": "number"}, "image_file_names": {"type": "array", "items": {"type": "string"}}}, "required": ["image_file_names", "message", "status", "time_ms"]}
b47643a4-9808-4ae9-97fb-8cdc25e03370/b6fa1c58-746f-426a-b9e3-6dbd222e09e0/0/0
Face Recognition
A comprehensive solution for face recognition and analysis, integrated with a dedicated database. It accurately identifies the location of human faces, provides recognized unique identifiers (UIDs), incorporates liveness detection, determines age and gender, analyzes facial expressions (emotions), and includes facemask...
9.4
Reset DB
Clear & Delete all face uid in your DB WARNING : all uids will not be backed up
200
Success Example
{"status": "success", "message": true}
{"type": "object", "properties": {"status": {"type": "string"}, "message": {"type": "boolean"}}}
b47643a4-9808-4ae9-97fb-8cdc25e03370/d69eedeb-fd4b-437f-a890-90cfde389d4b/0/0
Face Recognition
A comprehensive solution for face recognition and analysis, integrated with a dedicated database. It accurately identifies the location of human faces, provides recognized unique identifiers (UIDs), incorporates liveness detection, determines age and gender, analyzes facial expressions (emotions), and includes facemask...
9.4
Register Face 2
Register a Face to database enter the face id as x-face-uid in the header (case sensitive) same as "regular" Register Face endpoint above but using JSON body of image urls as input
200
Success Example
{"status": "success", "message": "john_doe registered successfully", "time_ms": 583.42, "image_file_names": ["WhatsApp Image 2022-08-12 at 14.11.10 (1).jpeg"]}
{"type": "object", "properties": {"status": {"type": "string"}, "message": {"type": "string"}, "time_ms": {"type": "number"}, "image_file_names": {"type": "array", "items": {"type": "string"}}}}
b47643a4-9808-4ae9-97fb-8cdc25e03370/8a4472ea-283b-4a6c-af3e-35608efe3130/0/0
Face Recognition
A comprehensive solution for face recognition and analysis, integrated with a dedicated database. It accurately identifies the location of human faces, provides recognized unique identifiers (UIDs), incorporates liveness detection, determines age and gender, analyzes facial expressions (emotions), and includes facemask...
9.4
View DB
Read / view all face uids in your DB as "faces_list"
200
Success Example
{"status": "success", "message": "faces list retrieved successfully", "faces_list": ["bagus_pamungkas", "hilmy_izzulhaq", "john_doe"], "time_ms": 20.08}
{"type": "object", "properties": {"status": {"type": "string"}, "message": {"type": "string"}, "faces_list": {"type": "array", "items": {"type": "string"}}, "time_ms": {"type": "number"}}}
b47643a4-9808-4ae9-97fb-8cdc25e03370/6a72f992-517f-4992-851c-f7786549fa55/0/0
Face Recognition
A comprehensive solution for face recognition and analysis, integrated with a dedicated database. It accurately identifies the location of human faces, provides recognized unique identifiers (UIDs), incorporates liveness detection, determines age and gender, analyzes facial expressions (emotions), and includes facemask...
9.4
Delete Face
Delete a face uid from your DB
200
Success Example
{"status": "success", "message": "john_doe deleted successfully", "time_ms": 3.15}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"status": {"type": "string"}, "message": {"type": "string"}, "time_ms": {"type": "number"}}, "required": ["message", "status", "time_ms"]}
db6d226c-e99a-42d8-a0b6-8e4c1eb891f3/4ebe066c-eff6-4111-b451-9f70e57e032c/0/0
HyperVerge Face Recognition
Offers highly accurate Deep Learning models for Face Liveness Verification, Face Match and Face Search (1:N). HyperVerge Face APIs have been used to process over 400 Million KYC checks across some of the largest banks, telcos, lenders and brokerages in the world. A NIST FRVT Top-100 solution
null
Selfie to Selfie Match
API to do a 1:1 match between 2 selfie face images
200
Example_1
{"requestId": "1622452110145-8614dc14-320d-4d8f-960b-fce214eb6d03", "result": {"match": "yes", "match-score": 86, "to-be-reviewed": "no"}, "status": "success", "statusCode": "200"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"requestId": {"type": "string"}, "result": {"type": "object", "properties": {"match": {"type": "string"}, "match-score": {"type": "integer"}, "to-be-reviewed": {"type": "string"}}, "required": ["match", "match-score", "to-be-reviewed"]}, "st...
db6d226c-e99a-42d8-a0b6-8e4c1eb891f3/e783a18c-a5ff-40af-8793-740a508aabe0/0/0
HyperVerge Face Recognition
Offers highly accurate Deep Learning models for Face Liveness Verification, Face Match and Face Search (1:N). HyperVerge Face APIs have been used to process over 400 Million KYC checks across some of the largest banks, telcos, lenders and brokerages in the world. A NIST FRVT Top-100 solution
null
Selfie to ID Card Match
API to do a 1:1 match between a selfie and an ID card
200
Example_1
{"requestId": "1622452110145-8614dc14-320d-4d8f-960b-fce214eb6d03", "result": {"match": "yes", "match-score": 86, "to-be-reviewed": "no"}, "status": "success", "statusCode": "200"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"requestId": {"type": "string"}, "result": {"type": "object", "properties": {"match": {"type": "string"}, "match-score": {"type": "integer"}, "to-be-reviewed": {"type": "string"}}, "required": ["match", "match-score", "to-be-reviewed"]}, "st...
6080d821-d82e-46f0-9d0c-940ed50131b6/fbdbca00-bbe9-4971-bfe2-9dd37ad66c88/0/0
Recaptcha V2 Solver
0.80$/1000 Only default recaptcha is officially supported, enterprise may or may not work. Solves Recaptcha V2 automatically and returns a token. Latency displays average solve time.
2.4
Request Recaptcha V2 Token
Creates a request to solve Recaptcha V2 and returns a token.
200
New Example
{"token": "example"}
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"token": {"type": "string"}}, "required": ["token"]}
2170ba45-17a5-42dd-a8ea-7d0dd2587761/d2ddd18e-560c-4e44-baaa-8084dcd07bce/0/0
Label Detection
Extract labels from image using (google vision label detection)
7.5
POST Label Detection
the important thing is that you should use image as a form_data key Example const data = new FormData(); data.append(‘image’, ‘image_path’);
200
New Example
{"labels": [{"text": "Wheel", "score": 0.972192645072937, "locale": ""}, {"text": "Tire", "score": 0.9719410538673401, "locale": ""}, {"text": "Car", "score": 0.9633665084838867, "locale": ""}, {"text": "Land vehicle", "score": 0.9593533277511597, "locale": ""}, {"text": "Vehicle", "score": 0.9581815004348755, "locale"...
{"type": "object", "properties": {"labels": {"type": "array", "items": {"type": "object", "properties": {"text": {"type": "string"}, "score": {"type": "number"}, "locale": {"type": "string"}}}}, "success": {"type": "boolean"}, "dimensions": {"type": "object", "properties": {"height": {"type": "integer"}, "width": {"typ...
2170ba45-17a5-42dd-a8ea-7d0dd2587761/5d6ce645-e302-47dc-a973-d278181c76d8/0/0
Label Detection
Extract labels from image using (google vision label detection)
7.5
GET Label Detection
the important thing is that you should use image as a query name Example (url?image=“image_url”)
200
New Example
{"labels": [{"text": "Wheel", "score": 0.972192645072937, "locale": ""}, {"text": "Tire", "score": 0.9719410538673401, "locale": ""}, {"text": "Car", "score": 0.9633665084838867, "locale": ""}, {"text": "Land vehicle", "score": 0.9593533277511597, "locale": ""}, {"text": "Vehicle", "score": 0.9581815004348755, "locale"...
{"type": "object", "properties": {"labels": {"type": "array", "items": {"type": "object", "properties": {"text": {"type": "string"}, "score": {"type": "number"}, "locale": {"type": "string"}}}}, "success": {"type": "boolean"}, "dimensions": {"type": "object", "properties": {"height": {"type": "integer"}, "width": {"typ...
cbf1cc0c-5bd6-4532-95f8-12fabd688444/07e1dca3-78d2-4738-a89f-6047bc602786/0/0
Hand Recognition
An input image (decodable normally and with appropriate aspect ratio) detects the hands in the image and outputs the coordinate frame, 21 bone node coordinate information of each hand.
8.3
Hand Recognition
Hand Recognition
200
Response
{"code": 0, "data": {"hand_info": [{"hand_parts": {"0": {"score": 0.816012442111969, "x": 829, "y": 707}, "1": {"score": 0.6850220561027527, "x": 873, "y": 620}, "2": {"score": 0.7553223967552185, "x": 916, "y": 533}, "3": {"score": 0.7928290963172913, "x": 938, "y": 467}, "4": {"score": 0.8811469674110413, "x": 993, "...
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"code": {"type": "integer"}, "data": {"type": "object", "properties": {"hand_info": {"type": "array", "items": {"type": "object", "properties": {"hand_parts": {"type": "object", "properties": {"0": {"type": "object", "properties": {"score": ...
f65d466d-9d6b-4b5d-914f-7fac819a8018/159c528f-bce0-470d-9ad3-a343beb00d37/0/0
Landmark Detection
Extract list of locations, name, boundingBox, score, locale and dimensions from image using (google vision landmark detection)
5.3
GET Landmark Detection
the important thing is that you should use image as a query name Example (url?image=“image_url”)
200
New Example
{"landmarks": [{"locations": [{"latitude": 55.75393029999999, "longitude": 37.620794999999994}], "text": "Red Square", "score": 0.9382750988006592, "locale": "", "boundingBox": {"tl": {"x": 0, "y": 0}, "tr": {"x": 640, "y": 0}, "br": {"x": 640, "y": 408}, "bl": {"x": 0, "y": 408}}}, {"locations": [{"latitude": 55.75202...
{"type": "object", "properties": {"landmarks": {"type": "array", "items": {"type": "object", "properties": {"locations": {"type": "array", "items": {"type": "object", "properties": {"latitude": {"type": "number"}, "longitude": {"type": "number"}}}}, "text": {"type": "string"}, "score": {"type": "number"}, "locale": {"t...
f65d466d-9d6b-4b5d-914f-7fac819a8018/634f36bf-2e52-4f5f-9345-9992cae926e2/0/0
Landmark Detection
Extract list of locations, name, boundingBox, score, locale and dimensions from image using (google vision landmark detection)
5.3
POST Landmark Detection
the important thing is that you should use image as a form_data key Example const data = new FormData(); data.append(‘image’, ‘image_path’);
200
New Example
{"landmarks": [{"locations": [{"latitude": 55.75393029999999, "longitude": 37.620794999999994}], "text": "Red Square", "score": 0.9382750988006592, "locale": "", "boundingBox": {"tl": {"x": 0, "y": 0}, "tr": {"x": 640, "y": 0}, "br": {"x": 640, "y": 408}, "bl": {"x": 0, "y": 408}}}, {"locations": [{"latitude": 55.75202...
{"type": "object", "properties": {"landmarks": {"type": "array", "items": {"type": "object", "properties": {"locations": {"type": "array", "items": {"type": "object", "properties": {"latitude": {"type": "number"}, "longitude": {"type": "number"}}}}, "text": {"type": "string"}, "score": {"type": "number"}, "locale": {"t...
07e09992-014e-4d81-bf69-10c0aac32582/affa777c-7836-4fe4-ba99-b7f823f967b1/0/0
OCR Text Extractor
Powerful image optical character recognition (OCR) for over 20 languages and with machine-readable-zone support. Perfect for a wide range of use-cases, including but not limited to receipt and invoice scanning as well as general image-based text extraction, the default service currently allows you to POST an image of u...
8.2
Extract Text From Image URI
Perform OCR on an image located at designated URI and return the text detected
200
Example_1
{"parsedResults": [{"textOverlay": {"lines": [], "hasOverlay": true, "message": "Total lines: 0"}, "fileParseExitCode": "Success", "parsedText": "Google", "errorMessage": "", "errorDetails": ""}], "ocrExitCode": "ParseSuccess", "isErroredOnProcessing": false, "errorMessage": null, "errorDetails": null, "processingTimeI...
{"type": "object", "properties": {"parsedResults": {"type": "array", "items": {"type": "object", "properties": {"textOverlay": {"type": "object", "properties": {"lines": {"type": "array"}, "hasOverlay": {"type": "boolean"}, "message": {"type": "string"}}}, "fileParseExitCode": {"type": "string"}, "parsedText": {"type":...
095a9bc9-d816-4efd-82c1-81ca0d3a21b0/997cbd88-67df-4208-920a-e6660279430e/0/0
Face Compare
face verification
null
Face Compare
Face match
200
New Example
{"matchedFaces": [{"matchResult": 1, "confidence": 100, "image1_face": {"faceRectangle": {"x": 12, "y": 11, "height": 249, "width": 203}, "points": [{"x": 12.7949295, "y": 18.13095}, {"x": 206.91957, "y": 11.364868}, {"x": 21.252525, "y": 260.78677}, {"x": 215.37718, "y": 254.02069}], "quality": 46.583878}, "image2_fac...
{"$schema": "http://json-schema.org/schema#", "type": "object", "properties": {"matchedFaces": {"type": "array", "items": {"type": "object", "properties": {"matchResult": {"type": "integer"}, "confidence": {"type": "integer"}, "image1_face": {"type": "object", "properties": {"faceRectangle": {"type": "object", "propert...
755be0b6-2462-4e2c-8641-c12c848a4cd8/951cc5ed-6df1-4f3c-b267-a55113ff2ba7/0/0
FaceAnalysis
Use our API for face detection, facial emotions, age and gender.
8.3
Age and gender by URL
Endpoint for age and gender prediction. Send us link to image, we return position of detected faces and predicted age and gender. Check out our tutorials for example of usage in Python.
200
New Example
{"detections": [{"crop": {"x1": 0.49029475450515747, "y1": 0.5199255347251892, "x2": 0.5589765906333923, "y2": 0.38276559114456177, "score": 0.9992923736572266}, "age": 23, "gender": {"F": 0.999700665473938, "M": 0.0002993345260620117}}, {"crop": {"x1": 0.11643223464488983, "y1": 0.5169875025749207, "x2": 0.18099755048...
{"type": "object", "properties": {"detections": {"type": "array", "items": {"type": "object", "properties": {"crop": {"type": "object", "properties": {"x1": {"type": "number"}, "y1": {"type": "number"}, "x2": {"type": "number"}, "y2": {"type": "number"}, "score": {"type": "number"}}}, "age": {"type": "integer"}, "gende...
755be0b6-2462-4e2c-8641-c12c848a4cd8/61531577-d6aa-4f83-af74-910b898b988d/0/0
FaceAnalysis
Use our API for face detection, facial emotions, age and gender.
8.3
BMI by URL
Endpoint for BMI estimation based on photo of face. Check out our tutorials for example of usage in Python.
200
New Example
{"detections": [{"crop": {"x1": 0.49029475450515747, "y1": 0.5199255347251892, "x2": 0.5589765906333923, "y2": 0.38276559114456177, "score": 0.9992923736572266}, "bmi": 22.93121337890625}, {"crop": {"x1": 0.11643223464488983, "y1": 0.5169875025749207, "x2": 0.18099753558635712, "y2": 0.39529597759246826, "score": 0.998...
{"type": "object", "properties": {"detections": {"type": "array", "items": {"type": "object", "properties": {"crop": {"type": "object", "properties": {"x1": {"type": "number"}, "y1": {"type": "number"}, "x2": {"type": "number"}, "y2": {"type": "number"}, "score": {"type": "number"}}}, "bmi": {"type": "number"}}}}}}
755be0b6-2462-4e2c-8641-c12c848a4cd8/096dcc7e-1cef-4912-816e-aa8db14fd414/0/0
FaceAnalysis
Use our API for face detection, facial emotions, age and gender.
8.3
Face Detection
Endpoint for face detection. Send us image, we return position of detected faces. Check out our tutorials for example of usage in Python.
200
New Example
{"detections": [{"crop": {"x1": 0.49029475450515747, "y1": 0.5199255347251892, "x2": 0.5589765906333923, "y2": 0.38276559114456177, "score": 0.9992923736572266}}, {"crop": {"x1": 0.11643223464488983, "y1": 0.5169875025749207, "x2": 0.18099753558635712, "y2": 0.39529597759246826, "score": 0.998594343662262}}, {"crop": {...
{"type": "object", "properties": {"detections": {"type": "array", "items": {"type": "object", "properties": {"crop": {"type": "object", "properties": {"x1": {"type": "number"}, "y1": {"type": "number"}, "x2": {"type": "number"}, "y2": {"type": "number"}, "score": {"type": "number"}}}}}}}}
755be0b6-2462-4e2c-8641-c12c848a4cd8/24eacd7d-ee3b-44f1-84c4-19bbb4a84941/0/0
FaceAnalysis
Use our API for face detection, facial emotions, age and gender.
8.3
Age and gender
Endpoint for age and gender prediction. Send us image, we return position of detected faces and predicted age and gender. Check out our tutorials for example of usage in Python.
200
New Example
{"detections": [{"crop": {"x1": 0.49029475450515747, "y1": 0.5199255347251892, "x2": 0.5589765906333923, "y2": 0.38276559114456177, "score": 0.9992923736572266}, "age": 23, "gender": {"F": 0.999700665473938, "M": 0.0002993345260620117}}, {"crop": {"x1": 0.11643223464488983, "y1": 0.5169875025749207, "x2": 0.18099755048...
{"type": "object", "properties": {"detections": {"type": "array", "items": {"type": "object", "properties": {"crop": {"type": "object", "properties": {"x1": {"type": "number"}, "y1": {"type": "number"}, "x2": {"type": "number"}, "y2": {"type": "number"}, "score": {"type": "number"}}}, "age": {"type": "integer"}, "gende...