Skip to main content
POST

授权

Authorization
string
header
必填

##所有接口均需要使用Bearer Token进行认证##

获取 API Key :

访问 API Key 管理页面 获取您的 API Key

使用时在请求头中添加:

请求体

application/json
model
enum<string>
必填

图像生成模型名称,文生图与图像编辑共用此模型名,根据是否传入 image_urls 自动切换模式

可用选项:
grok-imagine-image-2.0
示例:

"grok-imagine-image-2.0"

prompt
string
必填

提示词,描述想要生成的图像,或描述如何编辑传入的参考图

多图引用语法:

  • 传入多张参考图时,可在提示词中用 <IMAGE_0><IMAGE_1><IMAGE_2> 分别引用第 1、2、3 张参考图
  • 序号从 0 开始,与 image_urls 数组顺序一一对应
  • 示例:把 <IMAGE_0> 中的人物放到 <IMAGE_1> 的场景里
示例:

"赛博朋克风格的东京街头夜景,霓虹灯倒映在湿漉漉的路面上"

image_urls
string<uri>[]

参考图像URL列表,用于图生图与图像编辑功能

注意:

  • 单次请求支持输入图像数量:0~3张(不传 = 文生图,传 1~3 张 = 图像编辑)
  • 仅支持公网可直接访问的 http / https 图像URL,不支持 base64 与 data URL
  • 支持的文件格式:.jpeg.jpg.png.webp
  • 图像URL需要服务器能直接查看,或者图像URL在访问时会直接进行下载(一般这种URL是以图像的扩展名作为结尾,例如.png.jpg
  • 图像编辑场景下,传入的参考图会产生额外费用,且每次请求只计算一次,不随 n 翻倍
Maximum array length: 3
示例:
size
enum<string>
默认值:auto

生成图像的宽高比,默认 auto

支持的比例(13 种):

注意:

  • auto:由模型自行决定比例,不传该参数等效于 auto(实际输出通常为竖版)
  • 不支持上表以外的取值
可用选项:
1:1,
4:3,
3:4,
3:2,
2:3,
16:9,
9:16,
2:1,
1:2,
19.5:9,
9:19.5,
20:9,
9:20,
auto
示例:

"16:9"

resolution
enum<string>
默认值:1K

输出图像的像素档位,默认 1K,支持 1K2K 两档

注意:

  • 本模型不支持 4K
  • 取值大小写不敏感
可用选项:
1K,
2K
示例:

"1K"

quality
enum<string>
默认值:medium

生成质量档位,控制模型的思考深度,默认 medium

注意:

  • 本模型仅支持 low / medium 两档,不支持 high 等其他取值
  • quality(质量档)与 resolution(像素档)互相独立,可自由组合
  • 取值大小写不敏感
可用选项:
low,
medium
示例:

"medium"

n
integer
默认值:1

生成图片数量,取值范围 1~10,默认 1

注意:

  • 每张图片独立计费,费用随 n 线性增加
  • 参考图产生的额外费用每次请求只计算一次,不随 n 翻倍
  • 任务完成后 result_urls 会返回 n 个互相独立的图像链接
必填范围: 1 <= x <= 10
示例:

1

callback_url
string<uri>

任务完成后的HTTPS回调地址

回调时机:

  • 任务完成(completed)、失败(failed)或取消(cancelled)时触发
  • 在计费确认完成后发送

安全限制:

  • 仅支持HTTPS协议
  • 禁止回调到内网IP地址(127.0.0.1、10.x.x.x、172.16-31.x.x、192.168.x.x等)
  • URL长度不超过2048字符

回调机制:

  • 超时时间:10
  • 失败后最多重试3次(会分别在失败的1秒/2秒/4秒后进行重试)
  • 回调响应体格式与任务查询接口返回的格式一致
  • 回调地址若返回2xx状态码视为成功,其他状态码会触发重试
示例:

"https://your-domain.com/webhooks/image-task-completed"

响应

图像任务创建成功

created
integer

任务创建时间戳

示例:

1757156493

id
string

任务ID

示例:

"task-unified-1757156493-imcg5zqt"

model
string

实际使用的模型名称

示例:

"grok-imagine-image-2.0"

object
enum<string>

任务的具体类型

可用选项:
image.generation.task
progress
integer

任务进度百分比 (0-100)

必填范围: 0 <= x <= 100
示例:

0

status
enum<string>

任务状态

可用选项:
pending,
processing,
completed,
failed
示例:

"pending"

task_info
object

异步任务信息

type
enum<string>

任务的输出类型

可用选项:
text,
image,
audio,
video
示例:

"image"

usage
object

使用量和计费信息