飞书文档

Feishu (Lark) Document API writing spec。Converts Markdown content to。Use when 需要文件处理、文档转换、格式互转、内容提取时使用。不适用于加密文件破解。适用于独立开发者、企业团队和自动化工作流场景。支持中文交互,无需复杂配置即开即用。 F...

天轰穿

@thcjp

Install

$ openclaw skills install @thcjp/feishu-doc-write

核心功能: 本技能提供中文交互、化工作流场景等能力。

feishu-doc-write

付费版扩展能力

能力免费版付费版
基础功能支持支持
多渠道消息批量发送不支持支持
消息模板与变量注入不支持支持
送达状态实时回调不支持支持
通信记录归档与检索不支持支持
消息频控与智能排队不支持支持

能力一览

  • Feishu (Lark) Document API writing spec
  • Converts Markdown content to Feishu Block structures and

场景介绍

场景输入输出
文档处理文件路径与格式选项转换结果与页面信息
飞书文档API写入规目标数据与配置参数处理结果与执行状态
把Markdown转目标数据与配置参数处理结果与执行状态

不适用于:需要人工判断的复杂决策场景

使用说明

  1. 确认运行环境满足依赖说明中的要求
  2. 根据适用场景选择合适的使用方式
  3. 执行操作并检查输出结果
  4. 如遇错误,参考错误处理章节

输入参数

参数名类型必填说明
contentstring否feishu-doc-write处理的内容输入
modestring否处理模式, 可选: json/text/markdown,
max_retriesinteger否单步最大重试次数, 默认: 2
skip_stepsarray否跳过的步骤编号(用于断点续传), 默认: []

结果格式

{
  "success": true,
  "data": {
    "final_result": {
      "write_result": "write_result_value",
      "write_metadata": "write_metadata_value",
      "write_status": "write_status_value"
    },
    "execution_log": [
      {
        "step": 1,
        "name": "按流程执行",
        "status": "completed",
        "duration_ms": 1200,
        "output_summary": "按流程执行"
      },
      {
        "step": 2,
        "name": "按流程执行",
        "status": "completed",
        "duration_ms": 3500,
        "output_summary": "按流程执行"
      },
      {
        "step": 3,
        "name": "按流程执行",
        "status": "completed",
        "duration_ms": 2100,
        "output_summary": "按流程执行"
      },
      {
        "step": 4,
        "name": "按流程执行",
        "status": "completed",
        "duration_ms": 800,
        "output_summary": "按流程执行"
      }
    ],
    "total_duration_ms": 7600,
    "gates_passed": 3,
    "gates_total": 3
  },
  "error": null
}

中间产物模板参考: assets/feishu-doc-write_template

异常应对

错误场景原因处理方式
配置错误参数缺失或格式错误检查依赖说明中的配置要求
运行时错误运行环境不满足确认运行环境符合依赖说明
网络错误连接超时或不可达

运行环境

运行环境

  • Agent平台: 支持SKILL.md的任意AI Agent(Claude Code / Cursor / Codex / Gemini CLI等)
  • 操作系统: Windows / macOS / Linux

依赖说明(补充)

依赖项类型是否必需获取方式
LLM APIAPI必需由Agent内置LLM提供

API Key 配置

可用性分类

  • 分类: MD+execute()
  • 说明: 基于Markdown的AI Skill,

API Key配置方式:

export API_KEY="${API_KEY:?请设置环境变量}"

配置后需重启会话或开启新终端生效。API Key应妥善保管,避免泄露到版本控制系统.

案例展示

Text

{
  "block_type": 2,
  "text": {
    "elements": [{
      "text_run": {
        "content": "Paragraph text here",
        "text_element_style": { "bold": false, "italic": false }
      }
    }]
  }
}

Heading

{ "block_type": 3, "heading1": { "elements": [{ "text_run": { "content": "H1 Title" } }] } }
{ "block_type": 4, "heading2": { "elements": [{ "text_run": { "content": "H2 Title" } }] } }

Bullet / Ordered List

{ "block_type": 12, "bullet": { "elements": [{ "text_run": { "content": "List item" } }] } }
{ "block_type": 13, "ordered": { "elements": [{ "text_run": { "content": "Numbered item" } }] } }

Each list item is a separate Block.

Code Block

{
  "block_type": 14,
  "code": {
    "elements": [{ "text_run": { "content": "console.log('hello');" } }],
    "style": { "language": 23, "wrap": false }
  }
}

Common language enums: PlainText=1, JavaScript=23, Python=40, TypeScript=49, Go=20, Shell=46, SQL=47, Java=22, Rust=44, C=12, CSS=17, HTML=21, Docker=19.

Callout (Feishu-specific highlight box)

Callout is a container block — create it first, then add child blocks inside.

// Step 1: Create callout as document child
{ "block_type": 19, "callout": { "background_color": 3, "border_color": 3, "emoji_id": "star" } }
# ...
// Step 2: POST .../blocks/{callout_block_id}/children
{ "children": [{ "block_type": 2, "text": { "elements": [{ "text_run": { "content": "Highlight text" } }] } }] }

Color enums: Red=1, Orange=2, Yellow=3, Green=4, Blue=5, Purple=6, Grey=7.

Divider

{ "block_type": 22, "divider": {} }

Image (two-step)

Step 1: Create placeholder block { "block_type": 27, "image": {} }
Step 2: Upload via POST /open-apis/drive/v1/medias/upload_all
  - multipart/form-data: file, file_name, parent_type="docx_image", parent_node=<image_block_id>

注意事项

  • 需要API Key,无Key环境无法使用

创新优势

效率提升量化分析

操作步骤手动耗时自动化耗时时间节约准确率提升
文档格式转换30分钟/次5分钟/次25分钟/次98%
文档内容提取1小时/次10分钟/次50分钟/次95%
文档批量处理2小时/次30分钟/次1.5小时/次97%
文档结构化1.5小时/次20分钟/次1小时/次96%
文档版本控制2小时/次30分钟/次1.5小时/次98%

差异化对比

对比维度本技能手动操作Python脚本专业软件
易用性高低中高
速度高低中高
准确率高低中高
成本低高中高
扩展性高低中高

核心痛点解决

痛点描述影响范围解决方案量化效果
文档处理效率低文档处理过程繁琐,耗时较长影响工作效率自动化处理,提高处理速度时间节约25%
文档格式不统一文档格式不统一,难以管理和查找影响文档管理效率格式转换,统一文档格式准确率提升98%
文档内容提取困难文档内容提取困难,难以获取所需信息影响信息获取效率自动化提取,快速获取信息时间节约50%

常见问题FAQ

Q1: 飞书文档API写入规范支持哪些Markdown语法?

A: 飞书文档API写入规范支持基本的Markdown语法,包括标题、列表、表格、代码块、链接、图片等。

Q2: 如何将Markdown内容转换为飞书Block结构?

A: 使用feishu-doc-write技能,提供Markdown内容作为输入参数,即可将Markdown内容转换为飞书Block结构。

Q3: feishu-doc-write技能是否支持加密文件?

A: 不支持。feishu-doc-write技能主要用于处理普通文档,不适用于加密文件破解。

Q4: feishu-doc-write技能的输出结果是什么格式?

A: feishu-doc-write技能的输出结果为JSON格式,包含处理结果、执行日志等信息。

Q5: 如何处理feishu-doc-write技能执行过程中的错误?

A: 检查输入参数是否正确,确认运行环境符合依赖说明,如遇网络错误可尝试重试。

问题处理指引

错误现象可能原因诊断步骤解决方案
转换结果不正确输入内容格式错误检查输入内容格式修正输入内容格式
执行过程中出现异常运行环境不满足检查运行环境确保运行环境符合依赖说明
网络连接失败网络连接不稳定检查网络连接尝试重新连接或更换网络环境
输出结果为空没有提供输入参数检查输入参数提供必要的输入参数

安全提醒

  1. 确保输入内容安全,避免包含敏感信息。
  2. 定期更新技能版本,修复已知安全漏洞。
  3. 限制技能访问权限,防止未授权访问。
  4. 使用HTTPS协议进行数据传输,确保数据安全。
  5. 对敏感数据进行加密处理,防止数据泄露。

安全风险防范

风险项等级防护措施验证方法
API密钥泄露高通过环境变量配置,禁止硬编码定期检查代码和配置文件
命令执行风险高仅执行白名单命令,避免拼接用户输入使用沙箱环境测试
网络通信安全中使用HTTPS协议,验证SSL证书定期检查证书有效期
敏感数据暴露高输出结果中不包含密钥、令牌等敏感信息日志脱敏审查
未授权访问中限制访问权限,实施认证机制定期审计访问日志

核心功能特点

  • 自动化执行: 飞书文档API写入规范,把Markdown转飞书Block结构。Feishu (Lark) Document API w
  • 文件处理: 支持多种文件格式的读取、解析和写入操作
  • API集成: 通过标准化接口调用外部服务并处理响应
  • 命令执行: 在安全沙箱中执行系统命令并收集结果

异常管理

针对飞书文档使用中可能遇到的常见问题,提供以下排查方案:

错误类型原因分析解决方案
API认证失败(401)API密钥错误或过期检查密钥配置,重新生成token
接口限流(429)请求频率超出限制降低调用频率,启用重试退避策略
响应超时(504)网络延迟或服务端负载过高增加超时阈值,检查网络连接
文件不存在路径错误或文件未创建检查路径拼写,确认文件已生成
文件格式不支持扩展名不在支持列表中转换为支持的格式后重试
权限不足当前用户无读写权限检查文件权限,以管理员身份运行
命令执行失败参数错误或环境依赖缺失检查命令语法,确认依赖已安装
进程超时命令执行时间过长增加超时设置,优化命令参数
网络连接失败DNS解析失败或防火墙拦截检查网络配置,确认代理设置

飞书文档通用排查步骤

  1. 检查输入参数: 确认所有必填参数已提供且格式正确
  2. 查看日志输出: 定位具体错误行和异常类型
  3. 验证环境配置: 确认依赖库版本和运行环境满足要求
  4. 逐步调试: 缩小问题范围,隔离故障模块

Top skills in this category