⌘K

MidJourney Edit

midjourney_edit

MidJourney Edit provides intelligent image editing capabilities with prompt-based modifications.

MidJourney API Notes

The MidJourney API is divided into two categories: Direct Generation and Secondary Editing. Direct Generation only requires providing necessary parameters such as prompts to generate images directly. Secondary Editing requires providing the previous task ID and image number to execute image generation. edit is a Secondary Editing category

Authentication

authorization string required

All APIs require authentication via Bearer Token.

Get API Key:

Visit API Key Management Page to get your API Key

Usage:

Add to request header:

Authorization: Bearer YOUR_API_KEY

Parameters

model string required

Model ID to use for the request

Options: midjourney_edit


jobId string required

Task ID


imageNo integer required

Image number, must be 0, 1, 2 or 3

Options: 0, 1, 2, 3


canvas object required

Canvas object

width integer required

Canvas width in pixels

height integer required

Canvas height in pixels


imgPos object required

Image position and size relative to canvas

width integer required

Image width in pixels

height integer required

Image height in pixels

x integer required

Horizontal offset from canvas top-left corner

y integer required

Vertical offset from canvas top-left corner


remixPrompt string required

Prompt text, length must be between 1-8192 characters


mask object

Original image repaint area


callback string

Callback URL for task result notification, must be valid HTTP/HTTPS URL


Polling

Since result generation takes time, you need to poll the task status after creating the task.

The initial response only returns information such as the task ID and initial status. The final result must be obtained by polling the task status endpoint using the task ID.

See the examples on the right for polling requests and responses.

Response Format

error object

Error information. Only present when status is failed.

code integer

Error code.

error_message string

Detailed error message.


output array

Generation results. Only present when status is completed.

content array

List of generated content.

type string

Resource type, e.g., video, image.

url string

Generated content URL.


usage object

Usage statistics. Only present when status is completed.

cost string

Total cost in USD.

discount number

Discount amount.


metadata object

Metadata information


Error Codes

Error CodeDescription
004007001Task ID missing
004007002Image number missing
004007003Invalid image number
004007004Prompt missing
004007005Invalid prompt length
004007006Canvas parameters missing
004007007Image position parameters missing
004007008Invalid callback URL
004007098Generation failed
004007099Service unavailable