公开 API

开发者

公开 API

面向项目、任务、冲刺和活动的 REST 端点——使用 Bearer API 密钥认证。

公开 API

Skrum 是一体化的 AI 项目控制平台——团队聊天、任务与冲刺、原生视频会议、以及入站代码活动,全部集中在一个工作空间中,每一项 AI 操作都会等待人工确认后才会执行。

在设置 → API 密钥中创建一个 API 密钥——仅显示一次。将其作为 Bearer 令牌发送到 /api/v1。每一个列表端点都返回 { data, nextCursor };将 nextCursor 作为下一页的 cursor 参数回传即可(每页 1 到 100 条,默认 25 条)。错误信息统一封装为 { error: { code, message } }。完整的接口规范位于 /api/v1/openapi.json。

端点

  • GET /projects
  • GET /projects/{key}
  • GET /projects/{key}/tasks
  • GET /projects/{key}/sprints
  • GET /projects/{key}/activity
  • GET /tasks/{ref}(例如 WEB-42)
  • POST /tasks

试一试

curl -H "Authorization: Bearer $SKRUM_API_KEY" https://your-workspace.example/api/v1/projects
curl -H "Authorization: Bearer $SKRUM_API_KEY" https://your-workspace.example/api/v1/tasks/WEB-1
curl -H "Authorization: Bearer $SKRUM_API_KEY" -H "Content-Type: application/json" \
  -d '{"projectKey":"WEB","title":"Ship the docs"}' https://your-workspace.example/api/v1/tasks

常见问题

  • 需要什么方案? REST API 需要 Agency 方案(参见方案)。
  • 有限流吗? 按令牌计算,可通过环境变量调整;默认值较为保守。

另请参阅: Skrum 文档