Help Doc Access Show

Schema Catalog

Reusable object definitions used by Zoho Show 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
Nested object that groups related basic settings for Shape.
block_arrow
Block Arrow Shape
Nested object that groups related block arrow settings for Shape.
flowchart
Flowchart Shape
Nested object that groups related flowchart settings for Shape.
mathematical_symbol
Mathematical Symbol Shape
Nested object that groups related mathematical symbol settings for Shape.
star
Star Shape
Nested object that groups related star settings for Shape.
callout
Callout Shape
Nested object that groups related callout settings for Shape.
custom
Custom Shape
Nested object that groups related custom settings for Shape.
text
Text
Shape text content. Paragraph update payloads include paragraph ids.
properties
Graphic Object Properties
Nested object that groups related properties settings for Shape.

Shape Insert

Shape payload used by insert requests. Choose exactly one geometry object: basic, block_arrow, flowchart, mathematical_symbol, star, callout, or custom. text and properties can be sent alongside the chosen geometry.

basic
Basic Shape
Nested object that groups related basic settings for Shape Insert.
text
Text Insert
Shape text content on insert. Send paragraphs with portions and optional paragraph style.
properties
Graphic Object Properties
Nested object that groups related properties settings for Shape Insert.
block_arrow
Block Arrow Shape
Nested object that groups related block arrow settings for Shape Insert.
flowchart
Flowchart Shape
Nested object that groups related flowchart settings for Shape Insert.
mathematical_symbol
Mathematical Symbol Shape
Nested object that groups related mathematical symbol settings for Shape Insert.
star
Star Shape
Nested object that groups related star settings for Shape Insert.
callout
Callout Shape
Nested object that groups related callout settings for Shape Insert.
custom
Custom Shape
Nested object that groups related custom settings for Shape Insert.

Basic Shape

Basic shape geometry. Some basic shape types accept an optional nested subtype object.

type
enum
Selects one of the supported values.
type
RECTANGLEROUNDED_RECTANGLESNIP_RECTANGLEROUND_SNIP_RECTANGLETRIANGLEOVALTRAPEZOIDPENTAGONHEXAGONDIAMONDPARALLELOGRAMHEPTAGONOCTAGONDECAGONPIECHORDTEARDROPFRAMEHALF_FRAMEL_SHAPEDIAGONAL_STRIPECROSSPLAQUECANCUBEBEVELDONUTNO_SYMBOLBLOCK_ARCFOLDED_CORNERSMILEYHEARTLIGHTNING_BOLTSUNMOONCLOUDARCBRACKETBRACECLOCK

Block Arrow Shape

Block arrow geometry. Use type to select the family, then send the matching nested subtype object where applicable.

type
enum
Selects one of the supported values.
type
SINGLECURVEDCALLOUTDOUBLEQUADLEFT_RIGHT_UPBENTU_TURNBENT_UPSTRIPED_RIGHTNOTCHED_RIGHTPENTAGON_ARROWCHEVRONLEFT_RIGHT_CALLOUTQUAD_CALLOUT

Flowchart Shape

Flowchart shape geometry.

type
enum
Selects one of the supported values.
type
PREDEFINED_PROCESSINTERNAL_STORAGEDOCUMENTPROCESSALTERNATE_PROCESSDECISIONDATAMULTI_DOCUMENTTERMINATORPREPARATIONMANUAL_INPUTMANUAL_OPERATIONCONNECTOROFFPAGE_CONNECTORPUNCHED_CARDPUNCHED_TAPESUMMING_JUNCTIONORCOLLATESORTEXTRACTMERGESTORED_DATADELAYSEQUENTIAL_ACCESS_STORAGEMAGNETIC_DISKDIRECT_ACCESS_STORAGEDISPLAY

Mathematical Symbol Shape

Mathematical symbol shape schema.

type
enum
Selects one of the supported values.
type
PLUSMINUSMULTIPLYDIVIDEEQUALNOT_EQUAL

Star Shape

Star shape geometry. Use type to select the family, then send the matching nested subtype object where applicable.

type
enum
Selects one of the supported values.
type
EXPLOSIONPOINTRIBBONSCROLLWAVE

Callout Shape

Callout shape schema.

type
enum
Selects one of the supported values.
type
LINERECTANGLE_CALLOUTROUNDED_RECTANGLE_CALLOUTOVAL_CALLOUTCLOUD_CALLOUT

Custom Shape

Path-based custom shape. Each path contains ordered drawing commands.

width
float
Viewbox width in px. Must be greater than 0.
height
float
Viewbox height in px. Must be greater than 0.
paths
Path[]
List of paths entries for Custom Shape. Preserve the documented item structure for each entry.

Path

commands
Point[]
Ordered path command objects. In each command object, choose exactly one of: move_to, line_to, cubic_to, quadratic_to, arc_to, smooth_cubic_to, smooth_quadratic_to, close_path. Point fields use .

Placeholder

type
enum
Selects one of the supported values.
type
TITLESUBTITLECONTENTIMAGECHARTTABLE

Graphic Object Properties

Visual property set shared by shapes, tables, and other graphic objects.

layout
Layout
Nested object that groups related layout settings for Graphic Object Properties.
fills
Fill[]
List of fills entries for Graphic Object Properties. Preserve the documented item structure for each entry.
strokes
Stroke[]
List of strokes entries for Graphic Object Properties. Preserve the documented item structure for each entry.
placeholder
Placeholder
Placeholder binding, marking this object as a layout placeholder slot (e.g. a title or content region).

Placeholder

Marks a graphic object as bound to a placeholder slot (e.g. the title or content region inherited from a layout/master). graphic_object_properties.proto field 10.

type
string
PlaceholderType enum. Allowed values: TITLE, SUBTITLE, CONTENT, IMAGE, CHART, TABLE. Required whenever the placeholder object is present.

Layout

Layout schema.

left
float
Canvas coordinate in points. It positions the Layout relative to its parent slide, layout, or object.
top
float
Canvas coordinate in points. It positions the Layout relative to its parent slide, layout, or object.
width
float
Width in px. Range: >= 0.
height
float
Height in px. Range: >= 0.
rotate
int
Rotation in degrees. Range: -360 to 360.
fliph
boolean
Set to true to flip on the horizontal axis.
flipv
boolean
Set to true to flip on the vertical axis.

Point

2D point with x and y coordinates.

x
float
Canvas coordinate in points. It positions the Point relative to its parent slide, layout, or object.
y
float
Canvas coordinate in points. It positions the Point relative to its parent slide, layout, or object.

Fill

Fill schema.

Fill Type Select one fill type field.
no_fill
object
Empty object {} for no fill.
solid
Solid Fill
Nested object that groups related solid settings for Fill.
gradient
Gradient Fill
Nested object that groups related gradient settings for Fill.
alpha
float
Alpha transparency ratio. Range: 0 (opaque) to 1 (transparent).

Gradient Fill

Gradient fill schema.

type
enum
Gradient type.
type
LINEARRADIALANGULARRECTANGULARPATH
stops
Gradient Stop[]
Gradient color stops. Minimum two stops for a gradient.
linear
Point
Geometry for LINEAR gradients. Contains start and end objects in normalized object space.
radial_angular
Radial Angular Geometry
Geometry for radial-style gradients.

Radial Angular Geometry

Geometry settings used by radial-style gradients.

center
Point
Nested point object used by Radial Angular Geometry. Expand it to see the fields you can send here.
spread_x
float
Horizontal spread. Range: >= 0.
spread_y
float
Vertical spread. Range: >= 0.
rotation_angle
float
float field used by Radial Angular Geometry. Send it when you need to control rotation angle.
flip_horizontal
boolean
Boolean toggle for this Radial Angular Geometry behavior. Send true to enable it, false to disable it.
flip_vertical
boolean
Boolean toggle for this Radial Angular Geometry behavior. Send true to enable it, false to disable it.

Gradient Stop

Single color stop inside a gradient fill.

color
Color
Color for this Gradient Stop. Send one of the color objects — RGB Color, HSB Color, or HEX Color.
position
float
Stop position ratio. Range: 0 to 1.

Stroke

type
enum
Selects one of the supported values.
type
SOLIDDASHSQUARE_DOT
width
float
Stroke width in px. Range: >= 0.
jointype
enum
Selects one of the supported values.
jointype
ROUNDBEVELMITER
fill
Stroke Fill
Nested object that groups related fill settings for Stroke.
captype
enum
Selects one of the supported values.
captype
FLATCAPROUNDSQUARE
position
enum
Selects one of the supported values.
position
CENTERINSIDEOUTSIDE

Stroke Fill

Stroke Fill schema.

Stroke Fill Type Select one stroke fill type field.
solid
Solid Fill
Nested object that groups related solid settings for Stroke Fill.
no_fill
object
Empty object {} for no stroke fill.
alpha
float
Stroke fill alpha ratio. Range: 0 to 1.

Connector

Connector schema.

type
enum
Connector type.
type
LINEELBOWCURVE
connected
Connected Shape
The two shapes this connector links.
stroke
Connector Stroke
Nested object that groups related stroke settings for Connector.

Connected Shape

The two endpoints a connector links together.

first
Connector Endpoint
Nested connector endpoint object used by Connected Shape. Expand it to see the fields you can send here.
second
Connector Endpoint
Nested connector endpoint object used by Connected Shape. Expand it to see the fields you can send here.

Connector Stroke

Connector stroke schema.

type
enum
Selects one of the supported values.
type
SOLIDDASHSQUARE_DOT
width
float
Stroke width in px. Range: >= 0.
jointype
enum
Selects one of the supported values.
jointype
ROUNDBEVELMITER
captype
enum
Selects one of the supported values.
captype
FLATCAPROUNDSQUARE
position
enum
Selects one of the supported values.
position
CENTERINSIDEOUTSIDE
fill
Connector Stroke Fill
Nested object that groups related fill settings for Connector Stroke.

Connector Stroke Fill

Connector Stroke Fill schema.

solid
Solid Fill
Nested object that groups related solid settings for Connector Stroke Fill.
alpha
float
Stroke fill alpha ratio. Range: 0 to 1.

Connector Endpoint

A connector endpoint either attaches to a shape side or sits at a free point.

shape_id
string
Unique identifier for the Connector Endpoint. Use the ID returned by Show APIs.
side
enum
Side of the connected shape to attach to.
side
NORTHEASTSOUTHWEST
point
Point
Attach point in local shape coordinates.
marker
enum
Marker at this endpoint.
marker
NONEOPENBLOCKCLASSICDIAMONDOVAL

Text Insert

Text payload used by insert templates. Send paragraphs with portions and optional paragraph style.

properties
Text Properties
Nested object that groups related properties settings for Text Insert.
paragraphs
Text Paragraph Insert[]
List of paragraphs entries for Text Insert. Preserve the documented item structure for each entry.

Text

Text payload used by non-insert operations. Paragraph ids are required when patching existing paragraphs.

properties
Text Properties
Nested object that groups related properties settings for Text.
paragraphs
Text Paragraph[]
List of paragraphs entries for Text. Preserve the documented item structure for each entry.

Text Paragraph Insert

Paragraph payload used on insert. Send portions and optional paragraph style.

portions
Text Portion[]
List of portions entries for Text Paragraph Insert. Preserve the documented item structure for each entry.
style
Paragraph Style
Nested object that groups related style settings for Text Paragraph Insert.

Text Paragraph

Paragraph payload used by update requests. Send id to identify the paragraph.

id
string
Unique identifier for the Text Paragraph. Use the ID returned by Show APIs.
portions
Text Portion[]
Ordered list of text portions. Each portion contains text content and optional style.
style
Paragraph Style
Nested object that groups related style settings for Text Paragraph.

Text Portion

Text run payload with text content and optional style.

text
string
string field used by Text Portion. Send it when you need to control text.
style
Portion Style
Nested object that groups related style settings for Text Portion.

Text Properties

valign
enum
Vertical alignment of all paragraphs in the text box.
valign
MIDDLETOPBOTTOM
inset
object
Internal text box margins in px. Fields: left, top, right, bottom (each >= 0).
para_style
Paragraph Style
Nested object that groups related para style settings for Text Properties.
auto_fit
enum
Selects one of the supported values.
auto fit
NONETEXTSHAPE

Group Shape

Group object payload sent in the group_shape field of an element.

objects
Graphic Object[]
Contained graphic objects. Each item can be a shape, connector, nested group, table, or picture.
layout
Layout
Nested object that groups related layout settings for Group Shape.

Group Shape Insert

Group object payload sent in the group_shape field of insert requests.

objects
Graphic Object Insert[]
Nested objects to include in the group. Each item can be a shape, connector, nested group, table, or picture.
layout
Layout
Nested object that groups related layout settings for Group Shape Insert.

Slide Group Shape

Group object payload sent in the group_shape field of slide graphic objects.

objects
Slide Group Shape Child[]
Nested slide objects. Each item can be a shape, connector, or nested group. Tables and pictures are not accepted inside slide group shapes.
layout
Layout
Nested object that groups related layout settings for Slide Group Shape.

Slide Group Shape Child

Slide Group Shape Child schema.

Object Type Select one object type field.
shape
Shape
Nested shape object used by Slide Group Shape Child. Expand it to see the fields you can send here.
connector
Connector
Nested object that groups related connector settings for Slide Group Shape Child.
group_shape
Slide Group Shape
Nested group payload with its own objects and layout.
id
string
Unique identifier for the Slide Group Shape Child. Use the ID returned by Show APIs.
name
string
Display name of the graphic object.

Slide Group Shape Insert

Group object payload sent in the group_shape field of slide insert requests.

objects
Slide Group Shape Child Insert[]
Nested slide objects. Each item can be a shape, connector, or nested group. Tables and pictures are not accepted inside slide group shapes.
layout
Layout
Nested object that groups related layout settings for Slide Group Shape Insert.

Slide Group Shape Child Insert

Slide Group Shape Child Insert schema.

Object Type Select one object type field.
shape
Shape Insert
Nested shape insert object used by Slide Group Shape Child Insert. Expand it to see the fields you can send here.
connector
Connector
Nested object that groups related connector settings for Slide Group Shape Child Insert.
group_shape
Slide Group Shape Insert
Nested group payload with its own objects and layout.
name
string
Display name of the graphic object.

Asset Ref

Reference to a reusable asset (e.g. a table style or a media file). The asset is always linked, never inlined.

local_id
string
Id of an asset within this document. System styles resolve by a well-known local id (e.g. table.system.default).

Table

Table object payload sent in the table field of an element.

layout
Layout
Nested object that groups related layout settings for Table.
style_ref
Asset Ref
Reference to a table style asset. System styles resolve by local id (e.g. table.system.default).
style
Table Style
Inline table style. Overrides style_ref.
columns
Table Column[]
List of columns entries for Table. Preserve the documented item structure for each entry.
rows
Table Row[]
Nested table row object used by Table. Expand it to see the fields you can send here.

Table Insert

Table object payload used in insert requests.

layout
Layout
Nested layout object used by Table Insert. Expand it to see the fields you can send here.
style_ref
Asset Ref
Reference to a table style asset. System styles resolve by local id (e.g. table.system.default).
style
Table Style
Inline table style. Overrides style_ref.
columns
Table Column[]
Nested table column object used by Table Insert. Expand it to see the fields you can send here.
rows
Table Row Insert[]
Nested table row insert object used by Table Insert. Expand it to see the fields you can send here.

Table Column

width
float
Column width in px. Range: >= 0.

Table Row

height
float
Row height in px. Range: >= 0.
cells
Table Cell[]
Nested table cell object used by Table Row. Expand it to see the fields you can send here.

Table Row Insert

height
float
Row height in px. Range: >= 0.
cells
Table Cell Insert[]
Nested table cell insert object used by Table Row Insert. Expand it to see the fields you can send here.

Table Cell

text
Text
Nested text object used by Table Cell. Expand it to see the fields you can send here.
merge_rows
int
Number of rows merged from this cell. Range: >= 0.
merge_cols
int
Number of columns merged from this cell. Range: >= 0.
is_merged
boolean
Boolean toggle for this Table Cell behavior. Send true to enable it, false to disable it.
fill
Fill
Nested object that groups related fill settings for Table Cell.
border
Table Cell Border
Nested object that groups related border settings for Table Cell.

Table Cell Insert

text
Text Insert
Cell text content on insert. Send paragraphs with portions and optional paragraph style.
merge_rows
int
Number of rows merged from this cell. Range: >= 0.
merge_cols
int
Number of columns merged from this cell. Range: >= 0.
is_merged
boolean
Boolean toggle for this Table Cell Insert behavior. Send true to enable it, false to disable it.
fill
Fill
Nested fill object used by Table Cell Insert. Expand it to see the fields you can send here.
border
Table Cell Border
Nested table cell border object used by Table Cell Insert. Expand it to see the fields you can send here.

Table Cell Border

top
Stroke
Canvas coordinate in points. It positions the Table Cell Border relative to its parent slide, layout, or object.
right
Stroke
Nested object that groups related right settings for Table Cell Border.
bottom
Stroke
Nested object that groups related bottom settings for Table Cell Border.
left
Stroke
Canvas coordinate in points. It positions the Table Cell Border relative to its parent slide, layout, or object.
all
Stroke
Nested object that groups related all settings for Table Cell Border.

Table Style

first_row
boolean
Enable/disable first row formatting.
last_row
boolean
Enable/disable last row formatting.
first_col
boolean
Enable/disable first column formatting.
last_col
boolean
Enable/disable last column formatting.
band_row
boolean
Boolean toggle for this Table Style behavior. Send true to enable it, false to disable it.
band_col
boolean
Boolean toggle for this Table Style behavior. Send true to enable it, false to disable it.
fill
Fill
Nested object that groups related fill settings for Table Style.
stroke
Stroke
Nested object that groups related stroke settings for Table Style.

Table Element

Table-specific object allowed inside the elements[] array for Tables insert APIs. Do not send an id field in insert requests.

name
string
Human-readable name shown in the editor or API responses. Use it to label the Table Element for users.
table
Table Insert
Table payload with layout, style, columns, and rows.

Graphic Object Insert

Graphic Object Insert schema.

Object Type Select one object type field.
shape
Shape Insert
Nested shape insert object used by Graphic Object Insert. Expand it to see the fields you can send here.
connector
Connector
Nested object that groups related connector settings for Graphic Object Insert.
group_shape
Group Shape Insert
Group payload with nested objects and layout.
table
Table Insert
Table payload with layout, style, columns, and rows.
picture
Picture
Nested picture object used by Graphic Object Insert. Expand it to see the fields you can send here.
name
string
Display name of the graphic object.

Slide Graphic Object Insert

Slide Graphic Object Insert schema.

Object Type Select one object type field.
shape
Shape Insert
Nested shape insert object used by Slide Graphic Object Insert. Expand it to see the fields you can send here.
connector
Connector
Nested object that groups related connector settings for Slide Graphic Object Insert.
group_shape
Slide Group Shape Insert
Group payload with nested slide objects and layout.
table
Table Insert
Table payload with layout, style, columns, and rows.
name
string
Display name of the graphic object.

Graphic Object

Graphic Object schema.

Object Type Select one object type field.
shape
Shape
Nested shape object used by Graphic Object. Expand it to see the fields you can send here.
connector
Connector
Nested object that groups related connector settings for Graphic Object.
group_shape
Group Shape
Group payload with nested objects and layout.
table
Table
Nested object that groups related table settings for Graphic Object.
picture
Picture
Nested picture object used by Graphic Object. Expand it to see the fields you can send here.
id
string
Unique identifier for the Graphic Object. Use the ID returned by Show APIs.
name
string
Display name of the graphic object.

Slide Graphic Object

Slide Graphic Object schema.

Object Type Select one object type field.
shape
Shape
Nested object that groups related shape settings for Slide Graphic Object.
connector
Connector
Nested object that groups related connector settings for Slide Graphic Object.
group_shape
Slide Group Shape
Group payload with nested slide objects and layout.
table
Table
Nested object that groups related table settings for Slide Graphic Object.
id
string
Unique identifier for the Slide Graphic Object. Use the ID returned by Show APIs.
name
string
Display name of the graphic object.

Picture

Picture payload used for picture placement.

media
Asset Ref
Reference to the related media asset.
properties
Graphic Object Properties
Picture properties, including properties.layout.
filters
Picture Filters
Nested picture filters object used by Picture. Expand it to see the fields you can send here.

Picture Filters

brightness
float
float field used by Picture Filters. Send it when you need to control brightness.
contrast
float
float field used by Picture Filters. Send it when you need to control contrast.

Slide

Slide object allowed inside the slides[] array for Insert Slides. Do not send an id field in insert requests.

name
string
Label shown for the slide in API responses and editor sidebars. Use a concise name that helps users identify the slide.
layout_id
string
Layout template to apply to the new slide. If omitted, the slide uses the TITLE_SLIDE layout by default.
layout_name
string
Layout template name to apply to the new slide. When both layout_name and layout_id are sent, layout_name takes precedence.
orientation
enum
Slide page orientation. Use LANDSCAPE for wide slides or PORTRAIT for vertical slides. If omitted, LANDSCAPE is applied by default.
orientation
LANDSCAPEPORTRAIT
graphic_objects
Slide Graphic Object Insert[]
Objects placed on the slide, in drawing order. Each item can be a shape, connector, group, or table. Pictures are not accepted in this field.

Slide Insertion Target

Destination position used by slide reorder and duplicate requests.

insert_index
int
Zero-based position in the presentation.

Master Layout

Master Layout object allowed inside the layouts[] array for Insert Layouts. Do not send an id field in insert requests. This is a slide template owned by a master, not the positioning layout used by shapes and other objects.

name
string
Human-readable name shown in the editor or API responses. Use it to label the Master Layout for users.
layout
Slide Layout
Nested object that groups related layout settings for Master Layout.
graphic_objects
Graphic Object Insert[]
Placeholder and guide objects on the layout.

Slide Layout

Slide Layout schema.

Template Select one template field.
titleSubTitle
Layout Variant Wrapper
Title + subtitle template. stack.type: STACK_VERTICAL_TITLE_SUBTITLE, STACK_VERTICAL_SUBTITLE_TITLE, STACK_HORIZONTAL_TITLE_SUBTITLE, STACK_HORIZONTAL_SUBTITLE_TITLE.
titleContent
Layout Variant Wrapper
Title + content template. stack.type: STACK_VERTICAL_TITLE_CONTENT, STACK_VERTICAL_CONTENT_TITLE, STACK_HORIZONTAL_TITLE_CONTENT, STACK_HORIZONTAL_CONTENT_TITLE.
titleImage
Layout Variant Wrapper
Title + image template. stack.type: STACK_VERTICAL_TITLE_IMAGE, STACK_VERTICAL_IMAGE_TITLE, STACK_HORIZONTAL_TITLE_IMAGE, STACK_HORIZONTAL_IMAGE_TITLE.
titleSubTitleImage
Layout Variant Wrapper
Title + subtitle + image template. The arrangement can use the nested outer/inner/order fields.
titleContentImageCaption
Layout Variant Wrapper
Title + content + image with caption template.
titleTwoContent
Layout Variant Wrapper
Title + two content blocks template.
titleTwoContentImage
Layout Variant Wrapper
Title + two content + image template.
titleTwoContentTwoImage
Layout Variant Wrapper
Title + two content + two image template.
comparison
Layout Variant Wrapper
Nested layout variant wrapper object used by Slide Layout. Expand it to see the fields you can send here.
titleThreeContent
Layout Variant Wrapper
Title + three content blocks template.
titleThreeContentImage
Layout Variant Wrapper
Title + three content + image template.
titleThreeContentThreeImage
Layout Variant Wrapper
Title + three content + three image template.
titleFourContent
Layout Variant Wrapper
Title + four content blocks template.
titleOnly
object
Title-only template. Empty object {}.
blank
object
Blank template. Empty object {}.

Layout Variant Wrapper

Arrangement wrapper for a slide-layout template. Send exactly one of stack, split, or grid — each is a Layout Variant. stack is the arrangement the layout engine builds from; split and grid are defined by the request contract.

stack
Layout Variant
Nested layout variant object used by Layout Variant Wrapper. Expand it to see the fields you can send here.
split
Layout Variant
Nested layout variant object used by Layout Variant Wrapper. Expand it to see the fields you can send here.
grid
Layout Variant
Nested layout variant object used by Layout Variant Wrapper. Expand it to see the fields you can send here.

Layout Variant

One arrangement inside a Layout Variant Wrapper. type selects the arrangement; outer/inner/order refine composite templates (such as title + subtitle + image).

type
string
Arrangement type for this template (for example STACK_VERTICAL_TITLE_CONTENT). Use the values listed on the template key in Slide Layout.
outer
string
Outer arrangement for composite templates.
inner
string
Inner arrangement for composite templates.
order
string
string field used by Layout Variant. Send it when you need to control order.

Flowchart Payload

Request body for Create Flowchart. Send payload with the structured graph data and optional absolute_bounds for placement.

payload
Flowchart Spec
Nested object that groups related payload settings for Flowchart Payload.
absolute_bounds
Absolute Bounds
Nested object that groups related absolute bounds settings for Flowchart Payload.

Flowchart Spec

Structured graph data inside the payload field. The server lays out the nodes and connects them per the edges.

title
string
Title/hint for the created diagram. Maximum length: 1000.
layout_direction
enum
Selects one of the supported values.
layout direction
TOP_DOWNLEFT_RIGHT
max_depth
int
Maximum traversal depth for generated layout.
nodes
Flowchart Node[]
List of nodes entries for Flowchart Spec. Preserve the documented item structure for each entry.
edges
Flowchart Edge[]
List of edges entries for Flowchart Spec. Preserve the documented item structure for each entry.

Flowchart Node

node_id
string
Stable client-provided node id, unique within the request. Referenced by edges.
text
string
Primary label/content for the node.
preferred_shape
enum
Preferred flowchart symbol.
preferred shape
PREDEFINED_PROCESSINTERNAL_STORAGEDOCUMENTPROCESSALTERNATE_PROCESSDECISIONDATAMULTI_DOCUMENTTERMINATORPREPARATIONMANUAL_INPUTMANUAL_OPERATIONCONNECTOROFFPAGE_CONNECTORPUNCHED_CARDPUNCHED_TAPESUMMING_JUNCTIONORCOLLATESORTEXTRACTMERGESTORED_DATADELAYSEQUENTIAL_ACCESS_STORAGEMAGNETIC_DISKDIRECT_ACCESS_STORAGEDISPLAY

Flowchart Edge

from_node_id
string
Unique identifier for the Flowchart Edge. Use the ID returned by Show APIs.
to_node_id
string
Unique identifier for the Flowchart Edge. Use the ID returned by Show APIs.
label
string
string field used by Flowchart Edge. Send it when you need to control label.
connector_type
enum
Connector style.
connector type
LINEELBOWCURVE
start_marker
enum
Start marker.
start marker
DEF_MARKER_TYPENONEOPENBLOCKCLASSICDIAMONDOVAL
end_marker
enum
End marker.
end marker
DEF_MARKER_TYPENONEOPENBLOCKCLASSICDIAMONDOVAL

Absolute Bounds

Bounding box for Create Flowchart placement.

x
float
Canvas coordinate in points. It positions the Absolute Bounds relative to its parent slide, layout, or object.
y
float
Canvas coordinate in points. It positions the Absolute Bounds relative to its parent slide, layout, or object.
width
float
Size in points. Must be positive and should fit inside the target slide or parent object.
height
float
Size in points. Must be positive and should fit inside the target slide or parent object.

Media Upload Payload

Media APIs (Pictures, Videos, Audios) use multipart/form-data. Send the media file part plus an optional JSON payload part for placement.

file
file
The media file part (the image, video, or audio file).
thumbnail
file
Videos only. A thumbnail image file part. Required for video upload.
shapePayload
Show SDK Media Proto
Pictures only. Optional JSON form-data part using .
proto
Show SDK Media Proto
Videos and Audios. Optional JSON form-data part using .

Show SDK Media Proto

JSON form-data field for multipart media upload endpoints. Use it for placement details such as layout bounds.

picture
Picture
Picture bounds carrier, typically picture.properties.layout.
shape
Shape
Shape bounds carrier, typically shape.properties.layout; used for video/audio placement.
properties
Graphic Object Properties
Alternative top-level bounds carrier, usually properties.layout.

Picture Media Proto

Picture-specific payload for the shapePayload multipart field.

properties
Graphic Object Properties
Alternative top-level bounds carrier, usually properties.layout.

Shape Media Proto

Video/audio-specific payload for the proto multipart field.

properties
Graphic Object Properties
Alternative top-level bounds carrier, usually properties.layout.

Text Edit

Text edit payload used by Show SDK text edit APIs. Use mutations to change text content and styles to change text formatting.

mutations
Text Mutation[]
List of mutations entries for Text Edit. Preserve the documented item structure for each entry.
styles
Text Style Entry[]
List of styles entries for Text Edit. Preserve the documented item structure for each entry.

Text Mutation

Text Mutation schema.

Edit Target Select one edit target field.
range
Range Text Mutation
Nested object that groups related range settings for Text Mutation.
cursor
Cursor Text Mutation
Nested object that groups related cursor settings for Text Mutation.
all_text
All Text Mutation
Nested object that groups related all text settings for Text Mutation.

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.

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.

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.

Portion Style

Character-level text styling.

font_name
Font Name
Nested font name object used by Portion Style. Expand it to see the fields you can send here.
size
float
float field used by Portion Style. Send it when you need to control size.
fontweight
enum
Selects one of the supported values.
fontweight
THINEXTRA_LIGHTLIGHTNORMALMEDIUMDEMI_BOLDBOLDHEAVYBLACK
italic
boolean
Boolean toggle for this Portion Style behavior. Send true to enable it, false to disable it.
underline
boolean
Boolean toggle for this Portion Style behavior. Send true to enable it, false to disable it.
strike
boolean
Boolean toggle for this Portion Style behavior. Send true to enable it, false to disable it.
color
Color
Color for this Portion Style. Send one of the color objects — RGB Color, HSB Color, or HEX Color.

Paragraph Style

Paragraph style schema.

halign
enum
Selects one of the supported values.
halign
LEFTCENTERRIGHTJUSTIFY
line
float
Inside spacing. Line spacing multiplier.
before
int
Inside spacing. Space before paragraph in pixels.
after
int
Inside spacing. Space after paragraph in pixels.
level
int
int field used by Paragraph Style. Send it when you need to control level.

Font Name

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
style
string
string field used by Font Name. Send it when you need to control style.

Color

Color schema.

Color Model Select one color model field.
rgb
RGB Color
Nested rgb color object used by Color. Expand it to see the fields you can send here.
hsb
HSB Color
Nested hsb color object used by Color. Expand it to see the fields you can send here.
hex
HEX Color
Nested hex color object used by Color. Expand it to see the fields you can send here.

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 component in degrees. Range: 0–360.
saturation
float
Saturation component. Range: 0–1.
brightness
float
Brightness component. Range: 0–1.

HEX Color

Hex color literal.

value
string
string field used by HEX Color. Send it when you need to control value.

Text Style

Text style payload used by Show SDK text style APIs. Contains styles array entries that select a target and apply portion/paragraph style.

styles
Text Style Entry[]
List of styles entries for Text Style. Preserve the documented item structure for each entry.

Table Cell Text

Payload for setting text in a table cell.

row_index
int
Zero-based row index of the target cell.
col_index
int
Zero-based column index of the target cell.
text
string
string field used by Table Cell Text. Send it when you need to control text.