Błędy
API VIDIO używa spójnego formatu obiektu błędu. Użyj tej strony, aby zrozumieć typowe rodzaje błędów, kody statusu HTTP i przykładowe komunikaty zwracane przez API.
Dostęp do API jest obecnie dostępny dla planu Studio i wyżej.
Podsumowanie
Gdy żądanie kończy się niepowodzeniem, API VIDIO zwraca obiekt error z type i message. Niektóre błędy mogą również zawierać dodatkowe pola, aby pomóc wyjaśnić niepowodzenie.
Format błędu
json
{
"error": {
"type": "invalid_request_error",
"message": "Nie znaleziono zadania"
}
}Referencja błędów
| Status | Type | Message | Description |
|---|---|---|---|
| 400 | invalid_request_error | Brakuje wymaganych parametrów zapytania w żądaniu adresu URL przesyłania | Zwracane, gdy w żądaniu adresu URL przesyłania brakują wymagane parametry zapytania. |
| 400 | invalid_request_error | Brak job_id | Zwracane, gdy żądanie renderowania nie zawiera identyfikatora zadania (job_id). |
| 400 | invalid_request_error | Brak dostępnych wyników dla tego zadania | Zwracane, gdy zadanie nie ma żadnych wyników do renderowania. |
| 400 | invalid_request_error | input_keys must be a non-empty array | Zwracane, gdy `input_keys` jest nieobecne lub puste. |
| 400 | invalid_request_error | input_keys must contain at least one valid input key | Zwracane, gdy wszystkie podane klucze wejściowe są puste lub nieprawidłowe po normalizacji. |
| 400 | input_duration_requirement_error | Total input duration must be greater than 2 seconds | Zwracane, gdy łączna długość wszystkich mediów wejściowych wynosi 2 sekundy lub mniej. |
| 400 | input_duration_requirement_error | Total input duration must be less than 6 hours | Zwracane, gdy łączna długość wszystkich mediów wejściowych wynosi 6 godzin lub więcej. |
| 400 | input_image_count_requirement_error | Number of input images must be no more than 4000 | Zwracane, gdy liczba obrazów wejściowych przekracza maksymalny dozwolony limit 4000. |
| 400 | input_video_count_requirement_error | Number of input videos must be no more than 400 | Zwracane, gdy liczba filmów wejściowych przekracza maksymalny dozwolony limit 400. |
| 400 | invalid_request_error | Invalid video_category. Allowed values: podcast, ball-sports, non-ball-sports, beauty-product-demo, wedding, travel, others | Zwracane, gdy `video_category` nie jest obsługiwane. |
| 400 | invalid_request_error | Invalid aspect_ratio. Allowed values: square, portrait, landscape | Zwracane, gdy `aspect_ratio` nie jest obsługiwany. |
| 400 | invalid_request_error | output_length must be a positive number | Zwracane, gdy `output_length` jest pominięty, równy zero lub ujemny. |
| 400 | invalid_request_error | Could not determine positive input duration from input_keys metadata | Zwracane, gdy API nie może określić prawidłowej długości trwania dla przesłanych wejść. |
| 400 | invalid_request_error | music_volume must be a number between 0 and 100 | Zwracane, gdy podano `music_volume`, ale nie jest to prawidłowa liczba między 0 a 100. |
| 400 | invalid_request_error | original_audio_volume must be a number between 0 and 100 | Zwracane, gdy podano `original_audio_volume`, ale nie jest to prawidłowa liczba między 0 a 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 | Zwracane, gdy podano `music_category`, ale nie odpowiada ona żadnej z obsługiwanych kategorii muzycznych. |
| 401 | authentication_error | Brak klucza API | Zwracane, gdy nagłówek `x-api-key` nie został podany. |
| 401 | authentication_error | Nieprawidłowy klucz API | Zwracane, gdy podany klucz API nie odpowiada aktywnemu kluczowi. |
| 402 | insufficient_balance | Nie masz wystarczająco kredytów, aby przetworzyć to zadanie | Zwracane, gdy konto nie ma wystarczającej liczby kredytów do przetworzenia lub renderowania. |
| 403 | permission_error | Nie masz uprawnień do dostępu do tego zadania | Zwracane, gdy uwierzytelniony użytkownik nie jest właścicielem żądanego zadania. |
| 403 | permission_error | Nie masz uprawnień do renderowania tego zadania | Zwracane, gdy uwierzytelniony użytkownik nie jest właścicielem zadania, które ma być renderowane. |
| 404 | invalid_request_error | Nie znaleziono zadania | Zwracane, gdy żądane zadanie nie istnieje. |
| 404 | invalid_request_error | Nie znaleziono użytkownika | Zwracane, gdy rekord uwierzytelnionego użytkownika nie może zostać znaleziony. |
| 429 | rate_limit_error | Zbyt wiele żądań | Zwracane, gdy klient przekroczy dozwoloną liczbę żądań dla tego punktu końcowego. Obecny limit to 60 żądań na minutę. Ograniczanie liczby żądań stosowane jest głównie względem klucza API przy użyciu nagłówka `x-api-key`, a w przypadku braku klucza API stosowane jest ograniczenie względem adresu IP klienta. Klienci, którzy osiągną ten limit, powinni zmniejszyć częstotliwość żądań i spróbować ponownie po zresetowaniu okna limitu. |
| 429 | rate_limit_error | Masz już 10 uruchomionych lub oczekujących zadań, co jest maksymalną dozwoloną liczbą. Proszę poczekaj, aż niektóre zadania zakończą się przed przesłaniem kolejnego. | Zwracane, gdy użytkownik już osiągnął maksymalną dozwoloną liczbę zadań w toku, zarówno uruchomionych na serwerach, jak i oczekujących w kolejce. Obecny limit to 10 łącznie uruchomionych lub oczekujących zadań na użytkownika. Własność określana jest przez dopasowanie każdego job_id na zajętych serwerach i wpisach w kolejce do pola user_email zadania. Klienci, którzy osiągną ten limit, powinni poczekać, aż jedno lub więcej istniejących zadań się zakończy, zanim utworzą lub wyrenderują kolejne zadanie. |
| 500 | api_error | Błąd uwierzytelniania | Zwracane, gdy uwierzytelnianie klucza API nieoczekiwanie nie powiodło się po stronie serwera. |
| 500 | api_error | Wewnętrzny błąd serwera | Zwracane w przypadku nieoczekiwanych błędów po stronie serwera w punktach końcowych status, render lub highlight reel. |
| 500 | server_error | Nie udało się wygenerować adresu URL przesyłania | Zwracane, gdy serwer nie zdoła wygenerować podpisanego adresu URL do przesyłania. |