AI Agents

Single-shot Azure AI Foundry agent that generates a therapy recommendation from session metadata + wav2vec output. NO…

post/api/therapy-planning-agent

Request

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

Request body

session_metadataobject required

REQUIRED. Object — must include patient_id (string). May also include session_id, timestamp, audio_file.

wav2vec_outputobject required

REQUIRED. Object — must include summary_statistics (typically {disfluency_types_detected, overall_fluency_rate, total_segments, ...}).

patient_anamnesisstring

Optional. Patient context — demographics: {age}, clinical_history: {diagnosis, severity}, therapy_information: {current_treatment_approach, total_sessions_completed}, etc.

emailstring

Optional. Used by the credit-validation flow.

Response

Successful response

successboolean

Boolean.

threadIdstring

Azure AI Foundry thread ID (always a new thread for this endpoint).

runIdstring

Run ID.

agentNamestring

Agent identifier.

statusstring

Run status string.

timestampstring date-time

ISO 8601 timestamp.

recommendationobject

Object — preferred shape contains primary_recommendation and related structured fields when the agent's JSON parses successfully. Fallback shape on parse failure: { raw_response, structured_content: bool, analysis_summary }.

allMessagesobject[]

Array — full thread message history.

remaining_creditsnumber

Number.

metadataobject

Object: { patient_id, session_id, processing_time_seconds, disfluency_types, fluency_rate, total_segments_analyzed, response_metadata: {responseLength, containsStructuredData, parseSuccess} }.

Changes

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