Roam Research

roam_create_outline

Add a structured outline to an existing page or block (by title text or uid), with customizable nesting levels. Best for:

  • Adding supplementary structured content to existing pages
  • Creating temporary or working outlines (meeting notes, brainstorms)
  • Organizing thoughts or research under a specific topic
  • Breaking down subtopics or components of a larger concept

Input Schema

NameRequiredDescriptionDefault
block_text_uidNoA relevant title heading for the outline (or UID, if known) of the block under which outline content will be nested. If blank, content will be nested under the page title.
outlineYesArray of outline items with block text and explicit nesting level
page_title_uidNoTitle (or UID if known) of the page. Leave blank to use the default daily page

Input Schema (JSON Schema)

{ "properties": { "block_text_uid": { "description": "A relevant title heading for the outline (or UID, if known) of the block under which outline content will be nested. If blank, content will be nested under the page title.", "type": "string" }, "outline": { "description": "Array of outline items with block text and explicit nesting level", "items": { "properties": { "level": { "description": "Indentation level (1-10, where 1 is top level)", "maximum": 10, "minimum": 1, "type": "integer" }, "text": { "description": "Content of the block", "type": "string" } }, "required": [ "text", "level" ], "type": "object" }, "type": "array" }, "page_title_uid": { "description": "Title (or UID if known) of the page. Leave blank to use the default daily page", "type": "string" } }, "required": [ "outline" ], "type": "object" }