Clarity Upscaler

POST/v1/run

Clarity Upscaler by ClarityAI - 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 clarity-ai/clarity-upscaler.

Default: clarity-ai/clarity-upscaler

stringpromptrequired

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

Default: masterpiece, best quality, highres

stringimagerequired

The URL of 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 20

Default: 4

Optional<integer>num_inference_steps

The number of inference steps to perform.

Range: 4 to 50

Default: 18

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.

Range: 0 to ∞

Optional<number>upscale_factor

The upscale factor

Range: 1 to 4

Default: 2

Optional<number>resemblance

The resemblance of the upscaled image to the original image. The higher the resemblance, the more the model will try to keep the original image. Refers to the strength of the ControlNet.

Range: 0 to 1

Default: 0.6

Optional<number>creativity

The creativity of the model. The higher the creativity, the more the model will deviate from the prompt. Refers to the denoise strength of the sampling.

Range: 0 to 1

Default: 0.35

Response Schema

The submit endpoint returns an accepted generation task. Poll the result endpoint with the returned id for terminal outputs or errors.

Optional<string>error

Error message if the task failed. Empty on success.

stringidrequired

Unique identifier for the generation task.

Optional<string>model

Model ID used for the prediction.

Optional<array>outputs

Array of generated content. Empty when status is not completed.

stringstatusrequired

Status of the task: pending, running, completed, failed, or timeout.

Allowed values: pending, running, completed, failed, timeout

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": "clarity-ai/clarity-upscaler",
  "prompt": "masterpiece, best quality, highres",
  "image": "https://static.sandbase.ai/examples/bytedance/seedvr/upscale/image/input_image_0.png"
}'

# 2. If the response is still running, poll the returned id
curl https://api.sandbase.ai/v1/run/run_abc123 \
  -H "Authorization: Bearer $SANDBASE_API_KEY"

Response202 Accepted

{
  "id": "run_abc123",
  "model": "clarity-ai/clarity-upscaler",
  "status": "running",
  "outputs": []
}