Помилки
VIDIO API використовує єдиний формат об'єкта помилки. Використовуйте цю сторінку, щоб зрозуміти поширені типи помилок, коди статусу HTTP та приклади повідомлень, які повертає API.
Доступ до API наразі доступний лише для корпоративних планів. Запросіть доступ тут, якщо ви не є корпоративним користувачем, але зацікавлені у використанні API.
Огляд
Коли запит не вдається, VIDIO API повертає об'єкт error з type та message. Деякі помилки також можуть містити додаткові поля для пояснення збою.
Формат помилки
json
{
"error": {
"type": "invalid_request_error",
"message": "Завдання не знайдено"
}
}Довідник помилок
| Status | Type | Message | Description |
|---|---|---|---|
| 400 | invalid_request_error | Відсутні обов'язкові параметри запиту у запиті на завантаження | Повертається, коли відсутні обов'язкові параметри запиту у запиті на завантаження. |
| 400 | invalid_request_error | Відсутній job_id | Повертається, коли запит на рендер не містить ідентифікатор завдання. |
| 400 | invalid_request_error | Немає доступних виходів для цього завдання | Повертається, коли завдання не має жодного рендерного виходу. |
| 400 | invalid_request_error | input_keys повинен бути непорожнім масивом | Повертається, коли `input_keys` відсутній або порожній. |
| 400 | invalid_request_error | input_keys повинен містити принаймні один допустимий ключ вводу | Повертається, коли всі надані ключі вводу є пустими або недійсними після нормалізації. |
| 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 не може визначити дійсну тривалість для завантажених вводу. |
| 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-адреси клієнта. Клієнти, які досягають цього ліміту, повинні зменшити частоту запитів і повторити спробу після скидання вікна обмеження частоти. |
| 500 | api_error | Помилка аутентифікації | Повертається, коли аутентифікація за API ключем не вдалася несподівано на сервері. |
| 500 | api_error | Внутрішня помилка сервера | Повертається за несподіваними збоями на стороні сервера в статусних, рендерних або хайлайтових ендпоінтах. |
| 500 | server_error | Не вдалося згенерувати URL для завантаження | Повертається, коли сервер не зміг згенерувати підписаний URL для завантаження. |