Skip to main content
POST
Text-to-image: generate images from a text prompt
🔒 デフォルトでは利用できません: Grok イマジン 2 は Default グループには属していません。独自の Grok_imagine グループに属しており、呼び出す前にアクセスをリクエストする必要があります(このページのプレイグラウンドを含みます)。アクセスがない場合、すべての呼び出しは 503 を返します。このファミリーのコンテンツ安全ポリシーは、プラットフォーム上の他のモデルと大きく異なり、一部のカテゴリはフィルタリングされません。そのため、コンプライアンスリスクを抑える目的でアクセスを選択的に付与しています。既存のお客様は、累計 $1,000 以上を利用している場合、ユースケースをサポートに説明することで有効化できます。それ以外のお客様は、ユースケースと導入済みのコンテンツモデレーション制御を説明したうえで、WeCom サポートから申請してください。詳しい手順: Grok イマジン 2 概要 - グループ設定。
右側のインタラクティブなプレイグラウンドでは、エンドポイントを直接テストできます。Authorization に API キーを入力し(形式: Bearer sk-xxx)、prompt を入力して、aspect_ratio / resolution を選択し、送信してください。
このページを使用する場面: prompt だけを使用したテキストから画像への画像生成です。画像のアップロードは必要ありません。既存の画像を変更したり、複数の画像を合成したりする場合は、画像編集エンドポイントを使用してください。
⚠️ 参照画像をこのエンドポイントに送信しないでくださいここで image / image_url / images を渡しても、エラーは発生しません。200 が返され、prompt からまったく新しい画像が生成されます。ただし、参照画像は暗黙的に破棄され、それでも課金されます。エラー通知がないため、通常は入力とまったく関係のない出力に気付いたときに初めて問題が判明します。参照画像を使用するワークフローでは、必ず /v1/images/edits を使用してください。
⚠️ 無効なパラメータを指定してもエラーは発生しません無効な aspect_ratio(例: 5:7)、resolution(例: 1K、1024x1024)、response_format(例: base64)はすべて暗黙的にデフォルト値へフォールバックし、それでも画像を返します。出力が期待どおりにならない場合は、まずパラメータのスペルを確認してください。なお、resolution の値は小文字の 1k / 2k です。例外として、resolution: "4k" は 503 model_service_unavailable を返します。これはティアがサポートされていないことを意味し、チャネルが停止しているという意味ではありません。再試行しても解決しません。
すべての画像 API は同期処理です。非同期タスク ID は存在しないため、リクエストの課金が続いている間にクライアントが切断されると、結果が失われます。1K は約 9 秒、2K は約 15-17 秒かかるため、クライアントのタイムアウトを 360 秒に設定してください。詳しくは 画像 API のベストプラクティスを参照してください。

コード例

Python (OpenAI SDK)

Python (生の requests)

cURL

Node.js (ネイティブ fetch)

ブラウザー JavaScript

パラメータリファレンス

アスペクト比ごとの実際の出力ピクセル数:
seed はサポートされていません(エラーなく受け付けられますが、効果はありません — 結果は再現できません)。マスクによる inpainting もサポートされていません。size / quality / style のような OpenAI 形式のフィールドは、黙って無視されます。

レスポンス形式

レスポンスフィールドの注意点
  • 各 data[] エントリには、response_format に応じて url または b64_json のどちらか一方が含まれます — 両方が含まれることはありません。
  • revised_prompt は返されず、respect_moderation / model も返されません。存在すると想定しないでください。
  • b64_json は data:image/...;base64, プレフィックスのない生の base64 です — そのままデコードしてください。
  • created は常に 0 であり、タイムスタンプとしては使用できません。
  • n > 1 では、data 配列に複数のエントリが入ります — data[0] だけを読まないでください。
usage は照合には使用できません: prompt_tokens は実際の prompt の長さにかかわらず常に 1000 x n です。このシリーズは画像ごとの定額料金($0.02 / $0.045)で課金されます。実際の請求額は APIYI Console の課金記録を参照してください。

承認

Authorization
string
header
必須

API Key created in the APIYI Console

ボディ

application/json
model
enum<string>
デフォルト:grok-imagine-image
必須

Model ID. The quality variant delivers higher fidelity at a higher price

利用可能なオプション:
grok-imagine-image,
grok-imagine-image-quality
prompt
string
必須

Prompt, English or Chinese. Describe subject, scene, style and lighting in detail

例:

"A photorealistic red wooden boat moored on a glassy alpine lake at dawn, mist over the water, snow-capped peaks behind, cinematic photography"

n
integer
デフォルト:1

Number of images, 1-10. Values of 11 or above return 400; 0 is silently treated as 1

必須範囲: 1 <= x <= 10
例:

1

aspect_ratio
enum<string>
デフォルト:1:1

Output aspect ratio. Actual pixel dimensions per resolution tier:

Values outside this enum do not raise an error — they silently fall back to 1:1.

利用可能なオプション:
1:1,
16:9,
9:16,
4:3,
3:4
例:

"16:9"

resolution
enum<string>
デフォルト:1k

Resolution tier. 1k is roughly 0.9-1.05 megapixels and returns JPEG; 2k is roughly 4.2-4.5 megapixels and returns PNG (5-6 MB per image). Both tiers cost the same.

4k returns 503; other invalid values (such as 1K or 1024x1024) silently fall back to 1k.

利用可能なオプション:
1k,
2k
例:

"1k"

response_format
enum<string>
デフォルト:url

Response format. url returns a direct image link (no signed query params); b64_json returns a raw base64 string (without the data: prefix).

Invalid values silently fall back to the default url.

利用可能なオプション:
url,
b64_json
例:

"url"

レスポンス

Images generated successfully

created
integer

Creation timestamp. Always 0 for this model — do not use it for timing

例:

0

data
object[]

Array of image results, length equals the requested n

usage
object

Placeholder values — do not use for billing reconciliation. prompt_tokens is always 1000 x n, regardless of actual prompt length. Use the Console billing records instead.