Start building
SandBase

Appearance

Stable Diffusion XL

POST/v1/run

Fast Sdxl Inpainting 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/fast-sdxl/inpainting.

Default: stability-ai/fast-sdxl/inpainting

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

The URL of the mask to use for inpainting.

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 65

Default: 25

Optional<number>strength

determines how much the generated image resembles the initial image

Range: 0.01 to 1

Default: 0.95

Optional<boolean>expand_prompt

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

Default: false

Optional<array<object>>loras

The list of LoRA weights to use.

Default:

Optional<string>request_id

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

Default:

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

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