Advanced Voice Analysis

Run the full voice assessment in one call. Send the recordings as multipart/form-data: at least one of 'vowel' (susta…

post/api/voice-assessment

Request

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

Response

Successful response

statusstring

"ok" when every measure succeeded, "partial" otherwise.

filenamestring

Echo of the filename parameter.

labelstring

Echo of the label parameter.

languagestring

Echo of the language parameter.

ageinteger

Echo of the age parameter, or null.

genderstring

Echo of the gender parameter, or null.

reference_textstring

Echo of the reference_text parameter, or null.

audioobject

object - {vowel, speech}, each {duration_seconds, sample_rate: 16000, channels: 1} or null.

summaryobject

object - Key results: avqi, avqi_cpps, jitter_local_percent, shimmer_local_percent, mean_f0_hz, hnr_db, cpp_db, gne, h1_h2_db, abi, the severities (jitter, shimmer, hnr, cpp, breathiness) and abnormal_flags [{measure, severity}]. A key is absent when its measure failed.

detailsobject

object - Raw result of every underlying measure, keyed by measure (jitter_shimmer, cpp, gne, hnr, h1_h2, formants, spectral, voice_dynamics, gemaps, pitch, intensity, speech_percentage, speech_segments, avqi, abi, pronunciation).

errorsobject

object - Failed measures: {measure: {message, status}}.

warningsobject[]

array - Warnings (strings).

pipeline_versionstring

Pipeline version, e.g. "voice-assessment@1.0.0".

processed_atstring date-time

ISO 8601 timestamp of the analysis.

processing_time_msnumber

number - Processing time in milliseconds.

Changes

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