Voice Quality Metrics

Calculate multi-band HNR with gender-specific F0 notes (no dysphonia verdict)

get/api/calculate-hnr-multiband

Request

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

Query parameters

svFileIdstring required

ID of the sustained vowel audio file (previously uploaded) - REQUIRED

ageinteger required

Patient age in years (integer) - REQUIRED (used for the age group note, no adjustment of HNR)

gender1 | 2 | 3 required

Patient gender: 1=Male, 2=Female, 3=Other/Unknown (integer) - REQUIRED

versionstring

HNR algorithm version (default: "v01") - OPTIONAL

Response

Successful response

HNR_FULLnumber

Full-spectrum HNR (80-8000 Hz) in dB. Example: 15.4

HNR_LOWnumber

Low-frequency HNR (80-500 Hz) in dB. Example: 18.2

HNR_MIDnumber

Mid-frequency HNR (500-1500 Hz) in dB. Example: 16.8

HNR_HIGHnumber

High-frequency HNR (1500-3500 Hz) in dB. Example: 12.3

MEAN_F0number

Mean fundamental frequency in Hz, null if pitch detection fails. Example: 195.4

F0_STDnumber

Standard deviation of F0. Example: 8.5

GENDERstring

Gender classification result. Example: "Female"

NOISE_RATIO_LOWnumber

Low-frequency noise percentage. Example: 12.5

NOISE_RATIO_MIDnumber

Mid-frequency noise percentage. Example: 18.2

NOISE_RATIO_HIGHnumber

High-frequency noise percentage. Example: 25.7

HNR_SLOPEnumber

Spectral tilt across frequency bands. Example: -0.68

OVERALL_QUALITYstring

Not classified, with reference norms. Example: "Not classified (no validated cutoff to our knowledge). Norms for sustained /a/ about 21-24.5 dB (Banh 2009)"

SEVERITYstring

No severity classification (no validated cutoff to our knowledge). Example: "Not classified (no validated cutoff to our knowledge)"

NOISE_PATTERNstring

Dominant noise pattern classification. Example: "Distributed noise pattern"

BREATHINESSstring

No breathiness classification (no validated cutoff for band HNR, to our knowledge). Example: "Not classified (no validated cutoff for band HNR, to our knowledge)"

PATIENT_AGEinteger

Patient age used in analysis. Example: 35

PATIENT_GENDERstring

Patient gender classification. Example: "Female"

AGE_GROUPstring

Age group classification. Example: "Young adult (18-44)"

AGE_NOTEstring

Age-related note (context only). Example: "Adult voice patterns expected"

F0_NOTEstring

F0 validation note. Example: "F0 within expected range for gender/age"

GENDER_NOTEstring

Gender-specific note. Example: "F0 consistent with reported gender"

EXPECTED_F0_MINnumber

Expected minimum F0 for age/gender. Example: 165.4

EXPECTED_F0_MAXnumber

Expected maximum F0 for age/gender. Example: 294.3

HNR_ADJUSTMENTinteger

Always 0 (no age adjustment), kept for API compatibility. Example: 0

ADJUSTED_HNR_FULLnumber

Equal to HNR_FULL (no age adjustment), kept for API compatibility. Example: 15.4

Changes

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