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. 전송 전 입력 검증 — API 호출 전에 클라이언트 측에서 필수 필드를 검증하여 1011 오류를 방지하세요.
  5. 콘텐츠 검토9010 또는 9038을 받으면 다시 제출하기 전에 플랫폼의 콘텐츠 정책에 따라 콘텐츠를 검토하세요.

© Ideal House AI — 모든 권리 보유.