开发者资源
Grok 5 Imagine API 文档
将 xAI 的 Grok 5 Imagine 模型集成到您的应用中。支持文生图、文生视频和图生视频,简单易用的 REST API。
1
身份认证
Grok 5 Imagine API 使用 Bearer Token 认证。在请求头中传递您的 API Key。
身份认证
Authorization: Bearer sk-your-api-key-here
请妥善保管您的 API Key,不要在客户端代码中暴露。
定价
| 类型 | 费用 | 描述 |
|---|---|---|
文生图 (text2img) | 5 积分 | 使用 Grok 5 AI 根据文本提示生成图片。 |
文生视频 (text2video) | 24 积分 | 使用 Grok 5 AI 根据文本提示生成视频。 |
图生视频 (img2video) | 24 积分 | 使用 Grok 5 AI 根据图片生成视频。 |
2
创建任务
POST
https://grok5ai.com/api/generate异步生成
定价
积分因模型而异:text2img 消耗 5 积分,text2video 和 img2video 各消耗 24 积分。
发起一个生成任务。API 会立即返回 task_id,您可以用它来轮询获取结果。
请求体参数
| 参数 | 类型 | 必填 | 描述 |
|---|---|---|---|
| model | string | 必填 | 使用的模型:text2img、text2video 或 img2video。 |
| prompt | string | 条件必填 | 生成的文本描述。最多 5000 个字符。text2img 和 text2video 必填。 |
| image_urls | array | 条件必填 | img2video 模式的图片 URL 数组。如果未提供 task_id 则必填。 |
| task_id | string | 条件必填 | 用作输入图片的先前生成任务 ID。如果未提供 image_urls 则必填。 |
| callback_url | string | 可选 | 任务完成时的 Webhook 回调 URL。 |
请求示例
文生图示例 (cURL)
curl -X POST https://grok5ai.com/api/generate \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "text2img",
"prompt": "A serene mountain landscape at sunset"
}'文生视频示例 (cURL)
curl -X POST https://grok5ai.com/api/generate \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "text2video",
"prompt": "A timelapse of clouds moving over mountains"
}'图生视频示例 (cURL)
curl -X POST https://grok5ai.com/api/generate \
-H "Authorization: Bearer YOUR_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"model": "img2video",
"image_urls": ["https://example.com/image.jpg"]
}'成功响应
{
"code": 200,
"data": {
"task_id": "grok5abc123def456img",
"status": "IN_PROGRESS"
}
}错误响应
{
"code": 400,
"message": "Bad Request: 'prompt' is required.",
"data": null
}3
查询状态
GET
https://grok5ai.com/api/status轮询此接口以查询任务进度。建议每 5-10 秒轮询一次。
查询参数
| 参数 | 类型 | 描述 |
|---|---|---|
| task_id | string | 从生成接口获取的任务 ID。 必填 |
状态值
PENDING任务排队中IN_PROGRESS处理中SUCCESS已完成FAILED发生错误cURL
curl -X GET "https://grok5ai.com/api/status?task_id=grok5abc123def456img" \
-H "Authorization: Bearer YOUR_API_KEY"响应(处理中)
{
"code": 200,
"data": {
"task_id": "grok5abc123def456img",
"status": "IN_PROGRESS",
"consumed_credits": 10,
"created_at": "2024-12-19T10:00:00Z"
}
}响应(已完成)
{
"code": 200,
"data": {
"task_id": "grok5abc123def456img",
"status": "SUCCESS",
"response": [
"https://cdn.example.com/image.png"
]
}
}响应(失败)
{
"code": 200,
"message": "success",
"data": {
"task_id": "grok5abc123def456img",
"status": "FAILED",
"consumed_credits": 0,
"error_message": "Content policy violation detected",
"created_at": "2024-12-19T10:00:00Z",
"request": { ... },
"response": null
}
}错误码
| 状态码 | 描述 |
|---|---|
| 200 | 成功 |
| 400 | 请求错误 - 参数无效(缺少 prompt、model 无效等) |
| 401 | 未授权 - API Key 缺失或无效 |
| 404 | 未找到 - 任务 ID 不存在 |
| 500 | 服务器内部错误 - 请重试或联系支持 |