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 tylko dla planów Enterprise. Poproś o dostęp tutaj, jeśli nie jesteś użytkownikiem Enterprise, ale jesteś zainteresowany korzystaniem z API.
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 | Brak wymaganych parametrów zapytania w żądaniu URL przesyłania | Zwracane, gdy brakuje wymaganych parametrów zapytania w żądaniu URL przesyłania. |
| 400 | invalid_request_error | Brak job_id | Zwracane, gdy żądanie renderowania nie zawiera identyfikatora zadania. |
| 400 | invalid_request_error | Brak dostępnych wyników dla tego zadania | Zwracane, gdy zadanie nie ma żadnych wyników możliwych do renderowania. |
| 400 | invalid_request_error | input_keys musi być niepustą tablicą | Zwracane, gdy `input_keys` jest brakujące lub puste. |
| 400 | invalid_request_error | input_keys musi zawierać co najmniej jeden prawidłowy klucz wejściowy | Zwracane, gdy wszystkie podane klucze wejściowe są puste lub nieprawidłowe po normalizacji. |
| 400 | invalid_request_error | Nieprawidłowa video_category. Dozwolone wartości: podcast, sporty z piłką, sporty bez piłki, demonstracja produktu kosmetycznego, wesele, podróże, inne | Zwracane, gdy `video_category` nie jest obsługiwane. |
| 400 | invalid_request_error | Nieprawidłowy aspect_ratio. Dozwolone wartości: kwadrat, portret, krajobraz | Zwracane, gdy `aspect_ratio` nie jest obsługiwane. |
| 400 | invalid_request_error | output_length musi być dodatnią liczbą | Zwracane, gdy `output_length` jest brakujące, równe zero lub ujemne. |
| 400 | invalid_request_error | Nie można określić dodatniego czasu trwania wejścia z metadanych input_keys | Zwracane, gdy API nie może określić prawidłowego czasu trwania dla przesłanych danych wejściowych. |
| 401 | authentication_error | Brak klucza API | Zwracane, gdy nagłówek `x-api-key` nie jest dostarczony. |
| 401 | authentication_error | Nieprawidłowy klucz API | Zwracane, gdy podany klucz API nie odpowiada aktywnemu kluczowi. |
| 402 | insufficient_balance | Nie masz wystarczających kredytów, aby przetworzyć to zadanie | Zwracane, gdy konto nie ma wystarczających kredytów do przetwarzania 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 renderowanego zadania. |
| 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 | Za dużo żądań | Zwracane, gdy klient przekracza dozwoloną częstotliwość żądań dla punktu końcowego. Obecny limit to 60 żądań na minutę. Ograniczenie częstości jest stosowane głównie na podstawie klucza API za pomocą nagłówka x-api-key i przechodzi do adresu IP klienta, gdy klucz API nie jest obecny. Klienci, którzy osiągną ten limit, powinni zmniejszyć częstotliwość żądań i spróbować ponownie po zresetowaniu okna limitu. |
| 500 | api_error | Błąd uwierzytelniania | Zwracane, gdy uwierzytelnienie klucza API kończy się niepowodzeniem w sposób nieoczekiwany na serwerze. |
| 500 | api_error | Wewnętrzny błąd serwera | Zwracane w przypadku niespodziewanych awarii po stronie serwera w punktach końcowych statusu, renderowania lub zestawów highlight. |
| 500 | server_error | Nieudane generowanie URL przesyłania | Zwracane, gdy serwer nie może wygenerować podpisanego URL przesyłania. |