Light Mode
Describe
POST
/api/v1/taskThis endpoint from PiAPI's Midjourney API produces four prompts based on the input image. The endpoint corresponds to the Describe
command from the official Midjourney.
Request
Header Params
X-API-Key
string
required
Insert your API Key here
Body Params application/json
model
enum<string>
required
Allowed value:
midjourney
task_type
enum<string>
required
Allowed value:
describe
input
object
required
image_url
string
required
Upload the image URL into this parameter (the URL should end with '.png', '.jpeg', or other valid image format.
process_mode
enum<string>
optional
This parameter indicates the operation process mode.
Allowed values:
relaxfastturbo
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": "describe",
"input": {
"image_url": "http://midjourney-guigu.oss-us-west-1.aliyuncs.com/images/75ed4202402292139294887.jpg",
"process_mode": "fast",
"bot_id": 0
},
"config": {
"service_mode": "",
"webhook_config": {
"endpoint": "",
"secret": ""
}
}
}
Request samples
Responses
OK(200)
Bad Request(400)
Unauthorized(401)
Server Error(500)
HTTP Code: 200
Content Type : JSONapplication/json
OK - Successful response
Data Schema
object {0}
Example
{
"code": 200,
"data": {
"task_id": "e7d57239-d490-4433-83b2-0e78a8cebf95",
"model": "midjourney",
"task_type": "describe",
"status": "pending",
"config": {
"service_mode": "public",
"webhook_config": {
"endpoint": "",
"secret": ""
}
},
"input": {},
"output": {
"description": ""
},
"meta": {},
"detail": null,
"logs": [],
"error": {
"code": 0,
"raw_message": "",
"message": "",
"detail": null
}
},
"message": "success"
}
Last modified: 11 days ago