创建草稿

草稿并非词条，而是指通过 API 发起创建新词条或更新现有词条的申请。词典管理员审核通过后，草稿将变为新的词条或覆盖已有词条。

Tip: - 创建新的词条时，无需传入 entity_id 字段
更新已有词条时，请传入对应词条的 entity_id 或 outer_info

Warning: 以用户身份创建草稿（即 Authorization 使用 user_access_token），对应用户将收到由飞书词典 Bot 发送的审核结果；以应用身份创建草稿（即 Authorization 使用 tenant_access_toke），不会收到任何通知。

请求

项目	值
HTTP URL	https://open.feishu.cn/open-apis/lingo/v1/drafts
HTTP Method	POST
接口频率限制	100 次/分钟
支持的应用类型	custom
权限要求调用该 API 所需的权限。开启其中任意一项权限即可调用开启任一权限即可	`baike:entity` 查看、创建、编辑、删除词典词条 `baike:entity:exempt_review` 创建、更新词典免审词条
字段权限要求	> Tip: 该接口返回体中存在下列敏感字段，仅当开启对应的权限后才会返回；如果无需获取这些字段，则不建议申请 `contact:user.employee_id:readonly` 获取用户 user ID

请求头

名称	类型	必填	描述
Authorization	string	是	`tenant_access_token` 或 `user_access_token` 值格式："Bearer `access_token`" 示例值："Bearer u-7f1bcd13fc57d46bac21793a18e560" 了解更多：如何选择与获取 access token
Content-Type	string	是	固定值："application/json; charset=utf-8"

查询参数

名称	类型	必填	描述
`repo_id`	`string`	否	词库ID（需要在指定词库创建草稿时填写，不填写默认创建至全员词库）如以应用身份创建草稿到非全员词库，需要在“词库设置”页面添加应用；若以用户身份创建草稿到非全员词库，该用户需要拥有对应词库的可见权限。示例值：72025****640276
`user_id_type`	`string`	否	用户 ID 类型示例值：open_id 可选值有： - `open_id`: 标识一个用户在某个应用中的身份。同一个用户在不同应用中的 Open ID 不同。了解更多：如何获取 Open ID - `union_id`: 标识一个用户在某个应用开发商下的身份。同一用户在同一开发商下的应用中的 Union ID 是相同的，在不同开发商下的应用中的 Union ID 是不同的。通过 Union ID，应用开发商可以把同个用户在多个应用中的身份关联起来。了解更多：如何获取 Union ID？ - `user_id`: 标识一个用户在某个租户内的身份。同一个用户在租户 A 和租户 B 内的 User ID 是不同的。在同一个租户内，一个用户的 User ID 在所有应用（包括商店应用）中都保持一致。User ID 主要用于在不同的应用间打通用户数据。了解更多：如何获取 User ID？默认值：`open_id` 当值为 `user_id`，字段权限要求： `contact:user.employee_id:readonly` 获取用户 user ID

请求体

名称	类型	必填	描述
`id`	`string`	否	词条 ID （需要更新某个词条时填写，若是创建新词条可不填写）示例值："enterprise_40217521"
`main_keys`	`term\[\]`	是	词条名数据校验规则： - 最大长度：`1`
└ `key`	`string`	是	名称示例值："飞书词典"
└ `display_status`	`display_status`	是	名称的展示范围
└ `allow_highlight`	`boolean`	是	是否允许在 IM 和 Doc 等场景进行高亮提示示例值：true
└ `allow_search`	`boolean`	是	是否允许在飞书中被搜索到示例值：true
`aliases`	`term\[\]`	否	别名数据校验规则： - 最大长度：`10`
└ `key`	`string`	是	名称的值示例值："飞书词典"
└ `display_status`	`display_status`	是	名称的展示范围
└ `allow_highlight`	`boolean`	是	是否允许在 IM 和 Doc 等场景进行高亮提示示例值：true
└ `allow_search`	`boolean`	是	是否允许在飞书中被搜索到示例值：true
`description`	`string`	否	纯文本格式词条释义。注：description 和 rich_text 至少有一个，否则会报错：1540001 示例值："词典是飞书提供的一款知识管理工具，通过飞书词典可以帮助企业将分散的知识信息进行聚合，并通过UGC的方式，促进企业知识的保鲜和流通" 数据校验规则： - 最大长度：`5000` 字符
`related_meta`	`related_meta`	否	词条相关信息
└ `users`	`referer\[\]`	否	相关联系人
└ `id`	`string`	是	格式根据 user_id_type 不同需要符合 open_id、user_id、union_id 格式的有效 id 示例值："ou_30b07b63089e***18789914dac63d36"
└ `title`	`string`	否	备注示例值："xxx 负责人"
└ `chats`	`referer\[\]`	否	相关公开群
└ `id`	`string`	是	公开群 id 示例值："oc_c13831833eaa8c92***cfa759ea4806"
└ `docs`	`referer\[\]`	否	飞书文档或飞书 wiki
└ `title`	`string`	否	文档标题示例值："快速了解飞书文档"
└ `url`	`string`	否	文档 url 示例值："https://example.feishu.cn/docs/doccnxlVCs*sJE15I7PLAjIWc" 数据校验规则**： - 正则校验：`(https?
└ `oncalls`	`referer\[\]`	否	飞书值班号
└ `id`	`string`	是	值班号 id 示例值："70236890***45548034"
└ `links`	`referer\[\]`	否	其他网页链接
└ `title`	`string`	否	标题示例值："飞书官网"
└ `url`	`string`	否	链接地址示例值："https://feishu.cn" 数据校验规则： - 正则校验：`(https?
└ `abbreviations`	`abbreviation\[\]`	否	相关词条
└ `id`	`string`	否	其他相关词条 id 示例值："enterprise_5158***7960"
└ `classifications`	`classification\[\]`	否	当前词条所属分类词条只能属于二级分类，且每个一级分类下只能选择一个二级分类。
└ `id`	`string`	是	二级分类 ID 示例值："7049606926****37761"
└ `father_id`	`string`	否	对应一级分类 ID 示例值："7049606926****37777"
└ `images`	`baike_image\[\]`	否	上传的相关图片数据校验规则： - 最大长度：`10`
└ `token`	`string`	是	通过文件接口上传图片后，获得的图片 token 示例值："boxbcEcmKiDia3e***WTpvdc7jc"
`outer_info`	`outer_info`	否	外部系统关联数据
└ `provider`	`string`	是	数据提供方（不能包含中横线 "-"）示例值："星云" 数据校验规则： - 长度范围：`2` ～ `32` 字符
└ `outer_id`	`string`	是	唯一标识，可用来和其他平台的内容进行绑定。需保证和百科词条唯一对应（不能包含中横线 "-"）示例值："12345abc" 数据校验规则： - 长度范围：`1` ～ `64` 字符
`rich_text`	`string`	否	富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考企业百科指南中的释义部分示例值："<b>加粗</b><i>斜体</i><p><a href="https://feishu.cn">l链接</a></p><p><span>企业百科是飞书提供的一款知识管理工具，通过企业百科可以帮助企业将分散的知识信息进行聚合，并通过UGC的方式，促进企业知识的保鲜和流通</span></p>" 数据校验规则： - 最大长度：`5000` 字符
`i18n_descs`	`i18n_entry_desc\[\]`	否	国际化的词条释义数据校验规则： - 最大长度：`3`
└ `language`	`int`	是	语言类型示例值：1 可选值有： - `1`: 中文 - `2`: 英文 - `3`: 日文
└ `description`	`string`	否	纯文本释义示例值："词典是飞书提供的一款知识管理工具，通过飞书词典可以帮助企业将分散的知识信息进行聚合，并通过UGC的方式，促进企业知识的保鲜和流通" 数据校验规则： - 长度范围：`1` ～ `5000` 字符
└ `rich_text`	`string`	否	富文本描述示例值："<b>加粗</b><i>斜体</i><p><a href="https://feishu.cn">l链接</a></p><p><span>企业百科是飞书提供的一款知识管理工具，通过企业百科可以帮助企业将分散的知识信息进行聚合，并通过UGC的方式，促进企业知识的保鲜和流通</span></p>" 数据校验规则： - 长度范围：`1` ～ `5000` 字符

请求体示例

json

{
    "id":"enterprise_40217***521",
    "main_keys": [
        {
            "key": "飞书词典",
            "display_status": {
                "allow_highlight": true,
                "allow_search": true
            }
        }
    ],
    "aliases": [
        {
            "key": "词典",
            "display_status": {
                "allow_highlight": true,
                "allow_search": true
            }
        }
    ],
    "description": "词典是飞书提供的一款知识管理工具，通过飞书词典可以帮助企业将分散的知识信息进行聚合，并通过UGC的方式，促进企业知识的保鲜和流通",
    "rich_text": "词典是飞书提供的一款知识管理工具，通过飞书词典可以帮助企业将分散的知识信息进行聚合，并通过UGC的方式，促进企业知识的保鲜和流通",
    "i18n_descs": [
        {
            "language": 1,
            "description": "国际化中文释义",
            "rich_text": "国际化中文释义"
        }
    ],
    "related_meta": {
        "users": [
            {
                "id": "ou_30b07b6****ea46518789914dac63d36",
                "title": "负责人"
            },
            {
                "id": "ou_b292c0****c14754639fa4501e80c36a",
                "title": ""
            }
        ],
        "chats": [
            {
                "id": "oc_c13831833e****92c52befa759ea4806"
            },
            {
                "id": "oc_c8161c910****a24127e73b10233b295"
            }
        ],
        "docs": [
            {
                "title": "猜你想问 / FAQs",
                "url": "https://example.feishu.cn/wiki/wikcnZ8Lq4f9DMCDOtdcIzCUjAh"
            },
            {
                "title": "快速了解飞书文档 | Introducing Feishu Docs",
                "url": "https://example.feishu.cn/docs/doccnxlVCCFjMsJE15I7PLAjIWc"
            }
        ],
        "links": [
            {
                "title": "飞书官网",
                "url": "https://feishu.cn"
            }
        ],
        "oncalls": [
            {
                "id": "702368904****548034"
            },
            {
                "id": "70240637****0910850"
            }
        ],
        "abbreviations": [
            {
                "id": "enterprise_44***90"
            },
            {
                "id": "enterprise_70348****374354564"
            },
            {
                "id": "enterprise_70365****3106796547"
            }
        ],
        "classifications": [
            {
                "id": "7049606926****37761",
                "father_id": "7049606926****37777"
            }
        ],
        "images": [
            {
                "token": "boxbcEcmKiD3SGHvgqWTpvdc7jc"
            }
        ]
    },
    "outer_info": {
        "provider": "星云",
        "outer_id": "client_653****98d"
    }
}

响应

响应体

名称	类型	描述
`code`	`int`	错误码，非 0 表示失败
`msg`	`string`	错误描述
`data`	`\-`	-
└ `draft`	`draft`	草稿信息
└ `draft_id`	`string`	草稿 ID
└ `entity`	`entity`	词条信息
└ `id`	`string`	词条 ID
└ `main_keys`	`term\[\]`	词条名
└ `key`	`string`	名称
└ `display_status`	`display_status`	名称展示范围
└ `allow_highlight`	`boolean`	是否允许在 IM 和 Doc 等场景进行高亮提示
└ `allow_search`	`boolean`	是否允许在飞书中被搜索到
└ `aliases`	`term\[\]`	别名
└ `key`	`string`	名称的值
└ `display_status`	`display_status`	名称展示范围
└ `allow_highlight`	`boolean`	是否允许在 IM 和 Doc 等场景进行高亮提示
└ `allow_search`	`boolean`	是否允许在飞书中被搜索到
└ `description`	`string`	纯文本格式词条释义。注：description 和 rich_text 至少有一个，否则会报错：1540001
└ `creator`	`string`	词条创建时间
└ `create_time`	`string`	词条创建时间（秒级时间戳）
└ `updater`	`string`	最近一次更新者
└ `update_time`	`string`	最近一次更新词条时间（秒级时间戳）
└ `related_meta`	`related_meta`	相关数据
└ `users`	`referer\[\]`	关联用户信息
└ `id`	`string`	数据 id
└ `title`	`string`	标题
└ `url`	`string`	链接地址
└ `chats`	`referer\[\]`	关联公开群组信息
└ `id`	`string`	数据 id
└ `title`	`string`	标题
└ `url`	`string`	链接地址
└ `docs`	`referer\[\]`	关联文档信息
└ `title`	`string`	标题
└ `url`	`string`	链接地址
└ `oncalls`	`referer\[\]`	关联值班者信息
└ `id`	`string`	数据 id
└ `title`	`string`	标题
└ `url`	`string`	链接地址
└ `links`	`referer\[\]`	关联链接信息
└ `title`	`string`	标题
└ `url`	`string`	链接地址
└ `abbreviations`	`abbreviation\[\]`	相关词条信息
└ `id`	`string`	相关其他词条 id
└ `classifications`	`classification\[\]`	所属分类信息（不支持传入一级分类。词条不可同时属于同一个一级分类下的多个二级分类，一级分类下的二级分类互斥）
└ `id`	`string`	唯一分类 ID
└ `father_id`	`string`	父级分类的 ID
└ `images`	`baike_image\[\]`	上传的相关图片
└ `token`	`string`	通过文件接口上传后的图片 token
└ `statistics`	`statistics`	统计数据
└ `like_count`	`int`	点赞数量
└ `dislike_count`	`int`	点踩数量
└ `outer_info`	`outer_info`	外部 id 关联数据
└ `provider`	`string`	数据提供方（不能包含中横线 "-"）
└ `outer_id`	`string`	唯一标识，可用来和其他平台的内容进行绑定。需保证和百科词条唯一对应（不能包含中横线 "-"）
└ `rich_text`	`string`	富文本格式（当填写富文本内容时，description字段将会失效可不填写），支持的格式参考企业百科指南中的释义部分
└ `source`	`int`	词条的创建来源，1：用户主动创建，2：批量导入，3：官方词，4：OpenAPI 创建
└ `i18n_descs`	`i18n_entry_desc\[\]`	国际化的词条释义
└ `language`	`int`	语言类型可选值有： - `1`: 中文 - `2`: 英文 - `3`: 日文
└ `description`	`string`	纯文本释义
└ `rich_text`	`string`	富文本描述

响应体示例

json

{
    "code": 0,
    "msg": "success",
    "data": {
        "draft": {
            "draft_id": "54567***567897",
            "entity": {
                "id": "enterprise_40****21",
                "main_keys": [
                    {
                        "key": "飞书词典",
                        "display_status": {
                            "allow_highlight": true,
                            "allow_search": true
                        }
                    }
                ],
                "aliases": [
                    {
                        "key": "词典",
                        "display_status": {
                            "allow_highlight": true,
                            "allow_search": true
                        }
                    }
                ],
                "description": "词典是飞书提供的一款知识管理工具，通过飞书词典可以帮助企业将分散的知识信息进行聚合，并通过UGC的方式，促进企业知识的保鲜和流通",
                "rich_text": "词典是飞书提供的一款知识管理工具，通过飞书词典可以帮助企业将分散的知识信息进行聚合，并通过UGC的方式，促进企业知识的保鲜和流通",
                "i18n_descs": [
                    {
                        "language": 1,
                        "description": "国际化中文释义",
                        "rich_text": "国际化中文释义"
                    }
                ],
                "related_meta": {
                    "users": [
                        {
                            "id": "ou_30b07b63089e***18789914dac63d36",
                            "title": "负责人"
                        },
                        {
                            "id": "ou_b292c0d285c1***639fa4501e80c36a",
                            "title": ""
                        }
                    ],
                    "chats": [
                        {
                            "id": "oc_c13831833eaa8c92***cfa759ea4806"
                        },
                        {
                            "id": "oc_c8161c9109966a24***e73b10233b295"
                        }
                    ],
                    "docs": [
                        {
                            "title": "猜你想问 / FAQs",
                            "url": "https://example.feishu.cn/wiki/wikcnZ8Lq4***CDOtdcIzCUjAh"
                        },
                        {
                            "title": "快速了解飞书文档 | Introducing Feishu Docs",
                            "url": "https://example.feishu.cn/docs/doccnxlVCs***sJE15I7PLAjIWc"
                        }
                    ],
                    "links": [
                        {
                            "title": "飞书官网",
                            "url": "https://feishu.cn"
                        }
                    ],
                    "oncalls": [
                        {
                            "id": "70236890***45548034"
                        },
                        {
                            "id": "70240637***60910850"
                        }
                    ],
                    "abbreviations": [
                        {
                            "id": "enterprise_4450***890"
                        },
                        {
                            "id": "enterprise_703481***74354564"
                        },
                        {
                            "id": "enterprise_703659***06796547"
                        }
                    ],
                    "classifications": [
                        {
                            "id": "70496069***2837761",
                            "father_id": "70496069***02837777"
                        }
                    ],
                    "images": [
                        {
                            "token": "boxbcEcmKiD***vgqWTpvdc7jc"
                        }
                    ]
                },
                "statistics": {
                    "like_count": 100,
                    "dislike_count": 20
                },
                "outer_info": {
                    "provider": "星云",
                    "outer_id": "client_6539i3498d"
                },
                "create_time": "1627540853",
                "update_time": "1627541853"
            }
        }
    }
}

错误码

HTTP状态码	错误码	描述	排查建议
400	2250001	invalid param	参数错误，参考文档检查输入参数
500	2250002	network anomaly, please try again	多数请求是服务超时，请重新请求，少数是服务异常请咨询客服

创建草稿 ​

请求 ​

请求头 ​

查询参数 ​

请求体 ​

请求体示例 ​

响应 ​

响应体 ​

响应体示例 ​

错误码 ​

创建草稿

请求

请求头

查询参数

请求体

请求体示例

响应

响应体

响应体示例

错误码