開発者リソース
Grok 5 Imagine API ドキュメント
xAIのGrok 5 Imagineモデルをアプリケーションに統合。シンプルなREST APIでテキストから画像、テキストから動画、画像から動画の生成をサポートします。
1
認証
Grok 5 Imagine APIはBearerトークン認証を使用します。リクエストヘッダーにAPIキーを入力してください。
認証
Authorization: Bearer sk-your-api-key-here
APIキーは安全に保管してください。クライアント側のコードで共有しないでください。
料金
| タイプ | コスト | 説明 |
|---|---|---|
テキストから画像 (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 | バッドリクエスト - 無効なパラメータ(プロンプトの欠落、無効なモデルなど) |
| 401 | 認証エラー - APIキーの欠落または無効 |
| 404 | 未検出 - タスクIDが存在しません |
| 500 | 内部サーバーエラー - 再試行するか、サポートにお問い合わせください |