文档

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