Creative Upscaler 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 sandbase-ai/creative-upscaler.

Default: sandbase-ai/creative-upscaler

stringpromptrequired

The prompt to use for generating the image. Be as descriptive as possible for best results. If no prompt is provide BLIP2 will be used to generate a prompt.

stringimagerequired

The image to upscale.

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 16

Default: 7.5

Optional<integer>num_inference_steps

The number of inference steps to use for generating the image. The more steps the better the image will be but it will also take longer to generate.

Range: 1 to 200

Default: 20

Optional<string>prompt_suffix

The suffix to add to the prompt. This is useful to add a common ending to all prompts such as 'high quality' etc or embedding tokens.

Default: high quality, highly detailed, high resolution, sharp

Optional<number>additional_lora_scale

The scale of the additional LORA model to use for the upscaling. Default is 1.0

Default: 1

Optional<string>base_model_url

The URL to the base model to use for the upscaling

Optional<string>model_type

The type of model to use for the upscaling. Default is SD_1_5

Allowed values: SD_1_5, SDXL

Default: SD_1_5

Optional<number>scale

The scale of the output image. The higher the scale, the bigger the output image will be.

Range: 1 to 5

Default: 2

Optional<string>additional_embedding_url

The URL to the additional embeddings to use for the upscaling. Default is None

Optional<number>detail

How much detail to add

Range: 0 to 5

Default: 1

Optional<boolean>skip_ccsr

If set to true, the image will not be processed by the CCSR model before being processed by the creativity model.

Default: false

Optional<number>shape_preservation

How much to preserve the shape of the original image

Range: 0 to 3

Default: 0.25

Optional<number>creativity

How much the output can deviate from the original

Range: 0 to 1

Default: 0.5

Optional<boolean>enable_safety_checks

If set to true, the resulting image will be checked whether it includes any potentially unsafe content. If it does, it will be replaced with a black image.

Default: true

Optional<string>additional_lora_url

The URL to the additional LORA model to use for the upscaling. Default is None

Optional<boolean>override_size_limits

Allow for large uploads that could take a very long time.

Default: false

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.

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