一步步教你使用 Loomloom 批处理 API。从健康检查到提交任务、下载结果,跟着做就行。
获取 API Key,确认服务可用。
登录 胜算云控制台,在「API Key 管理」中创建密钥。所有请求都需要在 Header 中携带:
调用健康检查接口,确认服务正常:
| 字段 | 说明 |
|---|---|
healthy | true 表示服务正常 |
message | 状态描述信息 |
{"healthy": true} 就可以开始下一步了。
Loomloom 内置了一批模板,每个模板对应一种批处理场景(如电商产品图、文案生成等)。
| 字段 | 说明 |
|---|---|
templateId | 模板唯一标识,后续所有操作都需要它 |
name | 模板名称 |
scenario | 适用场景说明 |
inputSummary | 输入要求概述(如"每行填写一段提示词") |
outputType | 输出类型(如"图片"、"文本") |
templateId 记下来,后面每一步都要用到。
查看模板的详细字段定义,下载 Excel 模板。
了解这个模板有哪些字段、哪些必填、支持什么类型的输入:
| 字段 | 说明 |
|---|---|
fields | 字段列表,每个字段有 key、label、required、type 等 |
columns | Excel 列定义(fieldKey 对应 fields 中的 key) |
instructions | 填写说明数组 |
sampleRows | 示例行数据,可以参考格式 |
打开下载的 Excel,按模板要求填写数据。
required: trueenumValuessampleRows,参考示例行的格式填写。
Loomloom 的核心特色:上传任意资产(文本、图片等),直接触发自定义工作流。
Loomloom 提供两种使用方式:
使用 UploadInputAsset 接口上传你的原始输入资产。支持的格式包括文本、图片、音频等,单文件大小上限 10 MiB。
| 字段 | 类型 | 说明 |
|---|---|---|
inputAssetId | string | 资产 ID(如 ia_xxx),用于后续工作流提交 |
filename | string | 原始文件名 |
mimeType | string | 服务端确认的 MIME 类型 |
sizeBytes | string (int64) | 资产大小(字节) |
uploadedAt | string (int64) | 上传时间戳(Unix 秒) |
inputAssetId。这个 ID 可以在后续自定义工作流提交时使用,替代官方模板中的文件上传。
上传资产拿到 inputAssetId 后(例如 ia_abc123),在模板行数据的图片/文件字段中直接填入该 ID:
字段值为 ia_ 前缀开头时,系统会自动将其识别为已上传资产引用,而不是普通文本 URL。
提交前先校验,避免正式提交时才发现格式错误。
重要:rows 中 values 的 key 必须使用模板 schema 中的中文字段标签(label),而非英文字段 key。请参考 GET /templates/{templateId}/schema 返回的 sampleRows 中的 key 格式。
| 字段 | 说明 |
|---|---|
valid | true 表示全部通过 |
fileErrors | 文件级错误(如格式不对) |
rowErrors | 行级错误,包含 rowIndex、fieldKey、error |
rowIndex 是 1-based(第1行是表头,数据从第2行开始)。如果报错 "第3行 xxx 字段为空",对应 Excel 的第3行。
提交前看看要花多少钱,余额够不够。
| 字段 | 说明 |
|---|---|
estimatedTotalCost | 预估总费用(单位:千万分之元) |
balanceCheck.availableBalance | 当前可用余额 |
balanceCheck.isSufficient | true 表示余额充足 |
estimatedTotalCost: 500000 = 0.05元。
数据校验通过、费用预估 OK,正式提交批处理任务。
| 字段 | 说明 |
|---|---|
runId | 重要!任务运行 ID,后续查询进度、下载结果都要用它 |
status | 初始状态(通常是 pending 或 running) |
acceptedAt | 接受时间戳 |
idempotencyKey 可以防止重复提交。同一个 key 多次提交只会创建一次任务。
任务提交后是异步执行的,需要轮询查看进度。
| 字段 | 说明 |
|---|---|
status | 运行状态:pending / running / completed / failed |
totalTasks | 总任务数 |
completedTasks | 已完成数 |
failedTasks | 失败数 |
actualCost | 实际费用(千万分之元) |
可以按 status 过滤,查看哪些任务失败了以及失败原因。
| 字段 | 说明 |
|---|---|
taskId | 任务唯一标识 |
sourceRowIndex | 对应原始数据行的索引(0-based),可定位到具体哪一行出错 |
status | 任务状态:pending / running / completed / failed / cancelled |
errorMessage | 失败原因(仅 status=failed 时有值) |
artifactCount | 该任务产生的产物数量 |
GetWorkflowRun,直到 status 变为 completed 或 failed。
任务完成后,下载生成的产物(图片、文本等)。
| 字段 | 说明 |
|---|---|
artifacts | 产物数组 |
artifactId | 产物 ID |
accessUrl | 短期签名 URL,可直接下载文件 |
inlineText | 小文本内容(< 4KB 时直接返回文本) |
sourceRowIndex | 对应原始 Excel 的行号(0-based) |
mimeType | 文件类型(如 image/png) |
直接用 accessUrl 下载,无需额外认证。
accessUrl 是短期签名 URL,通常有效期几小时。请尽快下载,过期后需要重新获取。