POST/mj/submit/action

Do Actions(Upscale Vary)

This endpoint allows you to retrieve a paginated list of all your messages (in a conversation if a conversation id is provided). By default, a maximum of ten messages are shown per page.

Required attributes

  • Name
    chooseSameChannel
    Type
    boolean
    Description

    Whether to choose accounts under the same channel, by default only use accounts associated with the task

  • Name
    customId
    Type
    string
    Description

    Action identifier, example value (MJ::JOB::upsample::2::3dbbd469-36af-4a0f-8f02-df6c579e7011)

  • Name
    taskId
    Type
    string
    Description

    Task ID, example value (14001934816969359)

  • Name
    notifyHook
    Type
    string
    Description

    Callback address, use the global notifyHook if empty

  • Name
    state
    Type
    string
    Description

    Custom parameters

Request

GET
/mj/submit/action
{
  "chooseSameChannel": true,
  "customId": "MJ::JOB::upsample::2::3dbbd469-36af-4a0f-8f02-df6c579e7011",
  "taskId": "14001934816969359",
  "notifyHook": "",
  "state": ""
}

Response

{
    "code": 1,
    "description": "Submit Success",
    "properties": {},
    "result": 1320098173412546
}
POST/mj/submit/blend

Blend Tasks

This endpoint allows you to send a new message to one of your conversations.

Required attributes

  • Name
    botType
    Type
    string
    Description

    Bot type, mj (default) or niji, Available values: MID_JOURNEY, NIJI_JOURNEY, Example value (MID_JOURNEY) false

  • Name
    base64Array
    Type
    array[string]
    Description

    Array of image base64 strings, Example value ([ "data:image/png;base64,xxx1", "data:image/png;base64,xxx2" ])

  • Name
    dimensions
    Type
    string
    Description

    Aspect ratio: PORTRAIT(2:3); SQUARE(1:1); LANDSCAPE(3:2), Available values: PORTRAIT, SQUARE, LANDSCAPE, Example value (SQUARE) false

  • Name
    notifyHook
    Type
    string
    Description

    Callback URL, use global notifyHook if empty false

  • Name
    state
    Type
    string
    Description

    Custom parameters false

Request

POST
/mj/submit/blend
{
  "botType": "MID_JOURNEY",
  "base64Array": [
  "data:image/png;base64,xxx1",
  "data:image/png;base64,xxx2"
],
  "dimensions": "SQUARE",
  "notifyHook": "",
  "state": ""
}

Response

{
    "code": 1,
    "description": "Submit Success",
    "properties": {},
    "result": 1320098173412546
}
POST/mj/submit/describe

Describe Tasks

This endpoint allows you to retrieve a message by providing the message id. Refer to the list at the top of this page to see which properties are included with message objects.

Required attributes

  • Name
    botType
    Type
    string
    Description

    Bot type, mj (default) or niji, Available values: MID_JOURNEY, NIJI_JOURNEY, Example value (MID_JOURNEY) false

  • Name
    base64
    Type
    string
    Description

    Image base64, Example value (data:image/png;base64,xxx)

  • Name
    notifyHook
    Type
    string
    Description

    Callback URL, use global notifyHook if empty false

  • Name
    state
    Type
    string
    Description

    Custom parameters false

Request

GET
/mj/submit/describe
{
  "botType": "MID_JOURNEY",
  "base64": "data:image/png;base64,xxx",
  "notifyHook": "",
  "state": ""
}

Response

{
    "code": 1,
    "description": "Submit Success",
    "properties": {},
    "result": 1320098173412546
}
POST/mj/submit/imagine

Imagine Tasks

This endpoint allows you to perform an update on a message. Examples of updates are adding a reaction, editing the message, or adding an attachment.

Required attributes

  • Name
    botType
    Type
    string
    Description

    Bot type, mj (default) or niji, Available values: MID_JOURNEY, NIJI_JOURNEY, Example value (MID_JOURNEY) false

  • Name
    prompt
    Type
    string
    Description

    Prompt, Example value (Cat)

  • Name
    base64Array
    Type
    array[string]
    Description

    Base64 array of background images false

  • Name
    notifyHook
    Type
    string
    Description

    Callback URL, use global notifyHook if empty false

  • Name
    state
    Type
    string
    Description

    Custom parameters false

Request

PUT
/mj/submit/imagine
{
  "botType": "MID_JOURNEY",
  "prompt": "Cat",
  "notifyHook": "",
  "state": ""
}

Response

{
  "code": 1,
  "description": "Submit Success",
  "properties": {},
  "result": 1320098173412546
}
POST/mj/submit/modal

This endpoint allows you to delete messages from your conversations. Note: This will permanently delete the message.

Required attributes

  • Name
    maskBase64
    Type
    string
    Description

    Base64 of the mask for partial redrawing false

  • Name
    prompt
    Type
    string
    Description

    Prompt false

  • Name
    taskId
    Type
    string
    Description

    Task ID, Example value (14001934816969359)

Request

POST
/mj/submit/modal
{
  "maskBase64": "",
  "prompt": "",
  "taskId": "14001934816969359"
}

Response

{
  "code": 1,
  "description": "Submit Success",
  "properties": {},
  "result": 1320098173412546
}
POST/mj/submit/shorten

Shorten Tasks

This endpoint allows you to delete messages from your conversations. Note: This will permanently delete the message.

Required attributes

  • Name
    botType
    Type
    string
    Description

    Bot type, mj (default) or niji, Available values: MID_JOURNEY, NIJI_JOURNEY, Example value (MID_JOURNEY) false

  • Name
    prompt
    Type
    string
    Description

    Prompt, Example value (Cat)

  • Name
    notifyHook
    Type
    string
    Description

    Callback URL, use global notifyHook if empty false

  • Name
    state
    Type
    string
    Description

    Custom parameters false

Request

POST
/mj/submit/shorten
{
  "botType": "MID_JOURNEY",
  "prompt": "Cat",
  "notifyHook": "",
  "state": ""
}

Response

{
  "code": 1,
  "description": "Submit Success",
  "properties": {},
  "result": 1320098173412546
}

Was this page helpful?