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

Обзор

VideoCensor API позволяет автоматически находить и цензурировать нецензурную лексику, оскорбления, упоминания наркотиков, экстремизм и другой нежелательный контент в тексте, аудио и видео.

Аутентификация

Все запросы требуют API-ключ. Передавайте его в заголовке:

X-API-Key: vc_live_ваш_ключ

Получить ключ можно в панели разработчика.

POST /analyze/text

Анализирует текст и возвращает найденные слова с категориями и позициями.

curl -X POST https://videocensor.ru/api/v1/analyze/text \
  -H "X-API-Key: vc_live_ваш_ключ" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Ну ты и идиот блять",
    "categories": ["profanity", "insults"]
  }'

{
  "totalWords": 5,
  "flaggedCount": 2,
  "categories": {
    "insults": { "count": 1, "words": ["идиот"] },
    "profanity": { "count": 1, "words": ["блять"] }
  },
  "cleanText": "Ну ты и *** ***"
}

POST /censor/text

Цензурирует текст — заменяет найденные слова на указанную строку.

curl -X POST https://videocensor.ru/api/v1/censor/text \
  -H "X-API-Key: vc_live_ваш_ключ" \
  -H "Content-Type: application/json" \
  -d '{
    "text": "Сука блять какой пиздец",
    "replacement": "[цензура]"
  }'

{
  "censored": "[цензура] [цензура] какой [цензура]",
  "replacements": 3
}

POST /analyze/media

Загружает медиафайл для анализа. Возвращает ID задачи для отслеживания.

curl -X POST https://videocensor.ru/api/v1/analyze/media \
  -H "X-API-Key: vc_live_ваш_ключ" \
  -F "file=@video.mp4" \
  -F "mode=standard"

{ "jobId": "550e8400-...", "status": "queued" }

POST /censor/media

Загружает медиафайл для цензуры. Мат будет запикан или заглушен.

curl -X POST https://videocensor.ru/api/v1/censor/media \
  -H "X-API-Key: vc_live_ваш_ключ" \
  -F "file=@video.mp4" \
  -F "wayOfBlocking=beep"

{ "jobId": "550e8400-...", "status": "queued" }

Задачи (Jobs)

Медиа-обработка асинхронная. После отправки файла вы получаете jobId и отслеживаете статус.

# Отправить файл
JOB_ID=$(curl -s -X POST https://videocensor.ru/api/v1/censor/media \
  -H "X-API-Key: $API_KEY" -F "file=@video.mp4" | jq -r .jobId)

# Проверить статус
curl -s https://videocensor.ru/api/v1/jobs/$JOB_ID -H "X-API-Key: $API_KEY"

# Скачать результат (когда status=done)
curl -s https://videocensor.ru/api/v1/jobs/$JOB_ID/download \
  -H "X-API-Key: $API_KEY" -o censored.mp4

Вебхуки

Вместо поллинга настройте вебхук — сервер отправит POST-запрос на ваш URL когда задача завершится. Подпись проверяется через HMAC-SHA256.

const crypto = require('crypto');

function verifyWebhook(body, headers, secret) {
  const signature = headers['x-webhook-signature'];
  const timestamp = headers['x-webhook-timestamp'];
  const expected = 'sha256=' + crypto
    .createHmac('sha256', secret)
    .update(timestamp + '.' + body)
    .digest('hex');
  return crypto.timingSafeEqual(
    Buffer.from(signature), Buffer.from(expected)
  );
}

Ошибки

API возвращает ошибки в формате RFC 7807 (Problem Details):

{
  "type": "about:blank",
  "title": "Bad Request",
  "status": 400,
  "detail": "Описание ошибки",
  "code": "BAD_REQUEST",
  "requestId": "abc-123"
}

Лимиты запросов

API использует скользящее окно (1 минута). Лимиты зависят от тарифа. Заголовки ответа:

Тарифы API

SDK

Официальные SDK для быстрой интеграции. Поддерживают retry, rate limiting и типизацию.