Phoneme & Classification

Kick off an asynchronous stuttering classification job on a previously-uploaded recording. Returns a session_id immed…

post/api/classify-stuttering

Request

  • Base URL: https://platform.vocametrix.com
  • URL: https://platform.vocametrix.com/api/classify-stuttering
  • Auth: API key in header X-API-Key

Request body

fileIdstring required

REQUIRED. fileId from a prior /api/assignFileId upload.

patientIdstring

Optional, default "unknown". Patient identifier — the literal value "PT-UNKNOWN" is explicitly rejected (use "unknown" or a real ID).

chunkOverlapstring

Optional, default 0.25. Overlap fraction between analysis chunks.

chunkSizenumber

Optional, default 4. Chunk size in seconds.

localestring

Optional, default "en-US". Locale used by the speech-to-text step within the classification pipeline.

transcribeboolean

optional (default true). When true, the recording is transcribed once (real-time STT) and each result block includes its transcription plus a words array of per-word timestamps. Set false to skip transcription for minimum latency.

includePhonemesboolean

optional (default false). When true, per-block phonetic transcription is computed (slower). When false, each block's phonemes is "N/A".

Response

Successful response

successboolean

Boolean — true when the job has been queued.

session_idstring

String of the form "cls-<uuid>". Pass to /api/therapy-status/:sessionId and /api/therapy-result/:sessionId to poll and retrieve.

messagestring

Human-readable confirmation, e.g. "Classification started. Use session_id to poll for progress."

Changes

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