ControlNet SDXL

POST/v1/run

Fast Sdxl Controlnet Canny is Stability AI's intelligent image editing model. Transform, retouch, and reimagine existing images using text prompts - from background replacement to artistic style conversion.

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/fast-sdxl-controlnet-canny/image-to-image.

Default: stability-ai/fast-sdxl-controlnet-canny/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>control_image_url

The URL of the control 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 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

# 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": "stability-ai/fast-sdxl-controlnet-canny/image-to-image",
  "prompt": "Ice fortress, aurora skies, polar wildlife, twilight",
  "image": "https://fal-cdn.batuhan-941.workers.dev/files/tiger/IExuP-WICqaIesLZAZPur.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"

Response202 Accepted

{
  "id": "f3d2e8a1-7c4b-4a12-9d2e-123456789abc",
  "model": "stability-ai/fast-sdxl-controlnet-canny/image-to-image",
  "status": "running"
}