API 文档
GrokImagine API 参考文档
完整的 API 文档,帮助你将 GrokImagine AI 集成到应用中。支持文本与图片生成高质量视频,并提供多种创意模式。
REST API
JSON 响应
视频生成
身份验证
GrokImagine API 使用 Bearer Token 进行身份验证。请在 Authorization Header 中加入你的 API Token:
Authorization: Bearer your-api-token-here
安全提示: 请勿在客户端代码或公开仓库中暴露你的 API Token。
基础 URL
所有 API 请求应发送至:
https://grokimagineapi.com
API 接口
POST
生成视频
/v1/generate使用 AI 模型根据文本提示或图片生成高质量视频。
请求体
{
"mode": "fun",
"prompt": "a beautiful landscape with mountains",
"images": ["https://example.com/image.png"],
"ratio": "1:1"
}参数
| 参数 | 类型 | 描述 |
|---|---|---|
| mode | string | 生成模式,支持:fun、normal、spicy |
| prompt | string | 用于视频生成的文本提示 |
| images | string? | 可选参数,图片 URL 数组,用于从图片生成视频。例如:['https://example.com/image.png'] |
| ratio | string | 宽高比,支持:2:3、3:2、1:1 |
💰 Pricing
Each generation consumes 40 credits, approximately 0.4 USD
Response
{
"code": 200,
"message": "success",
"data": {
"task_id": "task_123456789"
}
}cURL Example
curl -X POST https://grokimagineapi.com/v1/generate \
-H "Authorization: Bearer your-api-token" \
-H "Content-Type: application/json" \
-d '{
"mode": "fun",
"prompt": "a beautiful landscape with mountains",
"ratio": "1:1"
}'GET
Get Task Status
/v1/status?task_id=xxxxCheck the status of an ongoing or completed video generation task.
Query Parameters
Use GET request with query parameter task_id=xxxx
Response
{
"code": 200,
"message": "success",
"data": {
"consumed_credits": 40,
"created_at": "2024-01-01T00:00:00Z",
"status": "completed",
"task_id": "task_123456789",
"request": {
"mode": "fun",
"prompt": "a beautiful landscape with mountains",
"ratio": "1:1"
},
"response": [
"https://cdn.example.com/generated/video1.mp4",
"https://cdn.example.com/generated/video2.mp4"
]
}
}📋 Response Fields
- consumed_credits: Number of credits consumed
- created_at: Task creation timestamp
- status: Task status
- task_id: Task ID
- request: Original request data
- response: Video URL string array
cURL Example
curl -X GET "https://grokimagineapi.com/v1/status?task_id=task_123456789" \ -H "Authorization: Bearer your-api-token"
错误处理
GrokImagine API 返回标准的 HTTP 状态码和错误信息:
HTTP 状态码
200OK
400Bad Request
401Unauthorized
429Rate Limited
500Server Error
错误响应格式
{
"code": 400,
"message": "Invalid request: The prompt parameter is required",
"error": "INVALID_REQUEST"
}最佳实践: 始终优雅处理错误,并在处理响应内容前检查 HTTP 状态码。
速率限制
100
次/分钟
免费计划
1000
requests/minute
专业版
5000
requests/minute
企业版
Rate Limit Headers: Each response includes X-RateLimit-Remaining and X-RateLimit-Reset headers to track your current usage.