Ideal House
Перейти к содержанию

Справочник по кодам ошибок API#

Базовый URL: https://api.ideal.house
Версия: v1
Обновлено: 2026-03-06

📖 Обзор#

Все ответы API следуют единой структуре JSON. При возникновении ошибки поле code содержит ненулевой код ошибки, а поле message предоставляет человекочитаемое описание ошибки.

Единый формат ответа

json
{
  "code": 1001,
  "message": "Request failed",
  "data": null
}
ПолеТипОписание
codeinteger0 = успех; любое другое значение указывает на ошибку
messagestringЧеловекочитаемое описание ошибки
dataanyДанные ответа; null при ошибке

✅ Код успеха#

КодНазваниеОписание
0SUCCESSЗапрос выполнен успешно

Пример

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

❌ Коды ошибок#

🔧 Общие ошибки#

КодНазваниеОписаниеРекомендуемое действие
1001FAILEDЗапрос не выполнен (общая ошибка)Проверьте поле message для получения конкретных деталей
1003INTERNAL_ERRORВнутренняя ошибка сервераПовторите запрос после короткой задержки; обратитесь в поддержку, если проблема сохраняется
1011PARAM_ERRORОшибка параметра запросаУбедитесь, что все обязательные параметры предоставлены и правильно отформатированы

🔐 Ошибки аутентификации#

КодНазваниеОписаниеРекомендуемое действие
5002API_KEY_INVALIDНедействительный или отсутствующий ключ APIУбедитесь, что заголовок APIKEY включен и значение корректно

🛡️ Ошибки модерации контента#

КодНазваниеОписаниеРекомендуемое действие
9010SCAN_TEXT_ERRORТекстовый промпт не прошел проверку контента — содержит запрещенный контентИзмените промпт, чтобы удалить чувствительный или незаконный контент
9038PROHIBITED_CONTENTСгенерированное выходное изображение содержит запрещенный контентОтрегулируйте промпт/стиль/входные данные и повторите попытку

💰 Ошибки кредитов#

КодНазваниеОписаниеРекомендуемое действие
9051COINS_NOT_ENOUGHНедостаточно монет / кредитовПополните кредиты на аккаунте и повторите попытку

📋 Полная сводка кодов ошибок#

КодНазваниеОписание
0SUCCESSЗапрос выполнен успешно
1001FAILEDЗапрос не выполнен (общая ошибка)
1003INTERNAL_ERRORВнутренняя ошибка сервера
1011PARAM_ERRORОшибка параметров запроса
5002API_KEY_INVALIDНедействительный ключ API
9010SCAN_TEXT_ERRORТекстовый промпт содержит запрещенный контент
9038PROHIBITED_CONTENTСгенерированное изображение содержит запрещенный контент
9051COINS_NOT_ENOUGHНедостаточно монет / кредитов

📦 Примеры ответов об ошибках#

1001 — Запрос не выполнен#

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

1003 — Внутренняя ошибка сервера#

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

1011 — Ошибка параметров#

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

5002 — Недействительный ключ API#

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

9010 — Не пройдена модерация текстового контента#

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

9038 — Запрещённый контент в результате генерации#

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

9051 — Недостаточно кредитов#

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

💡 Лучшие практики обработки ошибок#

  1. Всегда проверяйте code — Не полагайтесь только на коды состояния HTTP; всегда проверяйте поле code в теле ответа.
  2. Обрабатывайте 1001 динамически — Это общий код ошибки; поле message будет содержать конкретную причину.
  3. Повторяйте при 1003 — Ошибки на стороне сервера обычно временны; реализуйте логику повторных попыток с экспоненциальной задержкой.
  4. Валидируйте входные данные перед отправкой — Избегайте ошибок 1011, валидируя обязательные поля на стороне клиента перед вызовом API.
  5. Модерация контента — Если вы получаете 9010 или 9038, проверьте свой контент на соответствие Политике контента платформы перед повторной отправкой.

© Ideal House AI — Все права защищены.