--- title: "Update FF.Multi settings" method: PATCH path: "/settings" tags: ["settings"] --- # Update FF.Multi settings `PATCH /settings` Use this method to update the FindFace Multi settings. ## Request body - PatchedSettingsRequest - `face_confidence_threshold` number, float — Face similarity threshold - `body_confidence_threshold` number, float — Body similarity threshold - `car_confidence_threshold` number, float — Car similarity threshold - `face_episodes_threshold` number, float — Human episodes face threshold - `body_episodes_threshold` number, float — Human episodes body threshold - `car_episodes_threshold` number, float — Car episodes car threshold - `minimum_face_quality` number, float — Minimum face quality for inclusion in a card - `minimum_car_quality` number, float — Minimum car quality for inclusion in a card - `minimum_body_quality` number, float — Minimum body quality for inclusion in a card - `ignore_unmatched` boolean — If enabled, unmatched events won't be saved to the database - `license_accepted` boolean — By setting this option to "true", you indicate that you have read and accepted the FindFace Security license agreement. - `face_events_max_matched_age` integer, nullable — Matched face events older than `events_max_age` will be removed every night by the cleanup script - `face_events_max_unmatched_age` integer — Unmatched face events older than `events_max_age` will be removed every night by the cleanup script - `face_events_max_fullframe_matched_age` integer, nullable — Fullframes from matched face events older than `events_max_fullframe_matched_age` will be removed every night by the cleanup script - `face_events_max_fullframe_unmatched_age` integer, nullable — Fullframes from unmatched face events older than `events_max_fullframe_unmatched_age` will be removed every night by the cleanup script - `face_cluster_events_max_age` integer, nullable — Face cluster events older than `face_cluster_events_max_age` will be removed every night by the cleanup script - `face_cluster_events_keep_best_max_age` integer, nullable — Face cluster events except of best cluster event older than `face_cluster_events_max_age` will be removed every night by the cleanup script - `car_events_max_matched_age` integer, nullable — Matched car events older than `events_max_age` will be removed every night by the cleanup script - `car_events_max_unmatched_age` integer — Unmatched car events older than `events_max_age` will be removed every night by the cleanup script - `car_events_max_fullframe_matched_age` integer, nullable — Fullframes from matched car events older than `events_max_fullframe_matched_age` will be removed every night by the cleanup script - `car_events_max_fullframe_unmatched_age` integer, nullable — Fullframes from unmatched car events older than `events_max_fullframe_unmatched_age` will be removed every night by the cleanup script - `car_cluster_events_max_age` integer, nullable — Car cluster events older than `car_cluster_events_max_age` will be removed every night by the cleanup script - `car_cluster_events_keep_best_max_age` integer, nullable — Car cluster events except of best cluster event older than `car_cluster_events_max_age` will be removed every night by the cleanup script - `body_events_max_matched_age` integer, nullable — Matched body events older than `events_max_age` will be removed every night by the cleanup script - `body_events_max_unmatched_age` integer — Unmatched body events older than `events_max_age` will be removed every night by the cleanup script - `body_events_max_fullframe_matched_age` integer, nullable — Fullframes from matched body events older than `events_max_fullframe_matched_age` will be removed every night by the cleanup script - `body_events_max_fullframe_unmatched_age` integer, nullable — Fullframes from unmatched body events older than `events_max_fullframe_unmatched_age` will be removed every night by the cleanup script - `body_cluster_events_max_age` integer, nullable — Body cluster events older than `body_cluster_events_max_age` will be removed every night by the cleanup script - `body_cluster_events_keep_best_max_age` integer, nullable — Body cluster events except of best cluster event older than `body_cluster_events_max_age` will be removed every night by the cleanup script - `face_events_features` FaceEventsFeaturesEnum[] — Features to extract when creating face events - `body_events_features` BodyEventsFeaturesEnum[] — Features to extract when creating body events - `car_events_features` CarEventsFeaturesEnum[] — Features to extract when creating car events - `liveness_threshold` number, float — Liveness classifier threshold (if liveness is enabled) - `thumbnail_jpeg_quality` integer — Thumbnail JPEG quality, default is 75 - `vms_cleanup_settings` VmsCleanupSettingsRequest - `keep_event_before_after` integer, nullable — interval in `seconds` to be added to track - `cleanup_threshold` integer, nullable — cleanup threshold in `seconds` between tracks that will not be deleted - `cleanup_archive` boolean, nullable - `archive_cleanup_age` integer, nullable — delete video older than specified age - `between_tracks_cleanup_start_age` integer, nullable — delete video between track older than specified age - `cleanup_between_tracks` boolean, nullable - `keep_event_types` string[], nullable — tracks with event types to be deleted ## Response `200` - Settings - `face_confidence_threshold` number, float, required — Face similarity threshold - `body_confidence_threshold` number, float, required — Body similarity threshold - `car_confidence_threshold` number, float, required — Car similarity threshold - `face_episodes_threshold` number, float, required — Human episodes face threshold - `body_episodes_threshold` number, float, required — Human episodes body threshold - `car_episodes_threshold` number, float, required — Car episodes car threshold - `minimum_face_quality` number, float, required — Minimum face quality for inclusion in a card - `minimum_car_quality` number, float, required — Minimum car quality for inclusion in a card - `minimum_body_quality` number, float, required — Minimum body quality for inclusion in a card - `ignore_unmatched` boolean, required — If enabled, unmatched events won't be saved to the database - `license_accepted` boolean, required — By setting this option to "true", you indicate that you have read and accepted the FindFace Security license agreement. - `face_events_max_matched_age` integer, nullable, required — Matched face events older than `events_max_age` will be removed every night by the cleanup script - `face_events_max_unmatched_age` integer, required — Unmatched face events older than `events_max_age` will be removed every night by the cleanup script - `face_events_max_fullframe_matched_age` integer, nullable, required — Fullframes from matched face events older than `events_max_fullframe_matched_age` will be removed every night by the cleanup script - `face_events_max_fullframe_unmatched_age` integer, nullable, required — Fullframes from unmatched face events older than `events_max_fullframe_unmatched_age` will be removed every night by the cleanup script - `face_cluster_events_max_age` integer, nullable, required — Face cluster events older than `face_cluster_events_max_age` will be removed every night by the cleanup script - `face_cluster_events_keep_best_max_age` integer, nullable, required — Face cluster events except of best cluster event older than `face_cluster_events_max_age` will be removed every night by the cleanup script - `car_events_max_matched_age` integer, nullable, required — Matched car events older than `events_max_age` will be removed every night by the cleanup script - `car_events_max_unmatched_age` integer, required — Unmatched car events older than `events_max_age` will be removed every night by the cleanup script - `car_events_max_fullframe_matched_age` integer, nullable, required — Fullframes from matched car events older than `events_max_fullframe_matched_age` will be removed every night by the cleanup script - `car_events_max_fullframe_unmatched_age` integer, nullable, required — Fullframes from unmatched car events older than `events_max_fullframe_unmatched_age` will be removed every night by the cleanup script - `car_cluster_events_max_age` integer, nullable, required — Car cluster events older than `car_cluster_events_max_age` will be removed every night by the cleanup script - `car_cluster_events_keep_best_max_age` integer, nullable, required — Car cluster events except of best cluster event older than `car_cluster_events_max_age` will be removed every night by the cleanup script - `body_events_max_matched_age` integer, nullable, required — Matched body events older than `events_max_age` will be removed every night by the cleanup script - `body_events_max_unmatched_age` integer, required — Unmatched body events older than `events_max_age` will be removed every night by the cleanup script - `body_events_max_fullframe_matched_age` integer, nullable, required — Fullframes from matched body events older than `events_max_fullframe_matched_age` will be removed every night by the cleanup script - `body_events_max_fullframe_unmatched_age` integer, nullable, required — Fullframes from unmatched body events older than `events_max_fullframe_unmatched_age` will be removed every night by the cleanup script - `body_cluster_events_max_age` integer, nullable, required — Body cluster events older than `body_cluster_events_max_age` will be removed every night by the cleanup script - `body_cluster_events_keep_best_max_age` integer, nullable, required — Body cluster events except of best cluster event older than `body_cluster_events_max_age` will be removed every night by the cleanup script - `face_events_features` FaceEventsFeaturesEnum[], required — Features to extract when creating face events - `body_events_features` BodyEventsFeaturesEnum[], required — Features to extract when creating body events - `car_events_features` CarEventsFeaturesEnum[], required — Features to extract when creating car events - `liveness_threshold` number, float, required — Liveness classifier threshold (if liveness is enabled) - `thumbnail_jpeg_quality` integer, required — Thumbnail JPEG quality, default is 75 - `vms_cleanup_settings` VmsCleanupSettings - `keep_event_before_after` integer, nullable — interval in `seconds` to be added to track - `cleanup_threshold` integer, nullable — cleanup threshold in `seconds` between tracks that will not be deleted - `cleanup_archive` boolean, nullable - `archive_cleanup_age` integer, nullable — delete video older than specified age - `between_tracks_cleanup_start_age` integer, nullable — delete video between track older than specified age - `cleanup_between_tracks` boolean, nullable - `keep_event_types` string[], nullable — tracks with event types to be deleted --- [API](https://skmtc.dev/ntechlab/apis/internal-api-documentation.md) · [All operations](https://skmtc.dev/ntechlab/apis/internal-api-documentation/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/ntechlab/internal-api-documentation/revisions/fe217a895bc7/schema)