クイックスタート
最初のAPIリクエスト
PixAI API への最初のリクエストを送信するためのステップバイステップガイド。
ベースURL: https://api.pixai.art/v2
認証: すべてのリクエストに Authorization: Bearer YOUR_API_KEY ヘッダーを追加してください。APIキーの取得方法はPixAI APIを使用するには?をご参照ください。
手順
タスクを送信する
POST /image/create を送信します。必須フィールドは modelVersionId と prompt です。
curl -X POST https://api.pixai.art/v2/image/create \
-H "Authorization: Bearer $PIXAI_API_KEY" \
-H "Content-Type: application/json" \
-d '{
"modelVersionId": "1983308862240288769",
"prompt": "1girl, green hair, masterpiece, best quality, solo, standing, flower",
"aspectRatio": "9:16",
"mode": "standard"
}'レスポンス:
{
"id": "TASK_ID",
"status": "waiting",
"createdAt": "2026-03-04T04:32:10.635Z",
"updatedAt": "2026-03-04T04:32:10.635Z",
"outputs": {
"mediaIds": [],
"mediaUrls": []
}
}レスポンス内の id を控えておいてください。これが次のステップで使用する TASK_ID です。
modelVersionId は PixAI のモデルバージョン URL(https://pixai.art/model/<id>/<modelVersionId>)の最後のセグメントです。推奨モデルはモデル一覧をご参照ください。
ステータスを確認する
status が終了状態になるまで繰り返します。
curl https://api.pixai.art/v1/task/TASK_ID \
-H "Authorization: Bearer $PIXAI_API_KEY"| ステータス | 意味 |
|---|---|
waiting | タスクはキュー待ち中 |
running | 生成処理中 |
completed | 完了、出力が利用可能 |
failed | 生成に失敗 |
cancelled | タスクがキャンセルされた |
completed の場合、outputs.mediaUrls に画像 URL が含まれます。
ポーリングは 1.5秒 に1回以下にしてください。再試行時はエクスポネンシャル・バックオフを使用してください。各アカウントでは waiting または running 状態のタスクを最大10件まで同時に実行できます。詳細は制限事項をご参照ください。
画像をダウンロードする
curl -L "MEDIA_URL" -o output.png
# またはメディアIDで:
curl -L https://api.pixai.art/v1/media/MEDIA_ID/image \
-H "Authorization: Bearer $PIXAI_API_KEY" -o output.png生成された画像は 永続的に保存されません。タスクが完了したらすぐにダウンロードしてください。