AI Agents

Adapts a speech-therapy exercise to a learner profile (ADHD, dyslexia, dysgraphia, dyspraxia, Tourette syndrome, auti…

post/api/adaptive-exercise-agent

Request

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

Request body

exerciseTextstring required

REQUIRED. The original exercise text.

profilestring required

REQUIRED. One of "adhd" | "dyslexia" | "dysgraphia" | "dyspraxia" | "tourette" | "autism" (case-insensitive). Other values return 400 with a validProfiles field.

includeTipsstring

Optional, default false. If true, the agent includes practitioner tips alongside the adapted exercise.

emailstring

Optional. Used by the credit-validation flow.

Response

Successful response

successboolean

Boolean.

adaptedHTMLstring

String — HTML version of the exercise adapted for the chosen profile.

metadataobject

Object: { profile, includeTips, threadId, agentName, processingTimeSeconds, timestamp }.

remaining_creditsnumber

Number.

Changes

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