REST API · JSON

API для вашего видеохостинга

Загружайте, обрабатывайте, публикуйте и анализируйте видео через единый API StreamBox. Создавайте собственные медиаплатформы без сложной серверной инфраструктуры.

Начать интеграцию Открыть API Reference

99.95% гарантированный SLA

< 200 мс средний ответ API

4K / HLS поддержка стриминга

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

Все запросы к API должны содержать персональный ключ доступа в HTTP-заголовке.

Создайте ключ

Перейдите в панель управления StreamBox и создайте API-ключ для нужного проекта.

Передайте токен

Используйте заголовок Authorization: Bearer в каждом защищённом запросе.

Ограничьте доступ

Создавайте отдельные ключи для development, staging и production окружений.

Важно: не добавляйте API-ключ в публичный JavaScript-код или репозиторий. Выполняйте авторизованные запросы с backend-сервера.

Быстрый старт

Получите список видео вашего проекта первым запросом.

cURL

curl -X GET "https://api.streambox.example/v1/videos" \
  -H "Authorization: Bearer sb_live_your_api_key" \
  -H "Content-Type: application/json"

Видео

Управляйте видеофайлами, их метаданными, статусом обработки и публикацией.

GET /v1/videos

Возвращает постраничный список видео в текущем проекте.

Авторизация Bearer token

Успешный ответ 200 OK

Лимит 100 запросов / мин.

Ответ · application/json

{
  "data": [
    {
      "id": "vid_8f2d4a91",
      "title": "Обзор нового продукта",
      "status": "ready",
      "duration": 183,
      "created_at": "2026-08-24T10:42:18Z"
    }
  ],
  "meta": {
    "page": 1,
    "per_page": 20
  }
}

POST /v1/videos

Создаёт видео-ресурс и возвращает URL для прямой загрузки файла в хранилище.

Авторизация Bearer token

Успешный ответ 201 Created

Content-Type application/json

Тело запроса

{
  "title": "Интервью с командой",
  "filename": "interview.mp4",
  "visibility": "private"
}

DELETE /v1/videos/{video_id}

Безвозвратно удаляет видео, связанные файлы и URL воспроизведения.

Авторизация Bearer token

Успешный ответ 204 No Content

Требуемый scope videos:write

Удаление нельзя отменить. Перед операцией рекомендуем сохранить резервную копию исходного видеофайла.

Параметры видео

Основные поля, которые можно передавать при создании и обновлении видео.

Параметр	Тип	Обязателен	Описание
`title`	`string`	Да	Заголовок видео, до 150 символов.
`filename`	`string`	Да	Исходное имя файла с расширением.
`description`	`string`	Нет	Описание видео, до 5 000 символов.
`visibility`	`enum`	Нет	`public`, `unlisted` или `private`.
`tags`	`string[]`	Нет	Массив поисковых тегов, максимум 20 значений.

Webhooks

Получайте уведомления о готовности видео, ошибках обработки и публикациях.

Пример события video.ready

{
  "event": "video.ready",
  "created_at": "2026-08-24T10:47:31Z",
  "data": {
    "id": "vid_8f2d4a91",
    "status": "ready",
    "playback_url": "https://cdn.streambox.example/hls/vid_8f2d4a91/master.m3u8"
  }
}

Коды ошибок

Все ошибки возвращаются в JSON-формате с полями error и message.

HTTP	Код	Описание
`400`	`invalid_request`	Некорректные параметры запроса или JSON.
`401`	`unauthorized`	API-ключ отсутствует, истёк или недействителен.
`404`	`video_not_found`	Видео с указанным идентификатором не найдено.
`429`	`rate_limit_exceeded`	Превышен лимит запросов. Повторите запрос позже.
`500`	`internal_error`	Внутренняя ошибка сервиса. Обратитесь в поддержку, если проблема повторяется.