Phoneme & Classification

Run a phoneme-recognition pass on a recording. Provide either a previously-uploaded fileId (preferred for performance…

post/api/analyze-phonemes-live

Request

  • Base URL: https://platform.vocametrix.com
  • URL: https://platform.vocametrix.com/api/analyze-phonemes-live
  • Auth: API key in header X-API-Key

Request body

fileIdstring

Optional (use this OR blobUrl). fileId from a prior /api/assignFileId upload.

blobUrlstring

Optional (use this OR fileId). HTTPS URL of the audio file. Will be downloaded server-side. If the host is vocametrixstorageaccount.blob.core.windows.net and keepBlob is false, the blob is deleted after processing.

referenceWordstring

Optional. Currently accepted by the API but not used by the JavaScript layer (passed through to the Python script which may use it).

languagestring

Optional, default "fr-FR". Accepted: "fr-FR" | "et-EE".

modelstring

Optional, French only. short-words-champion (isolated short words, recommended), logatome-champion (logatomes / nonsense syllables), or omit for the CNAM wav2vec2-french-phonemizer-v2 baseline (continuous speech). Must be a known alias (server-side isKnownAlias) — an unknown alias returns 400. Resolved to a model blob URL internally, never exposed to the client.

keepBlobstring

Optional, default false. If false and blobUrl was used, the source blob is deleted after success (only when hosted on the Vocametrix storage account).

Response

Successful response

successboolean

Boolean — true when analysis completed (including the empty-result "Silence detected" case).

statusstring

"completed" on success.

messagestring

Descriptive message, e.g. "Analysis completed successfully" or "Silence detected".

languagestring

Echoed language code processed.

transcriptionstring

Space-separated sequence of detected phonemes (empty string if silence).

phoneme_countnumber

Total number of phonemes detected.

phonemesobject[]

Array of unique phoneme labels, in order of first appearance (duplicates removed). Use transcription or phoneme_timings for the full sequence.

phoneme_timingsobject[]

Array of { phoneme, start, end, duration, confidence, second_phoneme, second_confidence } — one entry per phoneme. second_phoneme/second_confidence (French champion models only) is the runner-up at that phoneme's most confident frame, or null if unavailable.

audio_infostring

{ duration_seconds, sample_rate } — sample_rate is always 16000.

Changes

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