API เอกสารอ้างอิงรหัสข้อผิดพลาด#

** URL พื้นฐาน:** https://api.ideal.house
เวอร์ชัน: v1
อัปเดต: 2026-03-06

📖 ภาพรวม#

การตอบสนองของ API ทั้งหมดใช้โครงสร้าง JSON แบบรวมศูนย์ เมื่อเกิดข้อผิดพลาด ฟิลด์ code จะมีรหัสข้อผิดพลาดที่ไม่ใช่ศูนย์ และฟิลด์ message จะให้คำอธิบายข้อผิดพลาดที่อ่านเข้าใจง่าย

รูปแบบการตอบสนองแบบรวมศูนย์

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

✅ รหัสสำเร็จ#

ตัวอย่าง

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

❌ รหัสข้อผิดพลาด#

🔧 ข้อผิดพลาดทั่วไป#

🔐 ข้อผิดพลาดการยืนยันตัวตน#

🛡️ ข้อผิดพลาดการตรวจสอบเนื้อหา#

💰 ข้อผิดพลาดเครดิต#

📋 สรุปรหัสข้อผิดพลาดทั้งหมด#

📦 ตัวอย่างการตอบสนองข้อผิดพลาด#

1001 — คำขอล้มเหลว#

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

1003 — ข้อผิดพลาดภายในเซิร์ฟเวอร์#

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

1011 — ข้อผิดพลาดพารามิเตอร์#

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

5002 — API Key ไม่ถูกต้อง#

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

9010 — การตรวจสอบเนื้อหาข้อความล้มเหลว#

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

9038 — เนื้อหาผลลัพธ์ต้องห้าม#

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

9051 — เครดิตไม่เพียงพอ#

{
  "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 — สงวนลิขสิทธิ์.