Skip to main content
POST
Upload an image
Send one multipart file and an optional type: reference (default), person, outfit, or mask. Use JPEG, PNG, or WebP for photos and a black-and-white PNG for masks. Keep image files at or below 15 MiB; the total multipart request must not exceed 32 MiB. The returned media object contains id, type, status, url, dimensions, and created_at. Save its ID for later operations. No Studio version fields are needed. Prepare try-on inputs →

Authorizations

Authorization
string
header
required

Create an API key in Studio → account menu → API Keys. Keep it on your server.

Body

multipart/form-data
file
file
required

One JPEG, PNG, or WebP image. Maximum image size 15 MiB; total multipart request maximum 32 MiB.

type
enum<string>
default:reference

Purpose of the image. Use mask for a black-and-white PNG matching the source dimensions.

Available options:
reference,
person,
outfit,
mask

Response

Success

id
string<uuid>
required
type
enum<string>
required
Available options:
image,
video
status
enum<string>
required
Available options:
pending,
generating,
completed,
failed,
policy_blocked
url
string<uri> | null
required
width
integer | null
required
height
integer | null
required
created_at
string<date-time>
required