▣ IMAGE PROCESSING · SECURITY & PRIVACY

Face Pixelizer

What it does

Face Pixelizer takes an image file or a public image URL, detects faces, and returns a pixelated version of the image. You can send the source as binary file upload or as an image_url, depending on your workflow.

Use POST /file when you already have the image in hand and want the processed image back as binary. Use POST /file/url to upload a file and get a presigned S3 url for the output instead. If your source image is already hosted elsewhere, POST /url/download accepts a public image_url and returns the pixelized image as a file, while POST /url returns a presigned output url.

Face Pixelizer is a good fit for anonymising profile photos, screenshots, social media assets, or user-submitted images before storage or publication. Supported input formats are jpeg, png, webp, bmp, and tiff, with a maximum file size of 5 MB.

▣ ENDPOINT 01 / 04

POST

Pixelize faces — file in, file out

https://api.eu.apyverse.com/apyhub/pixelize-faces/file

QUICKSTART

GUIDE

Quickstart

Upload a single image file to pixelize detected faces.

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

What you'll get back

Returns a binary file containing the pixelized image.

TRY ITLIVE · 10 ATOMS

API key

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.

About this endpoint

What it does

Uploads an image file and returns a pixelized version of that image as a binary file. The request body must include the source image file; the response is the processed image file.

Request Body

Parameter	Type	Mandatory	Description
file	String	Yes	The source image file. Supported formats are jpeg, png, webp, bmp, tiff. Maximum file size is 5 MB.

Response

Returns a binary file containing the pixelized image. The output schema is a single binary string, so the success response is the processed file itself.

Parameter	Type	Mandatory	Description
—	String	Yes	Binary file content of the pixelized image.

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.

▣ ENDPOINT 02 / 04

POST

Pixelize faces — file in, URL out

https://api.eu.apyverse.com/apyhub/pixelize-faces/file/url

QUICKSTART

GUIDE

Quickstart

Upload one image file to get a pixelated version back.

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

What you'll get back

Returns a JSON object with a url string field containing a presigned S3 URL for the pixelated output image.

{
  "url": "https://s3.amazonaws.com/apyhub-images/sample-output.jpg"
}

TRY ITLIVE · 10 ATOMS

API key

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.

About this endpoint

What it does

Uploads an image file and returns a presigned URL for the pixelated output image. The request accepts a single source file and the response contains a url field pointing to the generated image.

Request Body

Parameter	Type	Mandatory	Description
file	String	Yes	The source image file. Supported formats are jpeg, png, webp, bmp, tiff. Maximum file size is 5 MB.

Response

Returns a JSON object with a url string field containing a presigned S3 URL for the pixelated output image.

Parameter	Type	Mandatory	Description
url	String	Yes	Presigned S3 URL for the pixelated output image.

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.

▣ ENDPOINT 03 / 04

POST

Pixelize faces — URL in, file out

https://api.eu.apyverse.com/apyhub/pixelize-faces/url/download

QUICKSTART

GUIDE

Quickstart

Convert an image from a public URL into a pixelized-faces result using the source image URL.

curl -X POST "https://api.eu.apyverse.com/apyhub/pixelize-faces/url/download" \
  -H "apy-token: $APY_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"image_url":"https://assets.apyhub.com/samples/sample.jpg"}'

What you'll get back

Returns a binary file response.

TRY ITLIVE · 10 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

Pixelizes faces in an image fetched from a public URL and returns the processed file as binary output.

Request Body

Parameter	Type	Mandatory	Description
image_url	String	Yes	A publicly accessible URL pointing to the source image. Supported formats are jpeg, png, webp, bmp, tiff. Maximum file size is 5 MB. Must be a URI.

Response

Returns a binary file response as a single top-level string with binary format. The success response body is the processed image file.

Parameter	Type	Mandatory	Description
value	String	Yes	Binary file content returned by the endpoint.

Body

Name

Type

Description

bodyREQUIRED

object

—

▣ ENDPOINT 04 / 04

POST

Pixelize faces — URL in, URL out

https://api.eu.apyverse.com/apyhub/pixelize-faces/url

QUICKSTART

GUIDE

Quickstart

Send the source image URL and get back a presigned URL for the pixelated output image.

curl -X POST "https://api.eu.apyverse.com/apyhub/pixelize-faces/url" \
  -H "apy-token: $APY_TOKEN" \
  -d '{"image_url":"https://assets.apyhub.com/samples/sample.jpg"}'

What you'll get back

Returns a JSON object with a url string field containing the presigned S3 URL for the pixelated output image.

{
  "url": "https://s3.amazonaws.com/apyhub-images/sample-output.jpg"
}

TRY ITLIVE · 10 ATOMS

API key

Loading your default key…

The full key is used to call the gateway and stays in this tab — never sent to orbit or saved.

About this endpoint

What it does

This endpoint takes a source image URL and returns a URL for the pixelized output image. The request body contains the input image location, and the response contains the generated image URL.

Request Body

Parameter	Type	Mandatory	Description
image_url	String	Yes	A publicly accessible URL pointing to the source image. Supported formats are jpeg, png, webp, bmp, tiff. Maximum file size is 5 MB.

Response

Returns a JSON object with a url string field containing the presigned S3 URL for the pixelated output image.

Parameter	Type	Mandatory	Description
url	String	Yes	Presigned S3 URL for the pixelated output image.

Body

Name

Type

Description

bodyREQUIRED

object

—

▣ 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.