开放平台

身份认证

使用个人访问令牌(PAT)进行 Castrel API 认证。

创建个人访问令牌

  1. 登录 Castrel 后,打开 设置 → 个人访问令牌
  2. 点击 创建令牌
  3. 填写:
    • 令牌名称:起一个易于辨识的名字,如 ci-scriptlocal-dev(1–100 字符)
    • 过期时间:可选 30 天 / 90 天 / 1 年 / 永不过期
  4. 点击确认创建
  5. 创建成功后请立即复制并保存令牌,关闭弹窗后将无法再次查看

使用个人访问令牌

在 HTTP 请求头中传入 Bearer Token:

curl -X POST "https://<your-instance>/personal/v1/knowledge/list" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{"page_num": 1, "page_size": 20}'

Python 示例

import requests

headers = {
    "Authorization": "Bearer <your-token>",
    "Content-Type": "application/json",
}

resp = requests.post(
    "https://<your-instance>/personal/v1/knowledge/list",
    headers=headers,
    json={"page_num": 1, "page_size": 20},
)
print(resp.json())

创建或更新知识

curl -X POST "https://<your-instance>/personal/v1/knowledge/upsert" \
  -H "Authorization: Bearer <your-token>" \
  -H "Content-Type: application/json" \
  -d '{"name": "常用运维命令", "content": "## 磁盘检查\n```bash\ndf -h\n```"}'

管理个人访问令牌

设置 → 个人访问令牌 页面可以查看和管理所有令牌。

吊销令牌

不再需要或怀疑泄露时,可以吊销令牌:

  • 单个吊销:在令牌操作菜单中选择 吊销
  • 批量吊销:勾选多个令牌后点击 批量吊销

吊销后立即生效,该令牌将无法继续使用。

轮换令牌

轮换会生成新令牌并同时吊销旧令牌,保留原有名称和过期时间窗口。

  • 单个轮换:在令牌操作菜单中选择 轮换,保存新令牌
  • 批量轮换:勾选多个令牌后点击 批量轮换

安全建议

  • 令牌创建后仅展示一次,请保存到密码管理器或环境变量中
  • 不要将令牌硬编码在代码或提交到版本控制系统
  • 定期轮换长期令牌,闲置令牌及时清理
  • 发现异常立即吊销

常见问题

令牌创建后能再次查看吗? 不能,只展示一次。丢失后请轮换取新。

令牌过期了怎么办? 过期后 API 请求会返回 401。可通过轮换续期。

令牌能跨工作区使用吗? 不能,每个令牌绑定到创建时的工作区。