Ошибки

API VIDIO использует согласованный формат объекта ошибки. Используйте эту страницу, чтобы понять распространенные типы ошибок, коды статуса HTTP и пример сообщений, возвращенных API.

Доступ к API в настоящее время доступен для плана Studio и выше.

Обзор

Когда запрос не выполняется, API VIDIO возвращает объект error с type и message. Некоторые ошибки также могут включать дополнительные поля для объяснения сбоя.

Формат ошибки

json

{
  "error": {
    "type": "invalid_request_error",
    "message": "Работа не найдена"
  }
}

Справочник по ошибкам

Status	Type	Message	Description
400	invalid_request_error	Отсутствуют обязательные параметры запроса в запросе на получение URL для загрузки	Возвращается, когда в запросе на получение URL для загрузки отсутствуют обязательные параметры.
400	invalid_request_error	Отсутствует job_id	Возвращается, когда в запросе на рендеринг не указан job_id.
400	invalid_request_error	Для этого задания нет доступных выходных файлов	Возвращается, когда у задания нет рендеримых выходных файлов.
400	invalid_request_error	input_keys должен быть непустым массивом	Возвращается, когда `input_keys` отсутствует или пуст.
400	invalid_request_error	input_keys должен содержать по крайней мере один допустимый ключ ввода	Возвращается, когда все предоставленные ключи ввода пусты или недействительны после нормализации.
400	input_duration_requirement_error	Общая длительность входных данных должна быть больше 2 секунд	Возвращается, когда суммарная длительность всех входных медиа составляет 2 секунды или меньше.
400	input_duration_requirement_error	Общая длительность входных данных должна быть меньше 6 часов	Возвращается, когда суммарная длительность всех входных медиа составляет 6 часов или больше.
400	input_image_count_requirement_error	Количество входных изображений не должно превышать 4000	Возвращается, когда количество входных изображений превышает максимально допустимый предел в 4000.
400	input_video_count_requirement_error	Количество входных видео не должно превышать 400	Возвращается, когда количество входных видео превышает максимально допустимый предел в 400.
400	invalid_request_error	Недопустимое значение video_category. Допустимые значения: podcast, ball-sports, non-ball-sports, beauty-product-demo, wedding, travel, others	Возвращается, когда `video_category` не поддерживается.
400	invalid_request_error	Недопустимое значение aspect_ratio. Допустимые значения: square, portrait, landscape	Возвращается, когда `aspect_ratio` не поддерживается.
400	invalid_request_error	output_length должен быть положительным числом	Возвращается, когда `output_length` отсутствует, равен нулю или отрицательный.
400	invalid_request_error	Не удалось определить положительную длительность входных данных из метаданных input_keys	Возвращается, когда API не может определить корректную длительность загруженных входных данных.
400	invalid_request_error	music_volume должен быть числом от 0 до 100	Возвращается, когда `music_volume` указан, но не является допустимым числом от 0 до 100.
400	invalid_request_error	original_audio_volume должен быть числом от 0 до 100	Возвращается, когда `original_audio_volume` указан, но не является допустимым числом от 0 до 100.
400	invalid_request_error	Недопустимое значение music_category. Допустимые значения: corporate, romantic, sports, kids_and_comedy, ambient_and_nature, horror_and_suspense, documentary, trending_vlogs	Возвращается, когда `music_category` указан, но не соответствует одной из поддерживаемых категорий музыки.
401	authentication_error	Отсутствует API-ключ	Возвращается, когда заголовок `x-api-key` не предоставлен.
401	authentication_error	Недействительный API-ключ	Возвращается, когда предоставленный API-ключ не соответствует активному ключу.
402	insufficient_balance	У вас недостаточно кредитов для обработки этого задания	Возвращается, когда на аккаунте недостаточно кредитов для обработки или рендеринга.
403	permission_error	У вас нет прав для доступа к этому заданию	Возвращается, когда аутентифицированный пользователь не является владельцем запрошенного задания.
403	permission_error	У вас нет прав для рендеринга этого задания	Возвращается, когда аутентифицированный пользователь не владеет заданием, которое пытаются отрендерить.
404	invalid_request_error	Задание не найдено	Возвращается, когда запрошенное задание не существует.
404	invalid_request_error	Пользователь не найден	Возвращается, когда запись аутентифицированного пользователя не найдена.
429	rate_limit_error	Слишком много запросов	Возвращается, когда клиент превышает допустимую частоту запросов к этому эндпоинту. Текущий лимит — 60 запросов в минуту. Ограничение частоты в первую очередь применяется по API-ключу через заголовок x-api-key, а при отсутствии API-ключа используется IP-адрес клиента. Клиентам, достигшим этого лимита, следует снизить частоту запросов и повторить попытку после сброса окна ограничения.
429	rate_limit_error	У вас уже запущено или в очереди 10 заданий, что является максимально допустимым. Пожалуйста, дождитесь завершения некоторых заданий, прежде чем отправлять новое.	Возвращается, когда у пользователя уже достигнуто максимально допустимое количество заданий в процессе выполнения — как запущенных на серверах, так и ожидающих в очереди. Текущий лимит — 10 заданий на пользователя суммарно (запущенные или в очереди). Владение определяется по сопоставлению каждого job_id на занятых серверах и записях в очереди с полем user_email задания. Клиентам, достигшим этого лимита, следует дождаться завершения одного или нескольких существующих заданий перед созданием или рендерингом нового.
500	api_error	Ошибка аутентификации	Возвращается, когда аутентификация API-ключа неожиданно терпит неудачу на сервере.
500	api_error	Внутренняя ошибка сервера	Возвращается при непредвиденных сбоях на стороне сервера в эндпоинтах статуса, рендеринга или формирования нарезок.
500	server_error	Не удалось сгенерировать URL для загрузки	Возвращается, когда сервер не может сгенерировать подписанный URL для загрузки.