API 快速入门
创建个人令牌,用 curl 获取机器人列表并创建第一条反应。
本页内容
API 让程序读取机器人、创建反应或获取数据。本指南面向开发集成的人;手动设置机器人可使用可视化编辑器。先创建访问密钥,即个人令牌,再用终端中的 curl 向 API 地址发送 HTTP 请求。请把示例中的 https://your-domain 换成您的 GetMyBot 安装地址。
第一步:创建个人令牌
在账号的个人令牌页面创建 PAT。创建时立即复制,值只显示一次,并以 mbp_ 开头。选择只够完成所需操作的权限范围(scopes),见身份验证指南。
第二步:地址与格式
REST 接口都位于 /api 下,路径中没有版本号。请求与响应主体是 JSON;带请求体时设置 Content-Type: application/json。在 Authorization: Bearer <个人令牌> 中,将包括尖括号的占位符换成完整令牌。令牌本身已含 mbp_,无需再加一次。
第三步:获取机器人列表
需要 bots:read(或 *)权限:
curl -H "Authorization: Bearer <个人令牌>" https://your-domain/api/bots
响应是机器人 JSON 数组。令牌无效或过期时返回 401 和 {"error":"..."},见API 错误。
第四步:创建第一条反应
这一步会修改选定项目的数据,只在您确实需要此反应的项目中执行。需要 reactions:write;将第三步获得的机器人 ID 填入:
curl -X POST https://your-domain/api/bots/BOT_ID/reactions \
-H "Authorization: Bearer <个人令牌>" \
-H "Content-Type: application/json" \
-d '{"name":"欢迎","trigger":{"type":"command","value":"/start"}}'
成功时返回新反应及其 id。请求体字段请以交互式接口参考为准;那里也有 curl、JavaScript 和 Python 示例。
第五步:查阅接口参考
交互式接口参考列出 API 地址、所需权限、请求字段和用于试调用的 Try it 按钮。
首次调用 Managed AI
创建含 managed_ai:invoke 权限的 PAT。Idempotency-Key 用来标识一次操作:重试同一操作时保持密钥和请求体不变,新操作则用新密钥。
curl -X POST https://your-domain/api/v1/ai/responses \
-H "Authorization: Bearer <个人令牌>" \
-H "Content-Type: application/json" \
-H "Idempotency-Key: ai-demo-0001" \
-d '{"profile":"balanced","provider":"auto","input":[{"role":"user","content":[{"type":"input_text","text":"简要总结这段对话"}]}],"max_output_tokens":300}'
若集成要显示 Managed AI 或 Meta 功能,请先查询 /api/public/capabilities,确认当前安装是否启用。功能未启用不等于网络故障;应隐藏入口或显示不可用状态。