OpenAPI Explorer

OpenAPI Explorer:

Unlock Native Feishu/Lark OpenAPI with Happycapy Skills

What Is This?

The OpenAPI Explorer (Skill ID: lark-openapi-explorer) is a specialized skill for the Happycapy Skills platform, designed to facilitate direct exploration and invocation of native Feishu (Lark) OpenAPI endpoints. Unlike standard skills or pre-registered CLI commands, OpenAPI Explorer provides a systematic means to discover and interact with raw OpenAPI interfaces as documented in Feishu's official markdown documentation repositories.

OpenAPI Explorer leverages the public documentation index and module structure provided by Feishu and Lark, utilizing WebFetch commands to programmatically navigate from the top-level index down to specific API documentation. This process enables users to identify and call API endpoints that are not encapsulated by existing CLI commands or other skills.

Why Use It?

OpenAPI Explorer is essential when your requirements cannot be met by existing lark-* skills or by any commands currently registered with the lark-cli. Feishu and Lark's platforms regularly update their OpenAPI offerings, and not all endpoints are immediately or ever integrated into CLI tools or skill libraries. This means there can be a significant gap between what is officially documented and what is easily accessible through standard tools.

By using OpenAPI Explorer, you gain:

• Access to the full breadth of Feishu/Lark OpenAPI: Interact with endpoints that are otherwise unavailable via CLI or other skills.
• Direct documentation-driven workflow: Fetch the most current endpoint specification straight from official sources.
• Enhanced flexibility: Freely explore, discover, and use undocumented or newly released APIs without waiting for CLI or skill updates.
• Minimized guesswork: The explorer enforces a strict step-by-step discovery process, reducing errors and ensuring only officially documented endpoints are used.

How to Use It

Prerequisites

Before using OpenAPI Explorer, review the shared skill documentation (lark-shared/SKILL.md) to understand authentication, identity switching, and security guidelines. You must have the lark-cli binary installed, as it is required for native API invocation.

Step-by-Step Usage

1. Confirm Existing Capability Gaps

First, check if your need is already met by an existing skill or CLI command:

lark-cli <possible-service> --help

If a suitable command exists, use it directly. Only proceed to the next steps if your need is unmet.

2. Locate Relevant Module via Top-Level Index

Use WebFetch to retrieve the top-level documentation index:

WebFetch https://open.feishu.cn/llms.txt

Extract the list of module documentation links and identify the module most relevant to your need using a query such as:

Extract: "List all module documentation links and identify those related to <your keywords>"

For the Lark brand, use https://open.larksuite.com/llms.txt. If in doubt, default to Feishu.

3. Find the Specific API in the Module Documentation

Fetch the selected module's documentation:

WebFetch https://open.feishu.cn/llms-docs/zh-CN/llms-<module>.txt

Query for relevant API documentation:

Extract: "Find API documentation and links related to <your requirement>"

4. Retrieve the Full API Specification

Once the API documentation link is identified, fetch it:

WebFetch <api-doc>.md

Parse the methods, endpoint path, parameters, request/response schema, and error codes.

5. Invoke the API via lark-cli

Using the complete specification, invoke the API using the lark-cli api command. For example:

lark-cli api --method POST --path /open-apis/attendance/v1/checkin --json '{"user_id": "ou_xxx", "date": "2024-06-01"}'

Replace method, path, and parameters with actual values from the documentation.

When to Use It

OpenAPI Explorer should be used only when:

• Your requirement cannot be fulfilled by existing Happycapy skills or lark-cli registered APIs.
• You need to access newly released, experimental, or rarely used Feishu/Lark OpenAPI endpoints.
• You require access to the most up-to-date or unwrapped API features directly from official documentation.

Avoid using OpenAPI Explorer for tasks already supported by higher-level skills or CLI commands, as those offer validated, user-friendly abstractions and error handling.

Important Notes

• Strict Process: Always follow the documented step-by-step approach. Never skip steps or guess at API endpoints. Only use endpoints verified in the official markdown documentation.
• Documentation Language: All official Feishu/Lark documentation is in Chinese. When interacting in English, translate the relevant documentation content before using it to ensure accuracy.
• Security: Ensure your usage is compliant with authentication and security guidelines as specified in the shared documentation. Improper or unauthorized API calls may lead to errors or security risks.
• Brand Specificity: Use open.feishu.cn for Feishu or open.larksuite.com for Lark. When in doubt, default to Feishu.
• lark-cli Dependency: This skill requires lark-cli to be installed and configured with appropriate credentials.
• Skill Scope: OpenAPI Explorer does not wrap or abstract APIs - it merely exposes raw documentation and facilitates direct invocation via CLI.

By adhering to these best practices and the defined exploration flow, OpenAPI Explorer empowers you to leverage the full capabilities of Feishu/Lark OpenAPI, even when those capabilities extend beyond standard skill or CLI coverage.