Skip to main content

Documentation Index

Fetch the complete documentation index at: https://doc.deepwl.cn/llms.txt

Use this file to discover all available pages before exploring further.

​
Midjourney Overview

Midjourney-related APIs use a separate set of routes and are not mixed with OpenAI Images or the unified video task structure.
  • Task submission mainly uses /mj/submit/*
  • Task querying mainly uses /mj/task/*
  • Public images can be accessed via /mj/image/{id}
  • Common operations include IMAGINE, BLEND, DESCRIBE, SHORTEN, MODAL, VIDEO, SWAP_FACE

Task Submission

POST /mj/submit/imagine, /blend, /modal, /describe, /shorten, /video, /upload-discord-images, /insight-face/swap

Task Querying

GET /mj/task/{id}/fetch, POST /mj/task/list-by-condition, GET /mj/task/{id}/image-seed

​
Route List

MethodPathDescription
POST/mj/submit/imagineSubmit an Imagine task
POST/mj/submit/blendSubmit a Blend task
POST/mj/submit/modalSubmit a Modal task
POST/mj/submit/describeSubmit a Describe task
POST/mj/submit/shortenSubmit a Shorten task
POST/mj/submit/videoSubmit a Video task
POST/mj/submit/upload-discord-imagesUpload images to Discord
POST/mj/insight-face/swapSubmit a SwapFace task
GET/mj/task/{id}/fetchQuery a single task
POST/mj/task/list-by-conditionQuery tasks in batches
GET/mj/task/{id}/image-seedQuery the task seed
GET/mj/image/{id}Proxy and return the task image

​
Common Return Codes

The common response structure for Midjourney submission APIs is: 
{
  "code": 1,
  "description": "Submit success",
  "result": "1712158011464906"
}
Common code meanings:
codeDescription
1Submission successful
21Task already exists, usually indicating an existing task is in progress or a result already exists
22Queued
23The queue is full, please try again later
24The prompt may contain sensitive words
4Local parameter validation or gateway processing error
30The current group load is saturated
The current gateway converts some upstream 21 and 22 states into success responses back to the client, so in actual use you may see a successful response while the task is still effectively in an “already exists” or “queued” state. The safe approach is still to take the task ID in result and query the task status again.

​
Common Field Conventions

FieldDescription
modeCommon values are RELAX and FAST; the project also includes a TURBO billing mode
notifyHookCallback URL; the current project code uses the camelCase form notifyHook
taskIdOriginal task ID, used to continue operations based on an existing task
base64ArrayMulti-image Base64 array
maskBase64Inpainting mask
stateCustom passthrough field
  1. Midjourney Task Submission
  2. Midjourney Task Querying
  3. Image Series Overview