POST/mj/submit/modal

提交Modal

提交需要输入参数的 Modal 操作，例如 Remix 或 Custom Zoom。

API Key application/json

MJ 异步任务协议

调用与返回说明

提交提交 Modal 任务。MJ 接口采用“提交任务 → 保存任务 ID → 查询/回调 → 读取结果或执行后续动作”的异步模式，不是同步返回图片或视频。

请求时注意

所有 MJ 接口都要在 Header 中发送 Authorization: Bearer <API_KEY>。生产环境请从服务端环境变量读取 Key。
请求地址使用当前站点配置的 API Base URL 拼接本文 endpoint；不要把 /v1 误加到 /mj 路径，也不要重复拼接 Base URL。
Modal 不是通用文本接口；必须先从任务状态确认任务处于 MODAL 或服务端要求 Modal 的阶段。

返回时注意

先检查 HTTP 状态，再检查响应体中的 code 或 status。提交接口的 code=1 通常表示成功接收，result 才是后续查询使用的任务 ID。
提交后继续按新的 result 任务 ID 查询；输入 prompt 或 maskBase64 前确认客户端已完成必要的用户确认。
任务查询的终态包括 SUCCESS、FAILURE、CANCEL；MODAL 表示需要继续提交 Modal。不要只根据 progress=100% 判定成功。

请求示例

curl -X POST https://top.qingyuntop.ai/mj/submit/modal \
  -H "Authorization: Bearer ${QINGYUN_TOP_API_KEY}" \
  -H "Content-Type: application/json" \
  -d '{
  "taskId": "TASK_ID",
  "prompt": "new prompt"
}'

请求参数

参数	位置	类型	必填	说明	示例
`Authorization`	Header	string	是	必填。Bearer API Key，例如 Bearer ${QINGYUN_TOP_API_KEY}。不要把真实 Key 写入前端、日志或代码仓库。	-
`taskId`	JSON body	string	是	等待 Modal 的原任务 ID。	TASK_ID
`prompt`	JSON body	string	否	Modal 要提交的新提示词。	-
`maskBase64`	JSON body	string	否	局部重绘使用的蒙版 Base64。	-
`noStorage`	JSON body	boolean	否	为 true 时返回原始图片链接。	false

返回响应 (200)

HTTP 成功不等于任务成功；请继续检查响应体中的 code 或 status。

参数	位置	类型	必填	说明	示例
`code`	响应 JSON	integer	否	业务状态码。通常 1 表示提交成功，22 表示已进入排队；其他值表示提交失败。	-
`description`	响应 JSON	string	否	提交结果描述。	-
`result`	响应 JSON	string	否	任务 ID。提交成功后用它查询任务或执行后续 Action/Modal。	-
`properties`	响应 JSON	object	否	可选的服务端任务属性，例如 Discord 频道或实例信息。不要依赖未定义的子字段。	-

响应示例

{
  "code": 1,
  "description": "Submit success",
  "result": "TASK_ID",
  "properties": {}
}

来源原始接口定义（用于追溯）

以下内容来自 Apifox 快照，可能包含兼容层字段或旧示例；公开调用请以本页的协议说明和当前模型列表为准。

{
  "method": "post",
  "path": "/mj/submit/modal",
  "description": "提交需要输入参数的 Modal 操作，例如 Remix 或 Custom Zoom。",
  "parameters": {
    "header": [
      {
        "name": "Authorization",
        "type": "string",
        "required": true,
        "description": "Bearer API Key。所有 MJ 接口都必须携带；不要把真实 Key 写入前端、日志或代码仓库。",
        "sampleValue": "Bearer ${QINGYUN_TOP_API_KEY}"
      }
    ],
    "path": []
  },
  "requestBody": {
    "type": "application/json",
    "jsonSchema": {
      "type": "object",
      "properties": {
        "taskId": {
          "type": "string",
          "description": "等待 Modal 的原任务 ID。",
          "example": "TASK_ID"
        },
        "prompt": {
          "type": "string",
          "description": "Modal 要提交的新提示词。"
        },
        "maskBase64": {
          "type": "string",
          "description": "局部重绘使用的蒙版 Base64。"
        },
        "noStorage": {
          "type": "boolean",
          "description": "为 true 时返回原始图片链接。",
          "example": "false"
        }
      },
      "required": [
        "taskId"
      ],
      "x-apifox-orders": [
        "taskId",
        "prompt",
        "maskBase64",
        "noStorage"
      ]
    },
    "examples": [
      {
        "value": "{\n  \"taskId\": \"TASK_ID\",\n  \"prompt\": \"new prompt\"\n}",
        "mediaType": "application/json",
        "description": "MJ 请求示例"
      }
    ]
  },
  "responses": [
    {
      "code": 200,
      "name": "成功或业务结果",
      "contentType": "json",
      "jsonSchema": {
        "type": "object",
        "properties": {
          "code": {
            "type": "integer",
            "description": "业务状态码。通常 1 表示提交成功，22 表示已进入排队；其他值表示提交失败。"
          },
          "description": {
            "type": "string",
            "description": "提交结果描述。"
          },
          "result": {
            "type": "string",
            "description": "任务 ID。提交成功后用它查询任务或执行后续 Action/Modal。"
          },
          "properties": {
            "type": "object",
            "description": "可选的服务端任务属性，例如 Discord 频道或实例信息。不要依赖未定义的子字段。"
          }
        },
        "x-apifox-orders": [
          "code",
          "description",
          "result",
          "properties"
        ]
      },
      "description": "HTTP 成功不等于任务成功；请继续检查响应体中的 code 或 status。"
    }
  ],
  "responseExamples": [
    {
      "name": "规范示例",
      "mediaType": "application/json",
      "data": "{\n  \"code\": 1,\n  \"description\": \"Submit success\",\n  \"result\": \"TASK_ID\",\n  \"properties\": {}\n}"
    }
  ]
}