Skip to main content
POST

承認

Authorization
string
header
必須

##すべてのAPIにBearer Token認証が必要です##

APIキーの取得:

APIキー管理ページにアクセスしてAPIキーを取得してください

リクエストヘッダーに追加:

ボディ

application/json
model
enum<string>
必須

画像生成モデル名。テキストから画像への生成と画像編集で同じモデル名を使用し、image_urls の有無によってモードが自動的に切り替わります

利用可能なオプション:
grok-imagine-image-2.0
:

"grok-imagine-image-2.0"

prompt
string
必須

生成したい画像、または渡した参照画像の編集方法を記述するプロンプト

複数画像の参照構文:

  • 複数の参照画像を渡す場合、プロンプト内で <IMAGE_0><IMAGE_1><IMAGE_2> を使って 1 枚目・2 枚目・3 枚目の参照画像をそれぞれ指定できます
  • インデックスは 0 から始まり、image_urls 配列の順序と 1 対 1 で対応します
  • 例: <IMAGE_0> の人物を <IMAGE_1> のシーンに配置してください
:

"サイバーパンク風の夜の東京の街並み、濡れた路面に映るネオンの光"

image_urls
string<uri>[]

画像から画像への変換および画像編集機能のための参照画像URLリスト

注意:

  • リクエストあたりの入力画像数: 0~3 枚(指定なし = テキストから画像への生成、1~3 枚 = 画像編集)
  • 公開ネットワークから直接アクセスできる http / https の画像URLのみ対応。base64 および data URL は非対応です
  • サポートされるファイル形式: .jpeg.jpg.png.webp
  • 画像URLはサーバーから直接アクセス可能であるか、アクセス時に直接ダウンロードする必要があります(通常、これらのURLは.png.jpgなどの画像ファイル拡張子で終わります)
  • 画像編集の場合、渡した参照画像には追加費用が発生します。費用はリクエストごとに 1 回のみ計上され、n 倍にはなりません
Maximum array length: 3
:
size
enum<string>
デフォルト:auto

生成画像のアスペクト比。デフォルトは auto

対応する比率(13 種類):

注意:

  • auto: モデルが比率を自動的に決定します。パラメータを指定しない場合は auto と同等です(出力は通常縦長になります)
  • 上表以外の値には非対応です
利用可能なオプション:
1:1,
4:3,
3:4,
3:2,
2:3,
16:9,
9:16,
2:1,
1:2,
19.5:9,
9:19.5,
20:9,
9:20,
auto
:

"16:9"

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

出力画像のピクセルレベル。デフォルトは 1K で、1K2K の 2 段階に対応

注意:

  • 本モデルは 4K に非対応です
  • 値は大文字小文字を区別しません
利用可能なオプション:
1K,
2K
:

"1K"

quality
enum<string>
デフォルト:medium

生成品質のレベル。モデルの思考の深さを制御します。デフォルトは medium

注意:

  • 本モデルは low / medium の 2 段階のみ対応。high などの値には非対応です
  • quality(品質レベル)と resolution(ピクセルレベル)は互いに独立しており、自由に組み合わせられます
  • 値は大文字小文字を区別しません
利用可能なオプション:
low,
medium
:

"medium"

n
integer
デフォルト:1

生成する画像の枚数。範囲は 1~10、デフォルトは 1

注意:

  • 画像ごとに個別に課金され、費用は n に比例して増加します
  • 参照画像による追加費用はリクエストごとに 1 回のみ計上され、n 倍にはなりません
  • タスク完了後、result_urls には互いに独立した n 個の画像リンクが返されます
必須範囲: 1 <= x <= 10
:

1

callback_url
string<uri>

タスク完了後の HTTPS コールバックアドレス

コールバックタイミング:

  • タスクが完了、失敗、またはキャンセルされた時にトリガーされます
  • 課金確認完了後に送信されます

セキュリティ制限:

  • HTTPS プロトコルのみサポート
  • 内部 IP アドレスへのコールバックは禁止(127.0.0.1、10.x.x.x、172.16-31.x.x、192.168.x.x など)
  • URL の長さは 2048 文字以内

コールバックメカニズム:

  • タイムアウト:10
  • 失敗時最大 3 回リトライ(1 秒/2 秒/4 秒後にリトライ)
  • コールバックレスポンスボディの形式はタスククエリ API のレスポンス形式と一致
  • コールバックアドレスが 2xx ステータスコードを返した場合は成功とみなされ、その他のステータスコードはリトライをトリガーします
:

"https://your-domain.com/webhooks/image-task-completed"

レスポンス

画像タスクが正常に作成されました

created
integer

タスク作成タイムスタンプ

:

1757156493

id
string

タスクID

:

"task-unified-1757156493-imcg5zqt"

model
string

実際に使用されたモデル名

:

"grok-imagine-image-2.0"

object
enum<string>

具体的なタスクタイプ

利用可能なオプション:
image.generation.task
progress
integer

タスク進行状況のパーセンテージ (0-100)

必須範囲: 0 <= x <= 100
:

0

status
enum<string>

タスクステータス

利用可能なオプション:
pending,
processing,
completed,
failed
:

"pending"

task_info
object

非同期タスク情報

type
enum<string>

タスクの出力タイプ

利用可能なオプション:
text,
image,
audio,
video
:

"image"

usage
object

使用量と課金情報