API reference · sandbase-ai

sandbase-ai/hy-wu-edit

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 IDsandbase-ai/hy-wu-edit

Input Schema

7 parameters · 1 required · 6 optional

Parameter	Type	Required	Description
`prompt`	string	Required	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'.
`seed`	integer	Optional	Random seed for reproducible results. If None, a random seed is used.
`images`	string[]	Optional	URLs of input images for editing. Typically 2 images: the base image and the reference image. Supports up to 3 images.
`aspect_ratio`	string	Optional	The aspect ratio of the generated image. · Options: 21:9, 16:9, 3:2, 4:3, 5:4, 1:1, 4:5, 3:4, 2:3, 9:16 21:916:93:24:35:41:14:53:42:39:16
`output_format`	string	Optional	The format of the generated image. · Options: jpeg, png · Default: "png" jpegpng
`enable_thinking`	boolean	Optional	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
`num_inference_steps`	integer	Optional	Number of diffusion denoising steps. · Min: 1 · Max: 100 · Default: 30

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

const apiKey = process.env.SANDBASE_API_KEY;
const response = await fetch("https://api.sandbase.ai/v1/run", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${apiKey}`,
    "Content-Type": "application/json",
  },
  body: JSON.stringify({
    "model": "sandbase-ai/hy-wu-edit",
    "images": [
      "https://static.sandbase.ai/examples/openai/gpt-image-1/edit/input_images_0.png",
      "https://static.sandbase.ai/examples/openai/gpt-image-1/edit/input_images_0.png"
    ],
    "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",
    "enable_thinking": true,
    "num_inference_steps": 30
  }),
});

if (!response.ok) throw new Error(await response.text());
let result = await response.json();
for (let attempt = 0; attempt < 120 && !["completed", "failed", "timeout"].includes(result.status); attempt++) {
  await new Promise((resolve) => setTimeout(resolve, 2_000));
  const poll = await fetch(`https://api.sandbase.ai/v1/run/${result.id}`, {
    headers: { Authorization: `Bearer ${apiKey}` },
  });
  if (!poll.ok) throw new Error(await poll.text());
  result = await poll.json();
}
if (result.status !== "completed") throw new Error(`Generation ended: ${result.status}`);
console.log(result);

← Back to Hy Wu Edit