Light Mode
Imagine
POST
/api/v1/taskThis endpoint from PiAPI's Midjourney API generates 4 unique images in a 2x2 grid from a text description also known as prompt. This endpoint corresponds with the /imagine
command from the offical Midjourney.
Request
Header Params
x-api-key
string
required
Your API Key for authorization.
Body Params application/json
model
enum<string>
required
Allowed value:
midjourney
task_type
enum<string>
required
Allowed value:
imagine
input
object
required
prompt
string
required
A prompt is a description that enables Midjourney API to produce an image.
aspect_ratio
string
optional
This parameter dictates the ouput image's aspect ratio value.
Default:
1:1
process_mode
enum<string>
optional
This parameter indicates the operation process mode
Allowed values:
relaxfastturbo
skip_prompt_check
boolean
optional
Use this parameter to skip our internal prompt check.
Default:
false
bot_id
integer
optional
Only Host-Your-Account users on the Pro Plan can use this parameter. This parameter specifies which Midjourney account will process this task.
Example
{
"model": "midjourney",
"task_type": "imagine",
"input": {
"prompt": "flying night city",
"aspect_ratio": "16:9",
"process_mode": "fast",
"skip_prompt_check": false,
"bot_id": 0
},
"config": {
"service_mode": "",
"webhook_config": {
"endpoint": "https://webhook.site/",
"secret": "123456"
}
}
}
Request samples
Responses
Success(200)
HTTP Code: 200
Content Type : JSONapplication/json
Data Schema
object {0}
Example
{
"code": 200,
"data": {
"task_id": "39631ce-xxxx-xxxx-xxxx-6de760cd2053",
"model": "midjourney",
"task_type": "imagine",
"status": "pending",
"config": {
"service_mode": "public",
"webhook_config": {
"endpoint": "",
"secret": ""
}
},
"input": {},
"output": {
"image_url": "",
"image_urls": null,
"temporary_image_urls": null,
"discord_image_url": "",
"actions": [],
"progress": 0,
"intermediate_image_urls": null
},
"meta": {},
"detail": null,
"logs": [],
"error": {
"code": 0,
"raw_message": "",
"message": "",
"detail": null
}
},
"message": "success"
}
Last modified: 11 days ago