API エラーコードリファレンス#

ベース URL: https://api.ideal.house
バージョン: v1
更新日: 2026-03-06

📖 概要#

すべての API レスポンスは統一された JSON 構造に従います。エラーが発生した場合、code フィールドにゼロ以外のエラーコードが入り、message フィールドに人が読める形式のエラー説明が入ります。

統一レスポンス形式

{
  "code": 1001,
  "message": "Request failed",
  "data": null
}

✅ 成功コード#

例

{
  "code": 0,
  "message": "success",
  "data": { }
}

❌ エラーコード#

🔧 一般的なエラー#

🔐 認証エラー#

🛡️ コンテンツ審査のエラー#

💰 クレジットのエラー#

📋 エラーコードの全一覧#

📦 エラーレスポンスの例#

1001 — リクエストの失敗#

{
  "code": 1001,
  "message": "Request failed",
  "data": null
}

1003 — サーバー内部のエラー#

{
  "code": 1003,
  "message": "Internal server error",
  "data": null
}

1011 — パラメーターエラー#

{
  "code": 1011,
  "message": "Request parameter error: imageUrl is required",
  "data": null
}

5002 — API キーが無効#

{
  "code": 5002,
  "message": "Invalid API Key",
  "data": null
}

9010 — テキストのコンテンツ審査に不合格#

{
  "code": 9010,
  "message": "Text prompt failed content review, contains prohibited content",
  "data": null
}

9038 — 出力に禁止された内容が含まれる#

{
  "code": 9038,
  "message": "Prohibited content",
  "data": null
}

9051 — クレジット不足#

{
  "code": 9051,
  "message": "Insufficient coins",
  "data": null
}

💡 エラー処理の推奨事項#

1. 必ず code を確認する — HTTP ステータスコードだけに頼らず、レスポンスボディの code フィールドを必ず確認します。
2. 1001 を内容に応じて処理する — 一般的なエラーコードです。message フィールドに具体的な理由が入ります。
3. 1003 では再試行する — サーバー側エラーは通常一時的です。待機時間を指数関数的に延ばす再試行処理を実装します。
4. 送信前に入力を検証する — API を呼び出す前にクライアント側で必須フィールドを検証し、1011 エラーを防ぎます。
5. コンテンツ審査 — 9010 または 9038 を受け取った場合は、再送信前にプラットフォームのコンテンツポリシーに照らして内容を確認します。

© Ideal House AI — 無断複製・転載を禁じます。