Single-file unscripted assessment
Add a file of an audio, and receive a transcription of that audio.This can accetp mp3, wav, flac. Audio data can be processed in 3 different ways:
- audio_file: @<local_audio_file_path> → (note the ‘@’ for multipart upload of a binary file) allows to send a local audio file to an audio file available online. Make sure the audio file is accessible.
- audio_data: <base64_data_string> → audio data sent as a string,encoded in base64
multipart/form-data
Request Body
Audio data can be processed in 3 different ways:
- audio_file: @<local_audio_file_path> → (note the ‘@’ for multipart upload of a binary file) allows to send a local audio file
- audio_path: <remote_audio_path_url> → points to a URL path to an audio file available online. Make sure the audio file is accessible.
- audio_data: <base64_data_string> → audio data sent as a string, encoded in base64
api_plan string required
Possible values: [standard
, premium
]
return_json boolean required
Possible values: [true
, false
]
audio_file binary required
Possible values: Value must match regular expression @<local_audio_file_path>;<remote_audio_path_url> ;<base64_data_string>
Responses
- 200
- 404
Records match query criteria.
application/json
Schema
Example (from schema)
Schema
- Array [
- Array [
- ]
- Array [
- Array [
- Array [
- ]
- ]
- ]
- Array [
- ]
- Array [
- ]
- Array [
- Array [
- Array [
- Array [
- ]
- ]
- Array [
- ]
- ]
- ]
- ]
- Array [
- ]
speakers object[]
speaker_id integer
total_time number
metrics object
general_scores object
elsa object
eps_score null
pronunciation_score number
intonation_score null
fluency_score null
grammar_score null
vocabulary_score null
cefr object
overall_cefr null
pronunciation_cefr string
intonation_cefr null
fluency_cefr null
grammar_cefr null
vocabulary_cefr string
other_scores object
ielts_score null
toefl_score null
toeic_score null
pte_score null
other_metrics object
pronunciation object
advanced_pronunciation_score integer
fluency object
words_per_minute null
words_per_minute_min null
words_per_minute_max null
vocabulary object
total_words_count integer
unique_words_count integer
uncommon_words_count integer
cefr_distribution object[]
cefr_level string
percentage integer
feedbacks object
show_transcript boolean
pronunciation object
top_errors object[]
phoneme string
count integer
errors object[]
type string
error_phoneme string
count integer
examples object[]
text string
start_index integer
end_index integer
grammar object
items object[]
vocabulary object
top_cefr_words object[]
utterances object[]
utterance_id integer
start_time number
end_time number
start_index integer
end_index integer
text string
result object
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 integer
correct_syllables_ratio number
correct_phones_ratio number
pausing_metrics object
pause_ratio number
pause_ratio_without_initial_sil integer
pausing_score_percentage null
initial_silence boolean
total_time number
has_speech boolean
decision string
nativeness_score number
nativeness_score_partial number
ipa string
intonation_score null
fluency_score null
ielts_score null
words object[]
start_index integer
end_index integer
start_time number
end_time number
word string
text string
ipa string
trans_arpabet string
nativeness_score integer
decision string
phonemes object[]
text string
start_index integer
end_index integer
start_time number
end_time number
ipa string
trans_arpabet string
decision string
nativeness_score integer
phoneme_error string
phoneme_error_arpabet string
feedback object[]
word_stress object[]
transcript string
timeline object[]
speaker_id integer
utterance_id integer
start_time number
end_time number
start_index integer
end_index integer
api_version string
api_plan string
recording_quality string
assessment_quality string
total_time number
success boolean
{
"speakers": [
{
"speaker_id": 0,
"total_time": 0,
"metrics": {
"general_scores": {
"elsa": {
"pronunciation_score": 0
},
"cefr": {
"pronunciation_cefr": "string",
"vocabulary_cefr": "string"
},
"other_scores": {}
},
"other_metrics": {
"pronunciation": {
"advanced_pronunciation_score": 0
},
"fluency": {},
"vocabulary": {
"total_words_count": 0,
"unique_words_count": 0,
"uncommon_words_count": 0,
"cefr_distribution": [
{
"cefr_level": "string",
"percentage": 0
}
]
}
}
},
"feedbacks": {
"show_transcript": true,
"pronunciation": {
"top_errors": [
{
"phoneme": "string",
"count": 0,
"errors": [
{
"type": "string",
"error_phoneme": "string",
"count": 0,
"examples": [
{
"text": "string",
"start_index": 0,
"end_index": 0
}
]
}
]
}
]
},
"grammar": {
"items": [
{}
]
},
"vocabulary": {
"top_cefr_words": [
{}
]
}
},
"utterances": [
{
"utterance_id": 0,
"start_time": 0,
"end_time": 0,
"start_index": 0,
"end_index": 0,
"text": "string",
"result": {
"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
},
"initial_silence": true,
"total_time": 0,
"has_speech": true,
"decision": "string",
"nativeness_score": 0,
"nativeness_score_partial": 0,
"ipa": "string",
"words": [
{
"start_index": 0,
"end_index": 0,
"start_time": 0,
"end_time": 0,
"word": "string",
"text": "string",
"ipa": "string",
"trans_arpabet": "string",
"nativeness_score": 0,
"decision": "string",
"phonemes": [
{
"text": "string",
"start_index": 0,
"end_index": 0,
"start_time": 0,
"end_time": 0,
"ipa": "string",
"trans_arpabet": "string",
"decision": "string",
"nativeness_score": 0,
"phoneme_error": "string",
"phoneme_error_arpabet": "string",
"feedback": [
{}
]
}
],
"word_stress": [
{}
]
}
]
}
}
]
}
],
"transcript": "string",
"timeline": [
{
"speaker_id": 0,
"utterance_id": 0,
"start_time": 0,
"end_time": 0,
"start_index": 0,
"end_index": 0
}
],
"api_version": "string",
"api_plan": "string",
"recording_quality": "string",
"assessment_quality": "string",
"total_time": 0,
"success": true
}
The resources were not found.
schema
Schema
Example (from schema)
Schema
error object
Example:{"message":Resources not found}
code integer
message string
errors string[]
{
"error": {
"code": 0,
"message": "string",
"errors": [
"string"
]
}
}
Loading...