API 文档

众森卫士内容安全平台内容安全检测 API 帮助文档，包含接入指南、接口规范、示例代码等

接入流程

1

注册账号

访问众森卫士官网，使用手机号注册账号

2

创建API Key

登录用户中心，在API Key管理页面创建新的密钥

3

调用检测接口

使用API Key调用文本安全检测接口，获取检测结果

4

处理检测结果

根据返回的安全标签和风险等级，对内容进行相应处理

名词解释

术语说明
API Key用于接口调用身份验证的密钥，格式为 zs_ + 19位随机字符，在用户中心创建和管理
安全标签检测结果中标识内容风险类型的标签，如"疑似色情内容"、"疑似暴力犯罪"等，共43种
风险等级内容风险严重程度的分级，从高到低依次为：high（高风险）、medium（中风险）、low（低风险）、none（无风险）
安全类别安全标签按风险类型归入的大类，共15大类别，如政治敏感类、色情低俗类等
requestId每次检测请求的唯一标识，由系统自动生成，用于问题排查和追踪
检测结果检测返回的结论，safe表示内容安全，unsafe表示检测到风险
拒答话术当检测到风险内容时，系统提供的标准化拒答回复模板
contentType内容类型参数，支持text（文本）、image（图片）、audio（音频）、video（视频）、file（文件）

通信协议

所有API接口均通过 HTTPS 协议进行通信，确保数据传输安全。

请求和响应数据格式均为 JSON，请求需设置 Content-Type: application/json。

请求规范

项目说明
协议HTTPS
请求方式POST
字符编码UTF-8
数据格式JSON
Content-Typeapplication/json

频率限制

默认QPS限制为10次/秒，每日调用配额根据套餐不同有所区别。超出限制将返回错误码 40006。

请求公共参数

参数名类型必填说明
x-api-keystring是API Key，放在请求Header中
Content-Typestring是固定值：application/json

响应公共参数

json
{
  "success": true,
  "code": 200,
  "message": "success",
  "data": {}
}
字段类型说明
successboolean请求是否成功
codenumber业务状态码，200表示成功
messagestring状态描述信息
dataobject业务数据，各接口不同

鉴权方式

众森卫士支持两种鉴权方式：

方式一：API Key鉴权（推荐）

在请求Header中携带 x-api-key 字段：

http
POST /api/v1/security/detect/text HTTP/1.1
Host: api.zhongsen.com
x-api-key: zs_a1b2c3d4e5f6g7h8i9j0k
Content-Type: application/json

方式二：JWT Token鉴权

在请求Header中携带 Authorization 字段：

http
POST /api/v1/security/detect/text HTTP/1.1
Host: api.zhongsen.com
Authorization: Bearer eyJhbGciOiJIUzI1NiIs...
Content-Type: application/json

API Key管理

API Key格式为 zs_ + 19位随机字符，例如 zs_a1b2c3d4e5f6g7h8i9j0k。

每个用户最多可创建5个API Key，支持随时启用/禁用和删除。

⚠ 请妥善保管API Key，切勿泄露到客户端代码或公开仓库中。

返回码说明

HTTP状态码

状态码说明
200请求成功（业务状态需检查code字段）
400请求参数错误
401未认证（API Key/Token无效或缺失）
403无权限（用户已被禁用）
500服务器内部错误

业务错误码

错误码说明建议处理方式
200请求成功-
400请求参数错误检查请求参数格式和必填项
401未认证检查x-api-key或Authorization头是否正确
403用户已被禁用联系管理员确认账号状态
40001API Key无效检查API Key格式和有效性
40002API Key已过期重新创建API Key
40003账户已禁用联系管理员确认账号状态
40004请求参数错误检查请求体JSON格式和参数类型
40005内容长度超限文本内容不超过10000字符
40006超出每日调用配额在用户中心查看配额用量
40007未分配检测服务联系管理员配置检测服务
40011Token已过期重新登录获取新Token
40012Token无效检查Token格式
50001检测服务异常请稍后重试
50002请求超时请稍后重试

文本安全检测

POST/api/v1/security/detect/text

对文本内容进行安全检测，识别潜在的安全风险。

请求参数

参数名类型必填说明
contentstring是待检测的文本内容，最大10000字符
contentTypestring否内容类型，默认text

请求示例

json
{
  "content": "待检测文本内容"
}

响应参数

字段类型说明
data.requestIdstring请求唯一标识
data.resultstring检测结果：safe / unsafe
data.riskLevelstring风险等级：high / medium / low / none
data.labelNamestring安全标签名称
data.categoryNamestring安全类别名称
data.confidencenumber置信度 0-1
data.refusalMessagestring拒答话术（检测到风险时）

响应示例 - 安全内容

json
{
  "success": true,
  "code": 200,
  "message": "success",
  "data": {
    "requestId": "req_abc123def456",
    "result": "safe",
    "riskLevel": "none",
    "labelName": null,
    "categoryName": null,
    "confidence": 0.98,
    "refusalMessage": null
  }
}

响应示例 - 风险内容

json
{
  "success": true,
  "code": 200,
  "message": "success",
  "data": {
    "requestId": "req_abc123def456",
    "result": "unsafe",
    "riskLevel": "high",
    "labelName": "疑似色情内容",
    "categoryName": "色情低俗类",
    "confidence": 0.95,
    "refusalMessage": "抱歉，我无法回答这个问题。"
  }
}

多语言示例代码

bash
curl -X POST 'https://api.zhongsen.com/api/v1/security/detect/text' \
  -H 'x-api-key: zs_a1b2c3d4e5f6g7h8i9j0k' \
  -H 'Content-Type: application/json' \
  -d '{"content": "待检测文本内容"}'

安全标签体系

众森卫士安全标签体系覆盖15大安全类别、43种安全标签，按风险等级分为高风险、中风险、低风险三个等级。

安全类别标签数量风险等级
政治敏感类7种🔴 高风险
色情低俗类4种🔴 高风险
暴力极端类4种🔴 高风险
违法犯罪类4种🔴 高风险
歧视辱骂类2种🔴 高风险
未成年人保护类1种🔴 高风险
提示词攻击类1种🔴 高风险
隐私侵犯类1种🔴 高风险
骚扰威胁类2种🔴 高风险
宗教敏感类5种🔴 高风险
广告引流类3种🟡 中风险
商业违规类1种🟡 中风险
知识产权类1种🟡 中风险
自我伤害类1种🟢 低风险
价值观与风俗类6种🟢 低风险

更新日志

v1.0.02026-05-01

首次发布，支持文本安全检测，覆盖15大安全类别、43种安全标签