A completed image will return an array of buttons which you can subsequently invoke on the image. These buttons are dynamic and a list of buttons you can press are included in every image completion. This may include buttons such as
upscale (U1, U2, U3, U4),
variations (V1, V2, V3, V4, 🔄),
pan and more. .
buttonMessageIdreturned in your webhook URL
buttonSend in any button seen in your previous response. You'll need to include the emoji and label exactly as received in your Webhook URL response from a previous request.
ref (optional)You can optionally pass
refin your command - which can be used useful when using webhooks
You can optionally pass
webhookOverride that will route a response to a webhook of your choosing.
Please note that using a webhook is completely optional. You are welcome to use the GET Message endpoint to retrieve responses.
Custom Zoom Options
Include a prompt in your request body to alter the original prompt.
Custom Zoom as a button, you will need to pass in a value between 1 and 2 for custom zoom
Custom Zoom as a button you can choose to add in an aspect ratio parameter such as
Your response will return a
messageId. Use the
messageId at the GET Message endpoint to poll for results, or to you can wait for the result to arrive via webhook.
Get your progress and retrieve a Message using GET
After receiving your
messageId you can use the GET /v2/message/<messageId> in order to retrieve your progress and image.
See the GET /v2/message/<messageId> docs for more information.
Completed ResponseThe message you receive by using the GET Message endpoint or received via your webhook, will have the following:
🚧 Note: You should be aware that content will also return messages from Midjourney including: