Skip to content

Public Contract

Widget tag

html
<medyou-recorder
    id="medyou-recorder"
    client-key="bpk_your_publishable_key"
    clinician-id="clinician_001"
    patient-id="patient_001"
    session-id="session_001">
</medyou-recorder>

Required attributes

  • client-key
  • clinician-id
  • patient-id
  • session-id

Notes

  • client-key must be a publishable key for the MedYou backend contract.
  • clinician-id, patient-id, and session-id should be stable identifiers from the host system.
  • The widget emits public events on the widget element itself.
  • Host applications should treat processing-completed as the canonical final success event.

Runtime behavior

  1. Access bootstrap happens through POST /access
  2. Audio is captured or uploaded in the browser
  3. The SDK sends audio and runtime metadata to the backend
  4. Progress and results are exposed through public widget events