Skip to content

FLUX Virtual Try-On

POST/v1/run

Flux Pro 1.0 Vto by BFL - AI-powered image editing, style transfer, and transformation. Edit photos with natural language instructions, remove backgrounds, change styles, and enhance images effortlessly.

Request body

Submit an async generation request. The model field selects the model; other fields are model-specific input parameters.

stringmodelrequired

Model identifier. Set to bfl/flux-pro/1.0/vto.

Default: bfl/flux-pro/1.0/vto

stringpromptrequired

Natural-language styling instructions describing how the garment should be worn on the person (e.g. tucked in, layered, sleeves rolled up).

Optional<integer>num_inference_steps

The number of denoising steps to perform.

Range: 1 to 4

Default: 4

Optional<string>output_format

The format of the generated image.

Allowed values: jpeg, png

Default: jpeg

Optional<integer>seed

The same seed and the same input will output the same image every time. If not provided, a random seed is used.

Optional<string>garment_image_url

The URL of the garment reference image. Maximum 1 megapixel; recommended around 0.5 MP. Multiple garments must be merged into a single composite image before submission.

Optional<string>human_image_url

The URL of the person image that the garment will be applied onto. The output keeps this image's aspect ratio. Maximum 2 megapixels; recommended under 1 MP.

Response Schema

The submit endpoint returns a run response. If its status is pending or running, poll GET /v1/run/{id} with the returned opaque ID until it reaches a terminal state.

stringidrequired

Opaque AGRouter run identifier. Use it exactly as returned; no prefix is guaranteed.

stringstatusrequired

Current public run status.

Allowed values: pending, running, completed, failed, timeout

Optional<string>model

Public AGRouter model name used for this run.

Optional<array<object>>outputs

Present only for completed runs. Each object is capability-specific; inspect the selected model schema for its fields.

Optional<object>error

Present only for failed or timeout runs. Contains a public error type and sanitized message.

Optional<string>error.type

Stable public error category.

Optional<string>error.message

Sanitized error message safe to show to clients.

Optional<object>usage

Usage details when available.

Model capabilities

array<string>capability_tagsrequired

Capabilities declared by the model registry.

Default: image-to-image

stringexecution_moderequired

Execution mode declared by the model registry.

Default: async