API reference · Bytedance

bytedance/seedream/5.0/pro/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 IDbytedance/seedream/5.0/pro/edit
01

Input Schema

6 parameters · 2 required · 4 optional

ParameterTypeRequiredDescription
imagesstring[]RequiredList of URLs of input reference images. Up to 10 images are supported; if more are sent, only the last 10 are used.
promptstringRequiredThe text prompt used to edit the image.
image_sizestringOptionalA named image-size preset. Leave unset when using the legacy aspect_ratio field. · Options: square_hd, square, portrait_4_3, portrait_16_9, landscape_4_3, landscape_16_9, auto_1K, auto_2K
square_hdsquareportrait_4_3portrait_16_9landscape_4_3landscape_16_9auto_1Kauto_2K
num_imagesintegerOptionalThe number of edited images to generate. · Min: 1 · Max: 6 · Default: 1
aspect_ratiostringOptionalThe 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_formatstringOptionalThe file format of the generated image. · Options: jpeg, png · Default: "jpeg"
jpegpng
02

Output Schema

FieldTypeDescription
idstringUnique identifier for the generation task
statusstringTask status: pending, running, completed, failed, timeout
modelstringModel used for the generation
outputsarrayArray of output items
outputs[].urlstringURL of the generated artifact
outputs[].content_typestringMIME type (e.g. image/png, video/mp4)
errorobject | nullError details if failed, null on success
error.typestringMachine-readable error type code
error.messagestringHuman-readable error description

Async Workflow

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

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

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": "bytedance/seedream/5.0/pro/edit",
    "images": [
      "https://static.sandbase.ai/examples/bytedance/seedream/5.0/pro/edit/input_images_0.png",
      "https://static.sandbase.ai/examples/bytedance/seedream/5.0/pro/edit/input_images_1.png",
      "https://static.sandbase.ai/examples/bytedance/seedream/5.0/pro/edit/input_images_2.png"
    ],
    "prompt": "Replace the product in Figure 1 with that in Figure 2. Seamlessly render the logo in Figure 3 into the product design, in a frosted glass texture.",
    "num_images": 1,
    "output_format": "jpeg"
  }),
});

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);