Ideal House
Przejdź do treści

API Referencja kodów błędów#

Podstawowy URL: https://api.ideal.house
Wersja: v1
Zaktualizowano: 2026-03-06


📖 Przegląd#

Wszystkie odpowiedzi API mają zjednoczoną strukturę JSON. W przypadku wystąpienia błędu pole code będzie zawierać nieliniowy kod błędu, a pole message dostarczy czytelny opis błędu.

Zjednoczony format odpowiedzi

json
{
  "code": 1001,
  "message": "Request failed",
  "data": null
}
PoleTypOpis
codeinteger0 = sukces; każda inna wartość wskazuje na błąd
messagestringCzytelny opis błędu
dataanyObciążenie odpowiedzi; null w przypadku błędu

✅ Kod sukcesu#

KodNazwaOpis
0SUCCESSŻądanie zakończone sukcesem

Przykład

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

❌ Kody błędów#

🔧 Błędy ogólne#

KodNazwaOpisSugerowane działanie
1001FAILEDŻądanie nie powiodło się (błąd ogólny)Sprawdź pole message, aby uzyskać szczegółowe informacje
1003INTERNAL_ERRORBłąd wewnętrzny serweraPowtórz żądanie po krótkim opóźnieniu; skontaktuj się z pomocą techniczną, jeśli problem utrzymuje się
1011PARAM_ERRORbłąd parametru żądaniaZweryfikuj, czy wszystkie wymagane parametry są podane i poprawnie sformatowane

🔐 Błędy uwierzytelniania#

KodNazwaOpisSugerowane działanie
5002API_KEY_INVALIDNieprawidłowy lub brakujący klucz APIUpewnij się, że nagłówek APIKEY jest dołączony i że wartość jest poprawna

🛡️ Błędy moderacji treści#

KodNazwaOpisSugerowane działanie
9010SCAN_TEXT_ERRORWskazówka tekstowa nie przeszła weryfikacji treści — zawiera zakazaną treśćZmodyfikuj wskazówkę, aby usunąć wszelkie wrażliwe lub nielegalne treści
9038PROHIBITED_CONTENTWygenerowany obraz wyjściowy zawiera treści zakazaneDostosuj wskazówkę/styl/wejścia i ponów próbę

💰 Błędy kredytów#

KodNazwaOpisSugerowane działanie
9051COINS_NOT_ENOUGHNiewystarczające monety / kredytyDoładuj kredyty na swoim koncie i spróbuj ponownie

📋 Pełne podsumowanie kodów błędów#

KodNazwaOpis
0SUCCESSŻądanie zakończone sukcesem
1001FAILEDŻądanie zakończone niepowodzeniem (ogólne)
1003INTERNAL_ERRORBłąd wewnętrzny serwera
1011PARAM_ERRORBłąd parametru żądania
5002API_KEY_INVALIDNieprawidłowy klucz API
9010SCAN_TEXT_ERRORWskazówka tekstowa zawiera zakazaną treść
9038PROHIBITED_CONTENTWygenerowany obraz wyjściowy zawiera zakazaną treść
9051COINS_NOT_ENOUGHNiewystarczające monety / kredyty

📦 Przykłady odpowiedzi błędów#

1001 — Żądanie zakończone niepowodzeniem#

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

1003 — Błąd wewnętrzny serwera#

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

1011 — Błąd parametru#

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

5002 — Nieprawidłowy klucz API#

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

9010 — Niepowodzenie moderacji treści tekstowej#

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

9038 — Zakazana treść wyjściowa#

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

9051 — Niewystarczające kredyty#

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

💡 Najlepsze praktyki obsługi błędów#

  1. Zawsze sprawdzaj code — Nie polegaj wyłącznie na kodach statusu HTTP; zawsze badaj pole code w treści odpowiedzi.
  2. Obsługuj 1001 dynamicznie — Jest to ogólny kod błędu; pole message będzie zawierać konkretną przyczynę.
  3. Ponawiaj w przypadku 1003 — Błędy po stronie serwera są zwykle przejściowe; wdroż logikę ponawiania z wykładniczym opóźnieniem.
  4. Waliduj dane wejściowe przed wysłaniem — Unikaj błędów 1011, walidując wymagane pola po stronie klienta przed wykonaniem wywołania API.
  5. Moderacja treści — Jeśli otrzymasz 9010 lub 9038, zweryfikuj swoją treść pod kątem Polityki treści platformy przed ponownym przesłaniem.

© Ideal House AI — Wszelkie prawa zastrzeżone.