创建敏感词库接口

创建敏感词库,提交名称、说明、词条列表和可选的启用状态。keywords 是词库内容,当前请求最多接受 1000 个词条。

所需权限

所需权限资源Scope资源服务
敏感词库管理(管理)sensitive-wordsadmin.v1.sensitive-words.manageqwenwork-biz-service

POST /api/openapi/v1/sensitive-word-libraries

认证与请求头

使用应用 API Key 调用。当前接口校验上方独立 Scope;读取、管理与执行权限互不包含。

名称位置类型必填说明示例
Authorizationheaderstring应用 API Key,使用 Bearer 方式传递。Bearer qwk_\\*
X-Request-Idheaderstring可选的调用追踪标识;未传入时由服务端生成。req-20260831-001

请求参数

名称位置类型必填说明示例
Idempotency-Keyheaderstring必填本次写操作的幂等键。同一操作重试时复用相同键和请求内容,避免重复处理。"<string>"
descriptionbodystring敏感词库的用途说明。 最多字符数:512。"<string>"
enabledbodyboolean是否启用这项配置。false
keywordsbodyarray | null必填敏感词库中的词条列表。 最少项数:1。 最多项数:1000。["<string>"]
namebodystring必填敏感词库的名称。 最多字符数:128。"<string>"

请求示例

将 <BASE_URL> 替换为企业部署的千问办公 API 服务地址,并填写实际参数。示例中的占位值不能直接用于请求。

curl --request POST --url '<BASE_URL>/api/openapi/v1/sensitive-word-libraries' --header 'Authorization: Bearer <API_KEY>' --header 'Idempotency-Key: <UNIQUE_REQUEST_ID>' --header 'Content-Type: application/json' --data '{  "description": "<string>",  "enabled": false,  "keywords": ["<string>"  ],  "name": "<string>"}'

响应

201 创建成功,返回新建的记录。

名称类型必填说明示例
created_atstring · date-time此记录的创建时间。"2026-08-27T10:00:00Z"
descriptionstring敏感词库的用途说明。"<string>"
enabledboolean是否启用这项配置。false
idstring此记录的唯一标识,查询、更新或删除对应记录时使用。"<string>"
keywordsarray | null敏感词库中的词条列表。["<string>"]
namestring敏感词库的名称。"<string>"
updated_atstring · date-time此记录最后一次更新的时间。"2026-08-27T10:00:00Z"
{
  "created_at": "2026-08-27T10:00:00Z",
  "description": "<string>",
  "enabled": false,
  "id": "<string>",
  "keywords": [
    "<string>"
  ],
  "name": "<string>",
  "updated_at": "2026-08-27T10:00:00Z"
}

default 请求失败,返回错误码和错误详情。

名称类型必填说明示例
codestring用于程序判断错误原因的稳定业务错误码。"<string>"
detailstring便于阅读的错误说明。"<string>"
detailsOpenapiErrorDetails字段校验失败时的详细信息。{"field":"<string>","reason":"<string>","suggestion":"<string>"}
details.fieldstring未通过校验的请求字段。"<string>"
details.reasonstring稳定的校验失败原因,用于判断字段为何不合法。"<string>"
details.suggestionstring建议采用的规范化字段值。"<string>"
errorstring稳定的 HTTP 错误类型。"<string>"
{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}