Seedream 5.0 Lite
テキストと最大 6 枚の参照画像から、2K または 4K で画像を生成・編集します。
- 非同期です。作成の呼び出しはすぐにタスク ID を返し、画像はタスクが成功した時点で得られます。
- 1 タスクにつき画像は 1 枚です。複数枚が必要な場合は、複数のタスクを作成してください。
- テキストから画像を生成するか、公開 HTTPS リンクで渡した最大 6 枚の参照画像を編集・合成します。
- 料金は 2K でも 4K でも同じ 1 枚あたりの価格に、
imagesの参照画像 1 枚ごとの少額の料金が加わります。1K はありません。 - 失敗したタスクには課金されません。仮確保された金額は全額戻されます。
このモデルをテスト画面で開きます。BeatAPI の API キーを入力するとタスクを作成できます。実際に呼び出され、ご自身の残高から課金されます。
エンドポイントと認証
POST https://api.beatapi.io/v1/images/tasks
Authorization
string
必須
BeatAPI の API キーを Bearer <BEATAPI_API_KEY> の形式で送信します。キーはダッシュボードで作成できます。キーはサーバー側で保管し、ブラウザーやモバイルアプリに含めないでください。
ボディは JSON で送信し、Content-Type: application/json を指定します。Idempotency-Key は任意です。論理的に 1 件のリクエストごとに一意の値(255 文字以内)を送り、まったく同じボディを再試行するときだけ再利用してください。24 時間以内に同じキーと同じボディで再試行すると、最初のレスポンスが Idempotent-Replayed: true 付きで再度返されます。同じキーで異なるボディを送ると 409 idempotency_conflict が返ります。2xx 以外のレスポンスは保存されないため、400 や 402 の後の再試行は改めて実行されます。
リクエストの流れ
タスクを作成する
下記のパラメーターをエンドポイントに POST します。201 が返れば、タスクが受け付けられ、料金が残高から仮確保されたことを意味します。処理はバックグラウンドで実行されます。data.id を保存してください。
完了を待つ
GET /v1/tasks/{task_id} を呼び出し、status が succeeded または failed になるまで、呼び出しの間隔を data.poll_after_seconds(画像は 5 秒、動画は 8 秒)だけ空けてください。あるいは task.succeeded と task.failed のWebhookを登録することもできます。処理タイムアウトで停止したタスクはイベントを送信しないため、フォールバックとしてポーリングも続けてください。
入力モード
リクエストパラメーター
model
string
必須
実行するモデルです。
値:seedream-5-lite
値が正しくない場合
- 指定がない:
"model" is required - 不明なモデル ID の場合:
"model" seedream-9 is not catalogued - 動画モデルをこのエンドポイントに送った場合:
"model" seedance-2.5 is served by POST /v1/videos/tasks, not this endpoint
prompt
string
必須
描きたい内容、または参照画像に加えたい変更です。被写体、スタイル、照明、構図、画像内に表示したい文字などを、普通の言葉で書くのが最適です。
長さ:1–5000 文字
- 長さは文字数で数えます(CJK の文字も 1 文字です)。
imagesを送る場合は、どの画像が何の役割かを書いてください。たとえば「1 枚目の画像を商品に、2 枚目の画像を背景に使う」のように指定します。
値が正しくない場合
- 指定がない:
"prompt" is required - 空、または上限を超えている:
"prompt" has an unsupported length - 文字列でない場合:
"prompt" must be a string
images
string[]
任意
編集または合成する参照画像です。このフィールドを送ると、リクエストはテキストからの画像生成ではなく、画像編集として扱われます。
要素数:1–6
各要素は公開されている https:// の URL です。ローカルファイルは先に アップロード(POST /v1/files)し、返された data.url を渡してください。
- 各要素は、画像ファイルへの公開
https://リンクにしてください。タスクの作成時、BeatAPI はリンクの形式だけを確認します。その時点では画像をダウンロードせず、形式やサイズも確認しません(制限の下の注記を参照)。 - Web ページ、ログインが必要なページ、期限切れの署名付き URL、ホットリンク対策のあるホストへのリンクは画像を返さず、タスクの作成後に失敗します。
- エラーメッセージ中の位置は 0 始まりです。
images[0]は 1 番目のリンクを指します。 - リンク 1 つごとに、タスクに少額の料金が加わります(料金の表を参照)。
値が正しくない場合
- 上限を超えている:
"images" accepts at most 6 items - 空の配列の場合:
"images" requires at least 1 item - https:// のリンクではない:
"images[0]" must be a public HTTPS URL - 配列ではない:
"images" must be an array
例
aspect_ratio
string
任意デフォルト: 1:1
画像の形状を 幅:高さ で指定します。
指定できる値:auto, 1:1, 4:3, 3:4, 16:9, 9:16, 3:2, 2:3
デフォルト:1:1
autoは、形状を固定せずモデルに任せます。- 省略すると
1:1が使われます。imagesを送った場合も同じです。 - このモデルには
21:9はありません。
値が正しくない場合
- 一覧にない値:
"aspect_ratio" must be one of: [auto 1:1 4:3 3:4 16:9 9:16 3:2 2:3]
resolution
string
任意デフォルト: 2K
画像のサイズ区分です。2K と 4K は同じ料金です。
指定できる値:2K, 4K
デフォルト:2K
- このモデルには 2K と 4K しかありません。1K は拒否されます。
16:9の場合、2K では 2736×1520、4K では 3840×2160 の画像が返ります。- K は大文字にしてください。
2kは拒否されます。2048x2048のようなピクセルサイズも受け付けません。
値が正しくない場合
- 一覧にない値(たとえば
1K):"resolution" must be one of: [2K 4K]
入力メディアの上限
ゲートウェイはタスク作成前にすべての入力を読み取り、次の上限を超えるものは、その入力を示す 400 bad_request で拒否します。課金はされません。
- 参照画像:公開されている HTTPS リンクを 1~6 個。
- タスクの作成時、BeatAPI はこれらのリンクをダウンロードせず、形式、サイズ、ピクセル寸法も確認しません。そのため、不正なリンクは事前には拒否されません。各リンクはモデルが自分で取得します。
- モデルが取得または読み取れないリンクは、タスクの作成後に失敗します。通常は
bad_requestで、タスクは返金されます。ログインなしでサーバーからのアクセスに応答するホスト上の、通常の画像ファイルへの直接リンクを使ってください。 - ローカルのファイルがある場合は、
POST /v1/filesでアップロードし、返されたdata.urlを渡してください。
このモデルが受け付けないフィールド
画像エンドポイントには、ほかの画像モデルが使うフィールドがいくつかあります。ここでそれらを送ると、無視されるのではなく拒否されるため、効果のない設定に料金を払うことはありません。
output_format、quality、seed、background、size、enhance_prompt→field "output_format" is not supported by model seedream-5-lite(送ったフィールド名が入ります)。- それ以外の未知のフィールド(たとえば
n)→unknown field: n。nはありません。1 つのタスクで作れる画像は 1 枚です。
リクエストに不正なフィールドが複数ある場合、メッセージにはそのうち 1 つだけが示されます。修正してから再送してください。
リクエスト例
テキストから画像
プロンプトから、2K の画像を生成します。
1 枚の画像を編集
商品写真をキャンペーン画像として再構成します。
複数の画像を合成
プロンプトでは、各参照画像を位置で指定します。
4K のポスター
2K と同じ料金の 4K ポスターです。
レスポンス
タスクの作成(201)
タスクオブジェクトです。タスクが成功するまで output は null です。「実行中」と記載されたフィールドは、タスクの完了後に表示されなくなります。
完了したタスク
GET /v1/tasks/{task_id} は HTTP 200 と status: "succeeded" を返し、結果は data.output に入ります。
出力フィールド
失敗したタスク
失敗したタスクも、GET /v1/tasks/{task_id} では HTTP 200 になります。失敗はボディに示されます。仮確保された金額は全額戻されるため、課金されません。
完全なコード例
タスクを作成し、サーバーが示すポーリング間隔で完了を待ち、結果の URL を出力します。環境変数に BEATAPI_API_KEY を設定し、requests をインストールしてください。
課金
- 1 つのタスクで画像 1 枚が生成され、料金は 2K と 4K で同じです(下の表を参照)。
imagesのリンク 1 つごとに少額の料金が加わります。 - 料金は、タスク作成時にあなたの残高から(キーにクォータがある場合はそこからも)仮確保されます。タスクが作られる前に拒否されたリクエストには課金されません。
- 成功したタスクは確保された金額のままです。失敗したタスクは全額が返金されます。このとき
credits_refundedはcredits_reservedと等しく、credits_chargedとcredits_settledは 0 です。
現在の定価です。料金ページと同じ金額です。割引を個別に契約しているアカウントでは、より低い金額になります。実際に課金された金額は、タスクの data.usage で確認できます。
よくあるエラー
HTTP エラー早見表
タスクが作られる前のエラーは、2xx 以外のレスポンスで返されます。課金はされません。error.code または error.retryable で処理を分岐してください。message には問題の内容が示されます。全一覧と再試行のルールはエラーにあります。
認証
API キーを Authorization: Bearer <BEATAPI_API_KEY> として送信してください。
ヘッダー
ボディは JSON で送信し、Content-Type: application/json を指定します。Idempotency-Key は任意です。論理的に 1 件のリクエストごとに一意の値(255 文字以内)を送り、まったく同じボディを再試行するときだけ再利用してください。24 時間以内に同じキーと同じボディで再試行すると、最初のレスポンスが Idempotent-Replayed: true 付きで再度返されます。同じキーで異なるボディを送ると 409 idempotency_conflict が返ります。2xx 以外のレスポンスは保存されないため、400 や 402 の後の再試行は改めて実行されます。
リクエスト
実行するモデルです。
値:seedream-5-lite
値が正しくない場合
- 指定がない:
"model" is required - 不明なモデル ID の場合:
"model" seedream-9 is not catalogued - 動画モデルをこのエンドポイントに送った場合:
"model" seedance-2.5 is served by POST /v1/videos/tasks, not this endpoint
描きたい内容、または参照画像に加えたい変更です。被写体、スタイル、照明、構図、画像内に表示したい文字などを、普通の言葉で書くのが最適です。
長さ:1–5000 文字
- 長さは文字数で数えます(CJK の文字も 1 文字です)。
imagesを送る場合は、どの画像が何の役割かを書いてください。たとえば「1 枚目の画像を商品に、2 枚目の画像を背景に使う」のように指定します。
値が正しくない場合
- 指定がない:
"prompt" is required - 空、または上限を超えている:
"prompt" has an unsupported length - 文字列でない場合:
"prompt" must be a string
画像の形状を 幅:高さ で指定します。
指定できる値:auto, 1:1, 4:3, 3:4, 16:9, 9:16, 3:2, 2:3
デフォルト:1:1
autoは、形状を固定せずモデルに任せます。- 省略すると
1:1が使われます。imagesを送った場合も同じです。 - このモデルには
21:9はありません。
値が正しくない場合
- 一覧にない値:
"aspect_ratio" must be one of: [auto 1:1 4:3 3:4 16:9 9:16 3:2 2:3]
編集または合成する参照画像です。このフィールドを送ると、リクエストはテキストからの画像生成ではなく、画像編集として扱われます。
要素数:1–6
各要素は公開されている https:// の URL です。ローカルファイルは先に アップロード(POST /v1/files)し、返された data.url を渡してください。
- 各要素は、画像ファイルへの公開
https://リンクにしてください。タスクの作成時、BeatAPI はリンクの形式だけを確認します。その時点では画像をダウンロードせず、形式やサイズも確認しません(制限の下の注記を参照)。 - Web ページ、ログインが必要なページ、期限切れの署名付き URL、ホットリンク対策のあるホストへのリンクは画像を返さず、タスクの作成後に失敗します。
- エラーメッセージ中の位置は 0 始まりです。
images[0]は 1 番目のリンクを指します。 - リンク 1 つごとに、タスクに少額の料金が加わります(料金の表を参照)。
値が正しくない場合
- 上限を超えている:
"images" accepts at most 6 items - 空の配列の場合:
"images" requires at least 1 item - https:// のリンクではない:
"images[0]" must be a public HTTPS URL - 配列ではない:
"images" must be an array
例
"images": [
"https://cdn.beatapi.io/samples/smart-bottle.png",
"https://cdn.beatapi.io/samples/neon-singer.png"
]
画像のサイズ区分です。2K と 4K は同じ料金です。
指定できる値:2K, 4K
デフォルト:2K
- このモデルには 2K と 4K しかありません。1K は拒否されます。
16:9の場合、2K では 2736×1520、4K では 3840×2160 の画像が返ります。- K は大文字にしてください。
2kは拒否されます。2048x2048のようなピクセルサイズも受け付けません。
値が正しくない場合
- 一覧にない値(たとえば
1K):"resolution" must be one of: [2K 4K]
レスポンス
タスクオブジェクトです。タスクが成功するまで output は null です。「実行中」と記載されたフィールドは、タスクの完了後に表示されなくなります。

