Seedream レイヤー分解

01

概要

サポートされているモデルとともにdecompose layersエンドポイントを使用してください。返却されたTask IDを使用して状態を取得するか、以下に記載の配信のために callback_url を指定してください。

クイックスタート

APIキーを作成し、RUNAPI_API_KEYとして設定します。
サポートされているモデルを選択し、そのモデルのスキーマに一致するボディを持つPOSTリクエストを送信します。
返されたタスクIDを保存し、終了状態になるまでポーリングするか、以下に記載されているコールバックを処理してください。

POST /api/v1/seedream/decompose_layers

ベースURL: https://runapi.ai
API バージョン: v1
認証: Authorization: Bearer YOUR_API_TOKEN

02

サポートされているモデル

現在の料金、レート制限、商用利用の詳細については、モデルページを開いてください。

seedream-5-pro-layer-decomposition

03

リクエストスキーマ

JSONボディ

フィールドと許可される値は選択したモデルによって異なります。指定した場合、callback_urlは以下に記載されたTask配信を受信します。

seedream-5-pro-layer-decompositionフィールド6件

callback_urlstring

任意

image_urlstring

必須

公開PNG、JPEG、WebP、BMP、TIFF、またはGIF画像URLを1つだけ指定します。HEICとHEIFはサポートされていません。最大30 MB、262,144〜36,000,000総ピクセル、アスペクト比1:16〜16:1。

modelstring

任意

output_formatstring

任意

ベース画像フォーマット。分離レイヤーはPNGです。

許可される値: png, jpeg デフォルト: jpeg

promptstring

任意

分離する要素を説明するオプションの指示。

範囲(固定): 5000

sizestring

任意 許可される値: auto, 1K, 1.5K, 2K デフォルト: auto

04

承認を作成する

HTTP 202

POST /api/v1/seedream/decompose_layers

レスポンススキーマ

JSON

{
  "properties": {
    "billing": {
      "properties": {
        "refund": {
          "oneOf": [
            {
              "properties": {
                "refunded_at": {
                  "type": "string"
                }
              },
              "required": [
                "refunded_at"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "reservation": {
          "oneOf": [
            {
              "properties": {
                "amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "amount_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "settlement": {
          "oneOf": [
            {
              "properties": {
                "amount_micro_cents": {
                  "type": "integer"
                },
                "charged_amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "charged_amount_cents",
                "amount_micro_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        }
      },
      "required": [
        "reservation",
        "settlement",
        "refund"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "processing"
      ],
      "type": "string"
    },
    "task_replayed": {
      "type": "boolean"
    }
  },
  "required": [
    "id",
    "status",
    "billing"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

JSON

{
  "billing": {
    "refund": null,
    "reservation": null,
    "settlement": null
  },
  "id": "tsk_reference_demo",
  "status": "processing"
}

05

ポーリング処理中

HTTP 200

GET /api/v1/seedream/decompose_layers/:id

レスポンススキーマ

JSON

{
  "properties": {
    "billing": {
      "properties": {
        "refund": {
          "oneOf": [
            {
              "properties": {
                "refunded_at": {
                  "type": "string"
                }
              },
              "required": [
                "refunded_at"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "reservation": {
          "oneOf": [
            {
              "properties": {
                "amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "amount_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "settlement": {
          "oneOf": [
            {
              "properties": {
                "amount_micro_cents": {
                  "type": "integer"
                },
                "charged_amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "charged_amount_cents",
                "amount_micro_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        }
      },
      "required": [
        "reservation",
        "settlement",
        "refund"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "processing"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "status",
    "billing"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

JSON

{
  "billing": {
    "refund": null,
    "reservation": null,
    "settlement": null
  },
  "id": "tsk_reference_demo",
  "status": "processing"
}

06

ポーリング完了

HTTP 200

GET /api/v1/seedream/decompose_layers/:id

レスポンススキーマ

JSON

{
  "properties": {
    "base_image": {
      "properties": {
        "url": {
          "type": "string",
          "x-runapi-generated-media": true
        }
      },
      "required": [
        "url"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    "billing": {
      "properties": {
        "refund": {
          "oneOf": [
            {
              "properties": {
                "refunded_at": {
                  "type": "string"
                }
              },
              "required": [
                "refunded_at"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "reservation": {
          "oneOf": [
            {
              "properties": {
                "amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "amount_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "settlement": {
          "oneOf": [
            {
              "properties": {
                "amount_micro_cents": {
                  "type": "integer"
                },
                "charged_amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "charged_amount_cents",
                "amount_micro_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        }
      },
      "required": [
        "reservation",
        "settlement",
        "refund"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    "id": {
      "type": "string"
    },
    "layers": {
      "items": {
        "properties": {
          "bounding_box": {
            "properties": {
              "absolute": {
                "items": {
                  "type": "integer"
                },
                "type": "array"
              },
              "normalized": {
                "items": {
                  "type": "integer"
                },
                "type": "array"
              }
            },
            "type": "object"
          },
          "description": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "url": {
            "type": "string",
            "x-runapi-generated-media": true
          },
          "z_index": {
            "type": "integer"
          }
        },
        "required": [
          "url",
          "z_index"
        ],
        "type": "object",
        "unevaluatedProperties": false
      },
      "type": "array"
    },
    "status": {
      "enum": [
        "completed"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "status",
    "base_image",
    "layers",
    "billing"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

JSON

{
  "base_image": {
    "url": "https://cdn.runapi.ai/public/samples/image.jpg"
  },
  "billing": {
    "refund": null,
    "reservation": null,
    "settlement": null
  },
  "id": "tsk_reference_demo",
  "layers": [
    {
      "bounding_box": {
        "absolute": [
          120,
          80,
          920,
          300
        ],
        "normalized": [
          117,
          78,
          898,
          293
        ]
      },
      "name": "Title text",
      "url": "https://cdn.runapi.ai/public/samples/image.png",
      "z_index": 1
    }
  ],
  "status": "completed"
}

07

ポーリング失敗

HTTP 200

GET /api/v1/seedream/decompose_layers/:id

レスポンススキーマ

JSON

{
  "properties": {
    "billing": {
      "properties": {
        "refund": {
          "oneOf": [
            {
              "properties": {
                "refunded_at": {
                  "type": "string"
                }
              },
              "required": [
                "refunded_at"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "reservation": {
          "oneOf": [
            {
              "properties": {
                "amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "amount_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        },
        "settlement": {
          "oneOf": [
            {
              "properties": {
                "amount_micro_cents": {
                  "type": "integer"
                },
                "charged_amount_cents": {
                  "type": "integer"
                }
              },
              "required": [
                "charged_amount_cents",
                "amount_micro_cents"
              ],
              "type": "object",
              "unevaluatedProperties": false
            },
            {
              "enum": [
                null
              ]
            }
          ]
        }
      },
      "required": [
        "reservation",
        "settlement",
        "refund"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    "error": {
      "type": "string"
    },
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "failed"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "status",
    "error",
    "billing"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

JSON

{
  "billing": {
    "refund": null,
    "reservation": null,
    "settlement": null
  },
  "error": "Task processing failed.",
  "id": "tsk_reference_demo",
  "status": "failed"
}

08

顧客コールバック: 完了

HTTP 200

POST callback_url

レスポンススキーマ

JSON

{
  "properties": {
    "base_image": {
      "properties": {
        "url": {
          "type": "string",
          "x-runapi-generated-media": true
        }
      },
      "required": [
        "url"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    "id": {
      "type": "string"
    },
    "layers": {
      "items": {
        "properties": {
          "bounding_box": {
            "properties": {
              "absolute": {
                "items": {
                  "type": "integer"
                },
                "type": "array"
              },
              "normalized": {
                "items": {
                  "type": "integer"
                },
                "type": "array"
              }
            },
            "type": "object"
          },
          "description": {
            "type": "string"
          },
          "name": {
            "type": "string"
          },
          "url": {
            "type": "string",
            "x-runapi-generated-media": true
          },
          "z_index": {
            "type": "integer"
          }
        },
        "required": [
          "url",
          "z_index"
        ],
        "type": "object",
        "unevaluatedProperties": false
      },
      "type": "array"
    },
    "status": {
      "enum": [
        "completed"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "status",
    "base_image",
    "layers"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

JSON

{
  "base_image": {
    "url": "https://cdn.runapi.ai/public/samples/image.jpg"
  },
  "id": "tsk_reference_demo",
  "layers": [
    {
      "bounding_box": {
        "absolute": [
          120,
          80,
          920,
          300
        ],
        "normalized": [
          117,
          78,
          898,
          293
        ]
      },
      "name": "Title text",
      "url": "https://cdn.runapi.ai/public/samples/image.png",
      "z_index": 1
    }
  ],
  "status": "completed"
}

09

顧客コールバック: 失敗

HTTP 200

POST callback_url

レスポンススキーマ

JSON

{
  "properties": {
    "error": {
      "oneOf": [
        {
          "type": "string"
        },
        {
          "properties": {
            "code": {
              "type": "string"
            },
            "limit_cents": {
              "type": "integer"
            },
            "message": {
              "type": "string"
            },
            "reset_at": {
              "format": "date-time",
              "type": [
                "string",
                "null"
              ]
            },
            "used_cents": {
              "type": "integer"
            },
            "window": {
              "enum": [
                "1h",
                "1d",
                "7d",
                "daily",
                "weekly",
                "monthly",
                "lifetime"
              ],
              "type": "string"
            }
          },
          "required": [
            "code",
            "message"
          ],
          "type": "object",
          "unevaluatedProperties": false
        }
      ]
    },
    "id": {
      "type": "string"
    },
    "status": {
      "enum": [
        "failed"
      ],
      "type": "string"
    }
  },
  "required": [
    "id",
    "status",
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

JSON

{
  "error": {
    "code": "generation_failed",
    "message": "Task processing failed."
  },
  "id": "tsk_reference_demo",
  "status": "failed"
}

10

エラー

HTTP 401

POST /api/v1/seedream/decompose_layers

レスポンススキーマ

JSON

{
  "properties": {
    "error": {
      "description": "人が読めるエラーメッセージ。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

JSON

{
  "error": "Authentication required"
}

11

エラー

HTTP 401

GET /api/v1/seedream/decompose_layers/:id

レスポンススキーマ

JSON

{
  "properties": {
    "error": {
      "description": "人が読めるエラーメッセージ。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

JSON

{
  "error": "Authentication required"
}

12

エラー

HTTP 400

POST /api/v1/seedream/decompose_layers

レスポンススキーマ

JSON

{
  "oneOf": [
    {
      "properties": {
        "error": {
          "description": "人が読めるエラーメッセージ。",
          "type": "string"
        }
      },
      "required": [
        "error"
      ],
      "type": "object",
      "unevaluatedProperties": false
    },
    {
      "properties": {
        "error": {
          "description": "人間が読める形式のバリデーションサマリー。",
          "type": "string"
        },
        "errors": {
          "additionalProperties": {
            "items": {
              "type": "string"
            },
            "type": "array"
          },
          "description": "公開リクエストフィールドをキーとするバリデーションメッセージ。各フィールドに対して人間が読める文字列の配列が含まれます。",
          "type": "object"
        }
      },
      "required": [
        "error",
        "errors"
      ],
      "type": "object",
      "unevaluatedProperties": false
    }
  ]
}

レスポンス例

JSON

{
  "error": "model must be one of: seedream-5-pro-layer-decomposition"
}

13

エラー

HTTP 402

POST /api/v1/seedream/decompose_layers

レスポンススキーマ

JSON

{
  "properties": {
    "error": {
      "description": "人が読めるエラーメッセージ。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

JSON

{
  "error": "Insufficient balance"
}

14

エラー

HTTP 429

POST /api/v1/seedream/decompose_layers

レスポンススキーマ

JSON

{
  "properties": {
    "error": {
      "description": "人が読めるエラーメッセージ。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

JSON

{
  "error": "API key credit limit exceeded"
}

15

エラー

HTTP 409

POST /api/v1/seedream/decompose_layers

レスポンススキーマ

JSON

{
  "properties": {
    "error": {
      "description": "人が読めるエラーメッセージ。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

JSON

{
  "error": "The request uses features that are not supported for the selected model"
}

16

エラー

HTTP 429

POST /api/v1/seedream/decompose_layers

レスポンススキーマ

JSON

{
  "properties": {
    "error": {
      "description": "人が読めるエラーメッセージ。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

JSON

{
  "error": "Rate limit reached. Please retry later."
}

17

エラー

HTTP 503

POST /api/v1/seedream/decompose_layers

レスポンススキーマ

JSON

{
  "properties": {
    "error": {
      "description": "人が読めるエラーメッセージ。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

JSON

{
  "error": "Service under maintenance, please try again later"
}

18

エラー

HTTP 504

POST /api/v1/seedream/decompose_layers

レスポンススキーマ

JSON

{
  "properties": {
    "error": {
      "description": "人が読めるエラーメッセージ。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

JSON

{
  "error": "The request timed out"
}

19

エラー

HTTP 404

GET /api/v1/seedream/decompose_layers/:id

レスポンススキーマ

JSON

{
  "properties": {
    "error": {
      "description": "人が読めるエラーメッセージ。",
      "type": "string"
    }
  },
  "required": [
    "error"
  ],
  "type": "object",
  "unevaluatedProperties": false
}

レスポンス例

JSON

{
  "error": "Task with id 'tsk_reference_demo' not found"
}

20

生成されたコードサンプル

cURLを直接使用するか、お使いの言語向けのSDKをインストールしてください。各サンプルは、このリファレンスに示されたバリデーション済みリクエストを送信します。

インストール

Shell

pip install runapi-seedream

PYTHON

import os
from runapi.seedream import SeedreamClient

client = SeedreamClient(api_key=os.environ["RUNAPI_API_KEY"])
task = client.decompose_layers.create(
  model="seedream-5-pro-layer-decomposition",
  image_url="https://cdn.runapi.ai/public/samples/image.jpg",
  size="1K",
  output_format="jpeg"
)

インストール

Shell

npm install @runapi.ai/seedream

JAVASCRIPT

import { SeedreamClient } from "@runapi.ai/seedream";

const client = new SeedreamClient({ apiKey: process.env.RUNAPI_API_KEY });
const task = await client.decomposeLayers.create({
  "model": "seedream-5-pro-layer-decomposition",
  "image_url": "https://cdn.runapi.ai/public/samples/image.jpg",
  "size": "1K",
  "output_format": "jpeg"
});

CURL

curl -X POST https://runapi.ai/api/v1/seedream/decompose_layers \
  -H 'Authorization: Bearer YOUR_API_TOKEN' \
  -H 'Content-Type: application/json' \
  -d '{"model":"seedream-5-pro-layer-decomposition","image_url":"https://cdn.runapi.ai/public/samples/image.jpg","size":"1K","output_format":"jpeg"}'

インストール

Shell

go get github.com/runapi-ai/seedream-sdk/go@latest

GO

package main

import (
  "context"
  "log"
  "os"

  "github.com/runapi-ai/core-sdk/go/option"
  seedream "github.com/runapi-ai/seedream-sdk/go/seedream"
)

func main() {
  client, err := seedream.NewClient(option.WithAPIKey(os.Getenv("RUNAPI_API_KEY")))
  if err != nil {
    log.Fatal(err)
  }

  task, err := client.DecomposeLayers.Create(context.Background(), seedream.DecomposeLayersParams{
    Model: seedream.SeedreamModel("seedream-5-pro-layer-decomposition"),
    ImageURL: "https://cdn.runapi.ai/public/samples/image.jpg",
    Size: seedream.LayerDecompositionSize("1K"),
    OutputFormat: seedream.OutputFormat("jpeg"),
  })
  if err != nil {
    log.Fatal(err)
  }
  _ = task
}

21

Seedream レイヤー分解

概要

クイックスタート

エンドポイント

サポートされているモデル

リクエストスキーマ

承認を作成する

レスポンス例

ポーリング処理中

レスポンス例

ポーリング完了

レスポンス例

ポーリング失敗

レスポンス例

顧客コールバック: 完了

レスポンス例

顧客コールバック: 失敗

レスポンス例

エラー

レスポンス例

エラー

レスポンス例

エラー

レスポンス例

エラー

レスポンス例

エラー

レスポンス例

エラー

レスポンス例

エラー

レスポンス例

エラー

レスポンス例

エラー

レスポンス例

エラー

レスポンス例

生成されたコードサンプル

インストール

関連ガイド