Lark Openapi Explorer

Name: Lark Openapi Explorer
Author: larksuite

larksuite/cli

384k installs
15.9k repo stars
Updated July 28, 2026
larksuite/cli

This is a copy of lark-openapi-explorer by open.feishu.cn - installs and ranking accrue to the original listing.

lark-openapi-explorer is an agent skill that navigates the official Feishu/Lark OpenAPI markdown documentation tree and invokes native REST endpoints through lark-cli api for developers who need API calls beyond register

About

lark-openapi-explorer is a lark-cli companion skill for Feishu/Lark integrations. When packaged lark-* skills or registered lark-cli commands cannot satisfy a requirement, the skill walks a three-level markdown doc hierarchy—llms.txt module index, llms-<module>.txt overviews, and per-endpoint <api-doc>.md files—to locate the exact HTTP method, path, parameters, response schema, and error codes. After discovery it executes the call with lark-cli api using --data or --params, following authentication and identity rules from lark-shared. Developers reach for it during bot, workflow, or enterprise automation builds that hit gaps in the CLI surface. Prerequisite: lark-cli must be installed and configured.

Follows strict 4-step discovery workflow that never guesses APIs
Crawls official llms.txt → module → API markdown hierarchy
Translates all Chinese documentation into English output
First validates against existing lark-cli commands before exploration
Returns complete method/path/parameters/response/error code specs

Lark Openapi Explorer by the numbers

384,024 all-time installs (skills.sh)
Security screen: MEDIUM risk (skills.sh audit)
Data as of Jul 28, 2026 (Skillselion catalog sync)

npx skills add https://github.com/larksuite/cli --skill lark-openapi-explorer

Add your badge

Show developers this skill is listed on Skillselion. Paste this into your README.

[![Listed on Skillselion](https://skillselion.com/badge/skills/larksuite/cli/lark-openapi-explorer.svg)](https://skillselion.com/skills/larksuite/cli/lark-openapi-explorer)

Installs	384k
repo stars	★ 15.9k
Security audit	1 / 3 scanners passed
Last updated	July 28, 2026
Repository	larksuite/cli ↗

How do you call undocumented Feishu OpenAPI endpoints?

When an existing Lark/Feishu skill or CLI command cannot fulfill a specific requirement and they need to discover and invoke the exact native OpenAPI endpoint.

Who is it for?

Developers extending Lark/Feishu bots or workflows when lark-cli registered commands and existing lark-* skills do not cover the needed API.

Skip if: Developers whose task is already covered by a registered lark-cli command, Shortcut, or existing lark skill without raw OpenAPI exploration.

When should I use this skill?

A Lark/Feishu integration requirement cannot be fulfilled by existing lark-cli commands, Shortcuts, or packaged lark skills.

What you get

Identified OpenAPI method/path, parameter schema, and executed lark-cli api response payload

OpenAPI endpoint specification
lark-cli api invocation result

By the numbers

Navigates a 3-level Feishu OpenAPI markdown documentation hierarchy
Requires the lark-cli binary as a prerequisite

Files

SKILL.mdMarkdownGitHub ↗

OpenAPI Explorer

前置条件： 先阅读 `../lark-shared/SKILL.md` 了解认证、身份切换和安全规则。

当用户的需求无法被现有 skill 或 CLI 已注册 API 覆盖时，使用本技能从飞书官方 markdown 文档库中逐层挖掘原生 OpenAPI 接口，然后通过 lark-cli api 裸调完成任务。

文档库结构

飞书 OpenAPI 文档以 markdown 层级组织：

llms.txt                          ← 顶层索引，列出所有模块文档链接
  └─ llms-<module>.txt            ← 模块文档，包含功能概述 + 底层 API 文档链接
       └─ <api-doc>.md            ← 单个 API 的完整说明（方法/路径/参数/响应/错误码）

文档入口：

品牌	入口 URL
飞书 (Feishu)	`https://open.feishu.cn/llms.txt`
Lark	`https://open.larksuite.com/llms.txt`

所有文档以中文编写。如果用户使用英文交流，需将文档内容翻译为英文后输出。

挖掘流程

严格按以下步骤逐层检索，不要跳步或猜测 API：

Step 1：确认现有能力不足

# 先检查是否已有对应的 skill 或已注册 API
lark-cli <可能的service> --help

如果已有对应命令或 shortcut，直接使用，不需要继续挖掘。

Step 2：从顶层索引定位模块

用 WebFetch 获取顶层索引，找到与需求相关的模块文档链接：

WebFetch https://open.feishu.cn/llms.txt
  → 提取问题："列出所有模块文档链接，找出与 <用户需求关键词> 相关的链接"

飞书品牌使用 open.feishu.cn
Lark 品牌使用 open.larksuite.com
如不确定用户品牌，默认使用飞书

Step 3：从模块文档定位具体 API

用 WebFetch 获取模块文档，找到具体 API 的文档链接：

WebFetch https://open.feishu.cn/llms-docs/zh-CN/llms-<module>.txt
  → 提取问题："找出与 <用户需求> 相关的 API 说明和文档链接"

Step 4：获取 API 完整规范

用 WebFetch 获取具体 API 文档，提取完整的调用规范：

WebFetch https://open.feishu.cn/document/server-docs/.../<api>.md
  → 提取问题："返回完整 API 规范：HTTP 方法、URL 路径、路径参数、查询参数、请求体字段（名称/类型/必填/说明）、响应字段、所需权限、错误码"

Step 5：通过 CLI 调用 API

使用 lark-cli api 裸调：

# GET 请求
lark-cli api GET /open-apis/<path> --params '{"key":"value"}'

# POST 请求
lark-cli api POST /open-apis/<path> --data '{"key":"value"}'

# PUT 请求
lark-cli api PUT /open-apis/<path> --data '{"key":"value"}'

# DELETE 请求
lark-cli api DELETE /open-apis/<path>

输出规范

向用户呈现挖掘结果时，按以下格式组织：

1. API 名称与功能：一句话描述 2. HTTP 方法与路径：METHOD /open-apis/... 3. 关键参数：列出必填和常用可选参数 4. 所需权限：scope 列表 5. 调用示例：给出 lark-cli api 的完整命令 6. 注意事项：频率限制、特殊约束等

如果用户使用英文交流，将以上所有内容翻译为英文。

安全规则

写入/删除类 API（POST/PUT/DELETE）调用前必须确认用户意图
建议先用 --dry-run 预览请求（如支持）
不要猜测 API 路径或参数——必须从文档中获取确认
涉及敏感操作（删除群、移除成员等）时，向用户说明影响范围

使用场景示例

场景 1：用户需要拉人进群（未被 CLI 封装）

# Step 1: 确认 CLI 没有封装
lark-cli im --help
# → 发现没有 chat_members 相关的 create 命令

# Step 2-4: 通过文档挖掘获得 API 规范
# → POST /open-apis/im/v1/chats/:chat_id/members

# Step 5: 调用
lark-cli api POST /open-apis/im/v1/chats/oc_xxx/members \
  --data '{"id_list":["ou_xxx","ou_yyy"]}' \
  --params '{"member_id_type":"open_id"}'

场景 2：用户需要设置群公告

# Step 1: 确认 CLI 没有封装
lark-cli im --help
# → 没有 announcement 相关命令

# Step 2-4: 挖掘文档
# → PATCH /open-apis/im/v1/chats/:chat_id/announcement

# Step 5: 调用
lark-cli api PATCH /open-apis/im/v1/chats/oc_xxx/announcement \
  --data '{"revision":"0","requests":["<html>公告内容</html>"]}'

参考

lark-shared — 认证和全局参数
lark-skill-maker — 如需将挖掘到的 API 固化为新 Skill

Related skills

Lark Openapi ExplorerInstantly explore, test, and generate calls against the full Lark (Feishu) OpenAPI surface without leaving their agent workflow.479k

Lark EventConsume real-time events from Lark/Feishu as structured NDJSON streams inside AI agent workflows.384k15.8k

Just ScrapeQuickly search, crawl, extract structured JSON, or monitor web pages without writing custom scraping code.245k38

Lark AppsQuery the current visibility and permission scope of a Lark (Feishu) app without writing HTTP client code.232k15.8k

SupabaseGet accurate, up-to-date Supabase implementation guidance across database, auth, realtime, storage, edge functions and vector search without relying on outd184k2.4k

Design An InterfaceGenerate multiple radically different interface or API designs in parallel before committing to one.182k190k

How it compares

Prefer lark-openapi-explorer over registered lark-cli commands only when Shortcut and schema-registered APIs do not expose the needed Feishu endpoint.

FAQ

When should I use lark-openapi-explorer?

lark-openapi-explorer applies when no existing lark-* skill or registered lark-cli command covers the Feishu/Lark requirement. The skill searches the official markdown OpenAPI library and invokes the native endpoint through lark-cli api.

What documentation structure does lark-openapi-explorer follow?

lark-openapi-explorer starts at llms.txt for module links, opens llms-<module>.txt for API overviews, then reads individual <api-doc>.md files containing method, path, parameters, responses, and error codes.

Is Lark Openapi Explorer safe to install?

skills.sh reports 1 of 3 security scanners passed. Review the Security Audits panel on this page before installing in production.

Backend & APIsagentsautomation