Skip to main content

创建敏感词库接口

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

  • Scope：admin.v1.sensitive-words.manage
  • 权限项：敏感词库管理（sensitive-words）
  • 权限类型：管理
  • 接口：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否词库说明"<string>"
enabledbodyboolean否保存后启用词库false
keywordsbodyarray ｜ null必填敏感词["<string>"]
namebodystring必填词库名称"<string>"

请求示例

curl --request POST \
  --url 'https://example.invalid/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

名称类型必填说明示例
created_atstring · date-time是创建时间"2026-08-27T10:00:00Z"
descriptionstring是词库说明"<string>"
enabledboolean是启用状态false
idstring是词库 ID"<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 Flat business error

名称类型必填说明示例
codestring否Stable business error code"<string>"
detailstring是Human-readable error description"<string>"
detailsOpenapiErrorDetails否错误详情-
errorstring是Stable HTTP error type"<string>"

details 字段

以下必填性针对对象存在时的子字段；父对象可否省略或为 null，以上层字段表为准。
字段类型必填说明
fieldstring否校验失败的请求字段
reasonstring否校验失败的原因代码
suggestionstring否建议使用的规范化值
{
  "code": "<string>",
  "detail": "<string>",
  "details": {
    "field": "<string>",
    "reason": "<string>",
    "suggestion": "<string>"
  },
  "error": "<string>"
}