Dokumentaatio

Käsittele virheitä menetämättä pyyntökohtia.

{
  "text": "Monimutkainen lähdesisältö valitulla kielellä.",
  "locale": "fi",
  "mode": "simple-language"
}

SDK- ja cURL-esimerkkejä saatavilla

Virhehyväksyn

Version 2 tuotantovirheen kirjekuori sisältää virheobjektin, jossa on vakaa koodi ja viestikentät.

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

Valinnainen tietoobjekti sisältää koneellisesti luettavan kontekstin, kuten retryAfterSeconds.

HTTP-vastausotsikoissa on todennus- ja uudelleenyritysten metatiedot tarvittaessa.

Vaatimääräinen virhe- kataloogi

Seuraavat koodit ovat nykyisen version 2 sopimus.

HTTPKoodiYmmärrettäAsiakkaan toiminta
400invalid_jsonPyynnön runko ei ole kelvollinen JSONKorjaa JSON-runko
400invalid_requestKenttä puuttuu, tuntematon tai virheellinen, tai teksti ylittää 10 000 merkkiäKorjaa pyyntö
400virheellinen_idempotenssiavainTyö- tai eräpyynnöllä ei ole kelvollista Idempotency-avaintaLähetä yksilöllinen avain, jossa on enintään 255 merkkiä
400invalid_webhook_endpointValittu webhook-päätepiste puuttuu tai ei ole aktiivinenValitse aktiivinen päätepiste tai käytä kyselyä
401virheellinen_api_avainKantaja-tunnus puuttuu, virheellinen tai peruutettuTarkista tai vaihda API-avain
402billing_requiredLaskutus on päivitettävä ennen kuin käsittelyä voidaan jatkaaPäivitä laskutus sovelluksessa
403subscription_requiredTyötilalla ei ole aktiivisia oikeuksiaValitse suunnitelma tai ota yhteyttä tukeen
403email_not_verifiedOmistajan tai järjestelmänvalvojan sähköpostiosoitetta ei ole vahvistettuVahvista kelvollinen tilin sähköpostiosoite
404job_not_foundTyötä ei ole olemassa, se kuuluu toiseen työtilaan tai on vanhentunutLopeta kysely ja luo tarvittaessa uusi työpaikka
404batch_not_foundErää ei ole olemassa, se kuuluu toiseen työtilaan tai se on vanhentunutLopeta kysely ja luo tarvittaessa uusi erä
429rate_limitedPyyntömäärä on saavutettuKunnioitetaan sitä jälkeen
429concurrency_limitLiian monta pyyntöä käsitellään samanaikaisestiYritä uudelleen, kun aktiivinen pyyntö on päättynyt
429korvaus_loppuunKuukausittainen merkkirajoitus on saavutettu, ja lisäkäyttö ei ole käytettävissä tai se on poistettu käytöstäOdota seuraavaa laskutuskautta tai ota lisäkäyttö käyttöön kelvollisella sopimuksella
502processing_failedPalvelu ei voinut käsitellä tekstiäYritä uudelleen turvallisesti ja ota yhteyttä tukeen pyyntötunnuksella, jos se jatkuu

Jokaisen virheen, asiakirjan uudelleenkoettavuuden, laskutuksen, lokin näkyvyyden ja tukitietojen osalta.