Modal

The Modal API supplies a prompt or mask to a subsequent action that requires additional input, such as inpainting. taskId must identify the original task. Whether a mask or prompt is required depends on the selected action.

POST/mj/submit/modal

Submit a prompt and an optional mask for a subsequent action that requires additional input.

Authorization

bearerAuth

AuthorizationBearer <token>

Use Bearer your-api-key in the Authorization header.

In: header

Request Body

application/json

Modal request parameters.

TypeScript Definitions

Use the request body type in TypeScript.

maskBase64?string

Base64-encoded mask image used for inpainting.

prompt?string

Text instruction describing how to redraw the selected area.

taskId*string

Original task ID.

Length1 <= length

Response Body

`application/json`

curl -X POST "https://example.com/mj/submit/modal" \  -H "Content-Type: application/json" \  -d '{    "maskBase64": "data:image/png;base64,MASK_BASE64",    "prompt": "Replace the selected area with blooming flowers",    "taskId": "14001934816969359"  }'

{
  "code": 1,
  "description": "Submitted successfully",
  "properties": {},
  "result": 1320098173412546
}

Authorization

Request Body

Response Body

200application/json

400application/json

401application/json

403application/json

404application/json

429application/json

500application/json

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`

`application/json`