Pan

The API simulates a Pan button click on the Midjourney channel. 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.

Request

Authorization

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

Body Params application/json

messageId

string

required

The unique identifier you get from your previous image generation request.

button

enum<string>

required

The valid button action for Midjourney. The button value needs be within the "buttons" array in /message endpoint's response. E.g. ⬅️, ➡️, ⬆️, ⬇️.

Allowed values:

⬅️➡️⬆️⬇️

ref

string

optional

The reference metadata which will return as part of the webhook.

webhookOverride

string

optional

The webhook URL which the response will send to, the payload of this webhook is same as our Message endpoint.

Example

{
  "messageId": "string",
  "button": "⬅️",
  "ref": "string",
  "webhookOverride": "string"
}

Responses

🟢200Success

application/json

Body

success

boolean

required

The status of the request.

messageId

string

required

The messageId of the request, which will be used for querying the progress, sending subsequential actions later, etc.

createdAt

string

required

The timestamp of the job creation.

error

string

optional

The error message, if any

Example

{
  "success": true,
  "messageId": "d15c1541-229a-442b-9873-d3494dede12a",
  "createdAt": "2023-08-01T14:03:01.817Z"
}

Request

Request samples

Responses