Skip to main content
POST
Swap faces into a group scene

Authorizations

Authorization
string
header
required

Supabase user JWT (or an internal service token). Send as Authorization: Bearer <token>.

Body

application/json
input_image_urls
string<uri>[]
required

HTTPS URLs of the source face images. 2–20 items.

Required array length: 2 - 20 elements
Example:
reference_image_url
string<uri>
required

HTTPS URL of the target scene or background image.

Example:

"https://example.com/office-scene.jpg"

genders
enum<string>[]

Gender hint per input image, in order.

Available options:
male,
female,
pets,
others
Example:
instructions
string

Additional instructions for the scene composition.

prompt
string

Override the auto-generated scene prompt.

num_output_images
integer
default:1

Number of output images.

Required range: 1 <= x <= 4
aspect_ratio
enum<string>

Output aspect ratio. Auto-detected from the reference image if omitted.

Available options:
auto,
1:1,
3:4,
4:3,
9:16,
16:9
resolution
enum<string>
default:low

Output resolution.

Available options:
low,
medium,
high
output_format
enum<string>
default:png

Output image format.

Available options:
png,
jpg

Response

Group photo generated successfully.

status
integer
Example:

200

data
object