API Documentation

Overview

VideoCensor API automatically detects and censors profanity, hate speech, drug references, extremism, and other unwanted content in text, audio, and video.

Authentication

All requests require an API key. Pass it in the header:

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

Get your key in the developer dashboard.

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)
  );
}

Errors

API returns errors in RFC 7807 (Problem Details) format:

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

Rate Limits

API uses a sliding window (1 minute). Limits depend on your tier. Response headers:

API plans

SDK

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