开发者手册

本手册面向编写软件来使用或扩展 OpenBot 的开发者。API 访问不会带来额外权限。每个请求仍以调用者的身份执行。

接入客户端

准备已有的 OpenBot 地址和组织账户。需要测试服务器时，使用本地 API 快速开始。

1. 实现登录、组织选择和令牌。
2. 使用 TypeScript 客户端或 HTTP 参考。
3. 发送 Bot 消息，读取 Chat 结果和流，并处理请求。
4. 按客户端需求接入文件、App或实时会话。

侧栏中的 API 任务指南说明请求字段、响应状态和错误。客户端负责自己的界面和返回路径。

发布 App

你需要控制 App 服务及其公开 HTTPS 地址。

1. 按 App Protocol发布文档。
2. 使用协议测试服务检查。
3. 通过发布者工具证明控制权、测试连接并申请收录。
4. 搜索和撤回规则见 App Index 契约。

参与 OpenBot 开发

1. 阅读贡献指南，了解环境、检查和项目规则。
2. 阅读包边界和执行设计。
3. 通过从代码运行组合服务端。在这里接入模型后端、实时后端或日志。
4. 维护项目发布时，遵循发布和检查。

正式环境的安装和机密配置见管理员手册。