青云TOP API使用教程&开发文档小白用户&专业开发者快速使用指南
控制台
返回模型调用 API 参考
POST/mj/submit/edits

提交 Edit 任务

提交图片编辑或局部重绘任务。

API Key application/json
MJ 异步任务协议

调用与返回说明

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

请求时注意

  • 所有 MJ 接口都要在 Header 中发送 Authorization: Bearer <API_KEY>。生产环境请从服务端环境变量读取 Key。
  • 请求地址使用当前站点配置的 API Base URL 拼接本文 endpoint；不要把 /v1 误加到 /mj 路径，也不要重复拼接 Base URL。
  • image 必填并支持 URL 或 Base64；使用 maskBase64 时先确认蒙版尺寸和透明区域符合服务要求。
  • 这是异步任务接口。HTTP 请求成功只代表请求被网关接受；还必须检查响应体 code，并保存 result 作为任务 ID。
  • notifyHook 可填写回调地址；为空时按外部文档说明使用全局回调配置。回调到达后仍应以任务查询结果为准，并做好签名/来源校验和幂等处理。
  • base64 图片建议使用 data:image/...;base64,... 格式，并控制请求体大小；可以先调用上传图片接口换取链接，再把链接用于需要 URL 的场景。

返回时注意

  • 先检查 HTTP 状态，再检查响应体中的 code 或 status。提交接口的 code=1 通常表示成功接收，result 才是后续查询使用的任务 ID。
  • Edit 返回异步任务提交结果，不要按同步图片 URL 处理。
  • 任务查询的终态包括 SUCCESS、FAILURE、CANCEL；MODAL 表示需要继续提交 Modal。不要只根据 progress=100% 判定成功。
Request

请求

/mj/submit/edits

Body

必填
Bodyapplication/json
Bodyobject
promptstring必填

编辑提示词。

示例change the jacket to blue
imagestring必填

输入图片，支持 URL 或 Base64。

maskBase64string

蒙版 Base64；透明区域表示编辑区域。

notifyHookstring

回调地址。

noStorageboolean

是否不存储。

示例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 异步任务协议

调用与返回说明

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

请求时注意

  • 所有 MJ 接口都要在 Header 中发送 Authorization: Bearer <API_KEY>。生产环境请从服务端环境变量读取 Key。
  • 请求地址使用当前站点配置的 API Base URL 拼接本文 endpoint；不要把 /v1 误加到 /mj 路径，也不要重复拼接 Base URL。
  • image 必填并支持 URL 或 Base64；使用 maskBase64 时先确认蒙版尺寸和透明区域符合服务要求。
  • 这是异步任务接口。HTTP 请求成功只代表请求被网关接受；还必须检查响应体 code，并保存 result 作为任务 ID。
  • notifyHook 可填写回调地址；为空时按外部文档说明使用全局回调配置。回调到达后仍应以任务查询结果为准，并做好签名/来源校验和幂等处理。
  • base64 图片建议使用 data:image/...;base64,... 格式，并控制请求体大小；可以先调用上传图片接口换取链接，再把链接用于需要 URL 的场景。

返回时注意

  • 先检查 HTTP 状态，再检查响应体中的 code 或 status。提交接口的 code=1 通常表示成功接收，result 才是后续查询使用的任务 ID。
  • Edit 返回异步任务提交结果，不要按同步图片 URL 处理。
  • 任务查询的终态包括 SUCCESS、FAILURE、CANCEL；MODAL 表示需要继续提交 Modal。不要只根据 progress=100% 判定成功。