跳到导航
BeatAPIGPT Image 2Image API

GPT Image 2

根据文本和最多 16 张参考图生成或编辑图片，支持 1K、2K、4K 或精确像素尺寸。

  • 异步：创建调用会立即返回任务 ID；任务成功后才能拿到图片。
  • 每个任务生成一张图片。需要多张图片时，请创建多个任务。
  • 文生图，或编辑、合成最多 16 张以公网 HTTPS 链接给出的参考图。
  • 用 resolution 和 aspect_ratio 选择画幅，或用一个精确的 size，例如 1536x1024。两者不能同时使用。
  • 按尺寸档位（1K、2K 或 4K）对每张图片计价；失败的任务不收费。
POST/v1/images/tasks试一试

在调试窗口里打开本模型，填入你的 BeatAPI API 密钥即可创建任务。调用是真实的，费用从你自己的余额中扣除。

模型 ID

这三个模型使用同一个接口和同一组字段。下方的取值直接来自网关契约。

模型 IDresolutionimages 上限background简介
gpt-image-21K, 2K, 4K16auto, opaque, transparentGPT Image 2 模型。
gpt-image-2.5-flare1K, 2K, 4K16auto, opaque, transparentGPT Image 2.5 系列模型。字段和限制与 GPT Image 2 相同；价格见价格表。
gpt-image-2.5-sunburst1K, 2K, 4K16auto, opaque, transparentGPT Image 2.5 系列模型。字段和限制与另外两个相同；价格见价格表。

接口与鉴权

POST https://api.beatapi.io/v1/images/tasks

Authorization string 必需

你的 BeatAPI API 密钥，以 Bearer <BEATAPI_API_KEY> 形式发送。在控制台创建密钥。密钥只能保存在你的服务端，不要放进浏览器或移动端应用。

请求体使用 JSON，并设置 Content-Type: application/json。Idempotency-Key 为可选：每个逻辑请求发送一个唯一值（最长 255 个字符），仅在重试完全相同的请求体时复用。24 小时内，用相同的键和请求体重试会再次返回第一次的响应，并带上 Idempotent-Replayed: true；相同的键搭配不同的请求体则返回 409 idempotency_conflict。非 2xx 的响应不会被保存，因此 400 或 402 之后的重试会重新执行。

请求流程

1

创建任务

向接口 POST 下方的参数。返回 201 表示任务已被接受，其价格已从你的余额中预留；任务在后台运行。保存 data.id。

2

等待任务完成

调用 GET /v1/tasks/{task_id}，两次调用之间等待 data.poll_after_seconds 秒（图片 5 秒，视频 8 秒），直到 status 为 succeeded 或 failed。也可以为 task.succeeded 和 task.failed 注册 Webhook；仍需保留轮询作为兜底，因为因处理超时而终止的任务不会发送事件。

3

保存结果

状态为 succeeded 时，下载每个 data.output.media[].url 并保存你需要的文件；BeatAPI 不承诺结果链接的保留时长。状态为 failed 时，读取 data.error_code 和 data.error_message：预扣的金额已退回你的余额，data.retryable 表示再次发送相同请求是否可能成功。

输入模式

模式必填输入说明
文生图model, prompt不要传 images。
编辑或合成图片model, prompt, images1 到 16 个公网 HTTPS 图片链接。在 prompt 中描述要修改、保留或合成的内容。

请求参数

model string 必需

要运行的模型。

取值：gpt-image-2

取值有误时

  • 缺失："model" is required
  • 未知的模型 ID："model" gpt-image-9 is not catalogued
  • 把视频模型发到了这个接口："model" seedance-2.5 is served by POST /v1/videos/tasks, not this endpoint

prompt string 必需

要画什么，或要修改参考图中的什么。用平实的语言效果最好：主体、风格、光线、构图，以及必须出现在图片中的文字。

长度：1–5000 个字符

  • 长度按字符计算（一个中日韩文字算一个字符）。
  • 传了 images 时，请说明每张图的作用，例如 “Use the first image for the product and the second for the background”。

取值有误时

  • 缺失："prompt" is required
  • 为空或超过长度上限："prompt" has an unsupported length
  • 不是字符串："prompt" must be a string

images string[] 可选

要编辑或合成的参考图。传入该字段会把请求从文生图切换为图片编辑。

数量：1–16
每一项都必须是公网 https:// 链接。本地文件请先上传（POST /v1/files），再传入返回的 data.url。

  • 每个链接必须通过公网 HTTPS 直接返回图片文件本身（PNG、JPEG 或 WebP），且不超过 50 MB。网关在创建任务之前会下载每个链接开头的若干字节，并根据这些字节识别类型，而不是根据文件名或 Content-Type。
  • 指向网页、登录页、已过期的签名链接或有防盗链的主机的链接会被拒绝，因为它们返回的不是图片。
  • 错误信息中的位置从 0 开始：images[0] 是第一个链接。

取值有误时

  • 超过数量上限："images" accepts at most 16 items
  • 空数组："images" requires at least 1 item
  • 不是 https:// 链接："images[0]" must be a public HTTPS URL
  • 私有或不安全的地址："images[0]" must be a publicly reachable HTTPS image URL
  • 主机返回 4xx 错误："images[0]" could not be downloaded: the URL returned HTTP 404
  • 链接返回的不是 PNG、JPEG 或 WebP："images[0]" is not a PNG, JPEG or WebP image: the URL returned text/html
  • 大于 50 MB："images[2]" is 63.4 MB; images must be 50 MB or smaller

示例

"images": [
  "https://media.beatapi.io/samples/smart-bottle.png",
  "https://media.beatapi.io/samples/neon-singer.png"
]

aspect_ratio string 可选默认值: auto

图片的形状，以 宽:高 表示。与 resolution 一起传，或两者都不传而改传 size。

可选值：auto, 1:1, 3:2, 2:3, 4:3, 3:4, 5:4, 4:5, 16:9, 9:16, 2:1, 1:2, 3:1, 1:3, 21:9, 9:21
默认值：auto

  • 默认值是 auto，所以省略该字段的请求同样会生成正方形。
  • 支持 2:1、1:2、3:1、1:3、21:9 和 9:21 等全景比例。最宽或最高的画幅是 3:1。
  • 不能与 size 同时使用。

auto 不是“沿用参考图的形状”。无论是否传了 images，它都会在所选 resolution 下生成正方形画幅。要把编辑结果改成其他形状，请指定比例，或传 size。

取值有误时

  • 取值不在列表中："aspect_ratio" must be one of: [auto 1:1 3:2 2:3 4:3 3:4 5:4 4:5 16:9 9:16 2:1 1:2 3:1 1:3 21:9 9:21]
  • 与 size 一起传："size" already fixes the output; do not send "aspect_ratio" with it

resolution string 可选默认值: 1K

图片的尺寸档位。档位越高，图片越大、价格越高；具体像素尺寸取决于 aspect_ratio，由模型决定。

可选值：1K, 2K, 4K
默认值：1K

  • K 必须大写：2k 会被拒绝。
  • 本页不承诺某个档位对应的精确像素尺寸。如果需要精确画幅，请传 size。
  • 不能与 size 同时使用；size 自带尺寸，并按其像素总数计价。

取值有误时

  • 取值不在列表中："resolution" must be one of: [1K 2K 4K]
  • 与 size 一起传："size" already fixes the output; do not send "resolution" with it

size string 可选

以像素表示的精确输出画幅，格式为 WIDTHxHEIGHT，例如 1536x1024。它会取代 resolution 和 aspect_ratio。

  • 两条边都必须是 16 的倍数，且在 16 到 3840 px 之间。
  • 像素总数必须在 655,360 到 8,294,400 之间，长边最多是短边的三倍。
  • 分隔符可以是 x、X 或 ×；两侧的空格会被忽略。
  • 价格档位按像素总数确定：不超过 2,097,152 像素为 1K，不超过 5,898,240 为 2K，超过则为 4K。示例见下方的表格“size 如何计费”。
  • 不要同时传 resolution 或 aspect_ratio，即使是默认值也不行。

size 按所传的值校验和计费，但本页不保证交付的图片恰好是这些像素。如果你的流程依赖精确尺寸，请读取已保存的文件。

取值有误时

  • 不是字符串："size" must be a string
  • 不是 WIDTHxHEIGHT 形式（单独一个数字、auto、逗号）："size" must be WIDTHxHEIGHT in pixels, for example 1536x1024
  • 某条边不是 16 的倍数："size" width and height must be multiples of 16
  • 某条边小于 16 或大于 3840："size" edges must be between 16 and 3840 pixels
  • 像素太少或太多："size" must have between 655,360 and 8,294,400 pixels; 512x512 has 262,144
  • 宽或高超过 3:1："size" must not be wider or taller than 3:1
  • 与 resolution 一起传："size" already fixes the output; do not send "resolution" with it
  • 与 aspect_ratio 一起传："size" already fixes the output; do not send "aspect_ratio" with it

示例

"size": "1536x1024"

background string 可选默认值: auto

图片是有填充背景，还是透明背景。

可选值：auto, opaque, transparent
默认值：auto

  • auto（默认值）由模型自行选择。opaque 要求填充背景。
  • transparent 要求背景无颜色的图片。结果是带 alpha 通道的 PNG；请查看 output.media[].mime_type。
  • 该字段不改变价格。

取值有误时

  • 取值不在列表中："background" must be one of: [auto opaque transparent]

网关还会在创建任务之前检查以下组合：

  • size 写为 宽x高，替代 resolution 和 aspect_ratio：两边均为 16 的倍数，各为 16–3840 像素；总像素为 655,360–8,294,400；最长边与最短边之比不超过 3:1。
  • 自定义尺寸按总像素计费：不超过 2,097,152 像素按 1K，不超过 5,898,240 像素按 2K，再高按 4K。

输入素材限制

网关会在创建任务之前读取每一项输入，超出这些限制的输入会被拒绝，并返回点名该输入的 400 bad_request。不扣费。

  • 参考图：PNG、JPEG 或 WebP，按文件内容识别；每张不超过 50 MB（十进制 MB；仅在主机声明大小时检查）；1 到 16 个链接。GIF、HEIC 和 SVG 会被拒绝。
  • 不检查参考图本身的像素或宽高比限制。
  • 如果主机未在时限内响应，创建任务时不会拒绝该链接。网关会在任务派发时再次获取；若仍无法获取，任务失败并退款。
  • 有本地文件？先用 POST /v1/files 上传，再传入返回的 data.url。

选择画幅：resolution 和 aspect_ratio，或 size

指定图片大小和宽高有两种方式，二者互斥：

  • 档位加比例。 传 resolution（1K、2K 或 4K），需要指定形状时再传 aspect_ratio。两者都不传，则得到 1K 和 auto，即正方形画幅。
  • 精确尺寸。 只传 size，例如 1536x1024。按其像素总数计费（见下表）。

把 size 与 resolution 或 aspect_ratio 一起传会被拒绝，错误为 "size" already fixes the output; do not send "resolution" with it（或 "aspect_ratio"）。即使另一个字段取的是默认值，也会触发该检查。

该模型不接受的字段

图片接口认识一些其他图片模型或其他 API 使用的字段。在这里传入其中任何一个都会被拒绝，而不是被忽略，这样你不会为一个没有效果的设置付费：

  • quality、seed、output_format、enhance_prompt → field "quality" is not supported by model gpt-image-2（其中是你所传的字段和你调用的模型）。这些模型不能选择结果格式：请读取输出中的 mime_type。
  • 其他任何未知字段，例如 n 或 moderation → unknown field: n。没有 n 这个字段：一个任务只生成一张图片。

size 如何计费

size 按其像素总数所在的档位计价。下面的示例严格遵循该规则：不超过 2,097,152 像素为 1K，不超过 5,898,240 为 2K，超过则为 4K。

size像素数计费档位
1024x10241,048,5761K
1536x10241,572,8641K
2048x11522,359,2962K
2560x14403,686,4002K
2048x20484,194,3042K
2880x28808,294,4004K
3840x21608,294,4004K

请求示例

curl --request POST \
  --url https://api.beatapi.io/v1/images/tasks \
  --header "Authorization: Bearer $BEATAPI_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "model": "gpt-image-2",
  "prompt": "A minimalist product photo of a glass water bottle on wet black stone, soft rim light, shallow depth of field",
  "aspect_ratio": "3:2",
  "resolution": "2K"
}'

文生图

根据提示词生成一张 2K 横版图片，指定了档位和比例。

curl --request POST \
  --url https://api.beatapi.io/v1/images/tasks \
  --header "Authorization: Bearer $BEATAPI_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "model": "gpt-image-2",
  "prompt": "A minimalist product photo of a glass water bottle on wet black stone, soft rim light, shallow depth of field",
  "aspect_ratio": "3:2",
  "resolution": "2K"
}'

编辑一张图片

更换背景并保留商品。这里明确指定了形状，因为 auto 会生成正方形。

curl --request POST \
  --url https://api.beatapi.io/v1/images/tasks \
  --header "Authorization: Bearer $BEATAPI_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "model": "gpt-image-2",
  "prompt": "Keep the bottle exactly as it is. Replace the background with a sunlit kitchen counter and add a soft reflection under the bottle.",
  "images": [
    "https://media.beatapi.io/samples/smart-bottle.png"
  ],
  "aspect_ratio": "1:1",
  "resolution": "1K"
}'

合成多张图片

在提示词中按位置指明每张参考图。

curl --request POST \
  --url https://api.beatapi.io/v1/images/tasks \
  --header "Authorization: Bearer $BEATAPI_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "model": "gpt-image-2",
  "prompt": "Place the bottle from the first image on a neon-lit stage like the one in the second image. Keep the bottle label readable.",
  "images": [
    "https://media.beatapi.io/samples/smart-bottle.png",
    "https://media.beatapi.io/samples/neon-singer.png"
  ],
  "aspect_ratio": "16:9",
  "resolution": "2K"
}'

精确尺寸

1536x1024 的画幅。size 单独使用：不传 resolution，也不传 aspect_ratio。按 1K 计费。

curl --request POST \
  --url https://api.beatapi.io/v1/images/tasks \
  --header "Authorization: Bearer $BEATAPI_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "model": "gpt-image-2",
  "prompt": "A flat illustration of a lighthouse on a cliff at dawn, pastel colours, clean shapes",
  "size": "1536x1024"
}'

透明背景

没有背景的贴纸风格主体。结果是带 alpha 通道的 PNG。

curl --request POST \
  --url https://api.beatapi.io/v1/images/tasks \
  --header "Authorization: Bearer $BEATAPI_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "model": "gpt-image-2",
  "prompt": "A single cartoon red fox sitting, sticker style, thick white outline, isolated on a transparent background",
  "aspect_ratio": "1:1",
  "resolution": "1K",
  "background": "transparent"
}'

响应

创建任务（201）

任务对象。任务成功之前 output 为 null。标注“运行中”的字段会在任务结束后消失。

{
  "data": {
    "id": "task_7Qm2Xc9LpR4vT8sKa1Nf6YbH3eWdJ0uZ",
    "object": "task",
    "task_kind": "image",
    "capability_id": "gpt-image-2",
    "capability_version": 1,
    "media_type": "image",
    "model": "gpt-image-2",
    "status": "queued",
    "stage": "queued",
    "created_at": 1791993600,
    "updated_at": 1791993600,
    "completed_at": null,
    "poll_after_seconds": 5,
    "output": null,
    "usage": {
      "credits_reserved": 0.03,
      "credits_settled": 0,
      "credits_refunded": 0,
      "credits_charged": 0.03
    },
    "request_id": "req_5f0c2a9e4b7d4e31",
    "error_code": null,
    "error_message": null
  }
}
字段类型说明
data.idstring任务 ID：task_ 后接 32 位字母和数字。用于轮询以及匹配 Webhook 事件。
data.objectstring固定为 task。
data.task_kindstringimage 或 video。
data.capability_idstring你发送的模型 ID。
data.capability_versioninteger模型的契约版本，当前为 1。
data.media_typestringimage 或 video。
data.modelstring你发送的模型 ID（与 capability_id 相同）。
data.statusstringqueued、processing、succeeded 或 failed。只有后两个是终态。
data.stagestring与 status 相同；为旧版客户端保留。
data.created_atinteger任务创建时间，Unix 秒。
data.updated_atinteger最后一次变更时间，Unix 秒。
data.completed_atinteger | null任务结束时间，Unix 秒；运行中为 null。
data.poll_after_secondsinteger运行中：下一次轮询前需要等待的秒数（图片 5，视频 8）。
data.typical_secondsobject运行中且近期样本足够时出现：在最近的 window 内，根据 samples 个任务统计的完成时间 p50 和 p90，单位为秒。
data.outputobject | null任务结果；status 为 succeeded 之前为 null。见下方输出字段。
data.usage.credits_reservednumber创建任务时从你的余额中预扣的美元金额。
data.usage.credits_chargednumber该任务的费用（美元）；失败的任务为 0。
data.usage.credits_settlednumber最终结算扣除的美元金额；任务成功时设置，否则为 0。
data.usage.credits_refundednumber退回你余额的美元金额；失败的任务在退款记录完成后等于预扣金额。
data.usage.billable_duration_secondsinteger仅视频：计价所依据的秒数。模型未上报时长时不出现。
data.request_idstring请求 ID。联系支持时请附上。
data.error_codestring | null失败码；任务未失败时为 null。
data.error_messagestring | null出了什么问题以及该改什么；任务未失败时为 null。

任务完成

GET /v1/tasks/{task_id} 返回 HTTP 200 和 status: "succeeded"，结果在 data.output 中。

{
  "data": {
    "id": "task_7Qm2Xc9LpR4vT8sKa1Nf6YbH3eWdJ0uZ",
    "object": "task",
    "task_kind": "image",
    "capability_id": "gpt-image-2",
    "capability_version": 1,
    "media_type": "image",
    "model": "gpt-image-2",
    "status": "succeeded",
    "stage": "succeeded",
    "created_at": 1791993600,
    "updated_at": 1791993690,
    "completed_at": 1791993690,
    "output": {
      "media": [
        {
          "type": "image",
          "url": "https://media.beatapi.io/outputs/task_7Qm2Xc9LpR4vT8sKa1Nf6YbH3eWdJ0uZ/0.png",
          "mime_type": "image/png"
        }
      ],
      "r2_url": "https://media.beatapi.io/outputs/task_7Qm2Xc9LpR4vT8sKa1Nf6YbH3eWdJ0uZ/0.png"
    },
    "usage": {
      "credits_reserved": 0.03,
      "credits_settled": 0.03,
      "credits_refunded": 0,
      "credits_charged": 0.03
    },
    "request_id": "req_5f0c2a9e4b7d4e31",
    "error_code": null,
    "error_message": null
  }
}

输出字段

字段类型说明
output.mediaobject[]生成的文件；该模型只有一项。
output.media[].typestring固定为 image。
output.media[].urlstring已保存图片的 HTTPS 链接。请下载并自行保存；不承诺保留期限。
output.media[].mime_typestring已保存文件的类型，例如 image/png。这些模型没有 output_format 字段，因此 BeatAPI 不会转换文件：请读取该值，不要自行假定类型。
output.r2_urlstring第一个 media 链接的重复，供旧版客户端使用。请读取 media。

任务失败

失败的任务在 GET /v1/tasks/{task_id} 上仍然是 HTTP 200：失败信息在响应体里。预扣金额会全额退回，因此不会扣费。

{
  "data": {
    "id": "task_7Qm2Xc9LpR4vT8sKa1Nf6YbH3eWdJ0uZ",
    "object": "task",
    "task_kind": "image",
    "capability_id": "gpt-image-2",
    "capability_version": 1,
    "media_type": "image",
    "model": "gpt-image-2",
    "status": "failed",
    "stage": "failed",
    "created_at": 1791993600,
    "updated_at": 1791993690,
    "completed_at": 1791993690,
    "output": null,
    "usage": {
      "credits_reserved": 0.03,
      "credits_settled": 0,
      "credits_refunded": 0.03,
      "credits_charged": 0
    },
    "retryable": true,
    "request_id": "req_5f0c2a9e4b7d4e31",
    "error_code": "processing_failed",
    "error_message": "The task failed during processing on our side. Retry; a failed task is refunded."
  }
}
字段类型说明
data.error_codestringbad_request 和 content_policy_violation（需修改请求）之一，或 processing_unavailable、processing_timeout、processing_failed 和 result_transfer_failed（稍后重试）之一。见错误码。
data.error_messagestring一句话，指出问题和处理方式。
data.retryableboolean仅在任务失败时出现：为 true 表示再次发送相同请求可能成功。
data.usageobject退款记录完成后（通常就在任务失败的那一刻）：credits_charged 和 credits_settled 为 0；credits_refunded 等于 credits_reserved。

完整示例

创建任务，按服务端给出的轮询提示等待，然后打印结果链接。请在环境变量中设置 BEATAPI_API_KEY 并安装 requests。

import os
import time
import uuid
import requests
API = "https://api.beatapi.io"
HEADERS = {"Authorization": f"Bearer {os.environ['BEATAPI_API_KEY']}"}
def create_task(body: dict) -> dict:
    # One Idempotency-Key per logical request: a retry with the same key cannot create a second task.
    headers = {**HEADERS, "Idempotency-Key": str(uuid.uuid4())}
    for attempt in range(3):
        response = requests.post(f"{API}/v1/images/tasks", headers=headers, json=body, timeout=60)
        if response.status_code in (429, 503) and attempt < 2:
            time.sleep(int(response.headers.get("Retry-After", 10)))
            continue
        break
    try:
        payload = response.json()
    except ValueError:  # an edge error page is not JSON
        response.raise_for_status()
        raise
    if not response.ok:
        error = payload["error"]
        raise RuntimeError(f"{response.status_code} {error['code']}: {error['message']} (request_id={error.get('request_id')})")
    return payload["data"]
def wait_for_task(task_id: str, timeout_seconds: int = 1800) -> dict:
    deadline = time.monotonic() + timeout_seconds
    while time.monotonic() < deadline:
        response = requests.get(f"{API}/v1/tasks/{task_id}", headers=HEADERS, timeout=30)
        if response.status_code == 429 or response.status_code >= 500:
            time.sleep(int(response.headers.get("Retry-After", 10)))
            continue
        response.raise_for_status()
        task = response.json()["data"]
        if task["status"] in ("succeeded", "failed"):
            return task
        time.sleep(task.get("poll_after_seconds", 5))
    raise TimeoutError(f"task {task_id} is still running; keep polling later")
task = create_task({
  "model": "gpt-image-2",
  "prompt": "A minimalist product photo of a glass water bottle on wet black stone, soft rim light, shallow depth of field",
  "aspect_ratio": "3:2",
  "resolution": "2K"
})
print("created", task["id"])
task = wait_for_task(task["id"])
if task["status"] == "failed":
    raise SystemExit(f"{task['error_code']}: {task['error_message']}")
for item in task["output"]["media"]:
    print(item["url"])

计费

  • 每个任务一张图片，按尺寸档位计价：你传的 resolution，或你的 size 所在的档位（见上表）。background 不改变价格。
  • 价格在创建任务时预扣，从你的余额中扣除；若密钥设有额度，也从密钥额度中扣除。在任务生成之前被拒绝的请求不收费。
  • 成功的任务保留预扣金额。失败的任务全额退回。

当前牌价，与价格页一致。享有协商折扣的账户实付更低；任务的 data.usage 始终显示实际扣费金额。

选项牌价（美元）
1 张图片 · 1K$0.02
1 张图片 · 2K$0.03
1 张图片 · 4K$0.04

常见错误

错误或现象原因处理方式
400 "size" already fixes the output; do not send "resolution" with itsize 与 resolution 或 aspect_ratio 一起传了，即使取的是默认值。只传 size，或只传 resolution 和 aspect_ratio 而不传 size。
400 "size" width and height must be multiples of 16尺寸如 1000x1000 或 1920x1080（1080 不是 16 的倍数）。把两条边取整为 16 的倍数，例如 1920x1088。
400 "size" must have between 655,360 and 8,294,400 pixels; 512x512 has 262,144画幅太小或太大。4096x4096 会更早因 3840 px 的边长限制而失败。边长不超过 3840 px，像素总数保持在 655,360 到 8,294,400 之间。
400 "resolution" must be one of: [1K 2K 4K]使用了小写的 2k、8K，或在 resolution 中填了 2048x2048 这样的像素尺寸。发送 1K、2K 或 4K，需要像素尺寸时改用 size 字段。
400 field "quality" is not supported by model gpt-image-2传了 OpenAI API 的字段（quality、output_format）或其他图片模型的字段（seed、enhance_prompt）。删除该字段。
400 unknown field: n想在一个任务里生成多张图片。删除 n，每张图片创建一个任务。
400 "images[0]" must be a public HTTPS URL使用了 http:// 链接、data: URI 或本地路径。把文件放到 HTTPS 地址上，或用 POST /v1/files 上传并使用 data.url。
400 "images[1]" is not a PNG, JPEG or WebP image: the URL returned text/html链接打开的是网页、登录页或已过期的签名链接，而不是文件。直接链接到图片文件。
400 "images[0]" could not be downloaded: the URL returned HTTP 403主机拒绝服务器下载（防盗链或私有存储桶）。把文件设为公开，或用 POST /v1/files 上传。
编辑后的图片是正方形aspect_ratio 被省略或设为 auto，这会生成正方形画幅。指定你想要的比例，或传 size。
任务 failed，错误码 content_policy_violation提示词、参考图或生成的图片被内容审核拒绝。修改提示词或图片。原样重试仍会失败；不收费。
任务 failed，错误码 processing_timeout图片未在处理时限内完成。重试；失败的任务已退款。

HTTP 错误速查

任务生成之前的错误会以非 2xx 响应返回，不扣费。请根据 error.code 或 error.retryable 判断处理方式；message 会指出问题所在。完整列表和重试策略见错误码。

{
  "error": {
    "code": "bad_request",
    "message": "\"prompt\" is required",
    "retryable": false,
    "request_id": "req_5f0c2a9e4b7d4e31"
  }
}
HTTP 状态码error.code处理方式
400bad_request, content_policy_violation修改请求；message 会点名出错的字段。不要原样重试。
401missing_api_key, invalid_api_key（旧版客户端可能看到 unauthorized）以 Authorization: Bearer <key> 发送有效的密钥。
402insufficient_credits充值，或提高密钥的额度，然后重新发送。
403forbidden该密钥或账户不能使用此模型（例如免费额度只覆盖部分模型）。不要原样重试。
404not_found在 GET /v1/tasks/{task_id} 上：该任务在此密钥所属账户下不存在。请检查 ID。
409idempotency_conflict换一个新的 Idempotency-Key，或等待使用该键的第一个请求完成。
429rate_limit_exceeded等待 Retry-After 秒（也见 error.retry_after_seconds）后重试。
500internal_error退避重试；若持续出现，请带上 request_id 联系支持。
503processing_unavailable, processing_timeout, processing_failed, result_transfer_failed未扣费。使用指数退避重试。

身份验证

AuthorizationBearer

Send your API key as Authorization: Bearer <BEATAPI_API_KEY>.

请求头

Idempotency-Keystring可选<=255 characters

请求体使用 JSON，并设置 Content-Type: application/json。Idempotency-Key 为可选：每个逻辑请求发送一个唯一值（最长 255 个字符），仅在重试完全相同的请求体时复用。24 小时内，用相同的键和请求体重试会再次返回第一次的响应，并带上 Idempotent-Replayed: true；相同的键搭配不同的请求体则返回 409 idempotency_conflict。非 2xx 的响应不会被保存，因此 400 或 402 之后的重试会重新执行。

请求

This endpoint expects an object.
modelenum必需

要运行的模型。

取值：gpt-image-2

取值有误时

  • 缺失："model" is required
  • 未知的模型 ID："model" gpt-image-9 is not catalogued
  • 把视频模型发到了这个接口："model" seedance-2.5 is served by POST /v1/videos/tasks, not this endpoint
允许的值:
promptstring必需1-5000 characters

要画什么，或要修改参考图中的什么。用平实的语言效果最好：主体、风格、光线、构图，以及必须出现在图片中的文字。

长度：1–5000 个字符

  • 长度按字符计算（一个中日韩文字算一个字符）。
  • 传了 images 时，请说明每张图的作用，例如 “Use the first image for the product and the second for the background”。

取值有误时

  • 缺失："prompt" is required
  • 为空或超过长度上限："prompt" has an unsupported length
  • 不是字符串："prompt" must be a string
aspect_ratioenum可选默认为 auto

图片的形状，以 宽:高 表示。与 resolution 一起传，或两者都不传而改传 size。

可选值：auto, 1:1, 3:2, 2:3, 4:3, 3:4, 5:4, 4:5, 16:9, 9:16, 2:1, 1:2, 3:1, 1:3, 21:9, 9:21

默认值：auto

  • 默认值是 auto，所以省略该字段的请求同样会生成正方形。
  • 支持 2:1、1:2、3:1、1:3、21:9 和 9:21 等全景比例。最宽或最高的画幅是 3:1。
  • 不能与 size 同时使用。

说明：auto 不是“沿用参考图的形状”。无论是否传了 images，它都会在所选 resolution 下生成正方形画幅。要把编辑结果改成其他形状，请指定比例，或传 size。

取值有误时

  • 取值不在列表中："aspect_ratio" must be one of: [auto 1:1 3:2 2:3 4:3 3:4 5:4 4:5 16:9 9:16 2:1 1:2 3:1 1:3 21:9 9:21]
  • 与 size 一起传："size" already fixes the output; do not send "aspect_ratio" with it
backgroundenum可选默认为 auto

图片是有填充背景，还是透明背景。

可选值：auto, opaque, transparent

默认值：auto

  • auto（默认值）由模型自行选择。opaque 要求填充背景。
  • transparent 要求背景无颜色的图片。结果是带 alpha 通道的 PNG；请查看 output.media[].mime_type。
  • 该字段不改变价格。

取值有误时

  • 取值不在列表中："background" must be one of: [auto opaque transparent]
允许的值:
imageslist of strings可选

要编辑或合成的参考图。传入该字段会把请求从文生图切换为图片编辑。

数量：1–16

每一项都必须是公网 https:// 链接。本地文件请先上传（POST /v1/files），再传入返回的 data.url。

  • 每个链接必须通过公网 HTTPS 直接返回图片文件本身（PNG、JPEG 或 WebP），且不超过 50 MB。网关在创建任务之前会下载每个链接开头的若干字节，并根据这些字节识别类型，而不是根据文件名或 Content-Type。
  • 指向网页、登录页、已过期的签名链接或有防盗链的主机的链接会被拒绝，因为它们返回的不是图片。
  • 错误信息中的位置从 0 开始：images[0] 是第一个链接。

取值有误时

  • 超过数量上限："images" accepts at most 16 items
  • 空数组："images" requires at least 1 item
  • 不是 https:// 链接："images[0]" must be a public HTTPS URL
  • 私有或不安全的地址："images[0]" must be a publicly reachable HTTPS image URL
  • 主机返回 4xx 错误："images[0]" could not be downloaded: the URL returned HTTP 404
  • 链接返回的不是 PNG、JPEG 或 WebP："images[0]" is not a PNG, JPEG or WebP image: the URL returned text/html
  • 大于 50 MB："images[2]" is 63.4 MB; images must be 50 MB or smaller

示例

"images": [
  "https://media.beatapi.io/samples/smart-bottle.png",
  "https://media.beatapi.io/samples/neon-singer.png"
]
resolutionenum可选默认为 1K

图片的尺寸档位。档位越高，图片越大、价格越高；具体像素尺寸取决于 aspect_ratio，由模型决定。

可选值：1K, 2K, 4K

默认值：1K

  • K 必须大写：2k 会被拒绝。
  • 本页不承诺某个档位对应的精确像素尺寸。如果需要精确画幅，请传 size。
  • 不能与 size 同时使用；size 自带尺寸，并按其像素总数计价。

取值有误时

  • 取值不在列表中："resolution" must be one of: [1K 2K 4K]
  • 与 size 一起传："size" already fixes the output; do not send "resolution" with it
允许的值:
sizestring可选格式: "image-size"

以像素表示的精确输出画幅，格式为 WIDTHxHEIGHT，例如 1536x1024。它会取代 resolution 和 aspect_ratio。

  • 两条边都必须是 16 的倍数，且在 16 到 3840 px 之间。
  • 像素总数必须在 655,360 到 8,294,400 之间，长边最多是短边的三倍。
  • 分隔符可以是 x、X 或 ×；两侧的空格会被忽略。
  • 价格档位按像素总数确定：不超过 2,097,152 像素为 1K，不超过 5,898,240 为 2K，超过则为 4K。示例见下方的表格“size 如何计费”。
  • 不要同时传 resolution 或 aspect_ratio，即使是默认值也不行。

说明：size 按所传的值校验和计费，但本页不保证交付的图片恰好是这些像素。如果你的流程依赖精确尺寸，请读取已保存的文件。

取值有误时

  • 不是字符串："size" must be a string
  • 不是 WIDTHxHEIGHT 形式（单独一个数字、auto、逗号）："size" must be WIDTHxHEIGHT in pixels, for example 1536x1024
  • 某条边不是 16 的倍数："size" width and height must be multiples of 16
  • 某条边小于 16 或大于 3840："size" edges must be between 16 and 3840 pixels
  • 像素太少或太多："size" must have between 655,360 and 8,294,400 pixels; 512x512 has 262,144
  • 宽或高超过 3:1："size" must not be wider or taller than 3:1
  • 与 resolution 一起传："size" already fixes the output; do not send "resolution" with it
  • 与 aspect_ratio 一起传："size" already fixes the output; do not send "aspect_ratio" with it

示例

"size": "1536x1024"

响应

任务对象。任务成功之前 output 为 null。标注“运行中”的字段会在任务结束后消失。

错误

400
Bad Request Error
401
Unauthorized Error
402
Payment Required Error
403
Forbidden Error
409
Conflict Error
429
Too Many Requests Error
500
Internal Server Error
503
Service Unavailable Error