Documentatie

Beheer fouten zonder de context van de aanvraag te verliezen.

{
  "text": "Complexe broninhoud in de geselecteerde taal.",
  "locale": "nl",
  "mode": "simple-language"
}

SDK- en cURL-voorbeelden beschikbaar

Fouten envelop

De productiefoutenvelop van versie 2 bevat een foutobject met stabiele code en berichtvelden.

json
{
  "error": {
    "code": "invalid_request",
    "message": "Check the request fields."
  }
}

Het optionele detailsobject bevat een door een machine leesbare context, zoals retryAfterSeconds.

HTTP-antwoordheaders bevatten authenticatie en proberen metagegevens opnieuw uit te voeren, indien van toepassing.

Verplicht foutcatalogus

De volgende codes zijn het huidige versie 2-contract.

HTTPCodeBetekenisKlantenhandeling
400invalid_jsonDe aanvraagtekst is geen geldige JSONCorrigeer de JSON-hoofdtekst
400invalid_requestEen veld ontbreekt, is onbekend of ongeldig, of de tekst telt meer dan 10.000 tekensVerwijder het verzoek
400ongeldige_idempotentie_sleutelEen taak- of batchaanvraag heeft geen geldige Idempotency-KeyStuur een unieke sleutel van maximaal 255 tekens
400ongeldig_webhook_eindpuntHet geselecteerde webhookeindpunt ontbreekt of is inactiefKies een actief eindpunt of gebruik polling
401ongeldige_api_keyHet Bearer-token ontbreekt, is ongeldig of is ingetrokkenControleer of vervang de API-sleutel
402facturering_vereistDe facturering moet worden bijgewerkt voordat de verwerking kan worden voortgezetUpdate de facturering in de applicatie
403abonnement_vereistDe werkruimte heeft geen actief rechtKies een abonnement of neem contact op met ondersteuning
403e-mail_niet_geverifieerdEr is geen e-mailadres van de eigenaar of beheerder geverifieerdVerifieer een in aanmerking komend account-e-mailadres
404vacature_niet_gevondenDe taak bestaat niet, behoort tot een andere werkruimte of is verlopenStop met pollen en creëer indien nodig een nieuwe baan
404batch_not_foundDe batch bestaat niet, behoort tot een andere werkruimte of is verlopenStop met het pollen en maak indien nodig een nieuwe batch
429tarief_beperktHet aanvraagpercentage is bereiktRespect na het terugproberen
429gelijktijdigheid_limietEr worden te veel verzoeken tegelijkertijd verwerktProbeer het opnieuw nadat een actief verzoek is voltooid
429toelage_uitgeputDe maandelijkse tekenlimiet is bereikt en extra gebruik is niet beschikbaar of uitgeschakeldWacht op de volgende factureringsperiode of schakel extra gebruik in voor een in aanmerking komend abonnement
502processing_failedDe service kon de tekst niet verwerkenProbeer het veilig opnieuw en neem contact op met de ondersteuning met de aanvraag-ID als het probleem zich blijft voordoen

Voor elke fout: herkansing van documenten, factureringseffect, zichtbaarheid van logboeken en ondersteuningsinformatie.