Agent 开放 API 指南
开放 API 主要给 Cursor、本地脚本或其他 Agent 使用。先在官网创建 API Key,再把 key 填到 Agent 的环境变量或配置里即可。
基础信息
API Key 以 gank_sk_live_ 开头。完整 key 只会在创建成功时显示一次,后面无法再次查看。
公开 API 按账号套餐限流:免费版和试用版 60 次/分钟,专业版 120 次/分钟,旗舰版 360 次/分钟。面试复盘这类消耗型接口还会继续检查对应套餐权益。
创建 API Key
API Key 在官网管理面板的账户设置里创建:
创建步骤:
- 打开官网并登录账号。
- 从右上角用户菜单进入“管理面板”。
- 打开“账户设置”,点击左侧的“API Key”。
- 点击“创建 Key”。
- 填写名称,例如
Cursor Agent或Local Sync Script。 - 勾选需要的权限。建议只选当前 Agent 会用到的权限。
- 如有需要,设置过期时间。
- 点击“创建并显示 Key”。
- 复制弹窗里的完整
gank_sk_live_...key。
忘记复制完整 key 时,不能重新查看,只能吊销后再创建一个新的。
在同一个页面可以查看已创建的 key,也可以吊销不用的 key。
权限说明
| Scope | 能力 |
|---|---|
resumes:read | 读取简历列表和详情 |
interviews:read | 读取面试/笔试记录 |
interviews:write | 上传本地面试/笔试文本记录 |
interviews:analyze | 生成面试复盘 |
recruitment:read | 读取投递进度 |
recruitment:write | 创建或更新投递进度 |
questions:read | 查询公共题库 |
questions:write | 收藏公共题到个人题库 |
campus:read | 查询校招岗位和资料 |
简历接口只开放读取,不支持通过开放 API 创建或修改简历。
常用接口
读取简历
读取面试记录
常用查询参数:
| 参数 | 说明 |
|---|---|
type | interview 或 exam |
query | 按公司、岗位或转写文本搜索 |
page | 页码,默认 1 |
limit | 每页数量,默认 20,最大 100 |
上传本地面试记录
字段说明:
| 字段 | 必填 | 说明 |
|---|---|---|
transcript | 是 | 本地整理后的面试或笔试文本 |
type | 否 | interview 或 exam,默认 interview |
startTime | 否 | ISO 8601 时间;不传则使用当前时间 |
endTime | 否 | ISO 8601 时间;不传则等于 startTime |
company | 否 | 公司名称 |
position | 否 | 岗位名称 |
round | 否 | 轮次,例如 一面、HR 面 |
parentId | 否 | 仅 type: "exam" 可用,用于关联到一条面试记录 |
生成面试复盘
投递进度
读取投递记录:
创建投递记录:
更新投递记录:
题库
查询公共题库:
收藏题目:
校招岗位和资料
查询校招岗位:
常用参数:q、company、industry、type、target、location、updatedAfter、page、pageSize。updatedAfter 使用 ISO 8601 时间,返回该时间及之后更新的岗位。
查询岗位详情:
查询校招资料:
常见错误
| 状态码 | 含义 |
|---|---|
401 | API Key 缺失、错误、过期或已吊销 |
403 | 当前 key 没有所需权限 |
429 | 请求过快,稍后重试 |
404 | 要读取或更新的记录不存在 |