Start building
SandBase

Appearance

SDXL ControlNet Union

POST/v1/run

Sdxl Controlnet Union is Stability AI's advanced text-to-image AI model. Create photorealistic images, illustrations, and concept art from natural language descriptions with exceptional detail and prompt adherence.

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.

Default: stability-ai/sdxl-controlnet-union

stringpromptrequired

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

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<number>guidance_scale

The CFG (Classifier Free Guidance) scale is a measure of how close you want the model to stick to your prompt when looking for a related image to show you.

Range: 0 to 20

Default: 7.5

Optional<integer>num_inference_steps

The number of inference steps to perform.

Range: 1 to 70

Default: 35

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<string>openpose_image_url

The URL of the control image.

Default: null

Optional<string>segmentation_image_url

The URL of the control image.

Default: null

Optional<string>request_id

An id bound to a request, can be used with response to identify the request itself.

Default:

Optional<string>teed_image_url

The URL of the control image.

Default: null

Optional<boolean>canny_preprocess

Whether to preprocess the canny image.

Default: true

Optional<boolean>expand_prompt

If set to true, the prompt will be expanded with additional prompts.

Default: false

Optional<boolean>normal_preprocess

Whether to preprocess the normal image.

Default: true

Optional<array<object>>loras

The list of LoRA weights to use.

Default:

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<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<boolean>openpose_preprocess

Whether to preprocess the openpose image.

Default: true

Optional<string>canny_image_url

The URL of the control image.

Default: null

Optional<string>safety_checker_version

The version of the safety checker to use. v1 is the default CompVis safety checker. v2 uses a custom ViT model.

Allowed values: v1, v2

Default: v1

Optional<number>controlnet_conditioning_scale

The scale of the controlnet conditioning.

Range: 0 to 1

Default: 0.5

Optional<string>format

The format of the generated image.

Allowed values: jpeg, png

Default: jpeg

Optional<array<object>>embeddings

The list of embeddings to use.

Default:

Optional<boolean>segmentation_preprocess

Whether to preprocess the segmentation image.

Default: true

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: text-to-image

stringexecution_moderequired

Execution mode declared by the model registry.

Default: async