ai_member_xiaobian/.agents/skills/lark-base/references/lark-base-field-create.md
2026-05-15 10:57:05 +08:00

3.5 KiB
Raw Permalink Blame History

base +field-create

前置条件: 先阅读 ../lark-shared/SKILL.md 了解认证、全局参数和安全规则。

创建一个字段。

Agent 最小工作流

  1. 先判断是不是 formula / lookup
  2. 如果是:先读对应 guide。
  3. 没读 guide 前,不要直接创建 formula / lookup 字段。
  4. 读完 guide 后,再构造 --json 并创建字段。
  5. 如果是跨表 formula / lookup再补查目标表的结构。

推荐命令

lark-cli base +field-create \
  --base-token <base_token> \
  --table-id <table_id> \
  --json '{"name":"预算","type":"number","style":{"type":"plain","precision":2}}'

lark-cli base +field-create \
  --base-token <base_token> \
  --table-id <table_id> \
  --json '{"name":"状态","type":"select","multiple":false,"options":[{"name":"Todo","hue":"Blue","lightness":"Lighter"},{"name":"Done","hue":"Green","lightness":"Light"}]}'

lark-cli base +field-create \
  --base-token <base_token> \
  --table-id <table_id> \
  --json '{"name":"负责人","type":"user","multiple":false,"description":"用于标记记录的直接负责人;协作约定可参考[团队字段约定](https://example.com/field-spec)"}'

参数

参数 必填 说明
--base-token <token> Base Token
--table-id <id_or_name> 表 ID 或表名
--json <body> 字段属性 JSON 对象

API 入参详情

HTTP 方法和路径:

POST /open-apis/base/v3/bases/:base_token/tables/:table_id/fields

JSON 值规范

  • --json 必须是 JSON 对象,顶层直接传字段定义,不要再套一层。
  • 顶层最少包含:nametype
  • 所有字段类型都支持可选 description;支持纯文本,也支持 Markdown 链接,如 协作约定可参考[团队字段约定](https://example.com/field-spec)
  • type 不同,必填子字段不同:
    • selectmultiple 控制是否多选,options 定义静态选项,dynamic_options_source 定义动态选项来源。静态与动态选项配置二选一,不能同时传。
    • link:必须有 link_table,可选 bidirectionalbidirectional_link_field_name
    • formula:必须有 expression;先读 formula guide再创建。
    • lookup:必须有 fromselectwhere;先读 lookup guide再创建。

正确base +field-create

{
  "name": "状态",
  "type": "select",
  "multiple": false,
  "options": [
    { "name": "Todo", "hue": "Blue", "lightness": "Lighter" },
    { "name": "Done", "hue": "Green", "lightness": "Light" }
  ]
}

字段说明示例

{
  "name": "负责人",
  "type": "user",
  "multiple": false,
  "description": "用于标记记录的直接负责人;协作约定可参考[团队字段约定](https://example.com/field-spec)"
}

返回重点

  • 返回 fieldcreated: true

工作流

  1. formula / lookup 字段必须先阅读对应指南;没读之前不要直接创建。

坑点

  • ⚠️ 这是写入操作,执行前必须确认。
  • ⚠️typeformulalookup 时,先读对应 guide再创建。

参考