Advanced Voice Analysis

Compare two recordings (a reference "model" and a learner "user") on prosodic dimensions. Returns per-dimension score…

get/api/calculate-prosody-similarity

Request

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

Query parameters

modelFileIdstring required

REQUIRED. fileId of the REFERENCE recording (the model the learner is trying to imitate).

userFileIdstring required

REQUIRED. fileId of the LEARNER recording.

modelStartTimenumber

Optional, default 0. Seconds into the model file from which to start aligning.

userStartTimenumber

Optional, default 0. Seconds into the user file from which to start aligning.

Response

Successful response

OVERALL_SCOREnumber

Composite similarity score on a 0–100 scale.

PITCH_SCOREnumber

Pitch-similarity sub-score (0–100).

RHYTHM_SCOREnumber

Rhythm-similarity sub-score (0–100).

INTENSITY_SCOREnumber

Intensity-similarity sub-score (0–100).

PERFORMANCE_LEVELstring

Categorical label (e.g. "Excellent", "Good", "Needs work").

OVERALL_FEEDBACKstring

Free-form coaching text (English).

BEST_MATCHstring

Free-form description of the best-matching dimension.

NEEDS_WORKstring

Free-form description of the dimension that needs the most work.

SPEECH_RATE_SIMILARITYnumber

Speech-rate similarity (0–1 or 0–100 depending on metric).

DURATION_SIMILARITYstring

Total-duration similarity.

PITCH_CONTOUR_SIMILARITYstring

Pitch-contour shape similarity.

INTENSITY_CONTOUR_SIMILARITYstring

Intensity-contour shape similarity.

DYNAMIC_RANGE_SIMILARITYstring

Dynamic-range similarity.

MODEL_F0_MEANstring

Mean F0 of the model recording (Hz).

USER_F0_MEANstring

Mean F0 of the learner recording (Hz).

MODEL_SPEECH_RATEstring

Speech rate of the model (e.g., syllables/sec).

USER_SPEECH_RATEstring

Speech rate of the learner.

MODEL_DURATIONstring

Duration of the model recording (sec).

USER_DURATIONstring

Duration of the learner recording (sec).

CURVE_DATAobject[]

Visualization-ready curves: { pitch: [{time, model, user}, …], intensity: [...], rhythm: [...] }. Each array is sampled at common time points and includes both signals so the UI can overlay them directly.

VISUALIZATION_METADATAobject

Object: { model_duration, user_duration, total_samples, pitch_range: { model_median, user_median } }.

ANALYSIS_TYPEstring

String — currently "Prosody_Similarity_Game".

ALGORITHM_VERSIONstring

String — currently "v01_with_curves".

Changes

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