Anonymize a file

post

https://api.brighter.ai/{service}/v4/{out_type}

Submit images and videos to be processed with one of our services.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Path Params

service

string

enum

required

Selection of the service to be performed on the data. Current services are a traditional blur anonymization (blur), mask anonymization (experimental - replace PIIs with zeros), a natural anonymization (dnat) based on Brighter AI's Deep Natural Anonymization™ technology, and a labeling service of the original personal identifiable information (PIIs) locations (redact_area).

Allowed:

out_type

string

enum

required

Output resource type of the service. Supports videos, images, archives and overlays. Overlays only contain the targeted PIIs without the original background.

Allowed:

Query Params

face

boolean

Defaults to true

Whether to target faces on the selected service.

license_plate

boolean

Defaults to true

Whether to target license plates on the selected service.

speed_optimized

boolean

Defaults to false

Option to increase processing speed by removing steps in the processing such as smoothing, cropping. Activating this parameter may have a impact on the visual quality of the data.

vehicle_recorded_data

boolean

Defaults to false

Option to optimize for vehicle recorded data.

single_frame_optimized

boolean

Defaults to false

Option to process videos or archives as single images instead of sequence. This parameter is recommended for videos with lower framerate (< 15 FPS).

lp_determination_threshold

number

0 to 1

Defaults to 0.586

Experimental Option to adjust the determination threshold for license plate detections, in the range of [0, 1]. Advanced users can change this value to override the default internal threshold for better accuracy on their data domain. The threshold value corresponds to the preference for reduction of false positives (anonymized identities that are not there) vs false negatives (missed identities). A threshold of 1.0 minimizes false positives as much as possible, a threshold of 0.0 minimizes false negatives as much as possible, and a threshold of 0.5 gives them both equal weighting. Note that there is no guarantee that this threshold will work on other data and after algorithm updates.

face_determination_threshold

number

0 to 1

Defaults to 0.543

Experimental Option to adjust the determination threshold for faces, in the range of [0, 1]. Advanced users can change this value to override the default internal threshold for better accuracy on their data domain. Note that there is no guarantee that this threshold will work on other data and after algorithm updates.

region

string

enum

Geographic region of the data, for performing region-specific replacement of PIIs.

Allowed:

full_body

boolean

Defaults to false

Whether to target full bodies on the selected service.

full_body_determination_threshold

number

0 to 1

Defaults to 0.3

Option to adjust the determination threshold for full bodies, in the range of [0, 1]. Advanced users can change this value to override the default internal threshold for better accuracy on their data domain. Note that there is no guarantee that this threshold will work on other data and after algorithm updates.

areas_of_interest

array

Experimental Only fully supported and tested for output type of videos and service type blur! Areas of interest's top left corner coordinates x and y, their height and width. Each area must be provided as a string in the following format [x,y,width,height]. Multiple areas can be defined but are not allowed to overlap. For example, one area "...&areas_of_interest=[0,0,960,540]", two areas "...&areas_of_interest=[[0,0,960,540],[0,540,960,540]]", two areas "...&areas_of_interest=[0,0,960,540]&areas_of_interest=[0,540,960,540]". The parameter might not yet fully work with all parameters and output types.

Areas Of Interest

Body Params

file

required

The file to anonymize. For a list of all supported codecs and containers please go to Guides/Data Requirements.

licence_plate_custom_stamp

file

Option to replace original license plates with a specific image instead of generated realistic license plates.

Responses

200Successful Response

422Validation Error