SpellyDocs

Per a desenvolupadors

Inici ràpid de l'API

Envia una gravació i el text amb què ha de coincidir. Rep sis puntuacions i el detall de cada paraula i cada so. És la mateixa avaluació que fan servir les apps de Spelly.

  1. La teva app envia

    La gravació, el text amb què ha de coincidir i el seu idioma.

  2. Spelly avalua

    Cada so es compara amb el so que necessita la paraula.

  3. Reps JSON

    Sis puntuacions, cada paraula i cada so, a punt per mostrar.

Inici ràpid

Cada ruta d’aquesta pàgina va darrere de https://spelly.ch: /api/assess és https://spelly.ch/api/assess. Envia la teva clau a la capçalera X-API-Key. Dues crides completes per començar:

Avaluar una gravació desada com a 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

Obtenir la veu del model amb el moment de cada so i de cada lletra

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 teva clau d'API

Envia la teva clau en una capçalera X-API-Key amb cada petició. La trobaràs a la consola d’operador. Guarda-la al teu servidor, mai en una pàgina web.

Els navegadors no poden cridar l’API des de les teves pàgines: només accepta peticions d’un altre origen des dels llocs de Spelly, i una clau en una pàgina es podria copiar. Crida-la des del teu servidor; perquè els alumnes practiquin en una pàgina web, fes servir el widget.

Cada gravació avaluada fa servir 1 unitat i cada veu del model (/api/tts, /api/tts/aligned, /api/assess/synthesize) 0,5; les altres crides són gratuïtes. Només les crides que surten bé fan servir unitats: una crida rebutjada o fallida no en fa servir cap. Les gravacions i les veus del widget fan servir les mateixes unitats. Una prova gratuïta té 100 unitats; quan s’esgoten, les crides responen 402 amb operator.trialExhausted a detail, i remaining i requested al costat.

Límits d’ús

Cada adreça pot enviar a l’API una mitjana de 50 peticions per segon, i fins a 300 més de cop. Per sobre, les crides responen 429 request.tooManyRequests. Una clau de prova gratuïta pot enviar 60 peticions per minut. Si la teva clau té el seu propi límit per minut, les crides que el superen també responen 429.

Les respostes 429 i 503 porten una capçalera Retry-After: els segons que cal esperar abans d’enviar la mateixa petició un altre cop.

Següent