> ## Documentation Index
> Fetch the complete documentation index at: https://docs.vecbase.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Feishu

> Connect your agent to Feishu as an enterprise app

# Feishu Setup

Connect your Vecbase agent to Feishu so team members can chat with it in group chats and direct messages.

<Warning>
  Currently only **Feishu** (feishu.cn) is supported. International Lark (larksuite.com) is not yet supported.
</Warning>

## Prerequisites

* A Feishu admin account (or an account with permission to create apps)
* A Vecbase agent created

## Step 1: Create an App on Feishu Open Platform

<Steps>
  <Step title="Open the platform">
    Go to [Feishu Open Platform](https://open.feishu.cn/) and log in with your Feishu account.
  </Step>

  <Step title="Create an app">
    Click **Create Custom App**. Enter a name and description.
  </Step>

  <Step title="Get credentials">
    On the **Credentials & Basic Info** page, find:

    * **App ID**: `cli_xxxxxxxxx`
    * **App Secret**: `xxxxxxxxxxxxxxxx`
  </Step>
</Steps>

## Step 2: Enable Bot Capability

<Steps>
  <Step title="Add bot capability">
    In the left sidebar, go to **App Capabilities** → **Bot** and click **Enable**.
  </Step>

  <Step title="Configure permissions">
    In **Permission Management**, add the following permissions:

    | Permission                   | Description                                        |
    | ---------------------------- | -------------------------------------------------- |
    | `im:message`                 | Send and receive messages                          |
    | `im:message.group_at_msg`    | Receive @mentions in group chats                   |
    | `im:resource`                | Send and receive files and images                  |
    | `contact:user.base:readonly` | Read basic user info (for displaying sender names) |
  </Step>

  <Step title="Publish the app">
    Go to **Version Management & Release**, create a version and submit for review.

    <Info>
      Internal enterprise apps are usually approved automatically. ISV apps require admin approval.
    </Info>
  </Step>
</Steps>

## Step 3: Connect in Vecbase

<Steps>
  <Step title="Open agent settings">
    Open your agent, tap **Settings** in the top right, then select **Channels**.
  </Step>

  <Step title="Add Feishu channel">
    Click **Add Channel** next to **Feishu**.
  </Step>

  <Step title="Enter credentials">
    * **Display Name**: A name for this channel (e.g., "Office Assistant")
    * **App ID**: Copy from the Open Platform
    * **App Secret**: Copy from the Open Platform
  </Step>

  <Step title="Create">
    Click **Create**. Status will change to **Connected**.
  </Step>
</Steps>

## Step 4: Test

Find your bot in Feishu (search for the app name) and send a message. Your agent will reply automatically.

### Direct messages

Send a message directly to the bot.

### Group chats

1. Add the bot to a group chat
2. @mention the bot name and send a message
3. The agent will reply in the group

## Feishu Office Suite

Once connected, your agent can also work with Feishu's office tools:

| Feature     | Description                             |
| ----------- | --------------------------------------- |
| Documents   | Create, read, and edit Feishu documents |
| Bitables    | Query and write data in Bitable         |
| Wiki        | Browse and manage Wiki pages            |
| Drive       | Manage files in Feishu Drive            |
| Permissions | Set document sharing permissions        |

Just tell your agent what you need — for example, "Create a meeting notes document" — and it handles the rest.

<Tip>
  These features require adding the corresponding API permissions for your app on the Feishu Open Platform.
</Tip>
