Skip to content

Commit ee141a1

Browse files
committed
Added documentation for detect_faces param
1 parent 9863e5c commit ee141a1

File tree

1 file changed

+2
-1
lines changed

1 file changed

+2
-1
lines changed

docs/Rest-API-description.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -405,7 +405,7 @@ Response body is binary image. Empty bytes if image not found.
405405
To recognize faces from the uploaded image:
406406

407407
```shell
408-
curl -X POST "http://localhost:8000/api/v1/recognition/recognize?limit=<limit>&prediction_count=<prediction_count>&det_prob_threshold=<det_prob_threshold>&face_plugins=<face_plugins>&status=<status>" \
408+
curl -X POST "http://localhost:8000/api/v1/recognition/recognize?limit=<limit>&prediction_count=<prediction_count>&det_prob_threshold=<det_prob_threshold>&face_plugins=<face_plugins>&status=<status>&detect_faces=<detect_faces>" \
409409
-H "Content-Type: multipart/form-data" \
410410
-H "x-api-key: <service_api_key>" \
411411
-F file=<local_file>
@@ -421,6 +421,7 @@ curl -X POST "http://localhost:8000/api/v1/recognition/recognize?limit=<limit>&
421421
| prediction_count | param | integer | optional | maximum number of subject predictions per face. It returns the most similar subjects. Default value: 1 |
422422
| face_plugins | param | string | optional | comma-separated slugs of face plugins. If empty, no additional information is returned. [Learn more](Face-services-and-plugins.md) |
423423
| status | param | boolean | optional | if true includes system information like execution_time and plugin_version fields. Default value is false |
424+
| detect_faces | param | boolean | optional | if false, CompreFace won't run a face detector. Instead, it will treat the image as a cropped face. Default value is true. Since 1.2 version |
424425

425426
Response body on success:
426427
```json

0 commit comments

Comments
 (0)