Hy Wu Edit

POST/v1/run

Hy Wu Edit by sandbase-ai - 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 sandbase-ai/hy-wu-edit.

Default: sandbase-ai/hy-wu-edit

stringpromptrequired

The text prompt describing the desired edit. Supports both English and Chinese. Use specific instructions like 'Replace the clothing on figure 1 with the outfit from figure 2'.

Optional<array<string>>images

URLs of input images for editing. Typically 2 images: the base image and the reference image. Supports up to 3 images.

Optional<integer>num_inference_steps

Number of diffusion denoising steps.

Range: 1 to 100

Default: 30

Optional<string>output_format

The format of the generated image.

Allowed values: jpeg, png

Default: png

Optional<boolean>enable_thinking

Enable thinking mode. The model reasons about the edit before generating, producing higher quality results at the cost of longer inference time. Disable for faster results on straightforward edits.

Default: true

Optional<string>aspect_ratio

The aspect ratio of the generated image.

Allowed values: 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16

Optional<integer>seed

Random seed for reproducible results. If None, a random seed is used.

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": "sandbase-ai/hy-wu-edit",
  "prompt": "Using image 1 as the base image, replace the outfit with the clothing from image 2 while keeping the subject, pose, and background unchanged.",
  "output_format": "png",
  "aspect_ratio": "21:9"
}'

# 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": "sandbase-ai/hy-wu-edit",
  "status": "running"
}