Help Doc Access Vani

Schema Catalog

Reusable object definitions used by Vani request schemas. Endpoint pages show request-specific required fields and interactive builders; this catalog only describes each schema once.

Shape

Shape schema.

Geometry Select one geometry field.
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.
text
Text
Shape text content.
properties
Shape Properties
Visual properties.
placeholder
Placeholder
Placeholder binding.

Basic Shape

Basic shape schema.

type
enum
Basic shape family.
type
RECTANGLEROUNDED_RECTANGLESNIP_RECTANGLEROUND_SNIP_RECTANGLETRIANGLEOVALTRAPEZOIDPENTAGONHEXAGONDIAMONDPARALLELOGRAMHEPTAGONOCTAGONDECAGONPIECHORDTEARDROPFRAMEHALF_FRAMEL_SHAPEDIAGONAL_STRIPECROSSPLAQUECANCUBEBEVELDONUTNO_SYMBOLBLOCK_ARCFOLDED_CORNERSMILEYHEARTLIGHTNING_BOLTSUNMOONCLOUDARCBRACKETBRACECLOCK
rounded_rectangle
Rounded Rectangle
Rounded rectangle detail.
snip_rectangle
Snip Rectangle
Snip rectangle detail.
triangle
Triangle
Triangle detail.
bracket
Bracket
Bracket detail.
brace
Brace
Brace detail.

Rounded Rectangle

Detail object used with basic.rounded_rectangle.

type
enum
Rounded rectangle type.
type
NORMALSINGLESAME_SIDEDIAGONAL

Snip Rectangle

Detail object used with basic.snip_rectangle.

type
enum
Snip rectangle type.
type
SNIP_SINGLESNIP_SAME_SIDESNIP_DIAGONAL

Triangle

Detail object used with basic.triangle.

type
enum
Triangle type.
type
ISOSCELESRIGHT_ANGLED

Bracket

Detail object used with basic.bracket.

type
enum
Bracket type.
type
DOUBLERIGHTLEFT

Brace

Detail object used with basic.brace.

type
enum
Brace type.
type
DOUBLERIGHTLEFT

Text Paragraph

Text paragraph schema.

id
string
Paragraph ID. Must be a UUID.
portions
Text Portion[]
Text portions. Each portion contains text content and optional style.
style
Paragraph Style
Paragraph style.

Text Portion

Text portion schema.

text
string
Text run content.
style
Portion Style
Portion style.

Portion Style

Character-level text styling.

font_name
Font Name
Font family.
size
float
Font size.
fontweight
enum
Selects one of the supported values.
fontweight
THINEXTRA_LIGHTLIGHTNORMALMEDIUMDEMI_BOLDBOLDHEAVYBLACK
italic
boolean
Italic text toggle.
underline
boolean
Underline text toggle.
strike
boolean
Strikethrough text toggle.
color
Color
Text color.

Font Name

Font name schema.

name
enum
Selects one of the supported values.
name
AbelAdaminaAguafina ScriptAlegreyaAlfa Slab OneAnticAntic DidoneAntic SlabAntonArapeyArchitects DaughterArchivoArchivo BlackArvoAveria Serif LibreBad ScriptBarlowBenthamBigshot OneBilbo Swash CapsBree SerifBubbler OneCabinCabin CondensedCabin SketchCaveatChivoComfortaaCookieCourier PrimeCoustardCrimson TextDancing ScriptDejaVu SansDidact GothicDoppio OneDosisDroid SansDroid SerifEconomicaExoFinger PaintFlamencoGabrielaGreat VibesIBM Plex MonoInterItalianaJockey OneJosefin SansJosefin SlabJuraJust Another HandKalamKaushan ScriptLatoLeague GothicLobsterLuckiest GuyMagraMarck ScriptMetrophobicMichromaMiltonianMolleMonotonMontezMontserratNiconneNixie OneNosiferNova CutNunitoOffice Code ProOld Standard TTOpen SansOreganoOSP DINOswaldOtama epPacificoParisiennePatua OnePermanent MarkerPhilosopherPlayballPlayfair DisplayPompierePoppinsPT SansQuandoQuestrialQuicksandQwigleyRacing Sans OneRalewayRobotoRochesterRock SaltRokkittRopa SansRubikSansationSatisfySawarabi GothicSchoolbellShort StackSignikaSource Code ProSource Sans ProSource Serif ProSpecial EliteSpicy RiceSquada OneSyncopateTekoTeXGyreAdventorTitillium WebTrade WindsUbuntuUnkemptUnnaVollkornYesteryearZoho Puvi

Color

Color schema.

Color Model Select one color model field.
rgb
RGB Color
RGB channel color.
hsb
HSB Color
HSB color.
hex
HEX Color
HEX literal color.

Paragraph Style

Paragraph style schema.

halign
enum
Selects one of the supported values.
halign
LEFTCENTERRIGHTJUSTIFY
spacing
Paragraph Spacing
Paragraph spacing.
level
int
Paragraph indent level.
portion_style
Portion Style
Default portion style for the paragraph.

Paragraph Spacing

Paragraph spacing schema.

line
float
Line spacing multiplier.
before
int
Space before paragraph.
after
int
Space after paragraph.

Text Box Properties

Text box properties schema.

valign
enum
Selects one of the supported values.
valign
MIDDLETOPBOTTOM
inset
Text Inset
Text padding.
para_style
Paragraph Style
Default paragraph style.
auto_fit
enum
Selects one of the supported values.
auto fit
NONETEXTSHAPE

Text Inset

Text inset schema.

left
float
Left text padding.
top
float
Top text padding.
right
float
Right text padding.
bottom
float
Bottom text padding.

Placeholder

Placeholder schema.

type
enum
Vani placeholder type. Use TXT for text placeholders, PICT for image placeholders, TABLE for table placeholders, or VIDEO for video placeholders.
type
TXTPICTTABLEVIDEO

Shape Properties

Shape properties schema.

layout
Layout
Position and size.
fills
Fill[]
Fill layers.
strokes
Stroke[]
Stroke layers.

Layout

Layout schema.

top
float
Top position (Y).
left
float
Left position (X).
width
float
Element width in pixels.
height
float
Element height in pixels.
rotate
int
Rotation angle in degrees.
fliph
boolean
Horizontal flip.
flipv
boolean
Vertical flip.

Fill

Fill schema.

Fill Type Select one fill type field.
solid
Solid Fill
Solid fill.
gradient
Gradient Fill
Gradient fill.
no_fill
object
No fill object.
alpha
float
Transparency ratio. Range: 0 to 1.

Solid Fill

Solid fill schema.

color
Color
Fill color.

Gradient Fill

Gradient fill schema.

type
enum
Gradient type.
type
LINEARRADIALANGULAR
stops
Gradient Stop[]
Gradient color stops. Minimum two stops are required.
linear
Linear Geometry
Geometry for LINEAR gradients.
radial_angular
Radial Angular Geometry
Geometry for RADIAL and ANGULAR gradients.

Gradient Stop

Gradient stop schema.

color
Color
Stop color.
position
float
Stop position. Range: 0 to 1.

Linear Geometry

Linear geometry schema.

start
Point
Gradient axis start point.
end
Point
Gradient axis end point.

Point

2D point with x and y coordinates.

x
float
X coordinate.
y
float
Y coordinate.

Radial Angular Geometry

Radial angular geometry schema.

center
Point
Gradient center point.
spread_x
float
Horizontal spread.
spread_y
float
Vertical spread.
rotation_angle
float
Rotation in degrees.
flip_horizontal
boolean
Mirror horizontally.
flip_vertical
boolean
Mirror vertically.

Stroke

Shape stroke schema.

type
enum
Stroke type. For no border, keep the type valid and set the stroke fill to no_fill.
type
SOLIDDASHSQUARE_DOT
width
float
Stroke width in pixels.
jointype
enum
Join type.
jointype
ROUNDBEVELMITER
captype
enum
Cap type.
captype
FLATCAPROUNDSQUARE
position
enum
Stroke position.
position
CENTERINSIDEOUTSIDE
fill
Stroke Fill
Stroke fill.

Stroke Fill

Stroke Fill schema.

Stroke Fill Type Select one stroke fill type field.
solid
Solid Fill
Solid stroke fill.
no_fill
object
No stroke fill. Use this for no border.
alpha
float
Stroke fill alpha ratio. Range: 0 to 1.

Block Arrow Shape

Use type to select the block-arrow family.

type
enum
Block arrow family.
type
SINGLECURVEDCALLOUTDOUBLEQUADLEFT_RIGHT_UPBENTU_TURNBENT_UPSTRIPED_RIGHTNOTCHED_RIGHTPENTAGON_ARROWCHEVRONLEFT_RIGHT_CALLOUTQUAD_CALLOUT
single_arrow
Single Arrow
Single arrow direction.
curved_arrow
Curved Arrow
Curved arrow direction.
arrow_callout
Arrow Callout
Arrow callout direction.
double_arrow
Double Arrow
Double arrow direction.

Single Arrow

Direction object used with block_arrow.single_arrow.

type
enum
Single arrow direction.
type
RIGHTLEFTTOPBOTTOM

Curved Arrow

Direction object used with block_arrow.curved_arrow.

type
enum
Curved arrow direction.
type
RIGHTLEFTTOPBOTTOM

Arrow Callout

Direction object used with block_arrow.arrow_callout.

type
enum
Arrow callout direction.
type
RIGHTLEFTTOPBOTTOM

Double Arrow

Direction object used with block_arrow.double_arrow.

type
enum
Double arrow direction.
type
UP_DOWNLEFT_RIGHTLEFT_UP

Flowchart Shape

Flowchart shape schema.

type
enum
Flowchart shape type.
type
PREDEFINED_PROCESSINTERNAL_STORAGEDOCUMENTPROCESSALTERNATE_PROCESSDECISIONDATAMULTI_DOCUMENTTERMINATORPREPARATIONMANUAL_INPUTMANUAL_OPERATIONCONNECTOROFFPAGE_CONNECTORPUNCHED_CARDPUNCHED_TAPESUMMING_JUNCTIONORCOLLATESORTEXTRACTMERGESTORED_DATADELAYSEQUENTIAL_ACCESS_STORAGEMAGNETIC_DISKDIRECT_ACCESS_STORAGEDISPLAY

Mathematical Symbol Shape

Mathematical symbol geometry selector.

type
enum
Mathematical symbol type.
type
PLUSMINUSMULTIPLYDIVIDEEQUALNOT_EQUAL

Star Shape

Star shape schema.

type
enum
Star family.
type
EXPLOSIONPOINTRIBBONSCROLLWAVE
point
Star Point
Star point detail.
ribbon
Star Ribbon
Ribbon detail.
scroll
Star Scroll
Scroll detail.
wave
Star Wave
Wave detail.

Star Point

Detail object used with star.point.

type
enum
Star point type.
type
FOUR_POINTFIVE_POINTSIX_POINTSEVEN_POINTEIGHT_POINTTEN_POINTTWELVE_POINTSIXTEEN_POINTTWENTY_FOUR_POINTTHIRTY_TWO_POINT

Star Ribbon

Detail object used with star.ribbon.

type
enum
Ribbon type.
type
UPDOWNCURVED_UPCURVED_DOWN

Star Scroll

Detail object used with star.scroll.

type
enum
Scroll type.
type
VERTICALHORIZONTAL

Star Wave

Detail object used with star.wave.

type
enum
Wave type.
type
SINGLEDOUBLE

Callout Shape

Callout shape schema.

type
enum
Callout shape type.
type
LINERECTANGLE_CALLOUTROUNDED_RECTANGLE_CALLOUTOVAL_CALLOUTCLOUD_CALLOUT

Custom Shape

Custom shape schema.

width
float
Custom shape width.
height
float
Custom shape height.
paths
Custom Path[]
Shape paths.

Custom Path

Custom path schema.

commands
Path Command[]
Ordered path command objects.

Path Command

Path Command schema.

Path Command Select one path command field.
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.

point
Point
Target point.

Cubic Path Command

Cubic path command schema.

control1
Point
First control point.
control2
Point
Second control point.
end
Point
End point.

Quadratic Path Command

Quadratic path command schema.

control
Point
Control point.
end
Point
End point.

Arc Path Command

Arc path command schema.

x_radius
float
X radius.
y_radius
float
Y radius.
start_angle
float
Start angle.
sweep_angle
float
Sweep angle.
end
Point
End point.

Smooth Cubic Path Command

Smooth cubic path command schema.

control2
Point
Second control point.
end
Point
End point.

Smooth Quadratic Path Command

Smooth quadratic path command schema.

end
Point
End point.

Connector Endpoint

Connector endpoint schema.

shape_id
string
Connected shape ID.
side
enum
Connection side.
side
NORTHEASTSOUTHWEST
point
Point
Custom attach point.
marker
enum
Marker type.
marker
NONEOPENBLOCKCLASSICDIAMONDOVAL

Connector Stroke

Connector stroke schema.

type
enum
Stroke type.
type
SOLIDDASHSQUARE_DOT
width
float
Stroke width in pixels.
jointype
enum
Join type.
jointype
ROUNDBEVELMITER
captype
enum
Cap type.
captype
FLATCAPROUNDSQUARE
position
enum
Stroke position.
position
CENTERINSIDEOUTSIDE
fill
Connector Stroke Fill
Connector stroke fill.

Connector Stroke Fill

Connector Stroke Fill schema.

solid
Solid Fill
Solid connector stroke fill.
alpha
float
Stroke fill alpha ratio. Range: 0 to 1.

RGB Color

RGB color schema.

red
int
Red channel. Range: 0–255.
green
int
Green channel. Range: 0–255.
blue
int
Blue channel. Range: 0–255.

HSB Color

HSB color schema.

hue
float
Hue. Range: 0–360.
saturation
float
Saturation. Range: 0–1.
brightness
float
Brightness. Range: 0–1.

HEX Color

Hex color literal.

value
string
Hex color literal.

Range Text Mutation

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

range
Text Range
Nested index range object.
operation
enum
What to do with the selected range.
operation
RANGE_TEXT_OPERATION_REPLACERANGE_TEXT_OPERATION_DELETE
replacement_text
string
New text to put in the selected range when the operation is RANGE_TEXT_OPERATION_REPLACE.

Text Range

Text range schema.

start_index
int
Where the range starts. This index is included.
end_index
int
Where the range ends. This index is not included.

Cursor Text Mutation

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

cursor_index
int
The text index where the cursor edit should happen.
operation
enum
What to do at the cursor.
operation
CURSOR_TEXT_OPERATION_INSERT_TEXTCURSOR_TEXT_OPERATION_INSERT_NEWLINECURSOR_TEXT_OPERATION_DELETE_NEWLINE
text
string
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.

operation
enum
What to do with the full text.
operation
ALL_TEXT_OPERATION_REPLACEALL_TEXT_OPERATION_DELETE
replacement_text
string
New full text when the operation is ALL_TEXT_OPERATION_REPLACE.

Frame

Frame schema.

meta
Frame Meta
Frame metadata.
type
enum
Selects one of the supported values.
type
A4A5A6A7SLIDE_LANDSCAPESLIDE_PORTRAITDEVICE_PHONEDEVICE_TABLETDEVICE_DESKTOPDEVICE_TVDEVICE_WATCHSM_TWITTER_POSTSM_TWITTER_HEADERSM_FB_POSTSM_FB_COVERSM_INSTAGRAM_POSTSM_INSTAGRAM_STORYSM_LINKEDIN_POSTSM_LINKEDIN_COVERCUSTOM
properties
Frame Properties
Frame visual properties.

Frame Meta

Frame metadata schema.

id
string
Frame ID. Must be a UUID.
name
string
Frame display name.

Frame Properties

Frame properties schema.

layout
Layout
Position and size.
fills
Fill[]
Fill layers.
strokes
Stroke[]
Stroke layers.