Помилки
VIDIO API використовує єдиний формат об'єкта помилки. Використовуйте цю сторінку, щоб зрозуміти поширені типи помилок, коди статусу HTTP та приклади повідомлень, які повертає API.
Доступ до API наразі доступний для плану Studio та вище.
Огляд
Коли запит не вдається, VIDIO API повертає об'єкт 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 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 не може визначити дійсну тривалість для завантажених вхідних даних. |
| 400 | invalid_request_error | music_volume must be a number between 0 and 100 | Повертається, коли надано `music_volume`, але воно не є дійсним числом у діапазоні від 0 до 100. |
| 400 | invalid_request_error | original_audio_volume must be a number between 0 and 100 | Повертається, коли надано `original_audio_volume`, але воно не є дійсним числом у діапазоні від 0 до 100. |
| 400 | invalid_request_error | Invalid music_category. Allowed values: 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 | You already have 10 running or queued jobs, which is the maximum allowed. Please wait for some jobs to finish before submitting another one. | Повертається, коли у користувача вже є максимально дозволена кількість активних завдань (запущених або в черзі) на серверах і в черзі. Поточний ліміт — 10 завдань загалом (запущених або в черзі) на користувача. Власність визначається шляхом зіставлення кожного job_id на зайнятих серверах та записах у черзі з user_email власника завдання. Клієнтам, які досягли цього ліміту, слід дочекатися завершення одного або кількох існуючих завдань перед створенням або рендером іншого. |
| 500 | api_error | Помилка аутентифікації | Повертається, коли аутентифікація API-ключа несподівано не вдається на сервері. |
| 500 | api_error | Внутрішня помилка сервера | Повертається у випадку несподіваних збоїв на стороні сервера в кінцевих точках статусу, рендерингу або підсумкового ролика (highlight reel). |
| 500 | server_error | Не вдалося згенерувати URL для завантаження | Повертається, коли сервер не може згенерувати підписаний URL для завантаження. |