Start building
SandBase

Appearance

SeedVR2

POST/v1/run

Seedvr Upscale Image is ByteDance's intelligent image editing model. Transform, retouch, and reimagine existing images using text prompts - from background replacement to artistic style conversion.

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 bytedance/seedvr/upscale/image/seamless.

Default: bytedance/seedvr/upscale/image/seamless

stringimagerequired

The input image to be processed

Optional<string>output_format

The format of the output image.

Allowed values: png, jpeg

Default: png

Optional<number>noise_scale

The noise scale to use for the generation process.

Range: 0 to 1

Default: 0.1

Optional<string>target_resolution

The target resolution to upscale to when `upscale_mode` is `target`.

Allowed values: 720p, 1080p, 1440p, 2160p

Default: 1080p

Optional<string>upscale_mode

The mode to use for the upscale. If 'target', the upscale factor will be calculated based on the target resolution. If 'factor', the upscale factor will be used directly.

Allowed values: target, factor

Default: factor

Optional<number>upscale_factor

Upscaling factor to be used. Will multiply the dimensions with this factor when `upscale_mode` is `factor`.

Range: 1 to 10

Default: 2

Optional<integer>seed

The random seed used for the generation process.

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