apyhub

Portrait Photo Retouch API

What it does

Portrait Photo Retouch smooths and sharpens a portrait image and returns the edited file as binary output. Send a single portrait photo file, and control the result with two query parameters: sharpen and strength.

Use it when you need to clean up face photos for profiles, staff directories, identity-related visuals, or other portrait assets that should look polished without rebuilding the image in your own pipeline. The service is designed for one-step image enhancement, with defaults that work for a typical portrait retouch.

The input schema is simple: upload one file up to 20 MB. The response is the processed image itself, so you can pass it straight into storage, download it, or continue downstream image handling without parsing a complex object.

If your workflow includes customer avatars, onboarding photos, or marketplace seller images, this endpoint gives you a consistent way to improve portrait clarity while keeping the integration surface small.

POST
Smooth and sharpen portrait photos
https://api.eu.apyhub.com/dosvak/retouch-portrait-photo

QUICKSTART

GUIDE

Quickstart

Upload a portrait photo to retouch it with the default sharpen and strength settings.

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

What you'll get back

Returns a binary file (string with format: binary) containing the retouched image.

<binary image data>
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*
Portrait image

About this endpoint

What it does

Smooths and sharpens a portrait photo. Send a portrait image file in the request body and optional query parameters to control the sharpening and smoothing strength; the response is a binary file.

Query Parameter(s)

AttributeTypeMandatoryDescription
sharpenNumberNoSharpening amount. Minimum 0, maximum 1, default 0.12.
strengthNumberNoSmoothing strength. Minimum 0, maximum 1, default 0.32.

Request Body

ParameterTypeMandatoryDescription
fileStringYesPortrait image file. Binary upload. Maximum size: 20 MB.

Response

Returns a binary file. The success response is a single binary payload, not a JSON object.

ParameterTypeMandatoryDescription
binaryStringYesThe processed portrait image returned as binary data.

Query parameters

Name
Type
Description
sharpenOPTIONAL
number
DEFAULT 0.12
strengthOPTIONAL
number
DEFAULT 0.32

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.