Fouten

De Reigniter API gebruikt standaard HTTP statuscodes. Elke foutrespons is JSON.

Foutlichaam

De meeste fouten zien er zo uit:

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

Veld	Altijd aanwezig	Wat het is
`error`	Ja	Een bericht dat je aan iemand kunt laten zien. De bewoording kan veranderen, dus match er niet op.
`code`	De meeste fouten	Een stabiele, hoofdlettercode. Tak hierop.
`details`	Enkele fouten	Extra context, bijvoorbeeld `retryAfter` of gebruikscijfers.
`retryAfter`	Sommige `429`s	Seconden wachten voordat je het opnieuw probeert.

Een paar fouten hebben geen code, zoals 404 Job not found en 403 Forbidden. Vertak op de status voor die.

Validatiefouten

Wanneer het request-lichaam niet overeenkomt met het schema, krijg je 400 met een detail string die elk probleem als field: message vermeldt:

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

Statuscodes

Status	Betekenis	Wat te doen
`200`	Succes.
`201`	Gemaakt (webhooks).
`202`	Geaccepteerd. De rendering is begonnen.	Poll de baan of wacht op de webhook.
`400`	Het verzoek werd afgewezen. Er werd niets in rekening gebracht.	Herstel het verzoek. Probeer het niet opnieuw zonder verandering.
`401`	Ontbrekend, ongeldig of ingetrokken API sleutel.	Controleer de sleutel.
`402`	Plan-, krediet- of gebruiksprobleem.	Lees `code`.
`403`	Een geschorst account, of een baan die niet van jou is.	Neem contact op met de support, of controleer de functie-ID.
`404`	Niet gevonden.	Controleer de ID of het pad.
`409`	Duplicaat verzoek of limiet bereikt.	Lees `code`.
`413`	Deze render zou meer kosten dan de limiet per render.	Gebruik minder scènes of een lagere `quality`.
`422`	De render heeft geen merk, product of presentator om het te verankeren.	Zie Video’s maken.
`429`	Te veel verzoeken of te veel renders tegelijk.	Wacht en probeer het opnieuw. Zie Grenzen.
`500`	Er is iets misgegaan aan onze kant.	Probeer het later opnieuw.
`502`	Planning vanuit je opdracht mislukte. Planningskredieten zijn terugbetaald.	Probeer het opnieuw, of herformuleer de briefing.
`503`	De levering is gepauzeerd of een dienst is niet meer in rekening. Er is niets in rekening gebracht.	Probeer het later opnieuw.

Een onbekend pad onder /v1/ keert terug 404 met code: "NOT_FOUND".

Foutcodes

Authenticatie en plan

Code	Status	Betekenis
`NO_API_KEY`	401	Geen `Authorization` header, of het token begint niet met `emp_`.
`INVALID_API_KEY`	401	De sleutel is onbekend of ingetrokken.
`PLAN_UPGRADE_REQUIRED`	402	API toegang heeft het Agency plan nodig.
`ACCOUNT_SUSPENDED`	403	Het account is geschorst.

Credits en gebruik

Code	Status	Betekenis
`NO_CREDITS`	402	De rekening heeft geen credits meer.
`INSUFFICIENT_CREDITS`	402	Niet genoeg credits voor deze render.
`ABUSE_CAP_EXCEEDED`	402	De maandelijkse gebruikslimiet voor het abonnement is bereikt.
`STORAGE_FULL`	402	De videobibliotheek van het account is vol. Verwijder wat video’s.
`UPGRADE_REQUIRED`	402	Video vereist een betaald abonnement.
`REQUEST_COST_TOO_HIGH`	413	Deze ene render kost meer dan de limiet per render.

Zie Account en facturering voor tegoeden en plannen.

Renderverzoeken

Code	Status	Betekenis
`CONTENT_BLOCKED`	400	De brief of een scène overtreedt de inhoudsregels.
`PRODUCT_IMAGE_REQUIRED`	400	Dit formaat heeft `product_image_url`, of `product_enabled: false`.
`PRESENTER_REQUIRED`	400	Een praatscène heeft geen gezicht. Voeg `avatar_preset_id` toe, of stuur `presenter_enabled: false`.
`UNSUPPORTED_MODEL`	400	Een scène vroeg om een rendermodel Reigniter niet kan gebruiken.
`BRAND_REQUIRED`	422	Er werd om een merk gevraagd, maar er was niets te vinden. Stuur `brand_logo_url`.
`NO_ANCHOR`	422	Geen merk, productfoto of presentator. Voeg er één toe, of meld je af.
`CANVAS_NOT_FOUND`	404	Een referentieproject staat niet op dit account.
`DUPLICATE_REQUEST`	409	Deze `Idempotency-Key` was al gebruikt. Er werd niets nieuws in rekening gebracht.
`PLAN_FAILED`	502	De planning uit de brief mislukte. Planningskredieten werden terugbetaald.

Met een brief kan een herhaalde Idempotency-Key ook terugkomen als 402 met de boodschap This request was already submitted. Behandel het als een duplicaat, niet als een kredietprobleem.

Koers en gelijktijdigheid

Code	Status	Betekenis
`RATE_LIMITED`	429	Te veel verzoeken. Wacht `retryAfter` (of `details.retryAfter`) seconden.
`CONCURRENT_LIMIT`	429	Te veel renders draaien tegelijk. Wacht tot er één klaar is.

Dienst

Code	Status	Betekenis
`USAGE_CHECK_UNAVAILABLE`	503	Het gebruik kon niet worden gecontroleerd, dus het renderen is gepauzeerd. Er werd niets in rekening gebracht.
`DB_UNAVAILABLE`	503	Een dienst is tijdelijk niet beschikbaar.
`FEATURE_NOT_AVAILABLE`	503	Rendering is momenteel niet beschikbaar.
`GLOBAL_KILL_SWITCH`	503	Het renderen is voor iedereen gepauzeerd.
`FEATURE_KILL_SWITCH`	503	Deze functie is gepauzeerd.
`USER_KILL_SWITCH`	503	Dit account is tijdelijk beperkt. Neem contact op met de support.

Webhooks

Code	Status	Betekenis
`UNKNOWN_EVENT`	400	Geen evenement waar je je op kunt abonneren. De reactie vermeldt de geldige evenementen.
`URL_NOT_DELIVERABLE`	400	De URL is geen openbaar http(s)-adres.
`HOOK_LIMIT`	409	Het account heeft al het maximale aantal webhooks.

Probeer het veilig opnieuw

Probeer opnieuw 429, 500, 502 en 503 met backoff. Probeer andere 4xx niet opnieuw ongewijzigd.
Stuur altijd een Idempotency-Key op POST /v1/render.
Helemaal geen reactie (een time-out of een verbroken verbinding): probeer opnieuw met dezelfde sleutel. Als het eerste verzoek een rendering start, wordt de herpoging geweigerd in plaats van een tweede te starten.
Een foutantwoord: er is geen render gestart voor dat verzoek. Los de oorzaak op, probeer het dan opnieuw met een nieuwe sleutel, want een verzoek dat gedeeltelijk mislukte kan zijn sleutel al hebben gebruikt. Rendercredits worden terugbetaald. De enige kosten die niet wordt terugbetaald is korte planning, wanneer de geplande render vervolgens wordt geweigerd (zie Video’s maken).
Als een render werd geaccepteerd (202) en later faalt, wordt de status van de opdracht failed en error geeft aan waarom. Tegoeden voor werk dat niet is uitgevoerd, worden terugbetaald.