Per gli sviluppatori
Errori dell'API
Ogni errore risponde in JSON con un codice in detail, come {"detail": "auth.unauthorized"}. Alcuni codici aggiungono campi accanto.
| Stato | Codice | Significato | Restituisce anche |
|---|---|---|---|
| 400 | assess.unsupportedLanguage | language (o source_language o target_language) non è uno dei codici lingua dell'API, scritto esattamente. | — |
| 400 | request.bodyNotJson | Il corpo JSON non si è potuto leggere come JSON. | — |
| 400 | request.unknownAudioFormat | audio_format non è né mp3 né wav. | — |
| 400 | assess.noAudio | Il file audio è vuoto. | — |
| 400 | assessment.audioUnreadable | Il file caricato non è un audio che Spelly sa leggere. | — |
| 401 | auth.unauthorized | L'header X-API-Key manca, è sbagliato o revocato. | — |
| 401 | widget.keyInvalid | La chiave del widget è sconosciuta o revocata. | — |
| 402 | operator.trialExhausted | Le tue unità sono esaurite. | remaining e requested (unità), upgrade_url (null finché non si vendono piani) |
| 403 | auth.endpointNotAllowed | La tua chiave non può chiamare questo percorso; quelli che può chiamare sono in Tutti gli endpoint. | — |
| 403 | operator.inactive | L'account a cui appartiene la chiave è in pausa o eliminato. | — |
| 404 | request.notFound | Questo percorso non esiste. | — |
| 405 | request.methodNotAllowed | Il percorso esiste, ma non con questo metodo. | — |
| 413 | assess.recordingTooLong | La registrazione supera la dimensione massima. | — |
| 413 | request.tooLarge | Il corpo della richiesta è troppo grande. | — |
| 422 | assessment.nothingHeard | La registrazione non contiene voce: è silenziosa, oppure il microfono non ha captato nulla. Non viene addebitato nulla. | — |
| 422 | request.invalid | Un campo manca, non è accettato dalla chiamata o ha un valore che non accetta; oppure il corpo non è un oggetto JSON. | errors: un {"field", "problem"} per ogni campo sbagliato, con un value per alcuni problemi; problem è un tipo come missing, extra_forbidden (un campo che la chiamata non accetta), string_too_long, no_letters (un testo senza lettere da leggere), dict_type (il corpo non è un oggetto JSON), unknown_sound o literal_error |
| 429 | request.tooManyRequests | Troppe richieste: dal tuo indirizzo (vedi Limiti di frequenza), o oltre il limite al minuto della tua chiave, se ne ha uno. | Header Retry-After: secondi da aspettare |
| 500 | server.failed | Qualcosa è andato storto dalla parte di Spelly. | — |
| 503 | service.busy | Spelly è occupato: ci sono richieste in attesa del loro turno. | Header Retry-After: secondi da aspettare |
| 503 | service.unavailable | Il servizio di valutazione e voce di Spelly non risponde in questo momento. Lo stato di Spelly dice se è fuori servizio. | Header Retry-After: secondi da aspettare |
| 503 | service.maintenance | Spelly si sta aggiornando, di solito per un minuto o due. Ogni chiamata viene rifiutata finché non torna, quindi niente resta a metà. Anche lo stato di Spelly lo mostra. | Header Retry-After: secondi da aspettare |