Ideal House
Saltar al contenido

Referencia de Códigos de Error de API#

URL base: https://api.ideal.house
Versión: v1
Actualizado: 2026-03-06


📖 Descripción general#

Todas las respuestas de API siguen una estructura JSON unificada. Cuando ocurre un error, el campo code contendrá un código de error distinto de cero, y el campo message proporcionará una descripción legible del error.

Formato de Respuesta Unificado

json
{
  "code": 1001,
  "message": "Request failed",
  "data": null
}
CampoTipoDescripción
codeinteger0 = éxito; cualquier otro valor indica un error
messagestringDescripción legible del error
dataanyPayload de respuesta; null en caso de error

✅ Código de Éxito#

CódigoNombreDescripción
0SUCCESSSolicitud exitosa

Ejemplo

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

❌ Códigos de Error#

🔧 Errores Generales#

CódigoNombreDescripciónAcción Sugerida
1001FAILEDFallo en la solicitud (error genérico)Verifica el campo message para detalles específicos
1003INTERNAL_ERRORError interno del servidorReintente la solicitud tras una breve demora; contacte a soporte si persiste
1011PARAM_ERRORError de parámetro de solicitudVerifica que todos los parámetros requeridos estén proporcionados y tengan un formato correcto

🔐 Errores de Autenticación#

CódigoNombreDescripciónAcción Sugerida
5002API_KEY_INVALIDClave API inválida o faltanteAsegúrese de que el encabezado APIKEY esté incluido y que el valor sea correcto

🛡️ Errores de Moderación de Contenido#

CódigoNombreDescripciónAcción Sugerida
9010SCAN_TEXT_ERROREl texto de entrada falló la revisión de contenido: contiene contenido prohibidoModifique la entrada para eliminar cualquier contenido sensible o ilegal
9038PROHIBITED_CONTENTLa imagen de salida generada contiene contenido prohibidoAjusta la sugerencia/estilo/entradas y reintenta

💰 Errores de Créditos#

CódigoNombreDescripciónAcción Sugerida
9051COINS_NOT_ENOUGHMonedas / créditos insuficientesRecarga los créditos de tu cuenta e intenta de nuevo

📋 Resumen Completo de Códigos de Error#

CódigoNombreDescripción
0SUCCESSSolicitud exitosa
1001FAILEDSolicitud fallida (genérico)
1003INTERNAL_ERRORError interno del servidor
1011PARAM_ERRORError en los parámetros de la solicitud
5002API_KEY_INVALIDClave API inválida
9010SCAN_TEXT_ERROREl texto de entrada contiene contenido prohibido
9038PROHIBITED_CONTENTLa imagen generada contiene contenido prohibido
9051COINS_NOT_ENOUGHSaldo insuficiente de monedas / créditos

📦 Ejemplos de Respuestas de Error#

1001 — Solicitud Fallida#

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

1003 — Error Interno del Servidor#

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

1011 — Error de Parámetros#

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

5002 — Clave API Inválida#

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

9010 — Fallo en Moderación de Contenido de Texto#

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

9038 — Contenido Prohibido en la Salida#

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

9051 — Créditos Insuficientes#

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

💡 Mejores Prácticas para el Manejo de Errores#

  1. Verifique siempre code — No confíe únicamente en los códigos de estado HTTP; inspeccione siempre el campo code en el cuerpo de la respuesta.
  2. Gestione 1001 de forma dinámica — Este es un código de error genérico; el campo message contendrá la razón específica.
  3. Reintente en caso de 1003 — Los errores del lado del servidor suelen ser transitorios; implemente lógica de reintento con retroceso exponencial.
  4. Valide las entradas antes de enviar — Evite errores 1011 validando los campos requeridos en el lado del cliente antes de realizar la llamada a API.
  5. Moderación de contenido — Si recibe 9010 o 9038, revise su contenido según la Política de Contenido de la plataforma antes de volver a enviarlo.

© Ideal House AI — Todos los derechos reservados.