API 文档

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

接入流程

注册账号

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

创建API Key

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

调用检测接口

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

处理检测结果

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

名词解释

← 左右滑动查看完整内容 →

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

通信协议

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

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

请求规范

← 左右滑动查看完整内容 →

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

频率限制

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

请求公共参数

← 左右滑动查看完整内容 →

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

响应公共参数

json

{
  "success": true,
  "code": 200,
  "message": "success",
  "data": {}
}

← 左右滑动查看完整内容 →

字段	类型	说明
`success`	boolean	请求是否成功
`code`	number	业务状态码，200表示成功
`message`	string	状态描述信息
`data`	object	业务数据，各接口不同

鉴权方式

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

方式一：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`	用户已被禁用	联系管理员确认账号状态
`40001`	API Key无效	检查API Key格式和有效性
`40002`	API Key已过期	重新创建API Key
`40003`	账户已禁用	联系管理员确认账号状态
`40004`	请求参数错误	检查请求体JSON格式和参数类型
`40005`	内容长度超限	文本内容不超过2000字符
`40006`	超出每日调用配额	在用户中心查看配额用量
`40007`	未分配检测服务	联系管理员配置检测服务
`40011`	Token已过期	重新登录获取新Token
`40012`	Token无效	检查Token格式
`40013`	无该模态检测权限	联系管理员开通对应模态的检测权限
`40014`	URL长度超限	非文本模态的URL地址长度不超过1024个字符
`40015`	URL格式无效	确保URL以http://或https://开头，格式合法
`40016`	模态配额已耗尽	该模态每日检测次数已达上限，联系管理员提升配额
`50001`	检测服务异常	请稍后重试
`50002`	请求超时	请稍后重试

内容安全检测接口

POST/api/v1/security/detect

统一内容安全检测接口，通过 contentType 参数区分内容类型，支持文本、图片、音频、视频、文档5种模态的安全检测。

公共请求参数

← 左右滑动查看完整内容 →

参数名	类型	必填	说明
`content`	string	是	文本内容（最大2000字符）、图片Base64（最大1000万字符）或URL地址（最大1024字符）
`contentType`	string	否	内容类型：text(默认)/image/audio/video/file
`detectionScene`	string	否	检测场景：input(输入端)/output(输出端)，所有模态均可使用

contentType 可选值

← 左右滑动查看完整内容 →

值	说明	content参数要求
`text`	文本检测	直接传入文本内容，最大2000字符
`image`	图片检测	传入图片URL地址（需以http://或https://开头）或Base64编码（data:image/xxx;base64,...），URL最大1024字符，Base64最大1000万字符
`audio`	音频检测	传入音频URL地址（需以http://或https://开头，不可含空格），长度不超过1024字符
`video`	视频检测	传入视频URL地址（需以http://或https://开头，不可含空格），长度不超过1024字符
`file`	文档检测	传入文档URL地址（需以http://或https://开头，不可含空格），长度不超过1024字符

公共响应参数

← 左右滑动查看完整内容 →

字段	类型	说明
`data.requestId`	string	请求唯一标识
`data.result`	string	检测结果：safe / unsafe
`data.riskLevel`	string	风险等级：high / medium / low / none
`data.labelName`	string	安全标签名称
`data.categoryName`	string	安全类别名称
`data.confidence`	number	置信度 0-1
`data.refusalMessage`	string	拒答话术（检测到风险时）

文本安全检测

对文本内容进行安全检测，识别政治敏感、色情低俗、暴力恐怖等各类安全风险。

请求示例

json

{
  "content": "待检测文本内容",
  "contentType": "text",
  "detectionScene": "input"
}

响应示例 - 安全内容

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": "抱歉，我无法回答这个问题。"
  }
}

图片安全检测

对图片内容进行安全检测，识别涉黄、涉暴、涉政等视觉安全风险。支持 URL地址 和 Base64编码 两种图片传入方式，覆盖JPG、PNG、BMP、WebP、GIF等常见格式，最大支持10MB。

图片传入方式

← 左右滑动查看完整内容 →

方式	content格式	说明
`URL地址`	https://example.com/image.jpg	传入公网可访问的图片URL，系统自动下载检测
`Base64编码`	data:image/jpeg;base64,/9j/4AAQ...	传入Base64编码的图片数据（需含data:image前缀）

请求示例 - URL地址方式

json

{
  "content": "https://example.com/image.jpg",
  "contentType": "image",
  "detectionScene": "input"
}

请求示例 - Base64编码方式

json

{
  "content": "data:image/jpeg;base64,/9j/4AAQSkZJRgABAQEASABIAAD/2wBD...",
  "contentType": "image",
  "detectionScene": "input"
}

响应示例 - 风险图片

json

{
  "success": true,
  "code": 200,
  "message": "检测完成",
  "data": {
    "requestId": "req_1784354965434_c032c0c8bc2b",
    "result": "unsafe",
    "riskLevel": "high",
    "labelName": "疑似色情内容",
    "categoryName": "色情低俗类",
    "confidence": 0.95,
    "refusalMessage": "抱歉，检测到图片可能包含不当内容，无法展示。"
  }
}

响应示例 - 安全图片

json

{
  "success": true,
  "code": 200,
  "message": "检测完成",
  "data": {
    "requestId": "req_1784354965434_c032c0c8bc2b",
    "result": "safe",
    "riskLevel": "none",
    "labelName": null,
    "categoryName": null,
    "confidence": null,
    "refusalMessage": null
  }
}

注意事项

• 图片大小不超过10MB，宽高不超过30,000像素

• URL方式需确保图片公网可访问，支持防盗链自动处理

• Base64方式需包含完整的 data:image/格式;base64, 前缀

• 支持格式：PNG、JPG/JPEG、BMP、WebP、GIF（GIF取第一帧）

音频安全检测

对音频URL进行安全检测，识别语音中的违规内容和敏感信息。支持MP3/WAV/AAC/FLAC等常见格式。

请求示例

json

{
  "content": "https://example.com/audio.mp3",
  "contentType": "audio",
  "detectionScene": "output"
}

响应示例 - 风险音频

json

{
  "success": true,
  "code": 200,
  "message": "检测完成",
  "data": {
    "requestId": "req_1784354965434_a812b3c4d5e6",
    "result": "unsafe",
    "riskLevel": "high",
    "labelName": "疑似暴恐信息",
    "categoryName": "暴力恐怖类",
    "confidence": 0.92,
    "refusalMessage": "抱歉，检测到音频可能包含不当内容，无法播放。"
  }
}

响应示例 - 安全音频

json

{
  "success": true,
  "code": 200,
  "message": "检测完成",
  "data": {
    "requestId": "req_1784354965434_a812b3c4d5e6",
    "result": "safe",
    "riskLevel": "none",
    "labelName": null,
    "categoryName": null,
    "confidence": null,
    "refusalMessage": null
  }
}

注意事项

• 音频URL需公网可访问，需以http://或https://开头，不可含空格

• 支持格式：MP3、WAV、AAC、FLAC、OGG、AMR等

• 音频时长有限制（默认60分钟），检测可能需要10-60秒

• 系统会自动下载音频文件并进行语音转文字+文本安全检测

视频安全检测

对视频URL进行安全检测，识别视频画面和音频中的安全风险。支持MP4/AVI/MOV/MKV等常见格式。

请求示例

json

{
  "content": "https://example.com/video.mp4",
  "contentType": "video",
  "detectionScene": "input"
}

响应示例 - 风险视频

json

{
  "success": true,
  "code": 200,
  "message": "检测完成",
  "data": {
    "requestId": "req_1784354965434_f723e8d9c0a1",
    "result": "unsafe",
    "riskLevel": "medium",
    "labelName": "疑似广告引流",
    "categoryName": "广告引流类",
    "confidence": 0.88,
    "refusalMessage": "抱歉，检测到视频可能包含不当内容，无法播放。"
  }
}

响应示例 - 安全视频

json

{
  "success": true,
  "code": 200,
  "message": "检测完成",
  "data": {
    "requestId": "req_1784354965434_f723e8d9c0a1",
    "result": "safe",
    "riskLevel": "none",
    "labelName": null,
    "categoryName": null,
    "confidence": null,
    "refusalMessage": null
  }
}

注意事项

• 视频URL需公网可访问，需以http://或https://开头，不可含空格

• 支持格式：MP4、AVI、MOV、MKV、FLV、WMV、WebM等

• 视频时长有限制（默认30分钟），检测可能需要30-120秒

• 系统会对视频关键帧进行图片安全检测，同时对音轨进行语音安全检测

文档安全检测

对文档URL进行安全检测，识别文档内容中的违规和敏感信息。支持PDF/Word/PPT/Excel等常见格式。

请求示例

json

{
  "content": "https://example.com/document.pdf",
  "contentType": "file",
  "detectionScene": "input"
}

响应示例 - 风险文档

json

{
  "success": true,
  "code": 200,
  "message": "检测完成",
  "data": {
    "requestId": "req_1784354965434_b456c7d8e9f0",
    "result": "unsafe",
    "riskLevel": "high",
    "labelName": "疑似涉政内容",
    "categoryName": "政治敏感类",
    "confidence": 0.96,
    "refusalMessage": "抱歉，检测到文档可能包含敏感内容，无法展示。"
  }
}

响应示例 - 安全文档

json

{
  "success": true,
  "code": 200,
  "message": "检测完成",
  "data": {
    "requestId": "req_1784354965434_b456c7d8e9f0",
    "result": "safe",
    "riskLevel": "none",
    "labelName": null,
    "categoryName": null,
    "confidence": null,
    "refusalMessage": null
  }
}

注意事项

• 文档URL需公网可访问，需以http://或https://开头，不可含空格

• 支持格式：PDF、Word（DOC/DOCX）、PPT/PPTX、Excel（XLS/XLSX）、TXT等

• 文档页数有限制（默认500页），检测可能需要10-60秒

• 系统会自动下载文档并提取文本内容进行安全检测

多语言示例代码

bash

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

# 图片检测 - URL方式
curl -X POST 'https://api.zhongsen.com/api/v1/security/detect' \
  -H 'x-api-key: zs_a1b2c3d4e5f6g7h8i9j0k' \
  -H 'Content-Type: application/json' \
  -d '{"content": "https://example.com/image.jpg", "contentType": "image", "detectionScene": "input"}'

# 图片检测 - Base64方式
curl -X POST 'https://api.zhongsen.com/api/v1/security/detect' \
  -H 'x-api-key: zs_a1b2c3d4e5f6g7h8i9j0k' \
  -H 'Content-Type: application/json' \
  -d '{"content": "data:image/jpeg;base64,/9j/4AAQSkZJRg...", "contentType": "image", "detectionScene": "input"}'

# 音频检测
curl -X POST 'https://api.zhongsen.com/api/v1/security/detect' \
  -H 'x-api-key: zs_a1b2c3d4e5f6g7h8i9j0k' \
  -H 'Content-Type: application/json' \
  -d '{"content": "https://example.com/audio.mp3", "contentType": "audio", "detectionScene": "output"}'

# 视频检测
curl -X POST 'https://api.zhongsen.com/api/v1/security/detect' \
  -H 'x-api-key: zs_a1b2c3d4e5f6g7h8i9j0k' \
  -H 'Content-Type: application/json' \
  -d '{"content": "https://example.com/video.mp4", "contentType": "video", "detectionScene": "input"}'

# 文档检测
curl -X POST 'https://api.zhongsen.com/api/v1/security/detect' \
  -H 'x-api-key: zs_a1b2c3d4e5f6g7h8i9j0k' \
  -H 'Content-Type: application/json' \
  -d '{"content": "https://example.com/document.pdf", "contentType": "file", "detectionScene": "input"}'

安全标签体系

众森卫士安全标签体系覆盖15大安全类别、43种安全标签，按风险等级分为高风险、中风险、低风险三个等级。所有模态（文本、图片、音频、视频、文档）共用同一套安全标签体系。

← 左右滑动查看完整内容 →

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

更新日志

v2.2.02026-07-19

补充音频、视频、文档检测响应示例和注意事项；明确URL格式校验规则（需以http://或https://开头，不可含空格）

v2.1.02026-07-18

图片检测新增Base64编码上传方式，支持直接传入图片Base64数据进行安全检测，无需公网URL

v2.0.02026-06-20

新增多模态检测支持，统一接口支持文本、图片、音频、视频、文档5种内容类型检测

v1.0.02026-05-01

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