Grok 5 Imagine 生成
API 文档
使用这些端点提交 Grok 5 Imagine 任务并检查其状态。每次调用都会根据使用的模型消耗积分。
身份验证
所有请求必须在 Authorization header:
Authorization: Bearer <YOUR_API_KEY>缺少或无效的密钥将返回 401 Unauthorized.
POST
https://grok5imagine.com/api/generate
创建生成任务
提交一个新的 Grok 5 Imagine 任务。调用会立即返回一个 task_id,同时渲染异步完成。
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
| model | string | 否 | 使用的模型:grok-imagine/text-to-image(默认)、text-to-video、image-to-video 或 upscale。 |
| input | object | 是 | 包含 prompt、image_urls 或 task_id 的输入参数对象,根据模型而定。 |
| input.prompt | string (max 5000 chars) | 否 | 描述要生成内容的文本提示(text-to-image 和 text-to-video 必需)。 |
| input.image_urls | string[] | 否 | 图像 URL 数组(image-to-video 必需)。 |
| input.task_id | string | 否 | 用于放大或 image-to-video 生成的先前任务 ID。 |
| callback_url | string | 否 | 接收任务完成通知的 Webhook URL。 |
| public | boolean | 否 | 将任务公开到公共图库。 |
积分消耗
积分在任务创建时扣除。失败的任务将自动退款。
| 模型 | 扣除积分 |
|---|---|
| grok-imagine/text-to-image | 5 |
| grok-imagine/text-to-video | 24 |
| grok-imagine/image-to-video | 24 |
| grok-imagine/upscale | 12 |
请求示例
{
"model": "grok-imagine/text-to-image",
"input": {
"prompt": "A majestic dragon flying over a neon-lit cyberpunk city"
}
}响应示例
{
"code": 200,
"message": "success",
"data": {
"task_id": "n31b6d54c8f4b4c4e8kie",
"status": "IN_PROGRESS"
}
}GET / POST
https://grok5imagine.com/api/status
检查任务状态
使用此端点来轮询最新的记录。当任务仍处于 IN_PROGRESS(进行中)状态时,我们在回复之前会再次查询提供者。
| 参数 | 类型 | 必需 | 描述 |
|---|---|---|---|
| task_id | string | 是 | 由 /generate 返回的 ID。通过查询参数 (?task_id=) 或 JSON 正文发送。 |
| 字段 | 描述 |
|---|---|
| task_id | 从 /generate 返回的 ID。 |
| status | SUCCESS(成功) |
| request | 已清理的用户提交有效负载副本。 |
| response | 当 status 为 SUCCESS 时返回包含 resultUrls 数组的对象。 |
| consumed_credits | 任务消耗的积分(退款时为 0)。 |
| error_message | 当 status 为 FAILED 时返回的提供者错误信息。 |
| created_at | 任务存储时的 UTC 时间戳。 |
请求示例
GET https://grok5imagine.com/api/status?task_id=n31b6d54c8f4b4c4e8kie
Authorization: Bearer <YOUR_API_KEY>
# or POST
POST https://grok5imagine.com/api/status
Authorization: Bearer <YOUR_API_KEY>
Content-Type: application/json
{
"task_id": "n31b6d54c8f4b4c4e8kie"
}响应示例
{
"code": 200,
"message": "success",
"data": {
"task_id": "n31b6d54c8f4b4c4e8kie",
"status": "SUCCESS",
"request": {
"model": "grok-imagine/text-to-image",
"input": {
"prompt": "A majestic dragon flying over a neon-lit cyberpunk city"
}
},
"response": {
"resultUrls": [
"https://static.gogloai.com/grok-imagine/image_001.png"
]
},
"consumed_credits": 5,
"error_message": null,
"created_at": "2025-06-14T05:21:11Z"
}
}错误处理
401 Unauthorized- API 密钥缺失或无效。402 Payment Required- 积分余额不足以支付扣除的费用。429 Too Many Requests- 减少轮询频率或请求速率。500- 暂时性问题;请使用指数退避策略重试。