Therapy Planning

Poll the status of a therapy (or stuttering-classification) session. Returns 404 if the session is unknown or has exp…

get/api/therapy-status/{sessionId}

Request

  • Base URL: https://platform.vocametrix.com
  • URL: https://platform.vocametrix.com/api/therapy-status/{sessionId}
  • Auth: API key in header X-API-Key

Path parameters

sessionIdstring required

Path parameter — the session ID.

Response

Successful response

successboolean

Boolean.

session_idstring

String — may be normalized from the input (the server does flexible lookup).

statusstring

"pending" | "processing" | "complete" | "pending_approval" | "failed".

progress_percentnumber

Number 0–100.

progressnumber

Number — alias for progress_percent (kept for back-compat).

status_messagestring

Free-form progress description.

error_messagestring

String, or null.

created_atstring date-time

ISO 8601 timestamp.

updated_atstring date-time

ISO 8601 timestamp.

completed_atstring date-time

ISO 8601 timestamp, or null until complete.

result_availableboolean

Boolean — true when status is "complete" or "pending_approval".

approval_requiredboolean

Boolean — true when status is "pending_approval".

generated_promptsobject[]

Array, or null. Workflow-internal prompts (mostly for debugging).

timestampstring date-time

ISO 8601 server time.

Changes

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