Skip to main content
文档

API 文档

将 Discuse 内容审核集成到应用所需的一切。简洁的 REST API、全面的功能,以及行业领先的准确率。

API 端点

快速了解可用的 API 端点。所有端点都接收 JSON,并返回 JSON 响应。

POST/api/v2/check

使用所有已启用功能进行完整的内容审核检查。

POST/api/v2/demo/check

公开演示端点(有速率限制,无需 API 密钥)。

POST/api/v2/scan

扫描文件中的恶意软件和病毒。

POST/api/v2/ocr

从图片和 PDFs 中提取文本,可选择同时进行内容审核。

POST/api/v2/summarize

为文档生成简洁摘要。

POST/api/v2/demo/ocr

公开 OCR 演示(有速率限制,无需 API 密钥;PDFs 最多 20 页)。

POST/api/v2/demo/summarize

公开摘要生成演示(有速率限制,无需 API 密钥;PDFs 最多 20 页)。

基础 URL

所有 API 请求都应发送到以下基础 URL:

https://api.discuse.com

身份验证

在请求头中包含你的 API 密钥,用于验证 API 请求。

X-API-Key: your_api_key_here

还没有 API 密钥? 从这里开始 创建一个。

响应格式

所有 API 响应都遵循统一的 JSON 结构:

{
  "has_violations": false,
  "cached": false,
  "message": "Content appears safe",
  "results": {
    "hits": false,
    "sentiment": {
      "hit": false,
      "toxic": 0.02,
      "profanity": 0.01,
      "threat": 0.00,
      "insult": 0.03
    },
    "spam_finder": {
      "is_spam": false,
      "confidence": 0.05
    },
    "language": {
      "detected": "en",
      "confidence": 0.98
    }
  },
  "processing_time_ms": 45,
  "usage": {
    "api_requests_used": 150,
    "api_requests_limit": 10000,
    "api_requests_remaining": 9850
  }
}

准备好开始了吗?

按照入门指南操作,几分钟内接入内容审核。

开始集成