Commands  ›   ›  Create Text Note

Create Text Note

writes to model Public API · not yet exposed

Coming soon

Before you run this

Active view must support text notes (not a schedule, legend, or 3D view).

After it runs

A new TextNote element exists in the active view at the specified location.

When to use this

Don't use this when

Creating keynotes or tags (use tagging commands). Not for sheet title blocks.

Inputs

NameKindTypeRequiredDefaultDescription
content config string no Text content
x config number no X coordinate in mm
y config number no Y coordinate in mm
textType config string no Optional text type name

Returns

NameTypeDescription
ResultJSONCreated text note id, view, textType, and placement coordinates

What you'll see in the chat

on start
Placing a text note in the active view...
Creating text annotation...
thinking
Reading text content and coordinates...
Resolving text note type...
Converting mm coordinates to internal units...
Creating text note element...
on success
Text note placed in {view} at ({x}, {y}) mm
on failure
Could not create text note: {error}

REST API

Not yet exposed

This command does not carry a [RestApi] attribute today. Once tagged, this section will auto-populate with:

  • POST /api/v1/commands/create_text_note
  • Request body schema (from [RestApiParam])
  • Response schema (from [RestApiResponse])
  • curl / JS / Python code examples

Keywords & intent patterns

create text note · add text · place text note · text annotation · add annotation
Patterns: create * text · add * text note · place * note · text * annotation

Pillar