Błędy

Reigniter API używa standardowych kodów HTTP statusu. Każda odpowiedź na błąd jest JSON.

Ciało błędu

Większość błędów wygląda tak:

{
  "error": "Rate limit exceeded",
  "code": "RATE_LIMITED",
  "retryAfter": 37
}

Pole	Zawsze obecny	Co to jest
`error`	Tak	Wiadomość, którą możesz pokazać osobie. Może zmienić sformułowanie, więc nie dopasowuj do niej.
`code`	Większość błędów	Stabilny, wielki kod. Rozgałęzij się na tym.
`details`	Kilka błędów	Dodatkowy kontekst, na przykład `retryAfter` lub dane dotyczące użycia.
`retryAfter`	Niektóre `429`	Kilka sekund na poczekanie przed ponowną próbą.

Kilka błędów nie ma code, takich jak 404 Job not found i 403 Forbidden. Rozgałęzij się na status dla nich.

Błędy walidacyjne

Gdy ciało żądania nie odpowiada schematowi, otrzymujesz 400 ciąg detail, który wymienia każdy problem jako field: message:

{
  "error": "Validation failed",
  "detail": "aspect: Invalid option: expected one of \"9:16\"|\"16:9\"|\"1:1\"|\"4:5\"|\"4:3\"|\"3:4\""
}

Kody statusowe

Status	Znaczenie	Co robić
`200`	Sukces.
`201`	Stworzone (webhooki).
`202`	Przyjęto. Renderowanie się rozpoczęło.	Sprawdź ofertę pracy lub poczekaj na webhook.
`400`	Prośba została odrzucona. Nic nie zostało postawione zarzutom.	Napraw żądanie. Nie próbuj ponownie bez zmian.
`401`	Brakuje, jest nieważna lub cofnięta API klucz.	Sprawdź klucz.
`402`	Problem z planem, kredytem lub użytkowaniem.	Przeczytaj `code`.
`403`	Zawieszone konto albo praca, która nie jest twoja.	Skontaktuj się z pomocą techniczną lub sprawdź identyfikator stanowiska.
`404`	Nie znalezione.	Sprawdź ID lub ścieżkę.
`409`	Zduplikowane żądanie lub osiągnięty limit.	Przeczytaj `code`.
`413`	Taki render kosztowałby więcej niż limit na render.	Używaj mniej scen lub niższej `quality`.
`422`	Render nie ma marki, produktu ani prezentera, który by go zakotwiczył.	Zobacz Tworzenie filmów.
`429`	Za dużo próśb albo za dużo renderów naraz.	Poczekaj i spróbuj ponownie. Zobacz Limits.
`500`	Coś poszło nie tak po naszej stronie.	Spróbuj ponownie później.
`502`	Planowanie na podstawie twojego briefu nie powiodło się. Kredyty za planowanie zostały zwrócone.	Spróbuj ponownie lub przeformułuj brief.
`503`	Renderowanie zostaje wstrzymane lub usługa jest niedostępna. Nic nie zostało obciążone.	Spróbuj ponownie później.

Nieznana ścieżka pod /v1/ wraca 404 z code: "NOT_FOUND".

Kody błędów

Uwierzytelnianie i plan

Kod	Status	Znaczenie
`NO_API_KEY`	401	Brak nagłówka `Authorization`, bo token nie zaczyna się od `emp_`.
`INVALID_API_KEY`	401	Klucz jest nieznany lub cofnięty.
`PLAN_UPGRADE_REQUIRED`	402	API dostęp wymaga Agency planu.
`ACCOUNT_SUSPENDED`	403	Konto zostaje zawieszone.

Kredyty i wykorzystanie

Kod	Status	Znaczenie
`NO_CREDITS`	402	Konto nie ma już żadnych kredytów.
`INSUFFICIENT_CREDITS`	402	Za mało kredytów do tego renderowania.
`ABUSE_CAP_EXCEEDED`	402	Miesięczny limit użytkowania planu został osiągnięty.
`STORAGE_FULL`	402	Biblioteka wideo konta jest pełna. Usuń kilka filmów.
`UPGRADE_REQUIRED`	402	Wideo wymaga płatnego planu.
`REQUEST_COST_TOO_HIGH`	413	Ten jeden render kosztowałby więcej niż limit na jeden render.

Zobacz Konto i rozliczenia , aby uzyskać kredyty i plany.

Żądania renderowania

Kod	Status	Znaczenie
`CONTENT_BLOCKED`	400	Brief lub scena łamie zasady treści.
`PRODUCT_IMAGE_REQUIRED`	400	Ten format wymaga `product_image_url` lub `product_enabled: false`.
`PRESENTER_REQUIRED`	400	Scena mówiąca nie ma twarzy. Dodaj `avatar_preset_id` lub wyślij `presenter_enabled: false`.
`UNSUPPORTED_MODEL`	400	Scena prosiła o model renderujący Reigniter którego nie można użyć.
`BRAND_REQUIRED`	422	Poproszono o znak, ale nie udało się go znaleźć. Wyślij `brand_logo_url`.
`NO_ANCHOR`	422	Brak marki, zdjęcia produktu ani prezentera. Dodaj jednego lub zrezygnuj.
`CANVAS_NOT_FOUND`	404	Na tym koncie nie znajduje się żaden projekt z odniesieniem.
`DUPLICATE_REQUEST`	409	Ten `Idempotency-Key` był już używany. Nic nowego nie zostało obciążone.
`PLAN_FAILED`	502	Planowanie na podstawie briefu nie powiodło się. Kredyty za planowanie zostały zwrócone.

Przy brief powtarzający się Idempotency-Key może również wrócić jako 402 wraz z wiadomością This request was already submitted. Traktuj to jako duplikat, a nie jako problem z kredytem.

Tempo i współbieg

Kod	Status	Znaczenie
`RATE_LIMITED`	429	Za dużo próśb. Poczekaj `retryAfter` (lub `details.retryAfter`) sekund.
`CONCURRENT_LIMIT`	429	Za dużo renderów działających jednocześnie. Poczekaj, aż jeden się skończy.

Służba

Kod	Status	Znaczenie
`USAGE_CHECK_UNAVAILABLE`	503	Nie można było sprawdzić użycia, więc renderowanie zostało wstrzymane. Nic nie było obciążane.
`DB_UNAVAILABLE`	503	Usługa jest krótko niedostępna.
`FEATURE_NOT_AVAILABLE`	503	Renderowanie nie jest obecnie dostępne.
`GLOBAL_KILL_SWITCH`	503	Renderowanie jest wstrzymane dla wszystkich.
`FEATURE_KILL_SWITCH`	503	Ta funkcja jest wstrzymywana.
`USER_KILL_SWITCH`	503	To konto jest tymczasowo ograniczone. Skontaktuj się z pomocą techniczną.

Webhooki

Kod	Status	Znaczenie
`UNKNOWN_EVENT`	400	To nie jest wydarzenie, na które można się zapisać. Odpowiedź wymienia te ważne.
`URL_NOT_DELIVERABLE`	400	URL nie jest publicznym adresem http(s).
`HOOK_LIMIT`	409	Konto ma już maksymalną liczbę webhooków.

Ponowne próbowanie w sposób bezpieczny

Spróbuj ponownie 429, 500, 502 i 503 z wycofaniem się. Nie próbuj ponownie innych 4xx bez zmian.
Zawsze wysyłaj Idempotency-Key na POST /v1/render.
Brak odpowiedzi (timeout lub zerwanie połączenia): spróbuj ponownie tym samym kluczem. Jeśli pierwsze żądanie faktycznie rozpoczęło renderowanie, próba jest odrzucana zamiast rozpoczęcia drugiej.
Odpowiedź na błąd: nie rozpoczęto renderowania dla tego żądania. Napraw przyczynę, a następnie spróbuj ponownie z nowym kluczem, ponieważ żądanie, które nie udało się w połowie, mogło już użyć swojego klucza. Kredyty renderowania są zwracane. Jedyną opłatą, która nie jest zwracana, jest krótka planowana planowana odpowiedź, gdy planowany render zostaje odrzucony (zobacz Tworzenie filmów).
Jeśli render został zaakceptowany (202), a później się nie uda, status zlecenia staje się failed i error wyjaśnia dlaczego. Zwrot punktów za pracę, która nie została wykonana.