Chyby
API VIDIO používá konzistentní formát objektu chyby. Použijte tuto stránku k pochopení běžných typů chyb, stavových kódů HTTP a příkladových zpráv vracených API.
Přístup k API je v současné době k dispozici pouze pro plány Enterprise. Požádejte o přístup zde, pokud nejste uživatel Enterprise, ale máte zájem o používání API.
Přehled
Když požadavek selže, API VIDIO vrátí objekt error s type a message. Některé chyby mohou také obsahovat další pole pro vysvětlení selhání.
Formát chyby
json
{
"error": {
"type": "invalid_request_error",
"message": "Práce nebyla nalezena"
}
}Reference chyb
| Status | Type | Message | Description |
|---|---|---|---|
| 400 | invalid_request_error | Chybí povinné parametry dotazu v požadavku na URL nahrání | Vrací se, když chybí povinné parametry dotazu v požadavku na URL nahrání. |
| 400 | invalid_request_error | Chybí job_id | Vrací se, když požadavek na renderování neobsahuje ID úlohy. |
| 400 | invalid_request_error | Žádné výstupy k dispozici pro tuto práci | Vrací se, když úloha nemá žádné výstupy, které lze renderovat. |
| 400 | invalid_request_error | input_keys musí být neprázdné pole | Vrací se, když `input_keys` chybí nebo je prázdný. |
| 400 | invalid_request_error | input_keys musí obsahovat alespoň jeden platný vstupní klíč | Vrací se, když jsou všechny poskytnuté vstupní klíče prázdné nebo neplatné po normalizaci. |
| 400 | invalid_request_error | Neplatná video_category. Povolené hodnoty: podcast, míčové sporty, nemíčové sporty, prezentace kosmetických produktů, svatba, cestování, ostatní | Vrací se, když `video_category` není podporováno. |
| 400 | invalid_request_error | Neplatný aspect_ratio. Povolené hodnoty: čtverec, portrét, krajina | Vrací se, když `aspect_ratio` není podporováno. |
| 400 | invalid_request_error | output_length musí být kladné číslo | Vrací se, když `output_length` chybí, je nula nebo záporná. |
| 400 | invalid_request_error | Nelze určit kladnou délku vstupu z metadat input_keys | Vrací se, když API nemůže určit platnou délku pro nahrané vstupy. |
| 401 | authentication_error | Chybí API klíč | Vrací se, když není poskytnut hlavička `x-api-key`. |
| 401 | authentication_error | Neplatný API klíč | Vrací se, když poskytnutý API klíč neodpovídá aktivnímu klíči. |
| 402 | insufficient_balance | Nemáte dostatek kreditů k zpracování této práce | Vrací se, když účet nemá dostatek kreditů pro zpracování nebo renderování. |
| 403 | permission_error | Nemáte oprávnění k přístupu k této práci | Vrací se, když autentizovaný uživatel nevlastní požadovanou práci. |
| 403 | permission_error | Nemáte oprávnění k renderování této práce | Vrací se, když autentizovaný uživatel nevlastní práci, která se renderuje. |
| 404 | invalid_request_error | Práce nebyla nalezena | Vrací se, když požadovaná práce neexistuje. |
| 404 | invalid_request_error | Uživatel nebyl nalezen | Vrací se, když záznam autentizovaného uživatele nelze nalézt. |
| 429 | rate_limit_error | Příliš mnoho požadavků | Vrací se, když klient překročí povolenou míru požadavků pro daný koncový bod. Aktuální limit je 60 požadavků za minutu. Omezování přírůstku se primárně aplikuje na každý API klíč pomocí hlavičky x-api-key a vrací se k IP adrese klienta, když žádný API klíč není přítomen. Klienti, kteří dosáhnou tohoto limitu, by měli snížit frekvenci požadavků a zkusit to znovu po resetování okna limitu. |
| 500 | api_error | Chyba autentizace | Vrací se, když selže autentizace API klíče nečekaně na serveru. |
| 500 | api_error | Interní serverová chyba | Vrací se při neočekávaných selháních na straně serveru v koncových bodech status, render nebo highlight reel. |
| 500 | server_error | Nepodařilo se vygenerovat URL pro nahrání | Vrací se, když server nedokáže vygenerovat podepsanou URL pro nahrání. |