API 文档

v1

Solo Works REST API 完整参考。使用这些端点将 AI 图片编辑集成到您的应用中。更新日期:2026-03-05

问 AI 怎么用这个 API

复制以下提示词,贴给你的 AI 助手(ChatGPT、Claude 等)即可快速上手。

阅读 https://soloworks.app/llms.txt 然后告诉我这些 API 如何使用,附上代码示例。
llms.txt
认证方式
所有 API 请求需通过 Authorization 头传送 API 密钥。

Base URL

https://soloworks.app/api/v1

认证头

Authorization: Bearer sk_live_YOUR_API_KEY

协议

这是标准 REST API。使用 GET 读取数据,POST 执行工作流。所有响应为 JSON 格式。图片输入接受 HTTP/HTTPS URL 或 base64 data URL。

快速开始

  1. GET /api/v1/workflows 查询可用工作流
  2. GET /api/v1/workflows/:id 获取工作流所需输入
  3. POST /api/v1/workflows/:id/execute 传入图片和参数执行
  4. GET /api/v1/executions/:id 轮询直到状态为 completed

查询

GET
/api/v1/workflows
查询
列出所有可用的 AI 图片编辑工作流。返回工作流 ID、名称、说明和积分费用。

参数

名称类型位置必填说明
tagstringquery选填用于筛选工作流的标签(如 'fashion'、'product')。
GET
/api/v1/workflows/{id}
查询
获取特定工作流的详情和输入 schema,包含图片字段、文本字段和选择字段。有预设选项的文本字段会包含 presetOptions 数组 — 执行时请使用此数组中的值。

参数

名称类型位置必填说明
idstringpath必填要查询详情的工作流 ID。

执行

POST
/api/v1/workflows/{id}/execute
执行
异步执行 AI 图片编辑工作流。返回执行 ID,通过 GET /api/v1/executions/:id 轮询结果。

参数

名称类型位置必填说明
idstringpath必填要执行的工作流 ID(路径参数)。
imagesRecord<string, string>body必填图片输入,格式为 fieldId → url 或 base64。URL 会由服务器自动下载。
textsRecord<string, string>body选填文本输入,以键值对方式传入:fieldId → value。
switchSelectionsRecord<string, string[]>body选填选择输入,格式为 switchFieldId → [optionId]。
globalOverrides{ aspectRatio?: string, imageSize?: string }body选填可选的输出覆盖设置。aspectRatio:"1:1"、"2:3"、"3:2"、"3:4"、"4:3"、"9:16"、"16:9"、"21:9"。imageSize:"1K" 或 "2K"。
GET
/api/v1/executions/{id}
执行
查询工作流执行状态。返回进度百分比,完成后返回结果 URL。

参数

名称类型位置必填说明
idstringpath必填执行端点返回的执行 ID。

账户

GET
/api/v1/balance
账户
查询当前 API 积分余额和网页积分明细。

此端点不需要参数。

可用的工作流程

以下工作流程目前可通过 API 使用。请使用工作流程 ID 搭配上方的 API 端点。

ID名称Tags点数
79c9e172-637f-44db-9beb-39092ff4d462
單色棚拍風
FashionModel
4