Sign in

v1

latestOpenAPI 3.0.32026-07-26229361630.0 KB
templates

Create Template

Create a custom note template. Describe the exact structure, sections and style you want in desc using plain text or markdown — for example "SOAP note with Subjective, Objective, Assessment, Plan; use bullet points; include a medication table". EkaScribe uses this description as the authoring instruction when generating notes. Pass the returned template_id in Create Session (templates) or Process Template.

post/voice/api/v1/template

Request body

titlestring required

Display name of the template.

descstring

The template instructions in plain text or markdown. Describe the sections, ordering, formatting (bullets, tables, headings) and tone you want in the generated note. This is what EkaScribe follows when generating notes with this template.

section_idsstring[] required

Pass an empty array []. Describe your desired structure in desc instead.

typestring

Template type. Use custom (default) for your own templates.

Example request

{
  "title": "Cardiology OPD Note",
  "section_ids": [],
  "type": "custom"
}

Response

Template created

msgstring
template_idstring

Example response

{
  "msg": "created successfully",
  "template_id": "tpl_7d1a2b3c4d5e"
}