Получение видео по идентификатору

Возвращает видео и текущий статус его обработки.

Используйте метод, чтобы дождаться готовности видео после загрузки: статус меняется UPLOADED → PROCESSING → READY. В статусе READY заполнено поле content со ссылкой на плеер, в статусе ERROR — поле error с описанием ошибки.

Опрашивайте метод не чаще одного раза в 5 секунд: обработка занимает время, пропорциональное длительности видео, а на магазин действует общий лимит запросов.

Видео в статусе ERROR удаляются автоматически, после удаления метод возвращает 404.

Request

GET

https://api.kit.yandex.net/v1/videos/{video_id}

Responses

200 OK

Видео

Body

application/json

{
  "id": "vplvusemmooxmhpwiqli",
  "status": "UPLOADED",
  "title": "promo.mp4",
  "created_at": "2020-01-01T00:00:00Z",
  "content": {
    "player_url": "https://example.com/player/vplvusemmooxmhpwiqli",
    "first_frame_url": "https://example.com/first-frame.jpg",
    "duration_seconds": 15
  },
  "error": {
    "code": "TRANSCODING_FAILED",
    "message": "Не удалось обработать видео"
  }
}

Name	Description
created_at	Type: string<date-time> Дата загрузки видео Example: `2020-01-01T00:00:00Z`
id	Type: VideoID Идентификатор видео. Min length: `1` Example: `vplvusemmooxmhpwiqli`
status	Type: VideoStatus Статус обработки видео: `UPLOADED` — видео загружено и поставлено в очередь на обработку. `PROCESSING` — видео обрабатывается. `READY` — видео готово к показу, заполнено поле `content`. `ERROR` — обработка завершилась ошибкой, детали в поле `error`. Enum: `UPLOADED`, `PROCESSING`, `READY`, `ERROR`
title	Type: string Название видео. Совпадает с именем загруженного файла. Example: `promo.mp4`
content	All of 1 type Type: VideoContent Ссылки на готовое видео. Example `{ "player_url": "https://example.com/player/vplvusemmooxmhpwiqli", "first_frame_url": "https://example.com/first-frame.jpg", "duration_seconds": 15 }` Ссылки на видео. Заполняется только в статусе `READY`. Example `{ "player_url": "https://example.com/player/vplvusemmooxmhpwiqli", "first_frame_url": "https://example.com/first-frame.jpg", "duration_seconds": 15 }`
error	All of 1 type Type: VideoError Ошибка обработки видео. Example `{ "code": "TRANSCODING_FAILED", "message": "Не удалось обработать видео" }` Описание ошибки обработки. Заполняется только в статусе `ERROR`. Example `{ "code": "TRANSCODING_FAILED", "message": "Не удалось обработать видео" }`

VideoID

Идентификатор видео.

Type: string

Min length: 1

Example: vplvusemmooxmhpwiqli

VideoStatus

Статус обработки видео:

UPLOADED — видео загружено и поставлено в очередь на обработку.
PROCESSING — видео обрабатывается.
READY — видео готово к показу, заполнено поле content.
ERROR — обработка завершилась ошибкой, детали в поле error.

Type: string

Enum: UPLOADED, PROCESSING, READY, ERROR

VideoContent

Ссылки на готовое видео.

Name	Description
player_url	Type: string<uri> Ссылка на плеер видео. Example: `https://example.com/player/vplvusemmooxmhpwiqli`
duration_seconds	Type: integer Длительность видео в секундах.
first_frame_url	Type: string<uri> Ссылка на превью — первый кадр видео. Example: `https://example.com/first-frame.jpg`

Example

{
  "player_url": "https://example.com/player/vplvusemmooxmhpwiqli",
  "first_frame_url": "https://example.com/first-frame.jpg",
  "duration_seconds": 15
}

VideoError

Ошибка обработки видео.

Name

Description

message

Type: string

Описание ошибки.

Example: Не удалось обработать видео

code

Type: string

Код ошибки. Может отсутствовать — не используйте его как однозначный признак причины сбоя.

Example: TRANSCODING_FAILED

Example

{
  "code": "TRANSCODING_FAILED",
  "message": "Не удалось обработать видео"
}

400 Bad Request

Некорректный запрос.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

401 Unauthorized

Не авторизован.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

404 Not Found

Ресурс не найден.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

500 Internal Server Error

Внутренняя ошибка сервера.

Body

application/json

{
  "code": "VALIDATION_ERROR",
  "message": "Invalid input",
  "trace_id": "00000000000000000000000000000000"
}

Name	Description
code	Type: string Example: `VALIDATION_ERROR`
message	Type: string Example: `Invalid input`
trace_id	Type: string Уникальный идентификатор запроса для отладки. Example: `00000000000000000000000000000000`

Была ли статья полезна?

Загрузка видео по ссылке

Список ресурсов