Creates a knowledge base synchronization link.
Try it now
Test
RAM authorization
Request syntax
POST HTTP/1.1Request parameters
|
Parameter |
Type |
Required |
Description |
Example |
| RegionId |
string |
Yes |
The region ID. |
cn-beijing |
| KnowledgeBaseId |
string |
Yes |
The unique ID of the knowledge base. |
pkb-xxxxx |
| LinkName |
string |
Yes |
The name of the synchronization link. |
testName |
| SourceType |
string |
Yes |
The data source type. Valid values: FEISHU and SHAREPOINT. |
FEISHU |
| TenantId |
string |
No |
The tenant ID. This parameter is required when SourceType is set to SHAREPOINT. |
63eexxxx-xxxx-xxxx-xxxx-xxxxxx090f82 |
| UserId |
string |
No |
The DingTalk user ID of the operator. |
123***56 |
| ClientId |
string |
Yes |
The client ID. |
cli_xxxxxxbe8 |
| ClientSecret |
string |
Yes |
The client secret. |
****** |
| UserAccessToken |
string |
No |
The Lark user access token. This token is used only when the application identity cannot expand group members because the bot is not in the group chat. |
****** |
| McpEndpoint |
string |
No |
The MCP Server endpoint for DingTalk documents. |
https://mcp-gw.dingtalk.com/server/1a2b3cxxxxxx789?key=d5e6fxxxxxx876 |
| SheetMcpEndpoint |
string |
No |
The MCP Server endpoint for DingTalk spreadsheets. |
https://mcp-gw.dingtalk.com/server/1a2b3cxxxxxx567?key=d5e6fxxxxxx543 |
| SourceDir |
string |
Yes |
The directory address of the synchronization source. |
https://example.feishu.cn/wiki/space/xxxxxx |
| Description |
string |
No |
The description of the synchronization link. |
testDesc |
| SyncIntervalMinutes |
integer |
No |
The synchronization interval. Unit: minutes. |
30 |
Response elements
|
Element |
Type |
Description |
Example |
|
object |
Schema of Response |
||
| ClientId |
string |
The client ID. |
cli_xxxxxxbe8 |
| CreationTime |
string |
The time when the synchronization link was created. The time is in the ISO 8601 standard in the UTC time zone (format: YYYY-MM-DDTHH:mm:ssZ). |
2026-08-14T05:58:42Z |
| Description |
string |
The description of the synchronization link. |
testDesc |
| ImPlatform |
string |
The source channel of the synchronization link. Valid values:
|
FEISHU |
| LinkId |
string |
The ID of the synchronization link. |
pkbl-xxxxxx |
| LinkName |
string |
The name of the synchronization link. |
testName |
| RequestId |
string |
Id of the request |
24A1990B-4F6E-482B-B8CB-75C612****** |
| SourceDir |
string |
The directory address of the synchronization source. |
https://example.feishu.cn/wiki/space/xxxxxx |
| SyncIntervalMinutes |
integer |
The synchronization interval. Unit: minutes. |
30 |
| SyncStatus |
string |
The synchronization status. Valid values:
|
CREATING |
Examples
Success response
JSON format
{
"ClientId": "cli_xxxxxxbe8",
"CreationTime": "2026-08-14T05:58:42Z",
"Description": "testDesc",
"ImPlatform": "FEISHU",
"LinkId": "pkbl-xxxxxx",
"LinkName": "testName",
"RequestId": "24A1990B-4F6E-482B-B8CB-75C612******",
"SourceDir": "https://example.feishu.cn/wiki/space/xxxxxx\n",
"SyncIntervalMinutes": 30,
"SyncStatus": "CREATING"
}Error codes
See Error Codes for a complete list.
Release notes
See Release Notes for a complete list.