The Feishu Open Platform provides server-side APIs for messaging, contacts, approval, sheets, Base, and many other product capabilities. This SDK wraps the repeated platform work around API calls, including token management, request signing, encryption/decryption, event dispatching, and typed request/response models.
- Preparations before development
- Calling server-side APIs
- Handle events
- Handle card callbacks
- SDK FAQs
pip install lark-oapiPython 3.8 or later is required.
import lark_oapi as lark
from lark_oapi.api.im.v1 import *
client = lark.Client.builder() \
.app_id("cli_xxx") \
.app_secret("your_app_secret") \
.build()
request = CreateMessageRequest.builder() \
.receive_id_type("chat_id") \
.request_body(CreateMessageRequestBody.builder()
.receive_id("oc_xxx")
.msg_type("text")
.content("{\"text\":\"hello world\"}")
.build()) \
.build()
response = client.im.v1.message.create(request)lark_oapi.register_app creates an app through the OAuth device flow. It
returns a verification URL in on_qr_code; render the URL as a QR code or show
it as a link for the user to open in Feishu/Lark.
import lark_oapi as lark
def on_qr_code(info):
print(info["url"])
result = lark.register_app(
on_qr_code=on_qr_code,
app_preset={
"avatar": [
"https://example.com/a.png",
"https://example.com/b.webp",
],
"name": "{user}'s app",
"desc": "Created by the business platform",
},
)
print(result["client_id"])For a real manual E2E run without mocked registration responses:
python3 samples/registration/app_preset_live_e2e.py --open| Parameter | Description | Type | Required | Default |
|---|---|---|---|---|
on_qr_code |
Callback when the verification URL is ready. Receives {"url": str, "expire_in": int} |
function | Yes | - |
on_status_change |
Callback on polling status changes. Status values include polling, slow_down, domain_switched |
function | No | - |
source |
Source identifier appended to the QR URL as python-sdk/{source} |
string | No | python-sdk |
cancel_event |
threading.Event used to cancel sync polling |
threading.Event | No | - |
domain |
Custom Feishu accounts base URL | string | No | https://accounts.feishu.cn |
lark_domain |
Custom Lark accounts base URL used when tenant brand is Lark | string | No | https://accounts.larksuite.com |
app_preset |
Pre-fill values for the app-creation page. All fields are optional; users can still edit them on the page. Pass raw values; the SDK URL-encodes them automatically | dict | No | - |
app_preset.avatar |
App avatar URL(s). 1-6 URLs supported; the first one is selected by default. Allowed formats are handled by the Web page: png / jpg / jpeg / webp / gif | string or list[string] | No | - |
app_preset.name |
App name. Supports the {user} placeholder, replaced by the Web page with the scanning user's name |
string | No | - |
app_preset.desc |
App description. Supports the {user} placeholder |
string | No | - |
lark_oapi.channel is a high-level module built on top of the OpenAPI client
and event transport. It bundles event listening, message normalization, safety
policy, outbound sending, media upload/download, card interactions, and
streaming replies into a single FeishuChannel entry point.
Use Channel when you are building a conversational bot that needs normalized message events, replies, media handling, card callbacks, mention policy, or WebSocket/webhook transport management.
import asyncio
import os
from lark_oapi.channel import FeishuChannel
channel = FeishuChannel(
app_id=os.environ["LARK_APP_ID"],
app_secret=os.environ["LARK_APP_SECRET"],
)
async def on_message(msg):
await channel.send(
msg.chat_id,
{"text": f"echo: {msg.content_text}"},
)
channel.on("message", on_message)
asyncio.run(channel.connect())Full Channel documentation:
More composite API examples and business scenario samples are available in oapi-sdk-python-demo.
- Send file message
- Send image message
- List users under a department
- Create a Base app with tables
- Robot quick start
MIT
Click Server SDK in the upper right corner of the documentation page and submit feedback.