---
title: "Compare two recordings (a reference \"model\" and a learner \"user\") on prosodic dimensions. Returns per-dimension score…"
method: GET
path: "/api/calculate-prosody-similarity"
tags: ["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

- `modelFileId` string, required
- `userFileId` string, required
- `modelStartTime` number
- `userStartTime` number

## Response `200`

Successful response

- object
  - `OVERALL_SCORE` number: Composite similarity score on a 0–100 scale.
  - `PITCH_SCORE` number: Pitch-similarity sub-score (0–100).
  - `RHYTHM_SCORE` number: Rhythm-similarity sub-score (0–100).
  - `INTENSITY_SCORE` number: Intensity-similarity sub-score (0–100).
  - `PERFORMANCE_LEVEL` string: Categorical label (e.g. "Excellent", "Good", "Needs work").
  - `OVERALL_FEEDBACK` string: Free-form coaching text (English).
  - `BEST_MATCH` string: Free-form description of the best-matching dimension.
  - `NEEDS_WORK` string: Free-form description of the dimension that needs the most work.
  - `SPEECH_RATE_SIMILARITY` number: Speech-rate similarity (0–1 or 0–100 depending on metric).
  - `DURATION_SIMILARITY` string: Total-duration similarity.
  - `PITCH_CONTOUR_SIMILARITY` string: Pitch-contour shape similarity.
  - `INTENSITY_CONTOUR_SIMILARITY` string: Intensity-contour shape similarity.
  - `DYNAMIC_RANGE_SIMILARITY` string: Dynamic-range similarity.
  - `MODEL_F0_MEAN` string: Mean F0 of the model recording (Hz).
  - `USER_F0_MEAN` string: Mean F0 of the learner recording (Hz).
  - `MODEL_SPEECH_RATE` string: Speech rate of the model (e.g., syllables/sec).
  - `USER_SPEECH_RATE` string: Speech rate of the learner.
  - `MODEL_DURATION` string: Duration of the model recording (sec).
  - `USER_DURATION` string: Duration of the learner recording (sec).
  - `CURVE_DATA` object[]: 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_METADATA` object: Object: `{ model_duration, user_duration, total_samples, pitch_range: { model_median, user_median } }`.
  - `ANALYSIS_TYPE` string: String — currently "Prosody_Similarity_Game".
  - `ALGORITHM_VERSION` string: String — currently "v01_with_curves".

## Other responses

- `400`: Bad request — missing or invalid parameter
- `401`: Unauthorized — missing or invalid API key
- `429`: Rate limit exceeded
- `500`: Server error

---

[API](https://skmtc.dev/vocametrix/apis/vocametrix-api.md) · [All operations](https://skmtc.dev/vocametrix/apis/vocametrix-api/llms.txt) · [OpenAPI document](https://skmtc.dev/vocametrix/apis/vocametrix-api/revisions/8a54d01bcc81?raw)