工流智能 - 开发接口文档

所有接口均在 /api/ 下,需登录的请求请在请求头携带 access-token

认证(二选一):
① 请求头 access-token: 登录返回的 data.token(推荐,直接写 token)
② 请求头 Authorization: Bearer 登录返回的 data.token(Bearer 后有一个空格)

调用说明、注册、登录可匿名;用户信息、列表与生成接口需登录。

0. 用户注册接口(客户端)

POST /api/register

无需登录。注册成功后直接返回 token 与用户信息,可当作已登录使用。必填:昵称、手机号、密码、公司信息。

参数类型必填说明
nicknamestring昵称
phonestring手机号(11位)
passwordstring密码(6~20位)
companystring公司信息

返回:与登录一致,含 tokenuser 等,后续请求头带 access-tokenAuthorization: Bearer token

0.1 用户登录接口(客户端)

POST /api/login/account

客户端登录用,非小程序。仅需账号、密码,不需要验证码。

参数类型必填说明
usernamestring登录账号(手机号)
passwordstring密码

返回:{"code":200,"data":{"token":"...","refresh_token":"...","expire":...,"refresh_expire":...,"user_type":"user","redirect":"/web","user":{...}}}。其中 data.user 含用户信息:id、nickname、phone、avatar、company、balance、quota、api_call_count、remaining_calls 等。后续请求在请求头带 access-token: data.tokenAuthorization: Bearer data.token

0.2 用户信息查询

GET /api/userinfo
POST /api/user/info

需登录(请求头 access-token)。无请求体。返回当前用户完整信息,包含:id、nickname、phone、avatar、company(公司信息)、balance(余额)、quota(额度)、api_call_count(接口调用次数)、remaining_calls(剩余次数)、status、create_time;以及个人中心统计:material_count(素材数,图片+视频内容数)、content_count(图文数,文章+图片数)、latest_projects(最新项目列表,最多 5 条)。

返回:{"code":200,"data":{...用户对象}}

0.3 完善个人信息

POST /api/userinfo/update

需登录。用于完善或修改个人资料:昵称、头像、公司名称。只传需要修改的字段即可,不传的字段保持不变。

参数类型必填说明
nicknamestring昵称
avatarstring头像(附件 ID 或 URL)
companystring公司名称

返回:{"code":200,"data":null,"message":"操作成功"}

0.4 我的素材分页列表(客户端)

POST /api/material/my/page

需登录。查询当前用户的素材列表,支持按类型筛选、关键词搜索(名称/标签/项目)、分页。返回总条数、总大小、各类型数量,便于客户端做 Tab 与统计。

参数类型必填说明
pageint页码,默认 1
sizeint每页条数,默认 20
typestring类型筛选:不传或 all=全部,image=图片,video=视频,audio=音频,document=文档,copywriting=文案
keywordstring搜索关键词(匹配素材名称、标签、所属项目)

返回示例:

{
  "code": 200,
  "data": {
    "list": [
      {
        "id": 1,
        "name": "宣传视频.mp4",
        "type": "video",
        "type_label": "视频",
        "size": 15728640,
        "size_text": "15 MB",
        "file_url": "https://xxx/xxx.mp4",
        "project_id": 2,
        "project_name": "青春校园剧",
        "tags": "宣传,视频",
        "create_time": "2024-01-17 10:00:00"
      }
    ],
    "count": 4,
    "total": 4,
    "total_size": 21474836,
    "total_size_text": "20.45 MB",
    "type_counts": {
      "all": 4,
      "image": 1,
      "video": 1,
      "audio": 1,
      "document": 1,
      "copywriting": 0
    }
  }
}

0.5 上传素材(客户端)

POST /api/material/upload

需登录。请求体为 multipart/form-data,上传文件并写入「我的素材」。支持格式:图片(jpg/png/gif/webp 等)、视频(mp4/avi/mov 等)、音频(mp3/wav/ogg 等)、文档(doc/docx/pdf/txt/xls/pptx/epub 等)。单文件最大 100MB。类型按扩展名自动识别。

参数类型必填说明
filefile文件(表单字段名 file)
namestring素材名称,不传则用文件名
project_idint所属项目 ID
project_namestring所属项目名称(可与 project_id 二选一或同时传)
tagsstring标签,逗号分隔

返回:{"code":200,"data":{...}},data 为新建素材对象,含 id、name、type、type_label、size、size_text、file_url、project_id、project_name、tags、create_time 等。

1. 调用接口说明(获取本说明的 JSON)

GETPOST /api/manju/call/spec

无需登录。返回 JSON 格式的完整接口说明(含各接口 URL、参数列表),便于客户端动态使用。

2. 工作流列表

POST /api/manju/workflow/list
参数类型必填说明
pageint页码,默认 1
sizeint每页条数,默认 100
statusint状态 1=已启用,默认 1

返回:{"code":200,"data":{"list":[...],"total":N}}

3. 智能体列表

POST /api/manju/agent/list
参数类型必填说明
pageint页码
sizeint每页条数
statusint状态 1=已启用

返回:{"code":200,"data":{"list":[...],"total":N}}

4. 接口列表(大模型接口)

POST /api/manju/api/list
参数类型必填说明
pageint页码
sizeint每页条数
statusint状态 1=已启用
categorystring类型 text/image/video 等
platformstring平台

返回:{"code":200,"data":{"list":[...],"total":N}}

4.1 开发工具列表

GETPOST /api/manju/datatool/tool/list

需登录。返回已启用的开发工具(翻译、去水印、小红书关键词等)全量列表,不分页。

返回:{"code":200,"data":[{"id":1,"name":"翻译接口","code":"translate","description":"...","price_per_call":"0.1000","request_method":"GET"},...]}

4.2 开发工具调用

POST /api/manju/datatool/tool/invoke

需登录。请求头带 access-token,Body 为 JSON:{"code":"工具code","params":{...}}。每次成功调用按 price_per_call 从用户余额扣费(上游失败不扣费)。

参数类型必填说明
codestring工具唯一标识,见下表
paramsobject业务参数,各工具不同,参数名必须与下表一致

完整请求示例(按工具分类)

一、故梦吖(gmya.net)— 参数名与官方一致

工具 code说明params 示例(JSON Body 中的 params)
translate翻译{"text":"你好世界"}
douyin_parse抖音去水印/解析{"url":"https://v.douyin.com/xxx 或 分享链接"}
kuaishou_parse快手去水印/解析{"url":"快手分享链接"}

二、灵感引擎(api.lgai.cc)— 多为 POST,参数名以官方为准(常见为 input)

工具 code说明params 示例
xhs_search小红书关键词搜索{"input":"关键词"}注意是 input 不是 text
xhs_home小红书主页搜索{"input":"用户ID或主页标识"}
xhs_outline小红书图文大纲见灵感引擎文档,一般为 {"input":"..."} 或文档指定字段
xhs_copywriting小红书文章仿写见灵感引擎文档
lgai_translate灵感引擎-翻译{"text":"要翻译的文本"}{"input":"..."}(以官方文档为准)
general_remark去水印解析{"url":"视频/图片链接"}{"input":"链接"}
general_short_video_copywriting短视频文案提取{"url":"视频链接"}{"input":"链接"}
general_daily_hot聚合热搜榜{}(无参数或可选参数)
general_audio_transcriptions音频转文本见文档,通常为 {"file":"音频URL或file_id"}
ai_prompt_image图片提示词反推{"image":"图片URL"} 等,见文档
openai_chatOpenAI 对话补全{"messages":[{"role":"user","content":"你好"}]} 等,见文档

三、单次请求示例(Postman/Apifox 等)

URL:POST https://你的域名/api/manju/datatool/tool/invoke
Header:Content-Type: application/jsonaccess-token: 登录获得的 token

例 1 - 故梦吖翻译:

{"code":"translate","params":{"text":"你好世界"}}

例 2 - 小红书关键词(参数名必须为 input):

{"code":"xhs_search","params":{"input":"你好世界"}}

例 3 - 抖音去水印:

{"code":"douyin_parse","params":{"url":"https://v.douyin.com/xxxxx/"}}

例 4 - 灵感引擎翻译:

{"code":"lgai_translate","params":{"text":"Hello world"}}

返回:{"code":200,"data":{"data": 第三方返回的原始数据,"price_per_call":0.05},"message":"success"}。上游失败时返回 400 且不扣费。

5. 调用接口(生成)

POST /api/manju/workbench/generate

至少选择 agent_id / api_id / workflow_id / model_id 中的一个;按次从用户余额扣费。

参数类型必填说明
module_typestringtext2text | text2image | text2video | image2text | image2image | image2video
agent_idint智能体ID(与 api_id/workflow_id/model_id 至少填一个)
api_idint大模型接口ID
workflow_idint工作流ID
model_idint模型ID
promptstring用户输入/提示词
system_promptstring系统提示词(选智能体时一般自动带)
negative_promptstring负向提示词(文生图/图生图)
widthint图片宽度
heightint图片高度
imagefile图片文件(图生文/图生图/图生视频时上传)

返回:{"code":200,"data":{...}} 成功时 data 为生成结果(含 task_id、url 等,视模块类型而定)。

JSON 接口说明(用于测试)

可将下方 JSON 保存为 api.json 或直接请求 GET /api/manju/call/spec 获取(会带当前域名)。

加载中…