Skip to main content

API 概览

管理 API 让您把原本需要在控制台团队页面完成的操作自动化 —— 邀请成员、变更角色、签发和轮换 API 密钥、读取用量 —— 全程不需要浏览器会话。适合用来搭建入职/离职自动化、密钥轮换流水线和用量报表。

API 章节

团队

读取团队信息,重命名团队(仅 Owner)。

API 密钥

列出、创建、轮换和吊销 API 密钥 —— 读取类接口永远不会返回密钥值。

成员

查看成员名单,变更角色,移除成员。

邀请

按邮箱邀请、列出邀请、撤销待接受的邀请。

用量

配额快照与指定时间段内按模型的消耗明细。
刻意不开放的能力:创建或删除团队、转让所有权,以及变更计费 —— 这些仍然是仅限控制台、需要人工确认的操作。

使用须知

响应结构、分页与错误码见概览错误处理。以下三项需要留意:

权限

各接口都会以 resource:action 的形式标注所需权限(例如 member:invite)。密钥以其创建者的角色行事 —— 由团队 Admin 创建的密钥,能做的就是该 Admin 能做的事。如果创建者失去了某项权限(或退出了团队),其名下的密钥也随之失去该权限。密钥本身有效但不具备所需权限时,返回 403ACCESS_DENIED

幂等

写入类接口接受可选的 Idempotency-Key 请求头(任意唯一字符串,例如一个 UUID)。用相同的值重试会重放第一次的结果,而不会把副作用再执行一遍 —— 对密钥轮换来说,这就是「再次拿到同一把新密钥」和「刚保存好的密钥又被作废」之间的区别。重放的响应会带上 Idempotency-Replayed: true 响应头。限流拒绝(429)永远不会被重放,因此固定幂等键的退避重试循环可以正常工作。

速率限制

后续步骤

团队

从 GET /team 开始 —— 读取您的团队以及密钥的角色

认证

获取 API Key,发出第一个请求