进阶 docs.leonardo.ai 2026-11-22 15:11:20 · 0 阅读
第62章 Leonardo Webhook 回调功能使用指南
Webhook 回调功能指南
生成图像需要几秒钟才能完成。与其反复轮询 Get a Single Generation API 端点,不如直接接收一条包含图片链接及其他元数据的消息,效率更高。要接收消息,你需要使用 webhook 回调功能。
设置 Webhook 回调
创建 production API key 时,你可以填写 webhook callback URL 和 webhook callback API key。
📘 注意
创建 API key 时,webhook callback URL 和 webhook callback API key 不是必填项。
webhook callback URL 必须使用 HTTPS。
webhook callback API key 用于对发到你 webhook 的请求进行身份验证,会以 authorization: Bearer $yourWebhookCallbackApiKey 的形式附加在请求头中。
如需更新 webhook callback URL 和 webhook callback API key,你需要用新的 webhook 信息创建一个新的 production API key,切换到新 key 后再删除旧的。
检查 Leonardo 发给你 webhook 的请求
很多用户发现,先用 Webhook.site 这类在线工具观察 Leonardo 发来的请求很有帮助。借助这类工具,你可以分析:
请求来自哪个主机、哪个地区,以便决定是否放行这些请求?
Leonardo 发送了哪些请求头,以确保你的 Web 服务器、防火墙、安全工具等不会拦截请求?
webhook callback API key 是否被正确传递?
用在线工具(Webhook.site)检查 HTTP 请求的示例截图。
🚧 没有在 webhook 里收到 Leonardo 的消息?
请注意,webhook callback API key 会以 authorization: Bearer $yourWebhookCallbackApiKey 的形式附加在请求头中,请确保你的系统能处理这个请求头。
请检查你的系统是否有按 IP 地址、地区、请求头等方式拦截流量的规则。
请检查 SSL 证书是否配置正确。例如,运行 openssl s_client -showcerts -connect YOUR_DOMAIN:443 -servername YOUR_DOMAIN 来确认服务器证书和中间证书是否正确设置。
发到你 webhook 的请求示例
以下是 Leonardo 向 webhook 回调发起的请求示例:
curl -X 'POST' \
'https://webhook.site/cc21af5f-4caa-498e-8f26-20c664680b73' \
-H 'connection: close' \
-H 'host: webhook.site' \
-H 'accept-encoding: gzip, compress, deflate, br' \
-H 'content-length: 3166' \
-H 'user-agent: axios/1.4.0' \
-H 'authorization: Bearer abcd' \
-H 'content-type: application/json' \
-H 'accept: application/json, text/plain, */*' \
-d '{
"type": "image_generation.complete",
"object": "generation",
"timestamp": 1699490546932,
"api_version": "v1",
"data": {
"object": {
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"createdAt": "2023-11-09T00:42:22.707Z",
"updatedAt": "2023-11-09T00:42:26.740Z",
"userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"public": false,
"flagged": false,
"nsfw": false,
"status": "COMPLETE",
"coreModel": "SD",
"guidanceScale": 7,
"imageHeight": 512,
"imageWidth": 512,
"inferenceSteps": 30,
"initGeneratedImageId": null,
"initImageId": null,
"initStrength": null,
"initType": null,
"initUpscaledImageId": null,
"modelId": "6bef9f1b-29cb-40c7-b9df-32b51c1f67d3",
"negativePrompt": "",
"prompt": "An oil painting of a cat",
"quantity": 1,
"sdVersion": "v2",
"tiling": false,
"imageAspectRatio": null,
"tokenCost": 0,
"negativeStylePrompt": "",
"seed": "905778432",
"scheduler": "EULER_DISCRETE",
"presetStyle": null,
"promptMagic": false,
"canvasInitImageId": null,
"canvasMaskImageId": null,
"canvasRequest": false,
"api": true,
"poseImage2Image": false,
"imagePromptStrength": null,
"category": null,
"poseImage2ImageType": null,
"highContrast": false,
"apiDollarCost": "9",
"poseImage2ImageWeight": null,
"alchemy": null,
"contrastRatio": null,
"highResolution": null,
"expandedDomain": null,
"promptMagicVersion": null,
"unzoom": null,
"unzoomAmount": null,
"apiKeyId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"photoReal": false,
"promptMagicStrength": null,
"photoRealStrength": null,
"imageToImage": false,
"controlnetsUsed": false,
"model": {
"id": "6bef9f1b-29cb-40c7-b9df-32b51c1f67d3",
"createdAt": "2023-01-06T01:02:38.315Z",
"updatedAt": "2023-03-01T11:45:06.428Z",
"name": "Leonardo Creative",
"description": "An alternative finetune of SD 2.1 that brings a little more creative interpretation to the mix.",
"public": true,
"userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"flagged": false,
"nsfw": false,
"official": true,
"status": "COMPLETE",
"classPrompt": null,
"coreModel": "SD",
"initDatasetId": null,
"instancePrompt": null,
"sdVersion": "v2",
"trainingEpoch": null,
"trainingSteps": null,
"tokenCost": null,
"batchSize": 4,
"learningRate": null,
"type": "GENERAL",
"modelHeight": 768,
"modelWidth": 768,
"leonardoInstancePrompt": null,
"trainingStrength": "MEDIUM",
"featured": false,
"featuredImageId": null,
"featuredPosition": 4,
"api": false,
"favouriteCount": 0,
"imageCount": 2416039,
"enhancedModeration": false,
"apiDollarCost": null,
"apiKeyId": null,
"modelLRN": null
},
"images": [
{
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"createdAt": "2023-11-09T00:42:26.733Z",
"updatedAt": "2023-11-09T00:42:26.733Z",
"userId": "ef8b8386-94f7-48d1-b10e-e87fd4dee6e6",
"url": "https://cdn.leonardo.ai/users/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/generations/XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX/Leonardo_Creative_An_oil_painting_of_a_cat_0.jpg",
"generationId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"nobgId": null,
"nsfw": false,
"likeCount": 0,
"trendingScore": 0,
"public": false
}
],
"apiKey": {
"id": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"createdAt": "2023-11-07T00:11:07.274Z",
"userId": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"key": "XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX",
"lastUsed": "2023-11-07T00:11:07.274Z",
"name": "webhook with key",
"type": "PRODUCTION",
"webhookCallbackUrl": "https://webhook.site/cc21af5f-4caa-498e-8f26-20c664680b73",
"webhookCallbackApiKey": "abcd"
}
}
}
}
'
Leonardo 请求使用的 IP 范围 发往您 Webhook 的请求将来自以下 IP 地址: 35.173.108.170 34.239.69.60 52.73.75.186 3.229.99.26 44.218.0.197 174.129.230.221 请务必将这些 IP 加入您的允许列表,以确保 Leonardo.Ai 能够向您的 Webhook 发送请求。更新于 10 个月前 此页面有帮助吗?
Leonardo 请求使用的 IP 范围 发往您 Webhook 的请求将来自以下 IP 地址: 35.173.108.170 34.239.69.60 52.73.75.186 3.229.99.26 44.218.0.197 174.129.230.221 请务必将这些 IP 加入您的允许列表,以确保 Leonardo.Ai 能够向您的 Webhook 发送请求。更新于 10 个月前 此页面有帮助吗?