API reference · ClarityAI

clarity-ai/clarity-upscaler

Integrate this model through SandBase's unified API, with production-ready schemas and examples.

IMAGEAsyncOpen model

Production endpoint

Send your first request

OpenAI-compatible endpoint with unified authentication and usage tracking.

POSThttps://api.sandbase.ai/v1/run

Model IDclarity-ai/clarity-upscaler

Input Schema

8 parameters · 2 required · 6 optional

Parameter	Type	Required	Description
`image`	string	Required	The URL of the image to upscale.
`prompt`	string	Required	The prompt to use for generating the image. Be as descriptive as possible for best results. · Default: "masterpiece, best quality, highres"
`seed`	integer	Optional	The same seed and the same prompt given to the same version of Stable Diffusion will output the same image every time. · Min: 0
`creativity`	number	Optional	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. · Min: 0 · Max: 1 · Default: 0.35
`resemblance`	number	Optional	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. · Min: 0 · Max: 1 · Default: 0.6
`guidance_scale`	number	Optional	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. · Min: 0 · Max: 20 · Default: 4
`upscale_factor`	number	Optional	The upscale factor · Min: 1 · Max: 4 · Default: 2
`num_inference_steps`	integer	Optional	The number of inference steps to perform. · Min: 4 · Max: 50 · Default: 18

Output Schema

Field	Type	Description
`id`	string	Unique identifier for the generation task
`status`	string	Task status: pending, running, completed, failed, timeout
`model`	string	Model used for the generation
`outputs`	array	Array of output items
`outputs[].url`	string	URL of the generated artifact
`outputs[].content_type`	string	MIME type (e.g. image/png, video/mp4)
`error`	object \| null	Error details if failed, null on success
`error.type`	string	Machine-readable error type code
`error.message`	string	Human-readable error description

Async Workflow

This model uses asynchronous execution. Submit a request and poll for the result.

Submit — POST to /v1/run, receive an id
Poll — GET /v1/run/{id} until status is completed, failed, or timeout
Retrieve — Read outputs from the completed response

Code Examples

Ready-to-run snippets

# Step 1: Submit
curl -X POST https://api.sandbase.ai/v1/run \
  -H "Content-Type: application/json" \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -d '{
  "model": "clarity-ai/clarity-upscaler",
  "image": "https://static.sandbase.ai/examples/bytedance/seedvr/upscale/image/input_image_0.png",
  "prompt": "masterpiece, best quality, highres",
  "creativity": 0.35,
  "resemblance": 0.6,
  "guidance_scale": 4,
  "upscale_factor": 2,
  "num_inference_steps": 18
}'

# Step 2: Poll result (replace <id>)
curl https://api.sandbase.ai/v1/run/<id> \
  -H "Authorization: Bearer YOUR_API_KEY"

← Back to Clarity Upscaler