Ошибки

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	Missing job_id	Возвращается, когда запрос на рендер не содержит job_id.
400	invalid_request_error	No outputs available for this job	Возвращается, когда у задания нет доступных для рендера результатов.
400	invalid_request_error	input_keys must be a non-empty array	Возвращается, когда `input_keys` отсутствует или пуст.
400	invalid_request_error	input_keys must contain at least one valid input key	Возвращается, когда все предоставленные ключи ввода пусты или недействительны после нормализации.
400	input_duration_requirement_error	Total input duration must be greater than 2 seconds	Возвращается, когда суммарная длительность всех входных медиа составляет 2 секунды или меньше.
400	input_duration_requirement_error	Total input duration must be less than 6 hours	Возвращается, когда суммарная длительность всех входных медиа составляет 6 часов или больше.
400	input_image_count_requirement_error	Number of input images must be no more than 4000	Возвращается, когда количество входных изображений превышает максимально разрешенное значение 4000.
400	input_video_count_requirement_error	Number of input videos must be no more than 400	Возвращается, когда количество входных видео превышает максимально разрешенное значение 400.
400	invalid_request_error	Invalid video_category. Allowed values: podcast, ball-sports, non-ball-sports, beauty-product-demo, wedding, travel, others	Возвращается, когда `video_category` не поддерживается.
400	invalid_request_error	Invalid aspect_ratio. Allowed values: square, portrait, landscape	Возвращается, когда `aspect_ratio` не поддерживается.
400	invalid_request_error	output_length must be a positive number	Возвращается, когда `output_length` отсутствует, равен нулю или отрицателен.
400	invalid_request_error	Could not determine positive input duration from input_keys metadata	Возвращается, когда API не может определить допустимую продолжительность для загруженных входных данных.
401	authentication_error	Missing API key	Возвращается, когда заголовок `x-api-key` не предоставлен.
401	authentication_error	Invalid API key	Возвращается, когда предоставленный API-ключ не соответствует активному ключу.
402	insufficient_balance	You do not have enough credits to process this job	Возвращается, когда на аккаунте недостаточно кредитов для обработки или рендера.
403	permission_error	You do not have permission to access this job	Возвращается, когда аутентифицированный пользователь не является владельцем запрошенного задания.
403	permission_error	You do not have permission to render this job	Возвращается, когда аутентифицированный пользователь не является владельцем задания, которое пытаются рендерить.
404	invalid_request_error	Job not found	Возвращается, когда запрошенное задание не существует.
404	invalid_request_error	User not found	Возвращается, когда запись аутентифицированного пользователя не найдена.
429	rate_limit_error	Too many requests	Возвращается, когда клиент превышает допустимую частоту запросов для этого эндпоинта. Текущий лимит — 60 запросов в минуту. Ограничение частоты запросов в первую очередь применяется по API-ключу с использованием заголовка x-api-key и, если API-ключ отсутствует, по IP-адресу клиента. Клиентам, достигшим этого лимита, следует уменьшить частоту запросов и повторить попытку после сброса окна лимита.
500	api_error	Authentication error	Возвращается, когда аутентификация API-ключа на сервере неожиданно не удалась.
500	api_error	Internal server error	Возвращается при неожиданных сбоях на стороне сервера в эндпоинтах status, render или highlight reel.
500	server_error	Failed to generate upload URL	Возвращается, когда сервер не может сгенерировать подписанный URL для загрузки.