> ## Documentation Index
> Fetch the complete documentation index at: https://dripart-stale2000-router-model-pages.mintlify.site/llms.txt
> Use this file to discover all available pages before exploring further.

# Use Seedream 5.0 260128 with Comfy Router

> Call byteplus/seedream-5-0-260128 through Comfy Router: endpoint, request shape and the response Router returns.

Use `byteplus/seedream-5-0-260128` with the Comfy Router API. BytePlus provides the model; Router gives it the shared authentication and request route below.

## Quick start

Create a key at [platform.comfy.org/profile/api-keys](https://platform.comfy.org/profile/api-keys) and export it as `COMFY_API_KEY`. The Python and TypeScript snippets use the Comfy SDKs (`pip install comfy-sdk`, `npm install @comfyorg/sdk`); the cURL snippet is the same call over raw HTTP.

**Model ID:** `byteplus/seedream-5-0-260128`

**Endpoint:** `POST https://api.comfy.org/v2/models/byteplus/seedream-5-0-260128`

<CodeGroup>
  ```python Python theme={null}
  import uuid
  from comfy_sdk import Comfy

  # Reads COMFY_API_KEY from the environment. Save this key and reuse it if you
  # retry this request after the SDK returns an error.
  idempotency_key = str(uuid.uuid4())
  with Comfy() as client:
      result = client.models.run(
          "byteplus/seedream-5-0-260128",
          {
              # Request fields are the provider's own — see Input below.
          },
          idempotency_key=idempotency_key,
      )

  print(result)
  ```

  ```typescript TypeScript theme={null}
  import { comfy } from "@comfyorg/sdk";

  // Reads COMFY_API_KEY from the environment. Save this key and reuse it if you
  // retry this request after the SDK returns an error.
  const idempotencyKey = crypto.randomUUID();
  const { data } = await comfy.models.run("byteplus/seedream-5-0-260128", {
    // Request fields are the provider's own — see Input below.
  }, { idempotencyKey });

  console.log(data);
  ```

  ```bash cURL theme={null}
  # Request fields are the provider's own — see Input below.
  # Run this line once. Reuse ROUTER_REQUEST_KEY if you retry the curl command.
  ROUTER_REQUEST_KEY=$(uuidgen)
  curl https://api.comfy.org/v2/models/byteplus/seedream-5-0-260128 \
    -H "X-API-Key: $COMFY_API_KEY" \
    -H "Idempotency-Key: $ROUTER_REQUEST_KEY" \
    -H "Content-Type: application/json" \
    -d '{}'
  ```
</CodeGroup>

## Schema

### Input

<Note>
  Router has not published an authored input schema for this model yet: `GET /v2/models/byteplus/seedream-5-0-260128/openapi.json` returns an open object with `x-comfy-input-schema-authored: false`. Router forwards the body to BytePlus unchanged, so [BytePlus's own API reference](https://docs.byteplus.com/) is authoritative for the request fields, and nothing is validated server side.
</Note>

### Output

<ResponseField name="created" type="integer">
  Unix timestamp (in seconds) indicating the time when the request was created
</ResponseField>

<ResponseField name="data" type="object[]">
  Contains information about the generated image(s).
  In the layer-separation scenario, the first element of the array is the base image (z\_index=0), and the following elements are the layers, ordered by increasing z\_index.
</ResponseField>

<ResponseField name="data[].b64_json" type="string">
  Base64-encoded image data (if response\_format is "b64\_json")
</ResponseField>

<ResponseField name="data[].bounding_box" type="object">
  The bounding-box information of the region that the current layer occupies within the base image. Only layers return this field; the base image covers the whole canvas and does not return bounding\_box. Returned only when layer\_decomposition is true.
</ResponseField>

<ResponseField name="data[].bounding_box.absolute" type="integer[]">
  The absolute pixel coordinates of the layer's bounding box, in the output base image's coordinate system with the top-left corner at (0, 0). Coordinate format: \[left, top, right, bottom].
</ResponseField>

<ResponseField name="data[].bounding_box.normalized" type="integer[]">
  The per-mille quantized (normalized) coordinates of the layer's bounding box, proportionally mapped to a discrete integer range of \[0, 1000] based on the base image size, truncated at a maximum of 1000. Coordinate format: \[left, top, right, bottom].
</ResponseField>

<ResponseField name="data[].description" type="string">
  A detailed description of the current separated element, providing richer layer characteristics (such as color, state, material) than name. Only layers return this field; the base image does not. Returned only when layer\_decomposition is true.
</ResponseField>

<ResponseField name="data[].name" type="string">
  The name/label of the current separated element, automatically generated by the model from the characteristics of the separated subject. Only layers return this field; the base image does not. Returned only when layer\_decomposition is true.
</ResponseField>

<ResponseField name="data[].output_format" type="string">
  The file format of the output image. Only seedream-5.0-pro supports this field.
</ResponseField>

<ResponseField name="data[].size" type="string">
  The width and height of the image in pixels, in the format \<width>x\<height>. Only seedream-5.0-pro, 5.0-lite, 4.5 and 4.0 support this parameter.
</ResponseField>

<ResponseField name="data[].url" type="string (uri)">
  URL for image download (if response\_format is "url")

  Format: `uri`
</ResponseField>

<ResponseField name="data[].z_index" type="integer">
  The stacking order of the layer, increasing from bottom to top: 0 is the bottom-most layer (the base image); larger values sit higher. Use it to recompose the layers into the complete image at the correct stacking order. Returned only when layer\_decomposition is true.
</ResponseField>

<ResponseField name="error" type="object">
  Error information (if any)
</ResponseField>

<ResponseField name="error.code" type="string">
  Error code
</ResponseField>

<ResponseField name="error.message" type="string">
  Error message
</ResponseField>

<ResponseField name="model" type="string">
  The model ID used for the request
</ResponseField>

<ResponseField name="usage" type="object" />

<ResponseField name="usage.generated_images" type="integer">
  Number of images generated by the model
</ResponseField>

<ResponseField name="usage.input_images" type="integer">
  The number of images input to the model. Only seedream-5.0-pro supports this field.
</ResponseField>

<ResponseField name="usage.output_tokens" type="integer">
  The number of tokens used for the picture generated by the model.
</ResponseField>

<ResponseField name="usage.total_tokens" type="integer">
  The total number of tokens consumed by this request.
</ResponseField>

## Examples

### Output

```json theme={null}
{
  "created": 1767225600,
  "data": [
    {
      "size": "1024x1024",
      "url": "https://example.invalid/byteplus/seedream-3-0-t2i-250415/generated.png"
    }
  ],
  "model": "seedream-3-0-t2i-250415",
  "usage": {
    "generated_images": 1
  }
}
```

## Before you ship

Save one `Idempotency-Key` for each call and reuse it for retries. Router can hold the connection for up to 10 minutes. The SDKs handle authentication; raw HTTP clients send the headers themselves.

Use `X-Comfy-Error-Type` to classify a failure. A `422` means Router rejected the input before calling the provider. Download generated assets promptly because [result URLs can expire](/development/comfy-router/reference#result-assets).

<CardGroup cols={3}>
  <Card title="Headers" icon="list" href="/development/comfy-router/headers">
    Authentication, idempotency, request IDs, error buckets, retry pacing, spend limits.
  </Card>

  <Card title="Using the Router API" icon="code" href="/development/comfy-router/models">
    Find models, inspect schemas, and retry safely.
  </Card>

  <Card title="Limitations" icon="triangle-exclamation" href="/development/comfy-router/limitations">
    What Router does not do today, and what to use instead.
  </Card>
</CardGroup>
