开发者门户 · SDK 2.0

开发者文档:Mod、AI 员工与开放 API

基于 XCAGI SDK 2.0 开发功能 Mod 或 AI 员工,支持 mod 与 ai 双发布目标;可在修茈 AI 市场提交上架。

2发布目标 mod / ai
4行业模板可复用
30%默认平台分成
XCautoOpenAI 兼容中转

能做什么

一套包,两种发布

同一个开发包既能作为功能 Mod 安装进客户工作台,也能上架为 AI 员工,由 manifest 的 release_targets 决定。

Mod 功能扩展

为客户的产品、订单、出货、客服等业务页提供新能力,挂接宿主事件与业务工作台。

AI 员工

声明模型、提示词与可调用工具,把行业知识做成会执行任务的 AI 员工。

mod + ai 双发布

release_targets: ["mod","ai"],一次开发同时面向功能与 AI 两个上架目标。

SDK 2.0

manifest、hook 与事件通信

通过声明式 manifest 与事件 hook 对接宿主;对外接口保持稳定,便于版本演进。

声明式 manifest

能力声明、宿主版本兼容区间、双发布目标与 AI 清单,安装前即可校验。

事件 hook

订阅业务事件,支持优先级排序、一次性订阅与返回值收集,卸载时自动清理。

事件通信

经 NeuroBus 发布业务事件,与宿主事件总线对齐,跨 Mod 协作有据可循。

XCauto

模型 API(OpenAI 兼容)

XCauto 提供统一的 OpenAI 兼容 REST 接口:固定 Base URL、Bearer 鉴权、按调用量从账户钱包扣费。支持账户默认路由(xcauto-account)或指定 provider/model

XCauto 基址:https://xiu-ci.com/v1 · 凭证 Authorization: Bearer <PAT 或 JWT>

OpenAI SDK:设 OPENAI_BASE_URL=https://xiu-ci.com/v1OPENAI_API_KEY=pat_…,模型用 xcauto-accountdeepseek/deepseek-chat

模型与对话(OpenAI 兼容)

方法路径说明
GET/v1/models可调用模型列表(含各厂商 provider/model
POST/v1/chat/completions对话补全;模型 xcauto-account 走账户默认路由
GET/api/llm/catalog模型目录与能力说明
GET/api/llm/resolve-chat-default解析 xcauto-account 实际上游
POST/api/llm/chat原生 JSON 对话(可指定 provider + model)
POST/api/llm/chat/streamSSE 流式输出(推荐长回复)

账户路由模型名:xcauto-account(别名 xcautoxiuci-account

余额 · 计费 · 用量

方法路径说明
GET/api/wallet/balance钱包余额(元)
GET/api/account/bootstrap余额 + 会员 + 默认模型偏好
GET/api/llm/pricing各模型计费单价(元/千 Token)
GET/api/llm/usage调用流水:Token、扣费、状态
POST/api/developer/tokens创建 PAT,勾选 llm:use

计费:调用前预扣、完成后按 Token 结算;响应头 X-Xiuci-Charge-CNY 为本次扣费金额(元)。

XCauto 调用示例

列出模型
OpenAI 兼容对话
查询余额与单价
Python(OpenAI SDK)

开放 API

只读市场接口无需登录,写操作走 PAT

与 AI 市场同域的 MODstore API。浏览商品、模板与 Catalog 包可直接调用;工作流执行、Mod 同步与 Webhook 需个人访问令牌(PAT)。

API 基址:https://xiu-ci.com · 凭证头 Authorization: Bearer <token>

公开只读(无需 Token)

供集成与查询使用;请遵守限流策略。

方法路径说明
GET/api/health服务健康、版本与调度状态
GET/api/market/facets市场筛选项(行业、素材类型、许可等)
GET/api/market/catalog商品列表(q、artifact、limit、offset)
GET/api/market/catalog/{id}商品详情
GET/api/market/catalog/{id}/reviews用户评价列表
GET/api/templates工作流模板列表(公开模板)
GET/api/templates/categories模板分类与数量
GET/api/templates/{id}模板详情(含节点图预览)
GET/v1/packagesCatalog 包分页列表
GET/v1/index.json轻量全量包索引
GET/v1/packages/{id}/{ver}包元数据
GET/v1/packages/{id}/{ver}/download下载包 zip
GET/market/download-release.json客户端安装包版本清单
POST/api/public/contact联系表单(匿名,限流)

需 PAT / 登录会话

在 AI 市场登录后于开发者中心创建 PAT;明文仅返回一次,请妥善保存。

方法路径说明
GET/api/developer/tokens我的 PAT 列表
POST/api/developer/tokens创建 PAT(含 scopes)
DEL/api/developer/tokens/{id}吊销 PAT
GET/api/developer/webhooksWebhook 订阅列表
POST/api/developer/webhooks创建事件订阅
POST/api/developer/webhooks/{id}/test发送测试事件
POST/api/templates/{id}/install模板一键安装为工作流
POST/v1/mod-sync/push库 → XCAGI mods(scope: mod:sync)
POST/v1/mod-sync/pullXCAGI mods → 库
GET/v1/mod-sync/export-zip/{mod_id}导出与工作台同布局 zip
POST/api/workflow/{id}/execute触发工作流执行

常用 scope:catalog:read · workflow:read · workflow:execute · mod:sync · webhook:manage

快速试用

拉取市场商品(前 5 条)
创建 PAT(需已登录 JWT)

完整接口定义见本站 OpenAPI JSON 与 Swagger / ReDoc。

上架与结算

发布、评价与分成

灰度发布

按比例与用户标签放量,观察稳定后逐步全量,异常一键回滚,降低上新风险。

  • 比例分桶 + 标签命中
  • 全量 / 暂停 / 回滚

评价与口碑

用户可对商品评分与评论;作者可在市场内回复。

  • 评分聚合与展示
  • 作者回复

收益结算

按成交计算分成,平台对账后结算并支持提现,收益明细清晰可查。

  • 成交分成(默认平台 30%)
  • 对账结算与提现

行业模板

四套参考模板

可从模板修改 manifest 与业务配置后用于开发与测试。

ERP

产品 / 客户 / 订单三域 + AI 助手双发布。

出货

发货单 / 出货记录 / 标签打印链路。

客服

工单 / 会话 / 知识库 + AI 客服员工。

财务

对账 / 开票 / 统一账本(仅 Mod 发布)。

接入步骤

四步上架你的第一个包

01

申请开发者权限

联系我们或在 AI 市场登录后创建 PAT;可先调用上方开放 API只读接口验证连通性。

02

从模板起步开发

复制行业模板,修改 manifest 的标识、能力与行业配置,实现后端 hook 与前端页面。

03

灰度上架

提交审核,按比例与标签灰度放量,结合稳定性数据逐步全量。

04

经营与结算

收集评价、迭代版本,按成交分成对账结算并提现。

申请开发者权限

如需上架 Mod 或 AI 员工,请通过下方入口提交申请或联系我们。

申请开发者权限