Advanced Voice Analysis

Estimate F1-F3 quickly, with the vowel position on the IPA chart, from a file pre-uploaded via POST /api/assignFileId…

post/api/estimate_formants

Request

  • Base URL: https://platform.vocametrix.com
  • URL: https://platform.vocametrix.com/api/estimate_formants
  • Auth: API key in header X-API-Key

Request body

fileIdstring required

ID returned by /api/assignFileId - REQUIRED

start_secnumber required

Start of the segment in seconds; 0 with stop_sec 0 analyses the whole file - REQUIRED

stop_secnumber required

End of the segment in seconds; 0 with start_sec 0 analyses the whole file - REQUIRED

languagestring

Language code, e.g. "fr-FR". Optional, default "en-US"

genderstring

"male" or "female". Optional, default "female"

ageGroupstring

"adult" or "child". Optional, default "adult"

sustained_vowelboolean

true for a sustained vowel: the most stable window is analysed. Optional, default false

Response

Successful response

successboolean

boolean - true when formants were measured

formantsobject

object - {f1_mean, f2_mean, f3_mean (Hz, f3 may be null), f1_std, f2_std, f3_std, num_measurements, f1_cv, f2_cv, estimated_f0}

ipa_coordinatesobject

object - {x, y} between 0 and 1: x front to back, y close to open

stability_scorenumber

number - Stability of the formant track

languagestring

Echo of the language parameter

analysis_durationnumber

number - Analysed duration in seconds

speaker_infoobject

object - {gender, age_group} used for the analysis

analysis_parametersstring

Parameter set used: "adult_female_default", "adult_male", "adult_female" or "child"

error_typestring

When success is false: "insufficient_data", "analysis_failure", "f0_failure" or "unknown"

suggestionsobject[]

array - When success is false: tips to get a usable recording

Changes

No recorded changes to this operation across all 1 revision of this API.