API 约定
献丑 CLI 只调用 /api/cli/* 下的专用接口。脚本和 Agent 不应该直接依赖 /run、/canvas 等 Web 内部接口。
当前 CLI 使用以下接口:
| 接口 | 用途 |
|---|---|
GET /api/cli/models/image | 获取当前项目可用的生图模型目录 |
GET /api/cli/models/video | 获取当前项目可用的生视频模型目录 |
POST /api/cli/images/generate | 提交生图任务 |
POST /api/cli/videos/generate | 提交生视频任务 |
GET /api/cli/tasks/{task_id} | 查询任务状态 |
POST /api/cli/tasks/{task_id}/settle | 任务成功后结算并确认结果 |
POST /api/cli/markdown/images/plan | 为 Markdown 生成插图计划 |
为什么使用专用接口
/api/cli/* 是为命令行和自动化场景准备的稳定边界。它能降低 Web 页面内部实现变化对脚本的影响,也方便 Agent 使用统一的认证、项目和任务协议。
认证方式
CLI 会从参数、环境变量或本地配置中读取 Access Key,并在请求时发送给 API。默认 API 地址是:
https://api.xianchou.com
如果需要连接测试环境,可以通过 --api-url 或 XIANCHOU_API_URL 覆盖。