Backbone LabDocs
Togglev2.3.0

Privacy Blur

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

Privacy Blur preview

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.

POST/v1/orders
import { 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.

OptionTypeDescription
privacybooleanTurn privacy blur on. Default: false.
privacy_facesbooleanBlur faces. Default: true.
privacy_license_platesbooleanBlur license plates. Default: true.
privacy_picturesbooleanBlur photos and frames. Faces inside them are blurred by privacy_faces. Default: false.
privacy_house_numbersbooleanExperimental: blur address numbers. Review for missed targets and unrelated objects. Default: false.
privacy_religious_objectsbooleanExperimental: crucifixes, Stars of David, menorahs and Buddha statues. Default: false.
thresholdnumberDetection 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.

RESTPythonJavaScriptKotlin
privacy_facesprivacy_facesprivacy.facesprivacyFaces
privacy_license_platesprivacy_license_platesprivacy.licensePlatesprivacyLicensePlates
privacy_picturesprivacy_picturesprivacy.picturesprivacyPictures
privacy_house_numbersprivacy_house_numbersprivacy.houseNumbersprivacyHouseNumbers
privacy_religious_objectsprivacy_religious_objectsprivacy.religiousObjectsprivacyReligiousObjects
thresholdprivacy_thresholdprivacy.thresholdprivacyThreshold

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.

BEFORE
AFTER

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.

See also

  • Batches — run a whole shoot in one call, with per-scene overrides.
  • Streaming — WebSocket and SSE progress in detail.