Topaz Upscale Image Creative

POST/v1/run

Upscale Image Creative by Topaz Labs - 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 topaz/upscale/image/creative.

Default: topaz/upscale/image/creative

stringimagerequired

Url of the image to be upscaled

Optional<string>output_format

Output format of the upscaled image.

Allowed values: jpeg, png

Default: jpeg

Optional<boolean>crop_to_fill

Request parameter supported by this model.

Default: false

Optional<number>upscale_factor

Factor to upscale the image by (e.g. 2.0 doubles width and height)

Range: 1 to 4

Default: 2

Optional<boolean>autoprompt

Enable automatic prompt generation. Applies to Bloom 2 only; Topaz defaults it to true when omitted.

Optional<boolean>color_preservation

Preserve the source image's colors in the output. Applies to Bloom 2 only.

Optional<integer>creativity

Creativity level (1-9). Higher values produce more creative/hallucinated details. Applies to Bloom 2 only.

Range: 1 to 9

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": "topaz/upscale/image/creative",
  "image": "https://static.sandbase.ai/examples/topaz/upscale/image/creative/input_image_0.jpeg",
  "output_format": "jpeg"
}'

# 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": "topaz/upscale/image/creative",
  "status": "running"
}