Webhook delivery channel for image generation job status events. Events are sent as HTTP POST requests with a JSON payload containing the full job object. The webhook_type parameter specified during job creation controls whether progress updates or only final results are delivered.
Sent when a job's progress percentage updates during processing. Only delivered when webhook_type is set to progress.
Content-Type: application/json
jobCompleted
Sent when a job finishes successfully and generated images are available for download. The result field contains URLs of all generated images.
Content-Type: application/json
jobFailed
Sent when a job fails due to an error such as content policy violation, invalid parameters, or an internal processing error. The error field contains details about the failure.
Content-Type: application/json
jobCancelled
Sent when a job is cancelled by the user before completion.
Content-Type: application/json
About AsyncAPI
The AsyncAPI specification describes event-driven APIs the way OpenAPI describes request/response APIs. A channel is the named pipe — a webhook URL, a Kafka topic, a WebSocket route, an MQTT subject — that producers and consumers publish or subscribe to. Each channel carries one or more messages with structured payloads, and an operation declares whether a given party sends or receives on that channel.
Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.
Get an API key
Free tier, no form to fill in. Signing in shares your email address with us — we
store it to create your key and to recognise you if you sign in with another
provider. See our Privacy Policy and
Terms.