Therapy Planning

Kick off therapy plan generation from an uploaded audio recording. Returns immediately (202) with a therapy_session_i…

post/api/generate-therapy-plan

Request

  • Base URL: https://platform.vocametrix.com
  • URL: https://platform.vocametrix.com/api/generate-therapy-plan
  • Auth: API key in header X-API-Key

Request body

fileIdstring required

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

patientIdstring required

REQUIRED. Patient identifier matching ^[a-zA-Z0-9_-]{1,100}$. The literal "PT-UNKNOWN" is explicitly rejected.

patientMetadataobject

Optional. Object describing the patient. Max 10,000 bytes when JSON-serialized. Optional sub-fields: demographics.age (0–120), clinical_history.severity ("Mild"|"Moderate"|"Severe"|"Very Severe"), current_goals (max 20 entries), recent_progress_notes (max 50), previous_exercises (max 30).

maxIterationsinteger

Optional integer 1–5, default 2. Max critic-agent iterations within the workflow.

therapyAgentTemperaturenumber

Optional number, default 0.3. Generation temperature for the therapy-planner LLM.

criticAgentTemperaturenumber

Optional number, default 0. Generation temperature for the critic LLM.

classificationSessionIdstring

Optional string. If present, links the new therapy session to a prior /api/classify-stuttering session so the workflow can use those classification results.

useAzureMLboolean

Optional boolean, default true. Whether to use Azure ML inside the workflow.

Response

Successful response

successboolean

Boolean — true when the job has been queued.

messagestring

Human-readable status message.

therapy_session_idstring

Session ID of the form "THERAPY-<patientId>-<uuid>".

statusstring

"pending" — the initial state.

status_urlstring

Convenience URL to poll status (/api/therapy-status/<id>).

result_urlstring

Convenience URL to fetch result once complete (/api/therapy-result/<id>).

estimated_time_secondsstring

Approximate wall-clock estimate (e.g., 120 s).

timestampstring date-time

ISO 8601 timestamp.

Changes

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