Note Template

This document outlines the main structures for creating Note Template objects.

NoteTemplate

NoteTemplate · Object

Show properties

globalPrompt · string

A global prompt applying to the entire template.

id · string · required

A unique ID for the template.

sections · Array of Section objects · required

Ordered list of sections that make up the template.

title · string · required

Title of the template.

Example

{
  "id": "template-abc",
  "title": "Project Documentation Template",
  "globalPrompt": "Overall style: straightforward",
  "sections": [
    {
      "id": "heading-1",
      "type": "heading",
      "properties": {
        "level": 1,
        "text": "Introduction"
      },
      "children": []
    },
    {
      "id": "text-1",
      "type": "text",
      "prompt": "Explain the project background",
      "properties": {
        "detail_level": "medium",
        "tone": "formal"
      }
    },
    {
      "id": "list-1",
      "type": "list",
      "prompt": "List key objectives",
      "properties": {
        "list_type": "bullet",
        "min_items": 1,
        "max_items": 3
      }
    }
  ]
}

---

Section

Section · Discriminated Union

A discriminated union that represents any one of the major section types. The type field determines which schema applies.

Show possible types

HeadingSection · Object

When type = “heading”

ListSection · Object

When type = “list”

TextSection · Object

When type = “text”

Example

[
  {
    "id": "heading-1",
    "type": "heading",
    "properties": { "level": 1, "text": "Overview" },
    "children": []
  },
  {
    "id": "text-1",
    "type": "text",
    "prompt": "Brief overview text",
    "properties": { "tone": "technical" }
  },
  {
    "id": "list-1",
    "type": "list",
    "prompt": "Key tasks",
    "properties": { "list_type": "bullet" }
  }
]

---

HeadingSection

Important Note on Nesting:
There is a maximum heading nesting depth of 2.

HeadingSection · Object

Show properties

children · Array of Section objects · required

Nested sections under this heading.

id · string · required

Unique identifier for this section.

properties · Object · required

Show properties

bold · boolean

Whether the content is bold.

hideIfEmpty · boolean

Hide this heading if empty.

italic · boolean

Whether the content is italic.

level · number · required

Heading level (0 ≤ level ≤ 6).

text · string · required

The heading text.

result · string

Resulting text if generated or stored.

type · string · required

Must be set to “heading”.

Example

{
  "id": "heading-1",
  "type": "heading",
  "properties": {
    "bold": true,
    "italic": false,
    "hideIfEmpty": false,
    "level": 1,
    "text": "Project Introduction"
  },
  "children": []
}

---

TextSection

TextSection · Object

Show properties

id · string · required

Unique identifier for this section.

prompt · string · required

A prompt or instruction for generating/filling text.

properties · Object · required

Show properties

bold · boolean

Whether the content is bold.

italic · boolean

Whether the content is italic.

hideIfEmpty · boolean

Hide this text if empty.

formatting_style · string · default: "markdown"

Content formatting style. One of: “markdown”, “plain”.

detail_level · string · default: "standard"

Detail depth of text. One of: “exhaustive”, “detailed”, “standard”, “brief”, “minimal”.

tone · string · default: "formal"

Tone of the text. One of: “formal”, “casual”, “technical”, “friendly”, “instructional”.

emptyPlaceholder · string

Placeholder if the content is empty.

label · string

A label or title for the text.

bold_label · boolean

Whether the label itself is bold.

italic_label · boolean

Whether the label itself is italic.

list_type · string

If this text is displayed as a list item. One of: “bullet”, “numeric”.

max_paragraphs · number

Maximum paragraphs (if auto-generating).

max_sentences · number

Maximum sentences (if auto-generating).

min_paragraphs · number

Minimum paragraphs (if auto-generating).

min_sentences · number

Minimum sentences (if auto-generating).

result · string

Final or generated text.

type · string · required

Must be set to “text”.

Example

{
  "id": "text-1",
  "type": "text",
  "prompt": "Provide a concise summary of the project scope.",
  "properties": {
    "bold": false,
    "italic": false,
    "hideIfEmpty": true,
    "formatting_style": "markdown",
    "detail_level": "brief",
    "tone": "casual",
    "label": "Project Scope",
    "bold_label": false,
    "italic_label": false,
    "min_sentences": 2,
    "max_sentences": 3,
    "emptyPlaceholder": "No scope defined yet"
  }
}

---

ListSection

ListSection · Object

Show properties

id · string · required

Unique identifier for this section.

prompt · string · required

A prompt or instruction for generating/filling the list.

properties · Object · required

Show properties

bold · boolean

Whether the content is bold.

italic · boolean

Whether the content is italic.

hideIfEmpty · boolean

Hide this list if empty.

formatting_style · string · default: "markdown"

Content formatting style. One of: “markdown”, “plain”.

detail_level · string · default: "standard"

Detail depth for list items. One of: “exhaustive”, “detailed”, “standard”, “brief”, “minimal”.

tone · string · default: "formal"

Tone of the list content. One of: “formal”, “casual”, “technical”, “friendly”, “instructional”.

emptyPlaceholder · string

Placeholder if the list is empty.

list_type · string · required

The format of the list. One of: “bullet”, “numeric”.

max_items · number

Maximum number of items.

min_items · number

Minimum number of items.

result · Array of strings

The final or generated list items.

type · string · required

Must be set to “list”.

Example

{
  "id": "list-1",
  "type": "list",
  "prompt": "List the main deliverables of the project.",
  "properties": {
    "bold": false,
    "italic": false,
    "hideIfEmpty": false,
    "formatting_style": "markdown",
    "detail_level": "minimal",
    "tone": "technical",
    "list_type": "bullet",
    "min_items": 1,
    "max_items": 5,
    "emptyPlaceholder": "No deliverables defined"
  }
}