~/Documentation
文件

Webhooks

Webhooks 在您的生成任務完成時啟用非同步通知。無需輪詢 API 取得結果,只需提供 webhook URL 即可接收包含生成結果的 POST 請求。

使用 Webhooks

在您的生成請求中加入 {code} 參數。當任務完成(或失敗)時,我們將向您的端點發送 POST 請求:

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

Webhook 酬載

您的端點將收到包含以下 JSON 酬載的 POST 請求:

{
  "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"
  }
}