跳到导航
BeatAPIGrok Imagine Image 2 0Image API

Grok Imagine Image 2.0

通过文本和最多 5 张参考图片生成或编辑一张图片，每张图片统一定价。

  • 异步：创建调用会立即返回任务 ID；任务成功后才能拿到图片。
  • 每个任务生成一张图片。需要多张图片时，请创建多个任务。
  • 文生图，或编辑、合成最多 5 张以公开 HTTPS 链接提供的参考图片。
  • 请求只有四个字段：model、prompt、images 和 aspect_ratio。没有分辨率、质量、seed 或输出格式可设置。
  • 失败的任务不收费：预扣金额会全额退回。
POST/v1/images/tasks试一试

在调试窗口里打开本模型，填入你的 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 为可选：每个逻辑请求发送一个唯一值（最长 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 到 5 个公开的 HTTPS 图片链接。请在 prompt 中说明要修改、保留或合成的内容。

请求参数

model string 必需

要运行的模型。

取值：grok-imagine-image-2.0

取值有误时

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

prompt string 必需

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

长度：1–5000 个字符

  • 长度按字符计算（一个中日韩字符算一个）。
  • 传入 images 时，请说明每张图片的作用，例如 “Keep the product from the first image and change the setting”。

取值有误时

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

images string[] 可选

要编辑或合成的参考图片。传入该字段会把请求从文生图切换为图片编辑；没有单独的模式开关。

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

  • 每一项都必须是指向图片文件的公开 https:// 链接。创建任务时，BeatAPI 只检查链接的格式；此时不会下载图片，也不检查其格式或大小（见限制下方的说明）。
  • 指向网页、登录页、已过期的签名 URL 或有防盗链的主机的链接不会返回图片，任务创建之后会失败。
  • 错误信息中的位置从 0 开始：images[0] 是第一个链接。

取值有误时

  • 超过上限："images" accepts at most 5 items
  • 空数组："images" requires at least 1 item
  • 不是 https:// 链接："images[0]" must be a public HTTPS URL
  • 不是数组："images" must be an array

示例

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

aspect_ratio string 可选默认值: 1:1

期望的图片宽高比，格式为 宽:高。

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

  • auto 表示由模型自行决定比例，而不是固定一种。仅在传了 images 时才被接受。
  • 不传则使用 1:1，传了 images 时同样如此。

取值有误时

  • 值不在列表中："aspect_ratio" must be one of: [auto 1:1 2:3 3:2 16:9 9:16]
  • 没有 images 时使用 auto：Grok Imagine Image 2.0 aspect_ratio=auto requires at least one image

输入素材限制

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

  • 参考图片：1 到 5 个公开的 HTTPS 链接。
  • 创建任务时，BeatAPI 不会下载这些链接，也不检查其格式、大小或像素尺寸，因此无效的链接不会被提前拒绝。每个链接由模型自行获取。
  • 模型无法获取或读取的链接会在任务创建之后导致任务失败，通常报 bad_request，并全额退款。请使用指向普通图片文件的直接链接，且所在主机无需登录即可响应服务器请求。
  • 手头只有本地文件？请用 POST /v1/files 上传，并传入返回的 data.url。

本模型不接受的字段

图片端点支持一些其他图片模型使用的字段。在这里传入它们会被拒绝而不是被忽略，因此你不会为没有效果的设置付费：

  • resolution、output_format、quality、seed、background、size、enhance_prompt → field "resolution" is not supported by model grok-imagine-image-2.0（其中是你传入的字段名）。
  • 其他任何未知字段，例如 n → unknown field: n。没有 n：一个任务只生成一张图片。

如果请求中有多个无效字段，报错信息只会指出其中一个；修正后再次发送即可。

由于没有 output_format，存储的文件就是模型返回的类型。请读取 output.media[].mime_type 查看。

请求示例

curl --request POST \
  --url https://api.beatapi.io/v1/images/tasks \
  --header "Authorization: Bearer $BEATAPI_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "model": "grok-imagine-image-2.0",
  "prompt": "Bold launch campaign visual for a sparkling water brand, cinematic contrast, condensation on the can",
  "aspect_ratio": "3:2"
}'

文生图

根据提示词生成一张 3:2 的横版图片。

curl --request POST \
  --url https://api.beatapi.io/v1/images/tasks \
  --header "Authorization: Bearer $BEATAPI_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "model": "grok-imagine-image-2.0",
  "prompt": "Bold launch campaign visual for a sparkling water brand, cinematic contrast, condensation on the can",
  "aspect_ratio": "3:2"
}'

编辑一张图片

保留商品并更换场景。这里允许使用 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": "grok-imagine-image-2.0",
  "prompt": "Keep the bottle exactly as it is. Replace the background with a sunlit kitchen counter.",
  "images": [
    "https://media.beatapi.io/samples/smart-bottle.png"
  ],
  "aspect_ratio": "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": "grok-imagine-image-2.0",
  "prompt": "Place the bottle from the first image on a neon-lit stage like the one in the second image.",
  "images": [
    "https://media.beatapi.io/samples/smart-bottle.png",
    "https://media.beatapi.io/samples/neon-singer.png"
  ],
  "aspect_ratio": "16:9"
}'

竖版图片

一张适合手机屏幕的 9:16 图片。

curl --request POST \
  --url https://api.beatapi.io/v1/images/tasks \
  --header "Authorization: Bearer $BEATAPI_API_KEY" \
  --header 'Content-Type: application/json' \
  --data '{
  "model": "grok-imagine-image-2.0",
  "prompt": "A rain-soaked neon street at night seen from a low angle, a lone cyclist crossing the frame",
  "aspect_ratio": "9:16"
}'

响应

创建任务（201）

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

{
  "data": {
    "id": "task_7Qm2Xc9LpR4vT8sKa1Nf6YbH3eWdJ0uZ",
    "object": "task",
    "task_kind": "image",
    "capability_id": "grok-imagine-image-2.0",
    "capability_version": 1,
    "media_type": "image",
    "model": "grok-imagine-image-2.0",
    "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": "grok-imagine-image-2.0",
    "capability_version": 1,
    "media_type": "image",
    "model": "grok-imagine-image-2.0",
    "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.jpg",
          "mime_type": "image/jpeg"
        }
      ],
      "r2_url": "https://media.beatapi.io/outputs/task_7Qm2Xc9LpR4vT8sKa1Nf6YbH3eWdJ0uZ/0.jpg"
    },
    "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 或 image/jpeg。该模型没有 output_format，所以是模型返回的类型。
output.r2_urlstring第一个 media 链接的重复，供旧版客户端使用。请读取 media。

任务失败

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

{
  "data": {
    "id": "task_7Qm2Xc9LpR4vT8sKa1Nf6YbH3eWdJ0uZ",
    "object": "task",
    "task_kind": "image",
    "capability_id": "grok-imagine-image-2.0",
    "capability_version": 1,
    "media_type": "image",
    "model": "grok-imagine-image-2.0",
    "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": "grok-imagine-image-2.0",
  "prompt": "Bold launch campaign visual for a sparkling water brand, cinematic contrast, condensation on the can",
  "aspect_ratio": "3:2"
})
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"])

计费

  • 每个任务生成一张图片，按下方唯一的挂牌价计费。价目表中该模型只有一行，也没有可以改变价格的字段。
  • 价格在创建任务时预扣，从你的余额中扣除；若密钥设有额度，也从密钥额度中扣除。在任务生成之前被拒绝的请求不收费。
  • 成功的任务保留预留的金额。失败的任务会全额退还：此时 credits_refunded 等于 credits_reserved，credits_charged 和 credits_settled 为 0。

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

选项牌价（美元）
1 张图片 · 文生图 · 1K$0.03

常见错误

错误或现象原因处理方式
400 Grok Imagine Image 2.0 aspect_ratio=auto requires at least one image在文生图请求中使用了 aspect_ratio: "auto"。指定 1:1 或 16:9 这样的比例，或传入 images。
400 "aspect_ratio" must be one of: [auto 1:1 2:3 3:2 16:9 9:16]传了该模型不提供的比例，例如 4:3 或 21:9。从列出的比例中选一个。
400 field "resolution" is not supported by model grok-imagine-image-2.0传了其他图片模型的字段（resolution、output_format、seed、quality、size、background、enhance_prompt）。删除该字段。
400 unknown field: n想在一个任务里生成多张图片。删除 n，每张图片创建一个任务。
400 "images" accepts at most 5 items参考图片超过 5 张。最多传 5 个链接。
400 "images[0]" must be a public HTTPS URL使用了 http:// 链接、data: URI 或本地路径。把文件放到 HTTPS 地址上，或用 POST /v1/files 上传并使用 data.url。
发送参考图片后，任务 failed，原因为 bad_request链接打开的是网页、登录页或已过期的签名 URL，或主机阻止了下载。直接链接到图片文件，或用 POST /v1/files 上传。不会收费。
400 aspect_ratio "9:16" is not available for this model right now; available: …目前没有任何服务该模型的线路接受这个组合。使用列出的值之一，或稍后重试。
任务 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必需

要运行的模型。

取值：grok-imagine-image-2.0

取值有误时

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

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

长度：1–5000 个字符

  • 长度按字符计算（一个中日韩字符算一个）。
  • 传入 images 时，请说明每张图片的作用，例如 “Keep the product from the first image and change the setting”。

取值有误时

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

期望的图片宽高比，格式为 宽:高。

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

默认值：1:1

  • auto 表示由模型自行决定比例，而不是固定一种。仅在传了 images 时才被接受。
  • 不传则使用 1:1，传了 images 时同样如此。

取值有误时

  • 值不在列表中："aspect_ratio" must be one of: [auto 1:1 2:3 3:2 16:9 9:16]
  • 没有 images 时使用 auto：Grok Imagine Image 2.0 aspect_ratio=auto requires at least one image
imageslist of strings可选

要编辑或合成的参考图片。传入该字段会把请求从文生图切换为图片编辑；没有单独的模式开关。

数量：1–5

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

  • 每一项都必须是指向图片文件的公开 https:// 链接。创建任务时，BeatAPI 只检查链接的格式；此时不会下载图片，也不检查其格式或大小（见限制下方的说明）。
  • 指向网页、登录页、已过期的签名 URL 或有防盗链的主机的链接不会返回图片，任务创建之后会失败。
  • 错误信息中的位置从 0 开始：images[0] 是第一个链接。

取值有误时

  • 超过上限："images" accepts at most 5 items
  • 空数组："images" requires at least 1 item
  • 不是 https:// 链接："images[0]" must be a public HTTPS URL
  • 不是数组："images" must be an array

示例

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

响应

任务对象。任务成功之前 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