AI Agents

Translate raw voice metrics (jitter, shimmer, HNR, CPPS, etc.) into a clinical-language interpretation with severity,…

post/api/voice-metrics-interpreter

Request

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

Request body

metricsobject required

REQUIRED. Object of voice metrics — typical keys: jitter, shimmer, hnr, cpps, etc. (validated server-side).

ageinteger required

REQUIRED. Patient age in years (1–120).

genderstring required

REQUIRED. "male" | "female" | "other".

languageCodestring

Optional. Output language code — server applies a default via validateLanguageCode if omitted.

threadIdstring

Optional. Azure AI Foundry thread ID for multi-turn continuity.

praatResultsobject

Optional. Full Praat output object — when present, the server merges F0 / expected-range fields into the metrics for richer interpretation.

emailstring

Optional. Used by the credit-validation flow.

Response

Successful response

successboolean

Boolean.

overallScorenumber

Number 0–100, or -1 if the agent's response could not be parsed.

pathologyLevelstring

Categorical string describing pathology severity.

problematicMetricsobject[]

Array of metric names flagged as problematic.

interpretationobject

Object: { summary, overallAssessment, metrics: [...], additionalNotes: [...], recommendedActions: [{category, recommendation}], riskLevel, nextSteps }.

metadataobject

Object: { languageCode, age, gender, metricsProcessed, threadId, agentName, processingTimeSeconds, timestamp, genderValidation: {detectedF0, expectedRange, f0Validity, note} | null }.

remaining_creditsnumber

Number.

Changes

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