小章 AI 开放平台通用技能包 (XiaoZhang AI OpenAPI Skill)
这是一个标准的 OpenAPI 技能包,用于连接和调用小章 AI 的后端全链路智能体工作流。
如何使用此技能
当你在 WorkBuddy 或其他支持的平台中加载此技能后,你可以直接使用自然语言来触发后端的 Agent 工作流。
1. 配置鉴权 (Authentication) 与用户引流
由于这是一个通用技能包,所有的请求都必须经过鉴权。
当你(智能体)发现用户没有提供 UID 时,必须使用以下话术引导用户获取:
> "欢迎使用小章AI全链路智能设计!为了帮您同步作品和积分,请先绑定您的专属账号。
> 👉 获取方式:请微信搜索并打开【小章AI】小程序,点击左上角头像进入个人中心即可查看并复制您的专属 UID 告诉我。
> 🔗 您也可以直接扫描下方二维码进入小程序:
> "
用户提供 UID 后,请在请求的 HTTP Headers 中包含:
Authorization: Bearer <你的UID>
2. 接口列表与调用方法
本技能包包含以下三个核心接口:
🟢 获取用户信息 (getUserInfo)
- 作用:检查当前 UID 是否有效,并查询当前账号的积分余额。
🟢 提交全链路任务 (executeAgentTask)
- 作用:向小章 AI 后端提交需求。
- 核心参数:
prompt(string): 提交给 AI 生成模型的画面描述(必填)。【重要提示】作为专业的 AI Agent,你绝不能仅仅将用户的短句原样传递!你必须先理解用户的意图,然后发挥你的 Prompt 编写能力,将其扩写为一段结构丰富、细节生动、适合 AI 绘画/视频模型理解的高质量提示词(包括主体细节、光影、材质、构图、色彩氛围等),然后再将其赋值给prompt参数提交。creation_id(integer): 【强烈推荐】 指定后端系统功能的 ID。例如 1(智能文案), 2(灵感Logo), 3(品牌VI), 4(极速海报), 5(旺铺招牌), 6(视界大片), 7(活动背景墙), 8(智能文化墙)。-
duration(integer): 当调用视频相关功能时,指定视频时长(秒)。 -
💡 各功能 (
creation_id) 对应的高级配置参数表:
你可以将用户在对话中提到的细节,通过以下对应的字段名称直接放进 JSON Body 传给后端,实现深度控制: - 【2: 灵感Logo】
brandName(品牌名),industry(行业),slogan(口号),designStyle(风格,如3D/极简),colorPref(颜色偏好),patternDesc(图案描述),ratio(画面比例,如1:1/16:9),referenceImage(参考图URL) - 【5: 旺铺招牌】
shopName(店名),industry(行业),style(风格),material(材质,如亚克力/3D发光字),storefrontImage(实拍门头图URL),logoImage(Logo图URL) - 【6: 视界大片】
duration(时长秒数,如果用户指定了秒数,如"15秒",必须提取为数字通过此参数传递),ratio(画面比例,如16:9/9:16/1:1),referenceImages(数组,参考图URL列表),referenceMode('frame'为首尾帧过渡,不传则为全局参考) - 【7: 活动背景墙】
category(分类),title(主题),content(内容),styleRef(风格图URL),size(画面尺寸比例,如16:9/4:3/3:4/1:1),logoImage,productImages(产品图数组),qrCodeImage(二维码URL) - 【8: 智能文化墙】
shopName(主题),style(风格),mainColor(主色调),stereo(立体层次),storefrontImage(实拍墙面图URL) -
【4: 极速海报】
title(标题),content(正文),styleRef(风格),size(画面尺寸比例,如9:16/16:9/3:4/4:3),logoImage,productImages(数组),qrCodeImage -
扣费说明:如果传入了
creation_id,将严格按照管理员在后台设置的对应积分(及视频倍率)扣费。 - 返回值:成功提交后会返回一个
task_id。
> ⚠️ 【重要】解决 Windows 终端中文乱码 (Mojibake Fix)
> 如果你在 Windows (PowerShell/CMD/Git Bash) 中使用 curl 提交带有中文的 prompt,直接在命令行使用 -d 传递 JSON 会导致后端接收到 GBK 编码的乱码(表现为菱形问号 `)。
> **必须使用文件方式传递 JSON**:
> 1. 先将 JSON 内容以 UTF-8 格式写入临时文件。
> 2. 然后使用curl -d @temp.json` 发送请求。
>
> ✅ 正确的调试命令示例:
> bash
> # 1. 将参数写入文件 (确保 UTF-8)
> echo '{"prompt": "帮我设计一个狗狗宠物店的logo", "creation_id": 5}' > payload.json
>
> # 2. 使用 @文件 的方式发送请求
> curl -s -X POST -H "Authorization: Bearer <UID>" -H "Content-Type: application/json; charset=utf-8" -d @payload.json "https://xiaozhangai.lanmaoapp.com.cn/api/openapi/v1/agent/execute"
>
🟢 轮询任务状态 (getTaskStatus)
- 作用:根据上一步获取的
task_id,查询后台生成进度和最终结果。 - 参数:
task_id(integer): 任务的唯一标识符。- 调用时机:获取到 task_id 后,智能体应每隔 5-10 秒调用一次此接口,直到返回状态为
completed(完成)或failed(失败),然后将生成的结果(设计图链接、报价单等)展示给用户。
注意事项
- 本技能包的后端地址固定为:
https://xiaozhangai.lanmaoapp.com.cn/api/openapi/v1 - 所有的计费都将直接关联到 Header 中传入的 UID 账号。