流式响应

流式响应事件

curl --request POST \
  --url https://api.powertokens.ai/byteplus/api/v3/images/generations

import requests

url = "https://api.powertokens.ai/byteplus/api/v3/images/generations"

response = requests.post(url)

print(response.text)

const options = {method: 'POST'};

fetch('https://api.powertokens.ai/byteplus/api/v3/images/generations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.powertokens.ai/byteplus/api/v3/images/generations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.powertokens.ai/byteplus/api/v3/images/generations"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.powertokens.ai/byteplus/api/v3/images/generations")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.powertokens.ai/byteplus/api/v3/images/generations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

"event: image_generation.partial_succeeded\ndata: {\"type\":\"image_generation.partial_succeeded\",\"model\":\"seedream-5-0-260128\",\"created\":1757396757,\"image_index\":0,\"url\":\"https://...\",\"size\":\"2496x1664\"}\n\nevent: image_generation.partial_succeeded\ndata: {\"type\":\"image_generation.partial_succeeded\",\"model\":\"seedream-5-0-260128\",\"created\":1757396785,\"image_index\":1,\"url\":\"https://...\",\"size\":\"2496x1664\"}\n\nevent: image_generation.partial_succeeded\ndata: {\"type\":\"image_generation.partial_succeeded\",\"model\":\"seedream-5-0-260128\",\"created\":1757396825,\"image_index\":2,\"url\":\"https://...\",\"size\":\"2496x1664\"}\n\nevent: image_generation.completed\ndata: {\"type\":\"image_generation.completed\",\"model\":\"seedream-5-0-260128\",\"created\":1757396825,\"usage\":{\"generated_images\":3,\"output_tokens\":48672,\"total_tokens\":48672}}\n\ndata: [DONE]\n"

POST

byteplus

api

images

generations

流式响应事件

curl --request POST \
  --url https://api.powertokens.ai/byteplus/api/v3/images/generations

import requests

url = "https://api.powertokens.ai/byteplus/api/v3/images/generations"

response = requests.post(url)

print(response.text)

const options = {method: 'POST'};

fetch('https://api.powertokens.ai/byteplus/api/v3/images/generations', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://api.powertokens.ai/byteplus/api/v3/images/generations",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"net/http"
	"io"
)

func main() {

	url := "https://api.powertokens.ai/byteplus/api/v3/images/generations"

	req, _ := http.NewRequest("POST", url, nil)

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("https://api.powertokens.ai/byteplus/api/v3/images/generations")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://api.powertokens.ai/byteplus/api/v3/images/generations")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)

response = http.request(request)
puts response.read_body

"event: image_generation.partial_succeeded\ndata: {\"type\":\"image_generation.partial_succeeded\",\"model\":\"seedream-5-0-260128\",\"created\":1757396757,\"image_index\":0,\"url\":\"https://...\",\"size\":\"2496x1664\"}\n\nevent: image_generation.partial_succeeded\ndata: {\"type\":\"image_generation.partial_succeeded\",\"model\":\"seedream-5-0-260128\",\"created\":1757396785,\"image_index\":1,\"url\":\"https://...\",\"size\":\"2496x1664\"}\n\nevent: image_generation.partial_succeeded\ndata: {\"type\":\"image_generation.partial_succeeded\",\"model\":\"seedream-5-0-260128\",\"created\":1757396825,\"image_index\":2,\"url\":\"https://...\",\"size\":\"2496x1664\"}\n\nevent: image_generation.completed\ndata: {\"type\":\"image_generation.completed\",\"model\":\"seedream-5-0-260128\",\"created\":1757396825,\"usage\":{\"generated_images\":3,\"output_tokens\":48672,\"total_tokens\":48672}}\n\ndata: [DONE]\n"

响应

200 - text/event-stream

SSE 流式响应。响应类型为 text/event-stream。

image_generation.partial_succeeded

当前仅 Seedream-5.0/4.5/4.0 支持流式响应。

在流式响应模式下，当任意图片生成成功时返回该事件。

type string

此处应为 image_generation.partial_succeeded。

model string

本次请求使用的模型 ID，格式为 <模型名称>-<版本>。

created integer

本次请求创建时间的 Unix 时间戳（秒）。

image_index integer

本次生图请求中，本次事件对应图片在请求中的序号。从 0 开始累加，不管生图是否成功，即在 image_generation.partial_succeeded、image_generation.partial_failed 事件，均会自动累加 1。

url string

本次事件对应图片的下载 URL。当请求中配置字段 response_format 为 url 时返回。

b64_json string

本次事件对应图片的 Base64 编码。当请求中配置字段 response_format 为 b64_json 时返回。

size string

图像的宽高像素值，格式 <宽像素>×<高像素>，如 2048×2048。

返回示例

{
  "type": "image_generation.partial_succeeded",
  "model": "doubao-seedream-5-0-260128",
  "created": 1589478378,
  "image_index": 0,
  "url": "https://...",
  "size": "2048×2048"
}

image_generation.partial_failed

当前仅 Seedream-5.0/4.5/4.0 支持流式响应。

在流式返回模式下，当任意图片生成失败时返回该事件。

若失败原因为审核不通过：仍会继续请求下一个图片生成任务，即不影响同请求内其他图片的生成流程。
若失败原因为内部服务异常（500）：不会继续请求下一个图片生成任务。

type string

此处应为 image_generation.partial_failed。

model string

本次请求使用的模型 ID，格式为 <模型名称>-<版本>。

created integer

本次请求创建时间的 Unix 时间戳（秒）。

image_index integer

本次生图请求中，本次事件对应图片在请求中的序号。从 0 开始累加，不管图片是否生成成功，即在 image_generation.partial_succeeded、image_generation.partial_failed 事件，均会自动累加 1。

error object

本次生图请求中，本次事件对应的错误原因。

error. code string

错误码。

error. message string

错误提示信息。

返回示例

{
  "type": "image_generation.partial_failed",
  "model": "doubao-seedream-5-0-260128",
  "created": 1589478378,
  "image_index": 2,
  "error": {
      "code":"OutputImageSensitiveContentDetected",
      "message":"The request failed because the output image may contain sensitive information."
  }
}

image_generation.completed

当前仅 Seedream-5.0/4.5/4.0 支持流式响应。

请求的所有图片（无论成功或失败）均处理完毕后返回，是该流式返回的最后一个响应事件。

type string

此处应为 image_generation.completed。

model string

本次请求使用的模型 ID，格式为 <模型名称>-<版本>。

created integer

本次请求创建时间的 Unix 时间戳（秒）。

tools array of object

本次请求配置的模型调用工具。

tools. type string

配置的调用工具类型。

web_search：联网搜索工具。

usage object

本次请求的用量信息。

usage. generated_images integer

模型成功生成的图片张数，不包含生成失败的图片。仅对成功生成图片按张数进行计费。

usage. output_tokens integer

模型生成的图片花费的 token 数量。计算逻辑为：计算 sum(图片长*图片宽)/256 ，然后取整。

usage. total_tokens integer

本次请求消耗的总 token 数量。当前不计算输入 token，故与 output_tokens 值一致。

usage. tool_usage object

使用工具的用量信息。

usage.tool_usage. web_search integer

调用联网搜索工具次数，仅开启联网搜索时返回。

返回示例

{
  "type": "image_generation.completed",
  "model": "doubao-seedream-5-0-260128",
  "created": 1589478378,
  "tools": [
         {
             "type": "web_search",
         }
     ],
  "usage": {
      "generated_images": 2,
      "output_tokens": xx,
      "total_tokens": xx,
      "tool_usage":{
        "web_search":1
    }
  }
}

error

本次请求如发生错误，对应的错误信息。

error object

本次请求错误返回的错误信息。

error. code string

错误码。

error. message string

错误提示信息。

返回示例

"error": {
  "code":"BadRequest",
  "message":"The request failed because it is missing one or multiple required parameters. Request ID: {id}"
}

图片创建

Kling 图像生成 kling-v2

聊天模型

图像模型

视频模型

音频模型

资产库

响应

image_generation.partial_succeeded

返回示例

image_generation.partial_failed

返回示例

image_generation.completed

返回示例

error

返回示例