Documentation

API Documentation

Everything you need to integrate Discuse content moderation into your application. Simple REST API, comprehensive features, and industry-leading accuracy.

Getting Started

Quick start guide to integrate Discuse API into your application.

AuthenticationAPI KeysQuick StartSDKs

Text Analysis

Analyze text content for spam, toxicity, sentiment, and language.

Sentiment AnalysisSpam DetectionLanguage DetectionProfanity Filter

Image Analysis

Detect NSFW content and inappropriate images with high accuracy.

NSFW DetectionContent ClassificationImage URLsBatch Processing

Document Processing

Extract text from images and PDFs with OCR, then moderate or summarize it.

OCRText ExtractionModerationSummarization

API Endpoints

Quick overview of available API endpoints. All endpoints accept JSON and return JSON responses.

POST/api/v2/check

Full content moderation check with all enabled features.

POST/api/v2/demo/check

Public demo endpoint (rate limited, no API key required).

POST/api/v2/scan

Scan files for malware and viruses.

POST/api/v2/ocr

Extract text from images and PDFs, with optional moderation.

POST/api/v2/summarize

Generate a concise summary of a document.

POST/api/v2/demo/ocr

Public OCR demo (rate limited, no API key; PDFs up to 20 pages).

POST/api/v2/demo/summarize

Public summarization demo (rate limited, no API key; PDFs up to 20 pages).

Method	Endpoint	Description
POST	`/api/v2/check`	Full content moderation check with all enabled features.
POST	`/api/v2/demo/check`	Public demo endpoint (rate limited, no API key required).
POST	`/api/v2/scan`	Scan files for malware and viruses.
POST	`/api/v2/ocr`	Extract text from images and PDFs, with optional moderation.
POST	`/api/v2/summarize`	Generate a concise summary of a document.
POST	`/api/v2/demo/ocr`	Public OCR demo (rate limited, no API key; PDFs up to 20 pages).
POST	`/api/v2/demo/summarize`	Public summarization demo (rate limited, no API key; PDFs up to 20 pages).

Base URL

All API requests should be made to the following base URL:

https://api.discuse.com

Authentication

Authenticate your API requests by including your API key in the request header.

X-API-Key: your_api_key_here

Don't have an API key? Get started here to create one.

Response Format

All API responses follow a consistent JSON structure:

{
  "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
  }
}

Ready to Get Started?

Follow our getting started guide to integrate content moderation in minutes.

Start Integration