Документация

Документация API

Всё, что нужно для интеграции модерации контента Discuse в ваше приложение. Простой REST API, широкие возможности и точность уровня лидеров рынка.

Начало работы

Краткое руководство по интеграции Discuse API в ваше приложение.

АутентификацияКлючи APIБыстрый стартSDKs

Анализ текста

Анализируйте текстовый контент на spam, токсичность, тональность и язык.

Анализ тональностиВыявление spamОпределение языкаФильтр ненормативной лексики

Анализ изображений

Выявляйте NSFW-контент и неподходящие изображения с высокой точностью.

Обнаружение NSFWКлассификация контентаURL изображенийПакетная обработка

Обработка документов

Извлекайте текст из изображений и PDFs с помощью OCR, а затем модерируйте или кратко пересказывайте его.

OCRИзвлечение текстаМодерацияКраткое изложение

Эндпоинты 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 страниц).

Метод	Эндпоинт	Описание
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
  }
}

Готовы начать?

Следуйте нашему руководству по началу работы, чтобы интегрировать модерацию контента за считанные минуты.

Начать интеграцию