Describe Endpoint - Midjourney API

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.

config

object

optional

webhook_config

object

optional

Webhook provides timely task notifications. Check PiAPI webhook for detail.

service_mode

enum<string>

optional

This allows users to choose whether this specific task will get processed under PAYG or HYA mode. If unspecified, then this task will get processed under whatever mode (PAYG or HYA)
the user chose on the workspace setting of your account.

public means this task will be processed under PAYG mode.

private means this task will be processed under HYA mode.

Allowed values:

publicprivate

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

Shell

JavaScript

Java

Swift

Go

PHP

Python

HTTP

C

C#

Objective-C

Ruby

OCaml

Dart

R

curl --location --request POST 'https://api.piapi.ai/api/v1/task' \
--header 'X-API-Key;' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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": ""
        }
    }
}'

Responses

🟢200OK

application/json

OK - Successful response

Body

code

integer

required

data

object

required

task_id

string

required

model

string

required

task_type

string

required

status

enum<string>

required

Hover on the "Completed" option and you coult see the explaintion of all status: completed/processing/pending/failed/staged

Allowed values:

CompletedProcessingPendingFailedStaged

input

object

required

output

object

required

meta

object

required

detail

null

required

logs

array [object]

required

error

object

required

message

string

required

If you get non-null error message, here are some steps you chould follow:

Check our common error message

Retry for several times

If you have retried for more than 3 times and still not work, file a ticket on Discord and our support will be with you soon.

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"
}

🟠400Bad Request

🟠401Unauthorized

🔴500Server Error