API reference

The complete public surface of @tortus-ai/embed-client. For task-oriented walkthroughs, see the guides.

​

loadTortus(config)

Initialises the TORTUS client and displays the standby screen automatically. Returns Promise<TortusClient> See Configuration for the full option list.

​

client.display(screen)

Navigate to a specific screen. Returns Promise<void>: resolves when navigation completes, rejects if it isn’t possible.

​

client.consultations.start(consultation, options?)

Start a new consultation. options Returns Promise<TortusConsultation>

​

client.dictations.start(options?)

Start a new dictation session. options Returns Promise<TortusDictation>

​

client.meetings.start(meeting, options?)

Start a new meeting recording. See Meetings for full examples. meeting options Returns Promise<TortusMeeting> The returned TortusMeeting exposes setNotes?(notes), setAudio?(audio), and close() for mid-flight updates and teardown.

​

client.on(event, callback)

Subscribe to client events. See Handling events & results for payload details. Consultation events Meeting events Event data For completion events, the consultation (or meeting) parameter contains all metadata, while result contains the generated artifacts (medicalNotes, letters, medicalCodes, transcriptions, and optionally structuredNotes). Filter artifacts by contentType rather than relying on array order. structuredNotes (StructuredNote[]) is the medical note in section-shaped form: each note carries templateId and ordered sections, each with id (stable per template — treat as an opaque string), sectionType, heading (always present, including for sections rendered without a visible heading), and content (Markdown). When present, it matches medicalNotes; it can be absent for any consultation by design, so always handle absence. See Handling events & results for details. Returns a function that unsubscribes from the event.

​

client.destroy()

Destroys the client and cleans up all resources. Returns Promise<void>