Skip to main content
POST
Remix

Authorizations

X-API-Key
string
header
required

Body

application/json

Request body for the remix endpoint.

input_image
string
required

Input image as a raw base64 string or publicly accessible URL. Supported formats: JPEG, PNG, WebP, and HEIC/HEIF. Images larger than 4K (4096px) are automatically resized.

reference_image
string
required

Reference image as a raw base64 string or publicly accessible URL. The output keeps the input image's content rendered in this image's style.

async
boolean
default:false

Submit asynchronously. Returns 202 with a job_id to poll at GET /v1/jobs/{job_id} instead of holding the connection until the image is ready.

callback_url
string | null

Optional https URL we POST the signed result to on completion. Best-effort (polling remains authoritative). Requires async=true.

client_request_id
string | null

Idempotency key. A retried submit with the same value returns the original job instead of creating (and charging for) a new one.

response_mode
enum<string>
default:bytes

Response delivery mode. 'bytes': return base64-encoded image data (default). 'urls': return signed download URLs (24-hour expiry) instead of image bytes.

Available options:
bytes,
urls
profile_ids
string[]

Profile IDs for identity preservation in the output. When a listed profile is recognized in the input image, the person's likeness is preserved through the restyle. Optional.

prompt
string | null

Optional text instructions to steer the remix (e.g. what to keep or emphasize).

num_output_images
integer
default:1

Number of output images to generate (1-4).

Required range: 1 <= x <= 4
output_format
enum<string>
default:png

Output image format (png, jpg). Default: png (will change to jpg on 2026-05-08).

Available options:
png,
jpg

Response

Successful Response

Response returned by the edit, generate, and enhance endpoints.

known_subjects
KnownGeneratedSubjectCounts · object
required

Dictionary mapping a known subject's profile_id to the number of times they were generated. If multiple variations are generated, this will be the aggregated count across all variations.

images
string[]

Output image(s) as raw base64-encoded strings. Format matches the requested output_format. Populated when response_mode='bytes', empty otherwise.

download_urls
string[]

Signed download URLs for each output image (24-hour expiry). Populated when response_mode='urls', empty otherwise.