AI Agents

Generate personalized speech therapy exercises. The agent returns a single conversational reply containing the exerci…

post/api/speech-exercise-generator

Request

  • Base URL: https://platform.vocametrix.com
  • URL: https://platform.vocametrix.com/api/speech-exercise-generator
  • Auth: API key in header X-API-Key

Request body

messagestring required

REQUIRED. Instructions or context for the exercise generation (e.g., "Generate 5 articulation exercises for /r/").

ageLevelstring required

Patient age range (e.g., "3-6 years", "7-12 years", "adults")

speechChallengestring required

The specific speech challenge to address (e.g., "R sounds", "S sounds")

languagestring required

Target language for exercises (English, French, Spanish)

Response

Successful response

responsestring

The agent reply containing the generated exercises as structured text

threadIdstring

Conversation thread ID — pass it back to continue the same session

agentNamestring

Identifier of the agent that produced the reply

runStatusstring

Internal run state (e.g., "completed")

remaining_creditsnumber

Number of API credits remaining in your account

parametersstring

Echo of the parameters used to produce the reply (ageLevel, speechChallenge, language)

Changes

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