Vault Media Public API

1.4.2 OAS 3.1

Программный интерфейс для управления медиатекой, обработки файлов и контроля доставки контента. Все запросы и ответы используют формат JSON, если для операции не указано иное.

Связаться с разработчиками Схемы данных Скачать OpenAPI JSON

Сервер

System

Состояние и метаданные сервиса

operationId: getHealth

Возвращает текущее состояние основных компонентов платформы. Авторизация не требуется.

Запрос

200 OK126 ms · application/json

Ответы

200	Сервис доступен
503	Компонент временно недоступен

Media Objects

Загрузка и управление медиаматериалами

operationId: listMedia

Возвращает страницу объектов медиатеки с фильтрацией по типу, статусу и дате создания.

Параметры

Имя	Тип	Описание
limit optional	integer	Количество объектов, от 1 до 100
cursor	string	Курсор следующей страницы

Query parameters

200 OK184 ms · application/json

Ответы

200	Список объектов
401	Требуется авторизация

operationId: createUpload

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

Request body required

{
  "filename": "brand_story.mov",
  "content_type": "video/quicktime",
  "size": 8402211042,
  "folder_id": "fld_8ea24d"
}

Request body

201 Created207 ms · application/json

Ответы

201	Сессия создана
422	Ошибка параметров

operationId: getMedia

Параметры

Имя	Тип	Описание
media_id required	string	Идентификатор объекта

media_id

200 OK141 ms · application/json

Ответы

200	Данные объекта
404	Объект не найден

operationId: deleteMedia

Помещает объект в корзину. Окончательное удаление выполняется согласно политике хранения.

media_id

202 Accepted163 ms · application/json

Ответы

202	Операция принята
409	Объект используется активной публикацией

Processing

Преобразование изображений, аудио и видео

operationId: createTransform

Создаёт задачу обработки по системному или пользовательскому профилю.

Request body required

{
  "media_id": "med_01J8K4M2Q9F7",
  "preset": "video.web.1080p",
  "callback_url": "https://example.org/hooks/media"
}

Request body

202 Accepted231 ms · application/json

Ответы

202	Задача добавлена в очередь
422	Профиль не поддерживает формат

Delivery

Публикации и зоны доставки

operationId: listDeliveryZones

Возвращает список активных зон, их домены и текущий статус конфигурации.

Запрос

200 OK154 ms · application/json

Ответы

200	Список зон
401	Требуется авторизация

Usage

Статистика потребления ресурсов

operationId: getUsageSummary

Параметры

Имя	Тип	Описание
period	string	Период: day, month или custom

period

200 OK173 ms · application/json

Ответы

200	Агрегированные метрики
403	Недостаточно прав

Методы по заданному фильтру не найдены.

Schemas

Модели данных

MediaObject

{
  "id": "string",
  "filename": "string",
  "content_type": "string",
  "size": "integer",
  "status": "uploaded | processing | ready | failed",
  "created_at": "string",
  "metadata": "object"
}

UploadSession

{
  "upload_id": "string",
  "upload_url": "string",
  "expires_at": "string",
  "headers": "object"
}

TransformJob

{
  "job_id": "string",
  "media_id": "string",
  "preset": "string",
  "state": "queued | running | completed | failed",
  "progress": "integer<0..100>"
}

ApiError

{
  "error": {
    "code": "string",
    "message": "string",
    "request_id": "string"
  }
}