API ドキュメント
GrokImagine API リファレンス
GrokImagine AI をアプリケーションに統合するための完全な API ドキュメント。テキストや画像から高品質な動画を生成できます。
REST API
JSON レスポンス
動画生成
認証
GrokImagine API は Bearer Token 認証を使用します。Authorization ヘッダーに API トークンを含めてください：
Authorization: Bearer your-api-token-here
セキュリティ注意: API トークンをクライアント側コードや公開リポジトリで公開しないでください。
ベース URL
すべての API リクエストは次の URL に送信してください：
https://grokimagineapi.com
API エンドポイント
POST
動画を生成
/v1/generateテキストプロンプトや画像を使用して、高品質な動画を生成できます。
リクエストボディ
{
"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.