Start building
SandBase

Appearance

SDXL ControlNet Union

POST/v1/run

Sdxl Controlnet Union by Stability AI - 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 stability-ai/sdxl-controlnet-union/image-to-image.

Default: stability-ai/sdxl-controlnet-union/image-to-image

stringpromptrequired

The prompt to use for generating the image. Be as descriptive as possible for best results.

stringimagerequired

The URL of the image to use as a starting point for the generation.

Optional<number>strength

determines how much the generated image resembles the initial image

Range: 0.05 to 1

Default: 0.95

Optional<string>canny_image_url

The URL of the control image.

Default: null

Optional<string>openpose_image_url

The URL of the control image.

Default: null

Optional<string>depth_image_url

The URL of the control image.

Default: null

Optional<boolean>teed_preprocess

Whether to preprocess the teed image.

Default: true

Optional<boolean>canny_preprocess

Whether to preprocess the canny image.

Default: true

Optional<string>teed_image_url

The URL of the control image.

Default: null

Optional<boolean>normal_preprocess

Whether to preprocess the normal image.

Default: true

Optional<boolean>segmentation_preprocess

Whether to preprocess the segmentation image.

Default: true

Optional<boolean>openpose_preprocess

Whether to preprocess the openpose image.

Default: true

Optional<string>segmentation_image_url

The URL of the control image.

Default: null

Optional<string>normal_image_url

The URL of the control image.

Default: null

Optional<boolean>depth_preprocess

Whether to preprocess the depth image.

Default: true

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 Stable Diffusion will output the same image every time.

Default: null

Optional<integer>num_inference_steps

Number of denoising or inference steps to run when supported.

Range: 1 to 70

Default: 35

Optional<number>guidance_scale

Request parameter supported by this model.

Range: 0 to 20

Default: 7.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