开始使用
身份验证
每一个请求都携带一个 bearer API key。密钥用于验证一个主体身份,并作为其权限的上限。
API 密钥
从你的密钥面板生成密钥。一个密钥属于一个主体——一个人类用户或一个项目服务账户——并存储明确的权限范围及可选的资源约束。系统只存储前缀和一个哈希值;完整的密钥仅在创建时显示一次。
shell
curl https://api.commandagi.com/me/credits \
-H "Authorization: Bearer $COMMANDAGI_API_KEY"权限范围与约束
权限范围可以是动作名称(view、chat、attachWorld、snapshot、configure、share),也可以是能力名称(viewer、operator、manager),或者 *。约束可以把一个密钥限定到具体的 projectIds、threadIds、worldIds 或 deviceIds。生效的权限是 principal_allows(action) && key_scope_allows(action)——默认最小权限。
用户与服务账户
个人密钥代表你本人,非常适合写脚本。服务账户是项目拥有的主体,有自己的密钥——用它们做共享、可审计的自动化。每一次密钥操作都会被记录(谁、做了什么、针对哪个资源、是否被允许),任何密钥都可以随时撤销。