API Reference

Webhooks

View Markdown

Completion notifications for image tasks.

Current availability

The image, video and audio task APIs currently use polling. They do not provide a public completion webhook or accept a callback URL.

Check for completion

Use GET /v1/tasks/{id} with your API key and check every few seconds until status is completed or failed.

If your application needs a notification, run this polling loop on your server and notify your own client when the task reaches a terminal state. Keep your API key on the server.

See Tasks for response fields and a polling example.