青云TOP API使用教程&开发文档小白用户&专业开发者快速使用指南
控制台
返回模型调用 API 参考
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% 判定成功。
Request

请求

/mj/submit/modal

Body

必填
Bodyapplication/json
Bodyobject
taskIdstring必填

等待 Modal 的原任务 ID。

示例TASK_ID
promptstring

Modal 要提交的新提示词。

maskBase64string

局部重绘使用的蒙版 Base64。

noStorageboolean

为 true 时返回原始图片链接。

示例false

路径、查询与 Header 参数

参数位置类型必填说明示例
AuthorizationHeaderstring是必填。使用青云TOP API 的 API Key，保留 Bearer 后的空格。Bearer YOUR_API_KEY
Response

返回响应 200

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

业务状态码。通常 1 表示提交成功，22 表示已进入排队；其他值表示提交失败。

descriptionstring

提交结果描述。

resultstring

任务 ID。提交成功后用它查询任务或执行后续 Action/Modal。

propertiesobject

可选的服务端任务属性，例如 Discord 频道或实例信息。不要依赖未定义的子字段。

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% 判定成功。