Privacy Blur
Blur faces and license plates, with optional photos and frames and experimental house-number and religious-object detection.

Ordering
Submit an order with POST /v1/orders — or one call of SDK. The snippets below cover upload, order, live progress and download using SDK 1.4.0 or Bash with curl and jq. See the SDK installation notes.
/v1/ordersimport { BkbnClient } from '@bkbnlab/api'
const bkbn = new BkbnClient() // reads BKBNLAB_API_KEY
const photo = await bkbn.upload('living-room.jpg')
const order = await bkbn.order({
inputs: [photo],
privacy: {
faces: true, licensePlates: true, pictures: false,
houseNumbers: false, religiousObjects: false,
},
})
const result = await order.wait({
onProgress: (p) => console.log(p.stage, p.percent),
})
await result.save('result.jpg')Privacy options
Set privacy to true to blur faces and license plates. Use the boolean options below to enable or disable each one. Photos and frames, house numbers and religious objects are off by default; faces inside a frame are still blurred as faces. Setting all five options to false disables privacy detection.
Options
These are REST request fields, alongside inputs. Defaults apply when neither an explicit value nor a selected preset supplies that setting. Shared delivery options are documented under Enhancer.
| Option | Type | Description |
|---|---|---|
privacy | boolean | Turn privacy blur on. Default: false. |
privacy_faces | boolean | Blur faces. Default: true. |
privacy_license_plates | boolean | Blur license plates. Default: true. |
privacy_pictures | boolean | Blur photos and frames. Faces inside them are blurred by privacy_faces. Default: false. |
privacy_house_numbers | boolean | Experimental: blur address numbers. Review for missed targets and unrelated objects. Default: false. |
privacy_religious_objects | boolean | Experimental: crucifixes, Stars of David, menorahs and Buddha statues. Default: false. |
threshold | number | Detection confidence threshold. Range: 0–1. Default: 0.3. |
SDK option names
These SDK options correspond to the REST fields below. Other options in the table above keep the same name. Dotted JavaScript names are properties of an options object.
| REST | Python | JavaScript | Kotlin |
|---|---|---|---|
privacy_faces | privacy_faces | privacy.faces | privacyFaces |
privacy_license_plates | privacy_license_plates | privacy.licensePlates | privacyLicensePlates |
privacy_pictures | privacy_pictures | privacy.pictures | privacyPictures |
privacy_house_numbers | privacy_house_numbers | privacy.houseNumbers | privacyHouseNumbers |
privacy_religious_objects | privacy_religious_objects | privacy.religiousObjects | privacyReligiousObjects |
threshold | privacy_threshold | privacy.threshold | privacyThreshold |
Inputs and outputs
inputs takes 1-5 ready asset ids owned by your key, uploads or previous deliveries — the exposure brackets of one scene. Magic Eraser takes exactly one image plus a mask. The completed order carries one outputAssetId (an opaque uuid) and its outputFormat. Authenticated GET /v1/assets/:id returns data.url and data.expiresIn; fetch the signed URL without your API key to download the bytes. A delivery's id can be reused as the input of another order: iterate on a result without uploading it again.
Before / After
Drag the slider to compare input and output. Switch between examples below.


Versioning
This page documents recipe privacy@2.3.0. The live catalog — every feature, its version and parameters — is public at GET /v1/features. Minor bumps improve quality without changing the interface.