Kaiten Skill
Manage Kaiten project boards via REST API (api/latest).
Configuration
Environment variables (loaded from ~/.openclaw/secrets/kaiten.env):
- -
KAITEN_TOKEN — Bearer API token - INLINECODE3 — Company subdomain (e.g.
company.kaiten.ru)
Before any API call, source the env file:
CODEBLOCK0
API Base
All requests go to: INLINECODE5
Auth header: INLINECODE6
Quick Reference
Read Operations
| Action | Endpoint | Method |
|---|
| List spaces | INLINECODE7 | GET |
| Get space |
/spaces/{id} | GET |
| List boards in space |
/spaces/{space_id}/boards | GET |
| Get board |
/boards/{id} | GET |
| List columns |
/boards/{board_id}/columns | GET |
| List lanes |
/boards/{board_id}/lanes | GET |
| List cards |
/cards?limit=N&offset=M | GET |
| Get card |
/cards/{card_id} | GET |
| Get card comments |
/cards/{card_id}/comments | GET |
| Get card checklists |
/cards/{card_id}/checklists | GET |
| Get card members |
/cards/{card_id}/members | GET |
| Get card files |
/cards/{card_id}/files | GET |
| Get card tags |
/cards/{card_id}/tags | GET |
| Get card children |
/cards/{card_id}/children | GET |
| Get card time logs |
/cards/{card_id}/time | GET |
| List all tags |
/tags | GET |
| List users |
/users | GET |
| Current user |
/users/current | GET |
| Search |
/search?query=TEXT | GET |
Write Operations
| Action | Endpoint | Method |
|---|
| Create card | INLINECODE26 | POST |
| Update card |
/cards/{card_id} | PATCH |
| Move card |
/cards/{card_id}/location | PATCH |
| Delete card |
/cards/{card_id} | DELETE |
| Add comment |
/cards/{card_id}/comments | POST |
| Add tag to card |
/cards/{card_id}/tags | POST |
| Remove tag |
/cards/{card_id}/tags/{tag_id} | DELETE |
| Add member |
/cards/{card_id}/members | POST |
| Remove member |
/cards/{card_id}/members/{id} | DELETE |
| Create checklist |
/cards/{card_id}/checklists | POST |
| Add checklist item |
/cards/{card_id}/checklists/{cl_id}/items | POST |
| Toggle checklist item |
/cards/{card_id}/checklists/{cl_id}/items/{item_id} | PATCH |
| Log time |
/cards/{card_id}/time | POST |
| Create board |
/spaces/{space_id}/boards | POST |
| Create column |
/boards/{board_id}/columns | POST |
Card Creation (POST /cards)
Required fields:
CODEBLOCK1
Optional fields: description, owner_id, type_id, size, size_text, asap, due_date, planned_start, planned_end, tag_ids, member_ids, sort_order.
Card States
- -
1 — active (default) - INLINECODE54 — archived
Card Movement (PATCH /cards/{card_id}/location)
CODEBLOCK2
State & Defaults
State file: INLINECODE55
Stores default_space_id, default_board_id, last_space_id, last_board_id, last_column_id, last_lane_id.
Rules:
- - When user sets a default space/board → update
default_* fields - After any operation on a space/board/column/lane → update
last_* fields - When creating a card without explicit board → use
default_board_id, fall back to INLINECODE65 - When user says "текущая доска" / "та же доска" → use INLINECODE66
- Read state before operations, write state after
CODEBLOCK3
Workflow
- 1. Source env: INLINECODE67
- Check state: INLINECODE68
- Use
scripts/kaiten.sh for common operations - For complex queries, use curl directly with the API base
Script Usage
The scripts/kaiten.sh helper wraps common operations:
CODEBLOCK4
API Details
For full endpoint documentation and field schemas, see references/api-reference.md.
Kaiten 技能
通过 REST API (api/latest) 管理 Kaiten 项目看板。
配置
环境变量(从 ~/.openclaw/secrets/kaiten.env 加载):
- - KAITENTOKEN — Bearer API 令牌
- KAITENDOMAIN — 公司子域名(例如 company.kaiten.ru)
在任何 API 调用前,先加载环境文件:
bash
source ~/.openclaw/secrets/kaiten.env
API 基础地址
所有请求发送至:https://$KAITEN_DOMAIN/api/latest/
认证头:Authorization: Bearer $KAITEN_TOKEN
快速参考
读取操作
/spaces/{id} | GET |
| 列出空间中的看板 | /spaces/{space_id}/boards | GET |
| 获取看板 | /boards/{id} | GET |
| 列出列 | /boards/{board_id}/columns | GET |
| 列出泳道 | /boards/{board_id}/lanes | GET |
| 列出卡片 | /cards?limit=N&offset=M | GET |
| 获取卡片 | /cards/{card_id} | GET |
| 获取卡片评论 | /cards/{card_id}/comments | GET |
| 获取卡片检查清单 | /cards/{card_id}/checklists | GET |
| 获取卡片成员 | /cards/{card_id}/members | GET |
| 获取卡片文件 | /cards/{card_id}/files | GET |
| 获取卡片标签 | /cards/{card_id}/tags | GET |
| 获取卡片子项 | /cards/{card_id}/children | GET |
| 获取卡片时间日志 | /cards/{card_id}/time | GET |
| 列出所有标签 | /tags | GET |
| 列出用户 | /users | GET |
| 当前用户 | /users/current | GET |
| 搜索 | /search?query=TEXT | GET |
写入操作
/cards/{card_id} | PATCH |
| 移动卡片 | /cards/{card_id}/location | PATCH |
| 删除卡片 | /cards/{card_id} | DELETE |
| 添加评论 | /cards/{card_id}/comments | POST |
| 为卡片添加标签 | /cards/{card_id}/tags | POST |
| 移除标签 | /cards/{card
id}/tags/{tagid} | DELETE |
| 添加成员 | /cards/{card_id}/members | POST |
| 移除成员 | /cards/{card_id}/members/{id} | DELETE |
| 创建检查清单 | /cards/{card_id}/checklists | POST |
| 添加检查清单项 | /cards/{card
id}/checklists/{clid}/items | POST |
| 切换检查清单项状态 | /cards/{card
id}/checklists/{clid}/items/{item_id} | PATCH |
| 记录时间 | /cards/{card_id}/time | POST |
| 创建看板 | /spaces/{space_id}/boards | POST |
| 创建列 | /boards/{board_id}/columns | POST |
卡片创建 (POST /cards)
必填字段:
json
{
title: 卡片标题,
board_id: 123,
column_id: 456,
lane_id: 789
}
可选字段:description、ownerid、typeid、size、sizetext、asap、duedate、plannedstart、plannedend、tagids、memberids、sort_order。
卡片状态
卡片移动 (PATCH /cards/{card_id}/location)
json
{
board_id: 123,
column_id: 456,
lane_id: 789
}
状态与默认值
状态文件:SKILL_DIR/scripts/kaiten-state.json
存储 defaultspaceid、defaultboardid、lastspaceid、lastboardid、lastcolumnid、lastlaneid。
规则:
- - 当用户设置默认空间/看板时 → 更新 default 字段
- 对空间/看板/列/泳道进行任何操作后 → 更新 last 字段
- 创建卡片时未指定看板 → 使用 defaultboardid,回退到 lastboardid
- 当用户说当前看板/同一看板时 → 使用 lastboardid
- 操作前读取状态,操作后写入状态
bash
读取状态
bash SKILL_DIR/scripts/kaiten.sh state
设置默认空间
bash SKILL
DIR/scripts/kaiten.sh set-default-space id>
设置默认看板
bash SKILLDIR/scripts/kaiten.sh set-default-board id>
工作流程
- 1. 加载环境:source ~/.openclaw/secrets/kaiten.env
- 检查状态:bash SKILL_DIR/scripts/kaiten.sh state
- 使用 scripts/kaiten.sh 进行常见操作
- 对于复杂查询,直接使用 curl 配合 API 基础地址
脚本使用
scripts/kaiten.sh 辅助工具封装了常见操作:
bash
先加载环境
source ~/.openclaw/secrets/kaiten.env
列出空间
bash SKILL_DIR/scripts/kaiten.sh spaces
列出空间中的看板
bash SKILLDIR/scripts/kaiten.sh boards id>
列出看板上的列
bash SKILLDIR/scripts/kaiten.sh columns id>
列出看板上的泳道
bash SKILLDIR/scripts/kaiten.sh lanes id>
获取卡片(可选限制/偏移)
bash SKILL_DIR/scripts/kaiten.sh cards [limit] [offset]
搜索卡片
bash SKILL_DIR/scripts/kaiten.sh search 查询文本
获取单个卡片
bash SKILLDIR/scripts/kaiten.sh card id>
创建卡片
bash SKILLDIR/scripts/kaiten.sh create-card id> id> id> 标题 [描述]
更新卡片
bash SKILLDIR/scripts/kaiten.sh update-card id> {title:新标题}
移动卡片
bash SKILLDIR/scripts/kaiten.sh move-card id> id> id>
添加评论
bash SKILLDIR/scripts/kaiten.sh comment id> 评论内容
列出标签
bash SKILL_DIR/scripts/kaiten.sh tags
为卡片添加标签
bash SKILLDIR/scripts/kaiten.sh add-tag id>
列出用户
bash SKILL_DIR/scripts/kaiten.sh users
当前用户
bash SKILL_DIR/scripts/kaiten.sh me
卡片检查清单
bash SKILLDIR/scripts/kaiten.sh checklists id>
创建检查清单
bash SKILLDIR/scripts/kaiten.sh create-checklist id> 检查清单名称
添加检查清单项
bash SKILLDIR/scripts/kaiten.sh add-checklist-item id> 项目文本
记录时间
bash SKILLDIR/scripts/kaiten.sh log-time id> <分钟数> [评论]
API 详情
有关完整的端点文档和字段模式,请参阅 references/api-reference.md。