เอกสาร

เว็บฮุก

เว็บฮุกช่วยให้แจ้งเตือนแบบอะซิงโครนัสเมื่องานสร้างเสร็จสิ้น แทนที่จะ polling API สำหรับผลลัพธ์ ให้ระบุ URL เว็บฮุกเพื่อรับคำขอ POST ที่มีผลลัพธ์การสร้าง

การใช้เว็บฮุก

เพิ่มพารามิเตอร์ {code} ในคำขอสร้างของคุณ เมื่องานเสร็จสิ้น (หรือล้มเหลว) เราจะส่งคำขอ POST ไปยัง endpoint ของคุณ:

{
  "type": "text-to-image",
  "model": "flux-dev",
  "prompt": "A beautiful sunset over mountains",
  "webhook_url": "https://your-app.com/webhooks/renderful"
}

เนื้อหาเว็บฮุก

Endpoint ของคุณจะได้รับคำขอ POST พร้อมเนื้อหา JSON ดังนี้:

{
  "event": "generation.completed",
  "data": {
    "id": "gen_abc123",
    "status": "completed",
    "model": "flux-dev",
    "outputs": ["https://..."],
    "created_at": "2024-01-15T10:30:00Z",
    "completed_at": "2024-01-15T10:30:15Z"
  }
}