Feishu Block Ops

v1.0.0

Low-level Feishu document block operations via REST API. Use when feishu_doc built-in actions are insufficient: batch update cells, precise position insert,...

0· 282·0 current·0 all-time
bydeadblue@deadblue22

Install

OpenClaw Prompt Flow

Install with OpenClaw

Best for remote or guided setup. Copy the exact prompt, then paste it into OpenClaw for deadblue22/feishu-block-ops.

Previewing Install & Setup.
Prompt PreviewInstall & Setup
Install the skill "Feishu Block Ops" (deadblue22/feishu-block-ops) from ClawHub.
Skill page: https://clawhub.ai/deadblue22/feishu-block-ops
Keep the work scoped to this skill only.
After install, inspect the skill metadata and help me finish setup.
Use only the metadata you can verify from ClawHub; do not invent missing requirements.
Ask before making any broader environment changes.

Command Line

CLI Commands

Use the direct CLI path if you want to install manually and keep every step visible.

OpenClaw CLI

Canonical install target

openclaw skills install deadblue22/feishu-block-ops

ClawHub CLI

Package manager switcher

npx clawhub@latest install feishu-block-ops
Security Scan
VirusTotalVirusTotal
Benign
View report →
OpenClawOpenClaw
Suspicious
high confidence
!
Purpose & Capability
The skill claims to perform low-level Feishu document block operations, which legitimately requires a Feishu tenant token. However, the skill metadata lists no required environment variables, primary credential, or config paths, while the instructions explicitly read ~/.openclaw/openclaw.json for appId and appSecret. The declared requirements do not match what the instructions need.
!
Instruction Scope
The SKILL.md gives detailed, purpose-aligned API guidance (endpoints, batch update semantics, rate-limit advice) which is appropriate. But it also directs the agent to read a specific user config file (~/.openclaw/openclaw.json) to obtain app credentials. That is a sensitive file access that was not declared in the metadata and should be surfaced to the user.
Install Mechanism
This is an instruction-only skill with no install specification and no code files, so it will not write or install artifacts on disk. That lowers installation risk.
!
Credentials
The skill needs Feishu credentials (app_id, app_secret -> tenant_access_token) to operate, but it requests none via requires.env nor lists any required config paths in metadata. Expecting the agent to read stored credentials from the user's OpenClaw config without declaring that requirement is disproportionate and surprising.
Persistence & Privilege
The skill is not marked always:true and does not request persistent system-wide changes in its instructions. It reads a config file to get credentials but does not instruct writing or modifying other skills or global agent settings.
What to consider before installing
Before installing, confirm you are comfortable with this skill reading ~/.openclaw/openclaw.json to obtain Feishu appId/appSecret. Ask the author to (a) declare that config path and required credentials in the skill metadata, or (b) allow you to supply credentials explicitly via environment variables or an input prompt. If you proceed, prefer using a dedicated Feishu app with minimal permissions and revoke its secrets after testing. Inspect the OpenClaw config file contents and ensure no unrelated secrets are stored there. If you don't trust the skill owner or cannot verify the source (homepage/source unknown), do not install or run this skill against real/production documents or credentials — test in a sandboxed account first.

Like a lobster shell, security has layers — review code before you run it.

latestvk97fb1kn0zsc8cez68afx5mdf1829y6g
282downloads
0stars
1versions
Updated 1mo ago
v1.0.0
MIT-0

Feishu Block Operations

Direct REST API operations for Feishu cloud documents when the feishu_doc tool's built-in actions don't cover your needs.

When to Use This (vs feishu_doc)

NeedUse
Read/write/append documentfeishu_doc
Create simple tablefeishu_doc create_table_with_values
Upload image/filefeishu_doc upload_image/upload_file
Batch update 200 cells at onceThis skill
Insert content at exact positionThis skill (or feishu-md2blocks)
Traverse block treeThis skill
Table row/column insert/deleteThis skill
Merge/unmerge table cellsThis skill
Replace images in-placeThis skill
Delete blocks by index rangeThis skill

Authentication

Get tenant access token from OpenClaw config:

import json, urllib.request

def get_feishu_token():
    with open(os.path.expanduser("~/.openclaw/openclaw.json")) as f:
        c = json.load(f)["channels"]["feishu"]
    payload = json.dumps({"app_id": c["appId"], "app_secret": c["appSecret"]}).encode()
    req = urllib.request.Request(
        "https://open.feishu.cn/open-apis/auth/v3/tenant_access_token/internal",
        data=payload, headers={"Content-Type": "application/json"}, method="POST")
    return json.loads(urllib.request.urlopen(req).read())["tenant_access_token"]

All API calls use header: Authorization: Bearer {token}

Rate Limits

OperationLimit
Read (GET)5 req/sec per app
Write (POST/PATCH/DELETE)3 req/sec per app, 3 req/sec per document

Use time.sleep(0.35) between write calls. For reads, time.sleep(0.25).

API Reference

Base URL: https://open.feishu.cn/open-apis/docx/v1/documents

1. Get Block

GET /docx/v1/documents/{doc}/blocks/{block_id}

Returns single block with full content (type, elements, children IDs, styles).

2. Get Children (with optional full tree)

GET /docx/v1/documents/{doc}/blocks/{block_id}/children
    ?with_descendants=true    # get ALL descendants, not just direct children
    &page_size=500            # max 500
    &document_revision_id=-1  # latest revision

Tip: Use with_descendants=true on table blocks to get all cells + cell content in one call.

3. Create Blocks (simple, flat only)

POST /docx/v1/documents/{doc}/blocks/{parent_id}/children
Body: {"children": [...blocks], "index": 0}
  • Max 50 blocks per call
  • Cannot create nested structures (e.g. table with cell content)
  • index in body: 0=beginning, -1=end (default)

4. Create Nested Blocks (tables, grids, etc.)

POST /docx/v1/documents/{doc}/blocks/{parent_id}/descendant
Body: {
    "children_id": ["temp_id_1", "temp_id_2"],
    "descendants": [...all_blocks_with_parent_child_relations],
    "index": 0
}
  • Max 1000 blocks per call
  • children_id: only first-level child IDs (NOT grandchildren — causes error 1770006)
  • descendants: flat array of ALL blocks including nested ones, each with block_id, block_type, children (list of child temp IDs)
  • ⚠️ index MUST be in request body, NOT as URL query parameter?index=N is silently ignored

5. Batch Update Blocks

PATCH /docx/v1/documents/{doc}/blocks/batch_update
Body: {"requests": [...update_requests]}

Max 200 blocks per call. Each request object contains block_id + one operation:

OperationPurpose
update_text_elementsReplace text content + inline elements
update_text_styleChange alignment, folded, language, wrap, background_color
update_table_propertyModify column widths, header rows/columns
insert_table_rowInsert rows at index
insert_table_columnInsert columns at index
delete_table_rowsDelete rows by index + count
delete_table_columnsDelete columns by index + count
merge_table_cellsMerge cells (row_start, row_end, column_start, column_end)
unmerge_table_cellsUnmerge previously merged cells
replace_imageReplace image block's content with new file_token

Example: batch update text in multiple cells

requests = []
for block_id, new_text in updates.items():
    requests.append({
        "block_id": block_id,
        "update_text_elements": {
            "elements": [{"text_run": {"content": new_text}}]
        }
    })

api_call(token, "PATCH",
    f"https://open.feishu.cn/open-apis/docx/v1/documents/{doc}/blocks/batch_update",
    {"requests": requests})

6. Update Single Block

PATCH /docx/v1/documents/{doc}/blocks/{block_id}
Body: {same operations as batch_update, without block_id wrapper}

7. Delete Blocks

DELETE /docx/v1/documents/{doc}/blocks/{parent_id}/children/batch_delete
Body: {"start_index": 0, "end_index": 5}
  • ⚠️ Uses start_index/end_index (half-open interval [start, end)), NOT block_ids
  • Indices are relative to the parent block's children list

Block Types

TypeIDNotes
Page1Document root, always one
Text2Plain paragraph
Heading1–93–11
Bullet12Unordered list item
Ordered13Ordered list item
Code14Code block
Quote15Block quote
Todo17Checkbox item
Callout19Highlighted block
Divider22Horizontal rule (body: {})
Grid24Multi-column layout
GridColumn25Column in grid
Image27Image block
Table31Table container
TableCell32Cell in table
QuoteContainer34Quote wrapper (body: {})

Text Elements

Text blocks contain an elements array. Each element is one of:

# Plain text
{"text_run": {"content": "hello", "text_element_style": {"bold": True, "link": {"url": "..."}}}}

# Mention user
{"mention_user": {"user_id": "ou_xxx", "text_element_style": {}}}

# Mention document
{"mention_doc": {"token": "xxx", "obj_type": 22, "text_element_style": {}}}

# Equation (LaTeX)
{"equation": {"content": "E=mc^2"}}

# Reminder
{"reminder": {"expire_time": 1234567890, "is_whole_day": True}}

Common Patterns

Pattern 1: Read table content

# 1. Get table's descendants in one call
url = f".../blocks/{table_block_id}/children?with_descendants=true&page_size=500&document_revision_id=-1"
items = api_call(token, "GET", url)["data"]["items"]

# 2. Extract text from cells
for item in items:
    if item["block_type"] == 2 and "text" in item:
        text = "".join(e.get("text_run", {}).get("content", "") for e in item["text"]["elements"])

Pattern 2: Insert Markdown at position

Use feishu-md2blocks skill's md2blocks.py script with --after <block_id>.

Or manually:

# 1. Convert markdown
convert_resp = api_call(token, "POST", ".../blocks/convert",
    {"content_type": "markdown", "content": md_text})

# 2. Clean table blocks (remove merge_info)
for block in convert_resp["data"]["blocks"]:
    if block.get("block_type") == 31 and "table" in block:
        block["table"]["property"].pop("merge_info", None)

# 3. Insert at position (index IN BODY)
api_call(token, "POST", f".../blocks/{parent_id}/descendant", {
    "children_id": convert_resp["data"]["first_level_block_ids"],
    "descendants": convert_resp["data"]["blocks"],
    "index": target_index
})

Pattern 3: Batch edit table cells

# 1. Get all descendants of table
items = get_descendants(table_id)

# 2. Build update map
updates = []
for item in items:
    if needs_update(item):
        updates.append({
            "block_id": item["block_id"],
            "update_text_elements": {
                "elements": [{"text_run": {"content": new_value}}]
            }
        })

# 3. Batch update (max 200 per call)
for i in range(0, len(updates), 200):
    api_call(token, "PATCH", f".../blocks/batch_update",
        {"requests": updates[i:i+200]})
    time.sleep(0.35)

Pattern 4: Delete then re-insert (position workaround)

When you need to replace content at a specific position:

# 1. Find the index range to replace
children = get_doc_children(doc)
start_idx = children.index(first_block_to_replace)
end_idx = children.index(last_block_to_replace) + 1

# 2. Delete old blocks
api_call(token, "DELETE", f".../children/batch_delete",
    {"start_index": start_idx, "end_index": end_idx})

# 3. Insert new content at same position
api_call(token, "POST", f".../blocks/{doc}/descendant", {
    "children_id": new_ids,
    "descendants": new_blocks,
    "index": start_idx
})

Gotchas & Lessons Learned

  1. /descendant index in body, not URL — The most common pitfall. ?index=N compiles but is silently ignored.
  2. batch_delete uses index range{"start_index": 0, "end_index": 5} deletes children[0..4]. Do NOT pass block_ids.
  3. Table merge_info is read-only — Must strip from blocks before insertion or API returns error.
  4. children_id is first-level only — Including grandchild IDs in children_id causes error 1770006.
  5. Rate limit is per-document — Multiple concurrent edits to the same doc share the 3/sec limit.
  6. with_descendants=true saves calls — One GET instead of N+1 for reading table content.
  7. Convert API returns temp IDs — After insertion, actual block IDs differ from the temp IDs used during convert.

Comments

Loading comments...