LightCC光算云文档

切换主题

LightCC 按量调用 API 文档 ​

💡 提示：在使用本 API 之前，请先阅读 API接入指南，了解如何申请密钥和进行身份认证。

获取上传预签名 ​

GET /system/api/v1/task/minio/uploadPath/{fileType}

上传预签名，通过调用该接口可以获取一个指定类型的上传链接和文件名称，通过PUT方法可以将所需的图片上传。url地址3分钟内有效

请求参数 ​

名称位置类型必选中文名说明
fileTypepathstring是文件后缀名例如：png

响应参数 ​

json
{
    "code": 200,
    "msg": null,
    "data": {
        "fileName": "4299723d22f14669809470dd181b936f.png",
        "url": "http://minio3.lightcc.cloud/task-image/upload_img/4299723d22f14669809470dd181b936f.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=7O9Rs7dw64oTtVvJZfa5%2F20250911%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250911T161422Z&X-Amz-Expires=180&X-Amz-SignedHeaders=host&X-Amz-Signature=6f391c908eff7c0ca0f9103519fa905a7e477e2b8b3e2f5bc3d4f6f3a85b7186"
    }
}
名称类型备注
fileNameString文件名，工作流中如果需要图片则使用这个名称
urlString工作流图片的上传地址

创建任务 ​

POST /system/api/v1/task/create

创建任务，需要ComfyUI中完整工作流。特别注意：必须在Comfy官方版镜像可运行的工作流。

请求参数 ​

json
{
  "prompt": {},//完整工作流
  "images": [
    "string"
  ],//上文件名，由请求上传预签名获取的filename
  "comfyApiKey": ""
}
名称位置类型必选中文名说明
promptbodyObject是工作流ComfyUI中可执行的工作流
imagesbodyArray否图片名图片必须先上传才可以使用
comfyApiKeybodyString否ComfyUI密钥调用ComfyUI官方付费节点的使用

响应参数 ​

返回结果参考

json
{
    "code": 200,
    "msg": null,
    "data": {
        "taskId": "1966177829595463680", //任务id，用于获取执行日志和执行结果
        "status": 0 // 任务的状态情况：0:排队
    }
}
名称类型备注
taskIdString任务的唯一标识，可使用它来获取执行日志和执行结果
statusNumber任务状态，创建任务默认为排队中

获取执行日志 ​

GET /system/api/v1/task/processLog/{taskId}

获取任务执行日志，包含任务状态、任务进度、任务执行情况等

请求参数 ​

名称位置类型必选中文名说明
taskIdpathstring是任务Id获取日志执行情况

响应参数 ​

返回结果参考

json
{
    "code": 200,
    "msg": null,
    "data": {
        "taskId": "1966175039158566912",
        "status": 1,//0:排队；1:运行；2:中断；3:异常；4：完成
        "process": 11,//任务进度
        "msg": "当前任务执行情况：1/9" //进度日志
    }
}
名称类型备注
taskIdString任务的唯一标识，可使用它来获取执行日志和执行结果
statusNumber任务状态：0:排队；1:运行；2:中断；3:异常；4：完成
processNumber进度百分比
msgString任务执行情况日志

获取执行结果 ​

GET /system/api/v1/task/result/{taskId}

获取任务执行结果，包含结果图片地址、消耗算力点，开始时间、结束时间、错误信息等。

请求参数 ​

名称位置类型必选中文名说明
taskIdpathstring否任务Id无值显示最近12小时记录，有值显示当前记录

响应参数 ​

返回结果参考

json
{
    "code": 200,
    "msg": null,
    "data": {
        "taskId": "1966175039158566912",
        "status": 4,//0:排队；1:运行；2:中断；3:异常；4：完成
        "costPoint": 10.0,//消耗算力点
        "result": [
            "http://minio3.lightcc.cloud/task-image/save_img/8905712d74c443d89ba1f369300c3f70.png?X-Amz-Algorithm=AWS4-HMAC-SHA256&X-Amz-Credential=7O9Rs7dw64oTtVvJZfa5%2F20250911%2Fus-east-1%2Fs3%2Faws4_request&X-Amz-Date=20250911T162426Z&X-Amz-Expires=259200&X-Amz-SignedHeaders=host&X-Amz-Signature=89f6559fc09910c08f4b7629362081070231f5369c65ab6c29269c1bb0a48ec1"
        ],//执行结果
        "error": null,//执行错误
        "startTime": 1757607635385,//开始时间
        "endTime": 1757607864839//结束时间
    }
}
名称类型备注
taskIdString任务的唯一标识，可使用它来获取执行日志和执行结果
statusNumber任务状态：0:排队；1:运行；2:中断；3:异常；4：完成
costPointNumber消耗算力点
resultArray工作流执行结果图片地址，图片地址3天内可访问
errorString执行错误信息
startTimeNumber开始时间
endTimeNumber结束时间

中断任务 ​

PUT /system/api/v1/task/interrupt/{taskId}

中断任务，注意：只能对排队中和运行中的任务中断。

请求参数 ​

名称位置类型必选中文名说明
taskIdpathstring是任务id中断任务，只能中断等待中和运行中

调用中断后返回任务信息，响应信息参考执行结果的返回值

json
{
    "code": 200,
    "msg": null,
    "data": {
        "taskId": "1966178373999345664",
        "status": 2,
        "costPoint": 0.0,
        "result": null,
        "error": null,
        "startTime": 1757608430374,
        "endTime": null
    }
}