FLUX.1 [dev] Control LoRA Canny API Reference

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-control-lora-canny/image-to-image.

Default: bfl/flux-control-lora-canny/image-to-image

stringpromptrequired

The prompt to generate an image from.

stringimagerequired

URL of image to use for inpainting. or img2img

Optional<number>strength

The strength to use for inpainting/image-to-image. Only used if the image_url is provided. 1.0 is completely remakes the image while 0.0 preserves the original.

Range: 0.01 to 1

Default: 0.85

Optional<string>output_format

The format of the generated image.

Allowed values: jpeg, png

Default: jpeg

Optional<number>control_lora_strength

The strength of the control lora.

Range: 0 to 2

Default: 1

Optional<string>control_lora_image_url

The image to use for control lora. This is used to control the style of the generated image.

Optional<string>aspect_ratio

The aspect ratio of the generated image.

Allowed values: 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16

Optional<integer>seed

The same seed and the same prompt given to the same version of the model will output the same image every time.

Optional<integer>num_inference_steps

Number of denoising or inference steps to run when supported.

Range: 1 to 50

Default: 28

Optional<number>guidance_scale

Request parameter supported by this model.

Range: 0 to 35

Default: 3.5

Optional<array>loras

LoRA adapters applied to the generation. At most three items are accepted.

Default:

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 SandBase 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 SandBase 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

# 1. Submit a generation request curl -X POST https://api.sandbase.ai/v1/run \ -H "Authorization: Bearer $SANDBASE_API_KEY" \ -H "Content-Type: application/json" \ -d '{ "model": "bfl/flux-control-lora-canny/image-to-image", "prompt": "A photo of a lion sitting on a stone bench", "image": "https://raw.githubusercontent.com/CompVis/latent-diffusion/main/data/inpainting_examples/overture-creations-5sI6fQgYIuo.png", "output_format": "jpeg", "aspect_ratio": "21:9" }' # 2. If the response is still running, poll the returned id curl https://api.sandbase.ai/v1/run/f3d2e8a1-7c4b-4a12-9d2e-123456789abc \ -H "Authorization: Bearer $SANDBASE_API_KEY"