Ideal House
Zum Hauptinhalt springen

API-Fehlercodereferenz#

Basis-URL: https://api.ideal.house
Version: v1
Aktualisiert: 2026-03-06


📖 Übersicht#

Alle API-Antworten folgen einer einheitlichen JSON-Struktur. Tritt ein Fehler auf, enthält das Feld code einen Fehlercode ungleich null, und das Feld message liefert eine menschenlesbare Fehlerbeschreibung.

Einheitliches Antwortformat

json
{
  "code": 1001,
  "message": "Request failed",
  "data": null
}
FeldTypBeschreibung
codeinteger0 = Erfolg; jeder andere Wert zeigt einen Fehler an
messagestringMenschenlesbare Fehlerbeschreibung
dataanyAntwort-Payload; bei Fehler null

✅ Erfolgscode#

CodeNameBeschreibung
0SUCCESSAnfrage erfolgreich

Beispiel

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

❌ Fehlercodes#

🔧 Allgemeine Fehler#

CodeNameBeschreibungEmpfohlene Maßnahme
1001FAILEDAnfrage fehlgeschlagen (generischer Fehler)Überprüfen Sie das message-Feld für spezifische Details
1003INTERNAL_ERRORInterner ServerfehlerWiederholen Sie die Anfrage nach kurzer Verzögerung; wenden Sie sich an den Support, wenn sie anhält
1011PARAM_ERRORFehler in den AnfrageparameternÜberprüfen Sie, ob alle erforderlichen Parameter vorhanden und korrekt formatiert sind

🔐 Authentifizierungsfehler#

CodeNameBeschreibungEmpfohlene Maßnahme
5002API_KEY_INVALIDUngültiger oder fehlender API KeyStellen Sie sicher, dass der APIKEY-Header enthalten ist und der Wert korrekt ist

🛡️ Fehler bei der Inhaltsmoderation#

CodeNameBeschreibungEmpfohlene Maßnahme
9010SCAN_TEXT_ERRORText-Prompt hat die Inhaltsprüfung nicht bestanden – enthält verbotene InhaltePassen Sie den Prompt an, um sensible oder illegale Inhalte zu entfernen
9038PROHIBITED_CONTENTGeneriertes Ausgabebild enthält verbotene InhaltePassen Sie Prompt/Stil/Eingaben an und wiederholen Sie

💰 Guthabeneinheiten-Fehler#

CodeNameBeschreibungEmpfohlene Maßnahme
9051COINS_NOT_ENOUGHUnzureichende Münzen / CreditsLaden Sie Ihre Kontocredits auf und wiederholen Sie den Vorgang

📋 Vollständige Fehlercodeübersicht#

CodeNameBeschreibung
0SUCCESSAnfrage erfolgreich
1001FAILEDAnfrage fehlgeschlagen (allgemein)
1003INTERNAL_ERRORInterner Serverfehler
1011PARAM_ERRORAnforderungsparameterfehler
5002API_KEY_INVALIDUngültiger API Key
9010SCAN_TEXT_ERRORText-Prompt enthält verbotene Inhalte
9038PROHIBITED_CONTENTGeneriertes Ausgabebild enthält verbotene Inhalte
9051COINS_NOT_ENOUGHUnzureichende Münzen / Guthabeneinheiten

📦 Fehlerantwortbeispiele#

1001 — Anfrage fehlgeschlagen#

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

1003 — Interner Serverfehler#

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

1011 — Parameterfehler#

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

5002 — Ungültiger API Key#

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

9010 — Moderation des Textinhalts fehlgeschlagen#

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

9038 — Ausgabe verbotene Inhalte#

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

9051 — Unzureichende Guthabeneinheiten#

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

💡 Bewährte Vorgehensweisen zur Fehlerbehandlung#

  1. Prüfen Sie stets code — Verlassen Sie sich nicht ausschließlich auf HTTP-Statuscodes; prüfen Sie immer das Feld code im Antwortkörper.
  2. Behandeln Sie 1001 dynamisch — Dies ist ein generischer Fehlercode; das Feld message enthält den spezifischen Grund.
  3. Wiederholen bei 1003 — Serverseitige Fehler sind meist vorübergehend; implementieren Sie Exponential-Backoff-Wiederholungslogik.
  4. Validieren Sie Eingaben vor dem Senden — Vermeiden Sie 1011-Fehler, indem Sie erforderliche Felder clientseitig validieren, bevor Sie den API-Aufruf tätigen.
  5. Inhaltsmoderation – Wenn Sie 9010 oder 9038 erhalten, überprüfen Sie Ihren Inhalt vor dem erneuten Einreichen gemäß der Inhaltsrichtlinie der Plattform.

© Ideal House AI — Alle Rechte vorbehalten.