MidJourney Inpaint

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. inpaint 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_inpaint

---

jobId string required

Task ID

---

imageNo integer required

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

Options: 0, 1, 2, 3

---

mask object required

Mask parameters, must contain areas or url

areas array

Array of mask area objects

width integer

Area width

Range: 500 - 4096

height integer

Area height

Range: 500 - 4096

points array

Array of area coordinate points, must contain at least 6 coordinate values (3 points)

url string

Mask image URL

---

remixPrompt string

Remix prompt, length must be between 1-8192 characters

---

callback string

Callback URL, 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 Code	Description
004006001	Task ID missing
004006002	Image number missing
004006003	Invalid image number
004006004	Invalid remix prompt length
004006005	Mask parameters missing
004006006	Invalid mask parameters
004006007	Invalid callback URL
004006098	Generation failed
004006099	Service unavailable