SpellyDocs

Per gli sviluppatori

Avvio rapido dell'API

Invia una registrazione e il testo a cui deve corrispondere. Ricevi sei punteggi e il dettaglio di ogni parola e di ogni suono. È la stessa valutazione usata dalle app di Spelly.

  1. La tua app invia

    La registrazione, il testo a cui deve corrispondere e la sua lingua.

  2. Spelly valuta

    Ogni suono viene confrontato con il suono che serve alla parola.

  3. Ricevi JSON

    Sei punteggi, ogni parola e ogni suono, pronti da mostrare.

Guida rapida

Ogni percorso di questa pagina va dopo https://spelly.ch: /api/assess è https://spelly.ch/api/assess. Invia la tua chiave nell'header X-API-Key. Due chiamate complete da cui partire:

Valutare una registrazione salvata come recording.wav

curl
curl https://spelly.ch/api/assess \
  -H 'X-API-Key: YOUR_KEY' \
  -F 'reference_text=The weather is lovely' \
  -F language=en-GB \
  -F audio=@recording.wav

Ottenere la voce del modello con il momento di ogni suono e di ogni lettera

curl
curl https://spelly.ch/api/tts/aligned \
  -H 'X-API-Key: YOUR_KEY' \
  -H 'Content-Type: application/json' \
  -d '{
    "text": "hello",
    "language": "en-GB",
    "audio_format": "mp3"
  }'

La tua chiave API

Invia la tua chiave in un header X-API-Key con ogni richiesta. La trovi nella console operatore. Tienila sul tuo server, mai in una pagina web.

I browser non possono chiamare l'API dalle tue pagine: accetta richieste cross-origin solo dai siti di Spelly, e una chiave in una pagina potrebbe essere copiata. Chiamala dal tuo server; per far esercitare gli studenti in una pagina web, usa il widget.

Ogni registrazione valutata usa 1 unità e ogni voce del modello (/api/tts, /api/tts/aligned, /api/assess/synthesize) 0,5; tutte le altre chiamate sono gratuite. Solo le chiamate riuscite usano unità: una chiamata rifiutata o fallita non usa nulla. Le registrazioni e le voci del widget usano le stesse unità. Una prova gratuita ha 100 unità; una volta esaurite, le chiamate rispondono 402 con operator.trialExhausted in detail, e accanto remaining e requested.

Limiti di frequenza

Ogni indirizzo può inviare all'API in media 50 richieste al secondo, e fino a 300 in più in un colpo solo. Oltre, le chiamate rispondono 429 request.tooManyRequests. Una chiave di prova gratuita può inviare 60 richieste al minuto. Se la tua chiave ha un proprio limite al minuto, anche le chiamate oltre quel limite rispondono 429.

Le risposte 429 e 503 hanno un header Retry-After: i secondi da aspettare prima di inviare di nuovo la stessa richiesta.

Avanti