Single-word/sentence assessment usage – Upload via File Path

Single-word/single-file assessment for a single file (batch) mode. The developer’s server/app sends a TCP call to the ELSA server with all the necessary information for the assessment. The ELSA server processes the request synchronously and returns the result in the same call once it’s ready.

To perform an assessment on a word or sentence, the developer must provide:

•   The word/sentence expected to be found in the audio
•   The URL path to the audio file (accessible online)
•   The API token provided by ELSA

Header Parameters

Authorization: Elsa string required

multipart/form-data

Request Body

Audio data must be provided as a file path (URL) accessible online:

- audio_path: <remote_audio_path_url> → The URL of an online audio file that the system can access and process. Make sure the file is publicly accessible or has the necessary permissions for retrieval.

sentence string required
audio_path uri required

URL to an audio file accessible online.

Responses

• 200

---

OK

application/json

Schema

Example (from schema)

---

Schema

api_version string
total_time number
utterance object[]
Array [
initial_silence boolean
sentence string
sentence_id integer
total_time number
attempt_type string
snr number
decision string
ipa string
intonation_score number
fluency_score integer
speed_metrics object
words_per_minute number
syllables_per_minute number
phones_per_minute number
articulated_words_per_minute number
articulated_syllables_per_minute number
articulated_phones_per_minute number
pronunciation_rate_metrics object
correct_words_per_minute number
correct_syllables_per_minute number
correct_phones_per_minute number
correct_words_ratio number
correct_syllables_ratio number
correct_phones_ratio number
pausing_metrics object
pause_ratio number
pause_ratio_without_initial_sil number
pausing_score_percentage integer
advanced_metrics_confidence string
ielts_score number
cefr_score string
toefl_score integer
toeic_score integer
pte_score integer
pronunciation_score number
pronunciation_score_partial number
eps_score number
recording_quality string
words object[]
Array [
start_index integer
end_index integer
start_time number
end_time number
trans_arpabet string
decoded boolean
ipa string
nativeness_score integer
decision string
word string
text string
phonemes object[]
Array [
start_index integer
end_index integer
text string
trans_arpabet string
start_time number
end_time integernumber
decision string
nativeness_score integer
phoneme_error string
phoneme_error_arpabet string
ipa string
]
word_stress object[]
Array [
start_index integer
end_index integer
decision string
stress_level_measured string
]
]
]
success boolean

{
  "api_version": "string",
  "total_time": 0,
  "utterance": [
    {
      "initial_silence": true,
      "sentence": "string",
      "sentence_id": 0,
      "total_time": 0,
      "attempt_type": "string",
      "snr": 0,
      "decision": "string",
      "ipa": "string",
      "intonation_score": 0,
      "fluency_score": 0,
      "speed_metrics": {
        "words_per_minute": 0,
        "syllables_per_minute": 0,
        "phones_per_minute": 0,
        "articulated_words_per_minute": 0,
        "articulated_syllables_per_minute": 0,
        "articulated_phones_per_minute": 0
      },
      "pronunciation_rate_metrics": {
        "correct_words_per_minute": 0,
        "correct_syllables_per_minute": 0,
        "correct_phones_per_minute": 0,
        "correct_words_ratio": 0,
        "correct_syllables_ratio": 0,
        "correct_phones_ratio": 0
      },
      "pausing_metrics": {
        "pause_ratio": 0,
        "pause_ratio_without_initial_sil": 0,
        "pausing_score_percentage": 0
      },
      "advanced_metrics_confidence": "string",
      "ielts_score": 0,
      "cefr_score": "string",
      "toefl_score": 0,
      "toeic_score": 0,
      "pte_score": 0,
      "pronunciation_score": 0,
      "pronunciation_score_partial": 0,
      "eps_score": 0,
      "recording_quality": "string",
      "words": [
        {
          "start_index": 0,
          "end_index": 0,
          "start_time": 0,
          "end_time": 0,
          "trans_arpabet": "string",
          "decoded": true,
          "ipa": "string",
          "nativeness_score": 0,
          "decision": "string",
          "word": "string",
          "text": "string",
          "phonemes": [
            {
              "start_index": 0,
              "end_index": 0,
              "text": "string",
              "trans_arpabet": "string",
              "start_time": 0,
              "decision": "string",
              "nativeness_score": 0,
              "phoneme_error": "string",
              "phoneme_error_arpabet": "string",
              "ipa": "string"
            }
          ],
          "word_stress": [
            {
              "start_index": 0,
              "end_index": 0,
              "decision": "string",
              "stress_level_measured": "string"
            }
          ]
        }
      ]
    }
  ],
  "success": true
}

Loading...