AigcPanel HTTP 接口文档

Base URL:http://localhost:{{PORT}}

GET /api/model/list 获取已安装的服务列表
请求参数

返回字段说明
字段类型说明
idstring服务唯一标识,格式 name|version,用于 /api/model/call 的 model 参数
functions[].namestring功能名称,用于 /api/model/call 的 function 参数
functions[].argsstring[]调用时 param 对象的顶层参数字段名,对应 param.字段名
functions[].paramobject[]调用时 param.param 的参数定义列表,每项含 name/title/type/defaultValue 等
返回示例
{
  "code": 0,
  "data": [
    {
      "id": "aigcpanel-server-tts|1.0.0",
      "name": "aigcpanel-server-tts",
      "version": "1.0.0",
      "title": "语音合成",
      "functions": [
        {
          "name": "soundTts",
          "args": ["text"],
          "param": [
            { "name": "speaker", "title": "发音人", "type": "select", "defaultValue": "", "options": [...] }
          ]
        },
        {
          "name": "soundClone",
          "args": ["text", "promptAudio", "promptText"],
          "param": []
        }
      ]
    },
    {
      "id": "aigcpanel-server-sd|1.2.0",
      "name": "aigcpanel-server-sd",
      "version": "1.2.0",
      "title": "图像生成",
      "functions": [
        {
          "name": "textToImage",
          "args": ["prompt"],
          "param": [
            { "name": "width", "title": "宽度", "type": "inputNumber", "defaultValue": 512 },
            { "name": "height", "title": "高度", "type": "inputNumber", "defaultValue": 512 }
          ]
        }
      ]
    }
  ]
}
POST /api/model/call 调用服务功能,异步返回 taskId
请求体 (JSON)
字段类型说明
model*必填string服务标识,格式为 name|version,来自 /api/model/list 的 id 字段
function*必填string调用的功能名称,来自 functions[].name
param*必填object功能参数对象,顶层字段来自 functions[].args,嵌套 param 字段来自 functions[].param
param.<arg>any各 args 字段直接放在 param 顶层,如 textpromptaudio
param.paramobject动态参数对象,字段定义来自 functions[].param,key 为各项的 name
请求示例(语音合成)
{
  "model": "aigcpanel-server-tts|1.0.0",
  "function": "soundTts",
  "param": {
    "text": "你好,欢迎使用 AigcPanel",
    "param": { "speaker": "zh-CN-XiaoxiaoNeural" }
  }
}
请求示例(图像生成)
{
  "model": "aigcpanel-server-sd|1.2.0",
  "function": "textToImage",
  "param": {
    "prompt": "a beautiful landscape, 4k",
    "param": { "width": 512, "height": 512, "steps": 20 }
  }
}
返回示例
{
  "code": 0,
  "data": { "taskId": "lz3k8m2abc1" }
}
GET /api/model/query 查询任务结果
Query 参数
字段类型说明
taskId*必填string由 /api/model/call 返回的任务 ID
返回示例(处理中)
{ "code": 0, "data": { "status": "pending" } }
返回示例(成功)
{
  "code": 0,
  "data": {
    "status": "success",
    "result": {
      "type": "success",
      "start": 1714300000000,
      "end": 1714300005000,
      "data": { "url": "/path/to/output.wav" }
    }
  }
}
返回示例(失败)
{ "code": 0, "data": { "status": "error", "error": "错误信息" } }