Apply Face Filters API

What it does

Apply preset color and style filters to an image and get the edited file back. Face Filters takes a binary image upload, applies one of five modes, and returns the transformed image as binary output.

Send the image file in the request body, then choose a filter mode in the query string: warm, cool, vivid, mono, or dream. If you want lighter or stronger treatment, set intensity from 0 to 1; the default is 0.38. That makes it easy to tune the result for social previews, profile photos, product imagery, or batch edits where you need a consistent look.

Use Face Filters when you need a simple image styling step without managing your own image pipeline. It is a direct fit for apps that let users enhance photos, standardize thumbnails, or generate alternate visual variants from the same source file.

POST

Apply preset color/style filters

https://api.eu.apyhub.com/dosvak/apply-face-filters

QUICKSTART

GUIDE

Quickstart

Upload an image and apply a face filter.

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

What you'll get back

Returns a binary string (format: "binary"), so the response body is the filtered image file itself.

<binary image data>

TRY ITLIVE · 100 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

Applies a preset color/style filter to an uploaded image and returns the processed image as a binary file.

Query Parameter(s)

Attribute	Type	Mandatory	Description
mode	ENUM	No	Filter preset to apply. Allowed values: `warm`, `cool`, `vivid`, `mono`, `dream`. Default: `warm`.
intensity	Number	No	Filter strength. Minimum: `0`, maximum: `1`. Default: `0.38`.

Request Body

Parameter	Type	Mandatory	Description
file	String	Yes	Image file. Binary upload. Max size: 20 MB.

Response

Returns a binary file containing the filtered image.

Parameter	Type	Mandatory	Description

Query parameters

Name

Type

Description

modeOPTIONAL

string

warm · cool · vivid · mono · dream

—

DEFAULT warm

intensityOPTIONAL

number

—

DEFAULT 0.38

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.