Skip to main content
⚠️ Archived Version: This documentation is for an outdated version. Please visit the latest version.

Create a Dot Phrase

POST 

/dot_phrases

Creates a Dot Phrase for the current user.

Request

Body

required
    title stringrequired

    A user-friendly title for the Dot Phrase. Does not impact the matching logic.

    trigger stringrequired

    The text which, if present in the transcript, will prompt the suggestion of this Dot Phrase.

    content_auto_update_enabled boolean

    If true, whenever this dot phrase is suggested, the replacement text will be automatically updated based on the encounter discussion.

    replacement stringrequired

    The replacement text for this Dot Phrase. If the Dot Phrase's trigger is detected, this text will be suggested in the note generation's response.

Responses

The created Dot Phrase.

Schema
    id uuidrequired

    Unique identifier of the Dot Phrase.

    title stringrequired

    A user-friendly title for the Dot Phrase. Does not impact the matching logic.

    trigger stringrequired

    The text which, if present in the transcript, will prompt the suggestion of this Dot Phrase.

    content_auto_update_enabled booleanrequired

    If true, whenever this dot phrase is suggested, the replacement text will be automatically updated based on the encounter discussion.

    replacement stringrequired

    The replacement text for this Dot Phrase. If the Dot Phrase's trigger is detected, this text will be suggested in the note generation's response.

Loading...