Skip to main content
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>
The TortusConsultation object contains all consultation data: reference, mode, patient, customFields, metadata, and integration. When the consultation completes, this same data is available in the consultation parameter of the consultation:completed event. The result parameter contains only the generated artifacts.

​
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). Filter artifacts by contentType rather than relying on array order. Returns a function that unsubscribes from the event.

​
client.destroy()

Destroys the client and cleans up all resources. Returns Promise<void>
destroy() cleans up all resources but won’t remove historical data saved in the browser.