{
"id": "<string>",
"model": "<string>",
"input": {},
"outputs": [
{
"url": "<string>"
}
],
"cost": {
"currency": "USD",
"estimated": "<string>",
"amount": "<string>",
"usage": [
{
"unit": "<string>",
"quantity": 1,
"unit_price": "<string>"
}
]
},
"error": {
"message": "<string>",
"retryable": true,
"param": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z"
}Generation completed
Sent to the webhook_url of a generation once it succeeds or fails, with the same body as GET /generations/{id}. Delivered at least once and retried with exponential backoff for 24 hours. Verify the signature before trusting the body.
{
"id": "<string>",
"model": "<string>",
"input": {},
"outputs": [
{
"url": "<string>"
}
],
"cost": {
"currency": "USD",
"estimated": "<string>",
"amount": "<string>",
"usage": [
{
"unit": "<string>",
"quantity": 1,
"unit_price": "<string>"
}
]
},
"error": {
"message": "<string>",
"retryable": true,
"param": "<string>"
},
"created_at": "2023-11-07T05:31:56Z",
"started_at": "2023-11-07T05:31:56Z",
"completed_at": "2023-11-07T05:31:56Z"
}Headers
Event ID, the same on every retry of a delivery; use it to drop duplicates.
When the delivery was sent, in Unix seconds.
Space-separated v1,<base64> HMAC-SHA256 signatures of <webhook-id>.<webhook-timestamp>.<body>, made with your webhook signing secret (whsec_…).
Body
The finished generation, as GET /generations/{id} returns it.
ID of the generation.
^gen_Slug of the model, as submitted.
The terminal state.
succeeded, failed The input, normalized: input assets point at Codzen copies; other fields are as submitted.
Show child attributes
Show child attributes
Delivered outputs; empty until the generation succeeds.
Show child attributes
Show child attributes
What the generation costs.
Show child attributes
Show child attributes
Why the generation failed; null unless it failed.
Show child attributes
Show child attributes
ISO 8601 time in UTC.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$When processing started; null while queued.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$When the generation finished; null until then.
^(?:(?:\d\d[2468][048]|\d\d[13579][26]|\d\d0[48]|[02468][048]00|[13579][26]00)-02-29|\d{4}-(?:(?:0[13578]|1[02])-(?:0[1-9]|[12]\d|3[01])|(?:0[469]|11)-(?:0[1-9]|[12]\d|30)|(?:02)-(?:0[1-9]|1\d|2[0-8])))T(?:(?:[01]\d|2[0-3]):[0-5]\d:[0-5]\d(?:\.\d+)?(?:Z))$Response
Received. Any 2xx status ends the delivery; any other answer is retried.