# Schema Catalog

Reusable structures shared by the Vani REST APIs.

## Shape

Shape schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `text` | Text | Optional | Shape text content. |
| `properties` | Shape Properties | Optional | Visual properties. |
| `placeholder` | Placeholder | Optional | Placeholder binding. |

**Geometry** — exactly one of the following:

| Field | Type | Description |
|---|---|---|
| `basic` | Basic Shape | Basic shape geometry. |
| `flowchart` | Flowchart Shape | Flowchart shape geometry. |
| `block_arrow` | Block Arrow Shape | Block arrow geometry. |
| `mathematical_symbol` | Mathematical Symbol Shape | Mathematical symbol geometry. |
| `star` | Star Shape | Star geometry. |
| `callout` | Callout Shape | Callout geometry. |
| `custom` | Custom Shape | Path-based custom geometry. |

## Basic Shape

Basic shape schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `type` | enum | Required | Basic shape family. Values: `RECTANGLE`, `ROUNDED_RECTANGLE`, `SNIP_RECTANGLE`, `ROUND_SNIP_RECTANGLE`, `TRIANGLE`, `OVAL`, `TRAPEZOID`, `PENTAGON`, `HEXAGON`, `DIAMOND`, `PARALLELOGRAM`, `HEPTAGON`, `OCTAGON`, `DECAGON`, `PIE`, `CHORD`, `TEARDROP`, `FRAME`, `HALF_FRAME`, `L_SHAPE`, `DIAGONAL_STRIPE`, `CROSS`, `PLAQUE`, `CAN`, `CUBE`, `BEVEL`, `DONUT`, `NO_SYMBOL`, `BLOCK_ARC`, `FOLDED_CORNER`, `SMILEY`, `HEART`, `LIGHTNING_BOLT`, `SUN`, `MOON`, `CLOUD`, `ARC`, `BRACKET`, `BRACE`, `CLOCK` |
| `rounded_rectangle` | Rounded Rectangle | Optional | Rounded rectangle detail. |
| `snip_rectangle` | Snip Rectangle | Optional | Snip rectangle detail. |
| `triangle` | Triangle | Optional | Triangle detail. |
| `bracket` | Bracket | Optional | Bracket detail. |
| `brace` | Brace | Optional | Brace detail. |

## Rounded Rectangle

Detail object used with basic.rounded_rectangle.

| Field | Type | Required | Description |
|---|---|---|---|
| `type` | enum | Required | Rounded rectangle type. Values: `NORMAL`, `SINGLE`, `SAME_SIDE`, `DIAGONAL` |

## Snip Rectangle

Detail object used with basic.snip_rectangle.

| Field | Type | Required | Description |
|---|---|---|---|
| `type` | enum | Required | Snip rectangle type. Values: `SNIP_SINGLE`, `SNIP_SAME_SIDE`, `SNIP_DIAGONAL` |

## Triangle

Detail object used with basic.triangle.

| Field | Type | Required | Description |
|---|---|---|---|
| `type` | enum | Required | Triangle type. Values: `ISOSCELES`, `RIGHT_ANGLED` |

## Bracket

Detail object used with basic.bracket.

| Field | Type | Required | Description |
|---|---|---|---|
| `type` | enum | Required | Bracket type. Values: `DOUBLE`, `RIGHT`, `LEFT` |

## Brace

Detail object used with basic.brace.

| Field | Type | Required | Description |
|---|---|---|---|
| `type` | enum | Required | Brace type. Values: `DOUBLE`, `RIGHT`, `LEFT` |

## Text

Text schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `paragraphs` | Text Paragraph[] | Optional | Text paragraphs. |
| `properties` | Text Box Properties | Optional | Text properties. |
| `placeholder` | Placeholder | Optional | Placeholder binding. |

## Text Paragraph

Text paragraph schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | string | Required | Paragraph ID. Must be a UUID. |
| `portions` | Text Portion[] | Optional | Text portions. Each portion contains text content and optional style. |
| `style` | Paragraph Style | Optional | Paragraph style. |

## Text Portion

Text portion schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `text` | string | Optional | Text run content. |
| `style` | Portion Style | Optional | Portion style. |

## Portion Style

Character-level text styling.

| Field | Type | Required | Description |
|---|---|---|---|
| `font_name` | Font Name | Optional | Font family. |
| `size` | float | Optional | Font size. |
| `fontweight` | enum | Optional | Selects one of the supported values. Values: `THIN`, `EXTRA_LIGHT`, `LIGHT`, `NORMAL`, `MEDIUM`, `DEMI_BOLD`, `BOLD`, `HEAVY`, `BLACK` |
| `italic` | boolean | Optional | Italic text toggle. |
| `underline` | boolean | Optional | Underline text toggle. |
| `strike` | boolean | Optional | Strikethrough text toggle. |
| `color` | Color | Optional | Text color. |

## Font Name

Font name schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `name` | enum | Optional | Selects one of the supported values. Values: `Abel`, `Adamina`, `Aguafina Script`, `Alegreya`, `Alfa Slab One`, `Antic`, `Antic Didone`, `Antic Slab`, `Anton`, `Arapey`, `Architects Daughter`, `Archivo`, `Archivo Black`, `Arvo`, `Averia Serif Libre`, `Bad Script`, `Barlow`, `Bentham`, `Bigshot One`, `Bilbo Swash Caps`, `Bree Serif`, `Bubbler One`, `Cabin`, `Cabin Condensed`, `Cabin Sketch`, `Caveat`, `Chivo`, `Comfortaa`, `Cookie`, `Courier Prime`, `Coustard`, `Crimson Text`, `Dancing Script`, `DejaVu Sans`, `Didact Gothic`, `Doppio One`, `Dosis`, `Droid Sans`, `Droid Serif`, `Economica`, `Exo`, `Finger Paint`, `Flamenco`, `Gabriela`, `Great Vibes`, `IBM Plex Mono`, `Inter`, `Italiana`, `Jockey One`, `Josefin Sans`, `Josefin Slab`, `Jura`, `Just Another Hand`, `Kalam`, `Kaushan Script`, `Lato`, `League Gothic`, `Lobster`, `Luckiest Guy`, `Magra`, `Marck Script`, `Metrophobic`, `Michroma`, `Miltonian`, `Molle`, `Monoton`, `Montez`, `Montserrat`, `Niconne`, `Nixie One`, `Nosifer`, `Nova Cut`, `Nunito`, `Office Code Pro`, `Old Standard TT`, `Open Sans`, `Oregano`, `OSP DIN`, `Oswald`, `Otama ep`, `Pacifico`, `Parisienne`, `Patua One`, `Permanent Marker`, `Philosopher`, `Playball`, `Playfair Display`, `Pompiere`, `Poppins`, `PT Sans`, `Quando`, `Questrial`, `Quicksand`, `Qwigley`, `Racing Sans One`, `Raleway`, `Roboto`, `Rochester`, `Rock Salt`, `Rokkitt`, `Ropa Sans`, `Rubik`, `Sansation`, `Satisfy`, `Sawarabi Gothic`, `Schoolbell`, `Short Stack`, `Signika`, `Source Code Pro`, `Source Sans Pro`, `Source Serif Pro`, `Special Elite`, `Spicy Rice`, `Squada One`, `Syncopate`, `Teko`, `TeXGyreAdventor`, `Titillium Web`, `Trade Winds`, `Ubuntu`, `Unkempt`, `Unna`, `Vollkorn`, `Yesteryear`, `Zoho Puvi` |

## Color

Color schema.

**Color Model** — exactly one of the following:

| Field | Type | Description |
|---|---|---|
| `rgb` | RGB Color | RGB channel color. |
| `hsb` | HSB Color | HSB color. |
| `hex` | HEX Color | HEX literal color. |

## Paragraph Style

Paragraph style schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `halign` | enum | Optional | Selects one of the supported values. Values: `LEFT`, `CENTER`, `RIGHT`, `JUSTIFY` |
| `spacing` | Paragraph Spacing | Optional | Paragraph spacing. |
| `level` | int | Optional | Paragraph indent level. |
| `portion_style` | Portion Style | Optional | Default portion style for the paragraph. |

## Paragraph Spacing

Paragraph spacing schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `line` | float | Optional | Line spacing multiplier. |
| `before` | int | Optional | Space before paragraph. |
| `after` | int | Optional | Space after paragraph. |

## Text Box Properties

Text box properties schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `valign` | enum | Optional | Selects one of the supported values. Values: `MIDDLE`, `TOP`, `BOTTOM` |
| `inset` | Text Inset | Optional | Text padding. |
| `para_style` | Paragraph Style | Optional | Default paragraph style. |
| `auto_fit` | enum | Optional | Selects one of the supported values. Values: `NONE`, `TEXT`, `SHAPE` |

## Text Inset

Text inset schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `left` | float | Optional | Left text padding. |
| `top` | float | Optional | Top text padding. |
| `right` | float | Optional | Right text padding. |
| `bottom` | float | Optional | Bottom text padding. |

## Placeholder

Placeholder schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `type` | enum | Required | Vani placeholder type. Use TXT for text placeholders, PICT for image placeholders, TABLE for table placeholders, or VIDEO for video placeholders. Values: `TXT`, `PICT`, `TABLE`, `VIDEO` |

## Shape Properties

Shape properties schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `layout` | Layout | Optional | Position and size. |
| `fills` | Fill[] | Optional | Fill layers. |
| `strokes` | Stroke[] | Optional | Stroke layers. |

## Layout

Layout schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `top` | float | Optional | Top position (Y). |
| `left` | float | Optional | Left position (X). |
| `width` | float | Optional | Element width in pixels. |
| `height` | float | Optional | Element height in pixels. |
| `rotate` | int | Optional | Rotation angle in degrees. |
| `fliph` | boolean | Optional | Horizontal flip. |
| `flipv` | boolean | Optional | Vertical flip. |

## Fill

Fill schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `alpha` | float | Optional | Transparency ratio. Range: 0 to 1. |

**Fill Type** — exactly one of the following:

| Field | Type | Description |
|---|---|---|
| `solid` | Solid Fill | Solid fill. |
| `gradient` | Gradient Fill | Gradient fill. |
| `no_fill` | object | No fill object. |

## Solid Fill

Solid fill schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `color` | Color | Required | Fill color. |

## Gradient Fill

Gradient fill schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `type` | enum | Optional | Gradient type. Values: `LINEAR`, `RADIAL`, `ANGULAR` |
| `stops` | Gradient Stop[] | Required | Gradient color stops. Minimum two stops are required. |
| `linear` | Linear Geometry | Conditional | Geometry for LINEAR gradients. |
| `radial_angular` | Radial Angular Geometry | Conditional | Geometry for RADIAL and ANGULAR gradients. |

## Gradient Stop

Gradient stop schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `color` | Color | Required | Stop color. |
| `position` | float | Required | Stop position. Range: 0 to 1. |

## Linear Geometry

Linear geometry schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `start` | Point | Required | Gradient axis start point. |
| `end` | Point | Required | Gradient axis end point. |

## Point

2D point with x and y coordinates.

| Field | Type | Required | Description |
|---|---|---|---|
| `x` | float | Required | X coordinate. |
| `y` | float | Required | Y coordinate. |

## Radial Angular Geometry

Radial angular geometry schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `center` | Point | Required | Gradient center point. |
| `spread_x` | float | Optional | Horizontal spread. |
| `spread_y` | float | Optional | Vertical spread. |
| `rotation_angle` | float | Optional | Rotation in degrees. |
| `flip_horizontal` | boolean | Optional | Mirror horizontally. |
| `flip_vertical` | boolean | Optional | Mirror vertically. |

## Stroke

Shape stroke schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `type` | enum | Optional | Stroke type. For no border, keep the type valid and set the stroke fill to no_fill. Values: `SOLID`, `DASH`, `SQUARE_DOT` |
| `width` | float | Optional | Stroke width in pixels. |
| `jointype` | enum | Optional | Join type. Values: `ROUND`, `BEVEL`, `MITER` |
| `captype` | enum | Optional | Cap type. Values: `FLAT`, `CAPROUND`, `SQUARE` |
| `position` | enum | Optional | Stroke position. Values: `CENTER`, `INSIDE`, `OUTSIDE` |
| `fill` | Stroke Fill | Optional | Stroke fill. |

## Stroke Fill

Stroke Fill schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `alpha` | float | Optional | Stroke fill alpha ratio. Range: 0 to 1. |

**Stroke Fill Type** — exactly one of the following:

| Field | Type | Description |
|---|---|---|
| `solid` | Solid Fill | Solid stroke fill. |
| `no_fill` | object | No stroke fill. Use this for no border. |

## Block Arrow Shape

Use type to select the block-arrow family.

| Field | Type | Required | Description |
|---|---|---|---|
| `type` | enum | Required | Block arrow family. Values: `SINGLE`, `CURVED`, `CALLOUT`, `DOUBLE`, `QUAD`, `LEFT_RIGHT_UP`, `BENT`, `U_TURN`, `BENT_UP`, `STRIPED_RIGHT`, `NOTCHED_RIGHT`, `PENTAGON_ARROW`, `CHEVRON`, `LEFT_RIGHT_CALLOUT`, `QUAD_CALLOUT` |
| `single_arrow` | Single Arrow | Optional | Single arrow direction. |
| `curved_arrow` | Curved Arrow | Optional | Curved arrow direction. |
| `arrow_callout` | Arrow Callout | Optional | Arrow callout direction. |
| `double_arrow` | Double Arrow | Optional | Double arrow direction. |

## Single Arrow

Direction object used with block_arrow.single_arrow.

| Field | Type | Required | Description |
|---|---|---|---|
| `type` | enum | Required | Single arrow direction. Values: `RIGHT`, `LEFT`, `TOP`, `BOTTOM` |

## Curved Arrow

Direction object used with block_arrow.curved_arrow.

| Field | Type | Required | Description |
|---|---|---|---|
| `type` | enum | Required | Curved arrow direction. Values: `RIGHT`, `LEFT`, `TOP`, `BOTTOM` |

## Arrow Callout

Direction object used with block_arrow.arrow_callout.

| Field | Type | Required | Description |
|---|---|---|---|
| `type` | enum | Required | Arrow callout direction. Values: `RIGHT`, `LEFT`, `TOP`, `BOTTOM` |

## Double Arrow

Direction object used with block_arrow.double_arrow.

| Field | Type | Required | Description |
|---|---|---|---|
| `type` | enum | Required | Double arrow direction. Values: `UP_DOWN`, `LEFT_RIGHT`, `LEFT_UP` |

## Flowchart Shape

Flowchart shape schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `type` | enum | Required | Flowchart shape type. Values: `PREDEFINED_PROCESS`, `INTERNAL_STORAGE`, `DOCUMENT`, `PROCESS`, `ALTERNATE_PROCESS`, `DECISION`, `DATA`, `MULTI_DOCUMENT`, `TERMINATOR`, `PREPARATION`, `MANUAL_INPUT`, `MANUAL_OPERATION`, `CONNECTOR`, `OFFPAGE_CONNECTOR`, `PUNCHED_CARD`, `PUNCHED_TAPE`, `SUMMING_JUNCTION`, `OR`, `COLLATE`, `SORT`, `EXTRACT`, `MERGE`, `STORED_DATA`, `DELAY`, `SEQUENTIAL_ACCESS_STORAGE`, `MAGNETIC_DISK`, `DIRECT_ACCESS_STORAGE`, `DISPLAY` |

## Mathematical Symbol Shape

Mathematical symbol geometry selector.

| Field | Type | Required | Description |
|---|---|---|---|
| `type` | enum | Required | Mathematical symbol type. Values: `PLUS`, `MINUS`, `MULTIPLY`, `DIVIDE`, `EQUAL`, `NOT_EQUAL` |

## Star Shape

Star shape schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `type` | enum | Required | Star family. Values: `EXPLOSION`, `POINT`, `RIBBON`, `SCROLL`, `WAVE` |
| `point` | Star Point | Optional | Star point detail. |
| `ribbon` | Star Ribbon | Optional | Ribbon detail. |
| `scroll` | Star Scroll | Optional | Scroll detail. |
| `wave` | Star Wave | Optional | Wave detail. |

## Star Point

Detail object used with star.point.

| Field | Type | Required | Description |
|---|---|---|---|
| `type` | enum | Required | Star point type. Values: `FOUR_POINT`, `FIVE_POINT`, `SIX_POINT`, `SEVEN_POINT`, `EIGHT_POINT`, `TEN_POINT`, `TWELVE_POINT`, `SIXTEEN_POINT`, `TWENTY_FOUR_POINT`, `THIRTY_TWO_POINT` |

## Star Ribbon

Detail object used with star.ribbon.

| Field | Type | Required | Description |
|---|---|---|---|
| `type` | enum | Required | Ribbon type. Values: `UP`, `DOWN`, `CURVED_UP`, `CURVED_DOWN` |

## Star Scroll

Detail object used with star.scroll.

| Field | Type | Required | Description |
|---|---|---|---|
| `type` | enum | Required | Scroll type. Values: `VERTICAL`, `HORIZONTAL` |

## Star Wave

Detail object used with star.wave.

| Field | Type | Required | Description |
|---|---|---|---|
| `type` | enum | Required | Wave type. Values: `SINGLE`, `DOUBLE` |

## Callout Shape

Callout shape schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `type` | enum | Required | Callout shape type. Values: `LINE`, `RECTANGLE_CALLOUT`, `ROUNDED_RECTANGLE_CALLOUT`, `OVAL_CALLOUT`, `CLOUD_CALLOUT` |

## Custom Shape

Custom shape schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `width` | float | Optional | Custom shape width. |
| `height` | float | Optional | Custom shape height. |
| `paths` | Custom Path[] | Required | Shape paths. |

## Custom Path

Custom path schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `commands` | Path Command[] | Required | Ordered path command objects. |

## Path Command

Path Command schema.

**Path Command** — exactly one of the following:

| Field | Type | Description |
|---|---|---|
| `move_to` | Path Point Command | Move to a point. |
| `line_to` | Path Point Command | Draw a line to a point. |
| `cubic_to` | Cubic Path Command | Draw a cubic Bezier curve. |
| `quadratic_to` | Quadratic Path Command | Draw a quadratic Bezier curve. |
| `arc_to` | Arc Path Command | Draw an arc to a point. |
| `smooth_cubic_to` | Smooth Cubic Path Command | Draw a smooth cubic Bezier curve. |
| `smooth_quadratic_to` | Smooth Quadratic Path Command | Draw a smooth quadratic Bezier curve. |
| `close_path` | object | Close the current path with an empty object. |

## Path Point Command

Path point command schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `point` | Point | Required | Target point. |

## Cubic Path Command

Cubic path command schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `control1` | Point | Required | First control point. |
| `control2` | Point | Required | Second control point. |
| `end` | Point | Required | End point. |

## Quadratic Path Command

Quadratic path command schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `control` | Point | Required | Control point. |
| `end` | Point | Required | End point. |

## Arc Path Command

Arc path command schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `x_radius` | float | Optional | X radius. |
| `y_radius` | float | Optional | Y radius. |
| `start_angle` | float | Optional | Start angle. |
| `sweep_angle` | float | Optional | Sweep angle. |
| `end` | Point | Required | End point. |

## Smooth Cubic Path Command

Smooth cubic path command schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `control2` | Point | Required | Second control point. |
| `end` | Point | Required | End point. |

## Smooth Quadratic Path Command

Smooth quadratic path command schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `end` | Point | Required | End point. |

## Connector

Connector schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `type` | enum | Optional | Connector type. Values: `LINE`, `ELBOW`, `CURVE` |
| `connected` | Connected Shapes | Required | Connected endpoint pair. |
| `stroke` | Connector Stroke | Optional | Connector stroke. |
| `text` | Connector Text | Optional | Connector label text. |

## Connected Shapes

Connected shapes schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `first` | Connector Endpoint | Required | Start endpoint. |
| `second` | Connector Endpoint | Required | End endpoint. |

## Connector Endpoint

Connector endpoint schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `shape_id` | string | Required | Connected shape ID. |
| `side` | enum | Optional | Connection side. Values: `NORTH`, `EAST`, `SOUTH`, `WEST` |
| `point` | Point | Optional | Custom attach point. |
| `marker` | enum | Optional | Marker type. Values: `NONE`, `OPEN`, `BLOCK`, `CLASSIC`, `DIAMOND`, `OVAL` |

## Connector Stroke

Connector stroke schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `type` | enum | Optional | Stroke type. Values: `SOLID`, `DASH`, `SQUARE_DOT` |
| `width` | float | Optional | Stroke width in pixels. |
| `jointype` | enum | Optional | Join type. Values: `ROUND`, `BEVEL`, `MITER` |
| `captype` | enum | Optional | Cap type. Values: `FLAT`, `CAPROUND`, `SQUARE` |
| `position` | enum | Optional | Stroke position. Values: `CENTER`, `INSIDE`, `OUTSIDE` |
| `fill` | Connector Stroke Fill | Optional | Connector stroke fill. |

## Connector Stroke Fill

Connector Stroke Fill schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `solid` | Solid Fill | Required | Solid connector stroke fill. |
| `alpha` | float | Optional | Stroke fill alpha ratio. Range: 0 to 1. |

## Connector Text

Connector text schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `paragraphs` | Text Paragraph[] | Optional | Text paragraphs. |
| `properties` | Text Box Properties | Optional | Text properties. |

## RGB Color

RGB color schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `red` | int | Required | Red channel. Range: 0–255. |
| `green` | int | Required | Green channel. Range: 0–255. |
| `blue` | int | Required | Blue channel. Range: 0–255. |

## HSB Color

HSB color schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `hue` | float | Required | Hue. Range: 0–360. |
| `saturation` | float | Required | Saturation. Range: 0–1. |
| `brightness` | float | Required | Brightness. Range: 0–1. |

## HEX Color

Hex color literal.

| Field | Type | Required | Description |
|---|---|---|---|
| `value` | string | Required | Hex color literal. |

## Text Mutation

Text Mutation schema.

**Edit Target** — exactly one of the following:

| Field | Type | Description |
|---|---|---|
| `range` | Range Text Mutation | Edit text between two indexes. |
| `cursor` | Cursor Text Mutation | Edit text at one cursor index. |
| `all_text` | All Text Mutation | Edit the full text content. |

## Range Text Mutation

Use range when the text edit applies only to part of the text.

| Field | Type | Required | Description |
|---|---|---|---|
| `range` | Text Range | Required | Nested index range object. |
| `operation` | enum | Required | What to do with the selected range. Values: `RANGE_TEXT_OPERATION_REPLACE`, `RANGE_TEXT_OPERATION_DELETE` |
| `replacement_text` | string | Required for replace | New text to put in the selected range when the operation is RANGE_TEXT_OPERATION_REPLACE. |

## Text Range

Text range schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `start_index` | int | Required | Where the range starts. This index is included. |
| `end_index` | int | Required | Where the range ends. This index is not included. |

## Cursor Text Mutation

Use cursor when the text edit happens at one cursor index.

| Field | Type | Required | Description |
|---|---|---|---|
| `cursor_index` | int | Required | The text index where the cursor edit should happen. |
| `operation` | enum | Required | What to do at the cursor. Values: `CURSOR_TEXT_OPERATION_INSERT_TEXT`, `CURSOR_TEXT_OPERATION_INSERT_NEWLINE`, `CURSOR_TEXT_OPERATION_DELETE_NEWLINE` |
| `text` | string | Required for text insert | Text to insert when the operation is CURSOR_TEXT_OPERATION_INSERT_TEXT. |

## All Text Mutation

Use all_text when the text edit applies to the full text content.

| Field | Type | Required | Description |
|---|---|---|---|
| `operation` | enum | Required | What to do with the full text. Values: `ALL_TEXT_OPERATION_REPLACE`, `ALL_TEXT_OPERATION_DELETE` |
| `replacement_text` | string | Required for replace | New full text when the operation is ALL_TEXT_OPERATION_REPLACE. |

## Frame

Frame schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `meta` | Frame Meta | Required | Frame metadata. |
| `type` | enum | Required | Selects one of the supported values. Values: `A4`, `A5`, `A6`, `A7`, `SLIDE_LANDSCAPE`, `SLIDE_PORTRAIT`, `DEVICE_PHONE`, `DEVICE_TABLET`, `DEVICE_DESKTOP`, `DEVICE_TV`, `DEVICE_WATCH`, `SM_TWITTER_POST`, `SM_TWITTER_HEADER`, `SM_FB_POST`, `SM_FB_COVER`, `SM_INSTAGRAM_POST`, `SM_INSTAGRAM_STORY`, `SM_LINKEDIN_POST`, `SM_LINKEDIN_COVER`, `CUSTOM` |
| `properties` | Frame Properties | Optional | Frame visual properties. |

## Frame Meta

Frame metadata schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `id` | string | Required | Frame ID. Must be a UUID. |
| `name` | string | Optional | Frame display name. |

## Frame Properties

Frame properties schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `layout` | Layout | Optional | Position and size. |
| `fills` | Fill[] | Optional | Fill layers. |
| `strokes` | Stroke[] | Optional | Stroke layers. |

## Asset Ref

Asset Ref schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `library` | Library Asset Ref | Optional |  |
| `local_id` | string | Optional |  |

## Auto Layout

Auto Layout schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `mode` | string | Optional | Values: `NONE`, `HORIZONTAL`, `VERTICAL`, `GRID` |
| `vertical_scale` | string | Optional | Values: `FIXED`, `FILL`, `HUG` |
| `horizontal_spacing` | object | Optional |  |
| `padding` | object | Optional |  |
| `horizontal_scale` | string | Optional | Values: `FIXED`, `FILL`, `HUG` |
| `vertical_align` | string | Optional | Values: `MIDDLE`, `TOP`, `BOTTOM` |
| `grid` | object | Optional |  |
| `horizontal_align` | string | Optional | Values: `LEFT`, `CENTER`, `RIGHT`, `JUSTIFY` |
| `vertical_spacing` | object | Optional |  |
| `wrap` | boolean | Optional |  |

## Chart

Chart schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `layout` | Layout | Optional |  |
| `area` | Chart_ Area Chart | Optional |  |
| `bar` | Chart_ Bar Chart | Optional |  |
| `bubble` | Chart_ Bubble Chart | Optional |  |
| `line` | Chart_ Line Chart | Optional |  |
| `scatter` | Chart_ Scatter Chart | Optional |  |
| `column` | Chart_ Bar Chart | Optional |  |
| `axes` | array of Chart_ChartAxis | Optional |  |
| `chart_title` | Chart_ Chart Title | Optional |  |
| `pie` | Chart_ Pie Chart | Optional |  |
| `table` | Table | Optional |  |
| `doughnut` | Chart_ Doughnut Chart | Optional |  |

## Chart_ Area Chart

Chart_ Area Chart schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `drop_lines` | Stroke | Optional |  |
| `grouping` | string | Optional | Values: `CLUSTERED`, `STACKED`, `PERCENT_STACKED` |

## Chart_ Bar Chart

Chart_ Bar Chart schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `overlap` | string | Optional |  |
| `series_line` | Stroke | Optional |  |
| `gap` | string | Optional |  |
| `grouping` | string | Optional | Values: `CLUSTERED`, `STACKED`, `PERCENT_STACKED` |

## Chart_ Bubble Chart

Chart_ Bubble Chart schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `bubble_size` | object | Optional |  |

## Chart_ Chart Axis

Chart_ Chart Axis schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `minor_tick` | Stroke | Optional |  |
| `cross_axis` | object | Optional |  |
| `axis_id` | string | Optional |  |
| `axis_title` | Chart_ Chart Title | Optional |  |
| `position` | string | Optional | Values: `TOP`, `LEFT`, `BOTTOM`, `RIGHT`, `CENTER` |
| `major_grid` | Stroke | Optional |  |
| `value_axis` | object | Optional |  |
| `major_tick` | Stroke | Optional |  |
| `minor_grid` | Stroke | Optional |  |

## Chart_ Chart Title

Chart_ Chart Title schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `title` | string | Optional |  |

## Chart_ Doughnut Chart

Chart_ Doughnut Chart schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `explosion` | string | Optional |  |
| `first_slice_angle` | string | Optional |  |
| `hole_size` | string | Optional |  |

## Chart_ Line Chart

Chart_ Line Chart schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `up_bar` | Fill | Optional |  |
| `down_bar` | Fill | Optional |  |
| `high_low_lines` | Stroke | Optional |  |
| `line_settings` | object | Optional |  |
| `drop_lines` | Stroke | Optional |  |
| `grouping` | string | Optional | Values: `CLUSTERED`, `STACKED`, `PERCENT_STACKED` |

## Chart_ Pie Chart

Chart_ Pie Chart schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `explosion` | string | Optional |  |
| `representative_pie` | object | Optional |  |
| `first_slice_angle` | string | Optional |  |

## Chart_ Scatter Chart

Chart_ Scatter Chart schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `line` | boolean | Optional |  |
| `line_settings` | object | Optional |  |

## Connector_ Connected Shape

Connector_ Connected Shape schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `first` | object | Optional |  |
| `second` | object | Optional |  |

## Database Table

Database Table schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `layout` | Layout | Optional |  |
| `columns` | array of DatabaseTable_DatabaseColumn | Optional |  |
| `name` | string | Optional |  |
| `view_config` | View Config | Optional |  |
| `id` | string | Optional |  |
| `rows` | array of DatabaseTable_DatabaseRow | Optional |  |

## Database Table View

Database Table View schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `layout` | Layout | Optional |  |
| `grid` | object | Optional |  |
| `kanban` | object | Optional |  |
| `name` | string | Optional |  |
| `view_config` | View Config | Optional |  |
| `id` | string | Optional |  |
| `table_id` | string | Optional |  |

## Database Table_ Database Column

Database Table_ Database Column schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `relation_column` | object | Optional |  |
| `rollup_column` | object | Optional |  |
| `unique` | boolean | Optional |  |
| `name` | string | Optional |  |
| `lookup_column` | object | Optional |  |
| `default_value` | object | Optional |  |
| `id` | string | Optional |  |
| `type` | string | Optional | Values: `TEXT`, `NUMBER`, `TOGGLE`, `CHECKBOX`, `SELECT`, `MULTI_SELECT`, `CATEGORY`, `DATE`, `PERSON`, `PHONE`, `EMAIL`, `URL`, `RATING`, `RELATION`, `LOOKUP`, `ROLLUP` |
| `select_column` | object | Optional |  |
| `category_column` | object | Optional |  |
| `required` | boolean | Optional |  |

## Database Table_ Database Row

Database Table_ Database Row schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `cells` | array of DatabaseTable_DatabaseRow_DatabaseCell | Optional |  |
| `id` | string | Optional |  |

## Domain Diagram

Domain Diagram schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `layout` | string | Optional | Values: `LAYOUT_UNSPECIFIED`, `TOP_DOWN`, `LEFT_RIGHT` |
| `dfd` | Domain Diagram_ Dfd Diagram | Optional |  |
| `uml` | Domain Diagram_ Uml Diagram | Optional |  |
| `erd` | Domain Diagram_ Erd Diagram | Optional |  |
| `type` | string | Optional | Values: `UML`, `DFD`, `ERD` |

## Domain Diagram_ Dfd Diagram

Domain Diagram_ Dfd Diagram schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `connectors` | array of DomainDiagram_DiagramConnector | Optional |  |
| `nodes` | array of DomainDiagram_DfdNode | Optional |  |
| `edges` | array of DomainDiagram_DiagramEdge | Optional |  |

## Domain Diagram_ Erd Diagram

Domain Diagram_ Erd Diagram schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `connectors` | array of DomainDiagram_DiagramConnector | Optional |  |
| `nodes` | array of DomainDiagram_ErdNode | Optional |  |
| `edges` | array of DomainDiagram_DiagramEdge | Optional |  |

## Domain Diagram_ Uml Diagram

Domain Diagram_ Uml Diagram schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `connectors` | array of DomainDiagram_DiagramConnector | Optional |  |
| `nodes` | array of DomainDiagram_UmlNode | Optional |  |
| `edges` | array of DomainDiagram_DiagramEdge | Optional |  |

## Fill

Fill schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `no_fill` | object | Optional |  |
| `solid` | Fill_ Solid Fill | Optional |  |
| `gradient` | Fill_ Gradient Fill | Optional |  |
| `alpha` | string | Optional |  |
| `picture` | Fill_ Picture Fill | Optional |  |

## Fill_ Gradient Fill

Fill_ Gradient Fill schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `linear` | object | Optional |  |
| `radial_angular` | object | Optional |  |
| `stops` | array of Fill_GradientFill_Stop | Optional |  |
| `type` | string | Optional | Values: `LINEAR`, `RADIAL`, `RECTANGULAR`, `PATH`, `ANGULAR` |

## Fill_ Picture Fill

Fill_ Picture Fill schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `offset_top` | string | Optional |  |
| `scale_y` | string | Optional |  |
| `scale_x` | string | Optional |  |
| `media` | Asset Ref | Optional |  |
| `type` | string | Optional | Values: `SCALE`, `TILE` |
| `offset_left` | string | Optional |  |

## Fill_ Solid Fill

Fill_ Solid Fill schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `color` | Color | Optional |  |

## Graphic Object Properties

Graphic Object Properties schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `strokes` | array of Stroke | Optional |  |
| `stroke_style` | Asset Ref | Optional |  |
| `shadow` | Shadow | Optional |  |
| `reflection` | Reflection | Optional |  |
| `effect_style` | Asset Ref | Optional |  |
| `region_id` | string | Optional |  |
| `fill_style` | Asset Ref | Optional |  |
| `spacing_style` | Asset Ref | Optional |  |
| `data_binding` | string | Optional |  |
| `layer_style` | Asset Ref | Optional |  |
| `layout` | Layout | Optional |  |
| `image_style` | Asset Ref | Optional |  |
| `placeholder` | Placeholder | Optional |  |
| `fills` | array of Fill | Optional |  |

## Index Path

Index Path schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `indices` | array of object | Optional |  |

## Kit Shape

Kit Shape schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `dfd` | object | Optional |  |
| `uml` | object | Optional |  |
| `erd` | object | Optional |  |
| `kit` | string | Optional | Values: `UML`, `DFD`, `ERD` |

## Layout_ Constraints

Layout_ Constraints schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `horizontal` | string | Optional | Values: `LEFT`, `RIGHT`, `CENTER`, `LEFT_RIGHT`, `HORIZONTAL_SCALE` |
| `vertical` | string | Optional | Values: `TOP`, `BOTTOM`, `MIDDLE`, `TOP_BOTTOM`, `VERTICAL_SCALE` |

## Library Asset Ref

Library Asset Ref schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `library_id` | string | Optional |  |
| `asset_id` | string | Optional |  |

## Para Style_ List Style

Para Style_ List Style schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `number` | object | Optional |  |
| `character` | object | Optional |  |
| `color` | Color | Optional |  |
| `type` | string | Optional | Values: `NONE`, `CHARACTER`, `NUMBER` |

## Para Style_ Spacing

Para Style_ Spacing schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `before` | string | Optional |  |
| `line` | string | Optional |  |
| `after` | string | Optional |  |

## Picture

Picture schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `media` | Asset Ref | Optional |  |
| `filters` | Picture Filters | Optional |  |
| `properties` | Graphic Object Properties | Optional |  |

## Picture Filters

Picture Filters schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `brightness` | string | Optional |  |
| `color_mode` | object | Optional |  |
| `contrast` | string | Optional |  |

## Picture Filters_ Color Mode_ Bilevel

Picture Filters_ Color Mode_ Bilevel schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `level` | string | Optional |  |

## Picture Filters_ Color Mode_ Duotone

Picture Filters_ Color Mode_ Duotone schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `first_color` | Color | Optional |  |
| `second_color` | Color | Optional |  |

## Reflection

Reflection schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `alpha_start` | string | Optional |  |
| `distance` | string | Optional |  |
| `alpha_end` | string | Optional |  |
| `position_end` | string | Optional |  |
| `position_start` | string | Optional |  |

## Resource Ref

Resource Ref schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `content_type` | string | Optional |  |
| `id` | string | Optional |  |
| `uri` | string | Optional |  |

## Shadow

Shadow schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `distance` | string | Optional |  |
| `color` | Color | Optional |  |
| `transparency` | string | Optional |  |
| `angle` | string | Optional |  |
| `blur` | string | Optional |  |
| `type` | string | Optional | Values: `INNER`, `OUTER` |

## Shape

Shape schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `callout` | object | Optional |  |
| `mathematical_symbol` | object | Optional |  |
| `star` | object | Optional |  |
| `custom` | Custom Shape | Optional |  |
| `block_arrow` | object | Optional |  |
| `flowchart` | object | Optional |  |
| `text` | Text | Optional |  |
| `basic` | object | Optional |  |
| `properties` | Graphic Object Properties | Optional |  |

## Stroke

Stroke schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `captype` | string | Optional | Values: `FLAT`, `CAPROUND`, `SQUARE` |
| `jointype` | string | Optional | Values: `ROUND`, `BEVEL`, `MITER` |
| `width` | string | Optional |  |
| `position` | string | Optional | Values: `CENTER`, `INSIDE`, `OUTSIDE` |
| `type` | string | Optional | Values: `SOLID`, `DASH`, `ROUND_DOT`, `SQUARE_DOT`, `LONG_DASH`, `DASHDOT`, `LONG_DASH_DOT`, `LONG_DASH_DOT_DOT`, `DASH_PATTERN` |
| `fill` | Fill | Optional |  |
| `dash_pattern` | array of object | Optional |  |

## Structure

Structure schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `stack` | Structure_ Stack | Optional |  |
| `kanban` | Structure_ Kanban | Optional |  |
| `mindmap` | Structure_ Mindmap | Optional |  |
| `title` | string | Optional |  |

## Structure_ Kanban

Structure_ Kanban schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `container` | Vani Graphic Object_ Group Shape | Optional |  |
| `horizontal` | object | Optional |  |
| `vertical` | object | Optional |  |
| `table_view_id` | string | Optional |  |

## Structure_ Mindmap

Structure_ Mindmap schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `container` | Vani Graphic Object_ Group Shape | Optional |  |
| `spacing` | object | Optional |  |
| `template_object` | Vani Graphic Object_ Group Shape | Optional |  |
| `top` | Vani Graphic Object_ Group Shape | Optional |  |
| `left` | Vani Graphic Object_ Group Shape | Optional |  |
| `bottom` | Vani Graphic Object_ Group Shape | Optional |  |
| `root` | Vani Graphic Object_ Group Shape | Optional |  |
| `top_down` | object | Optional |  |
| `right` | Vani Graphic Object_ Group Shape | Optional |  |
| `left_right` | object | Optional |  |

## Structure_ Stack

Structure_ Stack schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `container` | Vani Graphic Object_ Group Shape | Optional |  |
| `horizontal` | object | Optional |  |
| `vertical` | object | Optional |  |
| `table_view_id` | string | Optional |  |

## Table

Table schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `layout` | Layout | Optional |  |
| `columns` | array of Table_TableColumn | Optional |  |
| `style_ref` | Asset Ref | Optional |  |
| `style` | Table Style | Optional |  |
| `rows` | array of Table_TableRow | Optional |  |

## Table Style

Table Style schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `band_row` | boolean | Optional |  |
| `first_col` | boolean | Optional |  |
| `band_col` | boolean | Optional |  |
| `first_row` | boolean | Optional |  |
| `last_row` | boolean | Optional |  |
| `fill` | Fill | Optional |  |
| `stroke` | Stroke | Optional |  |
| `last_col` | boolean | Optional |  |

## Table_ Table Column

Table_ Table Column schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `width` | string | Optional |  |
| `id` | string | Optional |  |

## Table_ Table Row

Table_ Table Row schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `cells` | array of Table_TableRow_TableCell | Optional |  |
| `id` | string | Optional |  |
| `height` | string | Optional |  |

## Vani Graphic Object

Vani Graphic Object schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `shape` | Vani Shape | Optional |  |
| `sticky_note` | Vani Graphic Object_ Sticky Note | Optional |  |
| `group_shape` | Vani Graphic Object_ Group Shape | Optional |  |
| `database_table` | Database Table | Optional |  |
| `picture` | Picture | Optional |  |
| `structure` | Structure | Optional |  |
| `domain_diagram` | Domain Diagram | Optional |  |
| `diagram` | object | Optional |  |
| `connector` | Connector | Optional |  |
| `name` | string | Optional |  |
| `database_table_view` | Database Table View | Optional |  |
| `id` | string | Optional |  |
| `chart` | Chart | Optional |  |
| `table` | Table | Optional |  |

## Vani Graphic Object_ Group Shape

Vani Graphic Object_ Group Shape schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `layout` | Layout | Optional |  |
| `auto_layout` | Auto Layout | Optional |  |
| `objects` | array of VaniGraphicObject_GroupShape_GroupObject | Optional |  |

## Vani Graphic Object_ Group Shape_ Group Object

Vani Graphic Object_ Group Shape_ Group Object schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `shape` | Vani Shape | Optional |  |
| `connector` | Connector | Optional |  |
| `sticky_note` | Vani Graphic Object_ Sticky Note | Optional |  |
| `name` | string | Optional |  |
| `group_shape` | Vani Graphic Object_ Group Shape | Optional |  |
| `id` | string | Optional |  |
| `picture` | Picture | Optional |  |

## Vani Graphic Object_ Sticky Note

Vani Graphic Object_ Sticky Note schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `layout` | Layout | Optional |  |
| `type` | string | Optional | Values: `STICKY_NOTE_TYPE_UNSPECIFIED`, `ARROW`, `FLAG`, `RING`, `PLAIN`, `CLIP`, `PIN`, `FOLDED` |

## Vani Shape

Vani Shape schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `shape` | Shape | Optional |  |
| `kit` | Kit Shape | Optional |  |

## View Config

View Config schema.

| Field | Type | Required | Description |
|---|---|---|---|
| `filter` | object | Optional |  |
| `visible_column_ids` | array of object | Optional |  |
| `group_by_column_id` | string | Optional |  |
| `sort` | array of Sort | Optional |  |