apyhub
▣ FILE SECURITY · IMAGE PROCESSING

Blur/Pixelate or Black out Image Faces API

What it does

Face Blur detects faces in an image and returns a processed image with those faces blurred, pixelated, or blacked out. Send a single image file as binary data, and choose the masking style with mode.

Use expand to widen the area around each detected face before masking, which helps cover hairlines, ears, and other nearby details. Use strength to control how aggressive the blur or pixelation should be. The service accepts images up to 20 MB and returns the edited image as binary output.

Use Face Blur when you need to anonymise people in photos before publishing them, share screenshots without exposing identities, or prepare visual assets for internal review. It is useful for moderation workflows, privacy filtering, and any process that needs face redaction without manual editing.

If you already have image pipelines in place, Face Blur fits as a simple preprocessing step: upload an image, select the masking mode, and pass the output on to storage, review, or publishing.

POST
Blur, pixelate, or black out detected faces
https://api.eu.apyhub.com/dosvak/blur-faces

QUICKSTART

GUIDE

Quickstart

Upload an image to blur, pixelate, or black out detected faces. This minimal example sends the required file and uses the default blur mode.

curl -X POST "https://api.eu.apyhub.com/dosvak/blur-faces" \
  -H "apy-token: $APY_TOKEN" \
  -F "file=@/path/to/image.jpg"

What you'll get back

Returns binary data (string with format: binary) - the processed image file.

TRY ITLIVE · 100 ATOMS
Loading your default key…
The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.
Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.
body*
Image file

About this endpoint

What it does

Blurs, pixelates, or blacks out detected faces in an uploaded image. The endpoint takes an image file plus optional processing controls and returns a binary image result.

Query Parameter(s)

AttributeTypeMandatoryDescription
modeENUMNoFace-processing mode. Allowed values: blur, pixelate, black. Default: blur.
expandNumberNoExpansion factor around detected faces. Default: 0.18. Minimum: 0, maximum: 0.6.
strengthIntegerNoProcessing strength. Default: 31. Minimum: 5, maximum: 99.

Request Body

ParameterTypeMandatoryDescription
fileStringYesImage file to process. Binary upload. Max size: 20 MB.

Response

Returns a binary string containing the processed image output.

Query parameters

Name
Type
Description
modeOPTIONAL
string
blur · pixelate · black
—
DEFAULT blur
expandOPTIONAL
number
—
DEFAULT 0.18
strengthOPTIONAL
integer
—
DEFAULT 31

Body

Name
Type
Description
bodyREQUIRED
object
—

Max 100MB total per request (all files combined). Larger? Use this API's URL-based endpoint instead, if it has one.

▣ COMMON ERRORS

Errors any endpoint can return

400bad_request

Required parameter missing or malformed body.

401unauthorized

API key missing, revoked, or not authorized for this service.

429rate_limited

Your plan's per-second rate exceeded. Retry with exponential backoff.

503upstream_busy

Backend temporarily unavailable. Try again in a few seconds.