ドキュメント

Webhook

Webhookは、生成タスクが完了したときに非同期通知を可能にします。結果のためにAPIをポーリングする代わりに、Webhook URLを提供して生成結果を含むPOSTリクエストを受信します。

Webhookの使用

生成リクエストに {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"
  }
}