Raw schema
{
"type": "object",
"properties": {
"id": {
"type": "string",
"description": "Template id from list_templates."
},
"name": {
"description": "New template name.",
"type": "string"
},
"theme_id": {
"description": "New theme: a catalog theme id or custom:<uuid>.",
"type": "string"
},
"palette": {
"description": "The template's deck palette: up to 64 entries [{ \"name\": \"Brand red\", \"color\": \"#c8102e\" }]. Names are 1-40 letters, digits, spaces, \"_\" or \"-\", unique (ignoring case). Elements point at an entry with \"palette:<name>\". Sending palette replaces the whole list; null or [] removes it. Leave it out to keep it as it is.",
"anyOf": [
{
"type": "array",
"items": {
"type": "object",
"properties": {
"name": {
"type": "string"
},
"color": {
"type": "string"
}
},
"required": [
"name",
"color"
],
"additionalProperties": {}
}
},
{
"type": "null"
}
]
},
"slides": {
"description": "Replaces all slides of the template.",
"minItems": 1,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "The slide's id from get_template. Keep it when you resend a slide; leave it out for a new slide and the server assigns one.",
"type": "string"
},
"layout": {
"type": "string",
"description": "Layout id from list_layouts or suggest_deck."
},
"slots": {
"description": "Slot id to text. Ids and their max_chars come from get_layout.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"objects": {
"description": "Images and text boxes laid over the slide, in 1920x1080 pixels. Resend the objects you got from get_template or they are removed. At most 50 per slide.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"description": "\"image\", \"text\" or \"shape\"."
},
"shape": {
"description": "For type \"shape\": \"rect\", \"roundRect\", \"ellipse\", \"line\" or \"arrow\".",
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"w": {
"type": "number"
},
"h": {
"type": "number"
},
"rotate": {
"type": "number"
},
"z": {
"type": "number",
"description": "Stacking order; larger is in front. Each layer (see behind) is ordered on its own."
},
"behind": {
"description": "true: drawn behind the layout's own elements, on top of the slide background. Absent or false: in front of the layout.",
"type": "boolean"
},
"group": {
"description": "Objects with the same group id move and copy together in the web editor; keep it when you resend.",
"type": "string"
},
"locked": {
"description": "true: the user locked it on the web; keep it when you resend.",
"type": "boolean"
},
"asset": {
"description": "For type \"image\": the id of an image in the user's media library.",
"type": "string"
},
"alt": {
"description": "For type \"image\": a short description of the picture for screen readers (up to 300 characters).",
"type": "string"
},
"text": {
"description": "For type \"text\", and a box shape's inner text.",
"type": "string"
},
"runs": {
"description": "For type \"text\". Formatting of part of the text: [{ start, end, bold?, italic?, underline?, color?, link? }]. start and end are UTF-16 offsets into the text (JavaScript string indices: a Korean syllable counts 1, an emoji outside the basic plane 2), end exclusive, start < end. bold, italic, underline are true or false (false undoes a look the whole text has); color takes the colour forms below; link is kept for a later version and not drawn yet. The text itself stays plain. Ranges must fit the text, else the call fails with invalid_input. Shown in the editor, the PPTX (one text run per piece) and the HTML export. Changing the text without sending runs moves the stored runs with it (text before a range shifts it; a range whose characters are all deleted is dropped); send runs with the text to set them yourself, null (update_objects) or [] to remove them. Fields you do not know on a run are kept.",
"type": "array",
"items": {
"type": "object",
"properties": {
"start": {
"type": "number"
},
"end": {
"type": "number"
}
},
"required": [
"start",
"end"
],
"additionalProperties": {}
}
},
"style": {
"description": "For type \"text\" and \"shape\". Look fields (all optional; send null to take one away and go back to the default): text: size (8-400 px; in an override entry it is called fontSize), weight (400 or 700), italic, underline, strike (true/false), align (\"left\", \"center\", \"right\"), lineHeight (multiple of the size, 0.5-4), vAlign (\"top\", \"middle\", \"bottom\"; text boxes only), color. box: fill (a colour or \"none\"), fillOpacity (0-1), borderColor, borderWidth (0-40 px), radius (0-540 px), shadow (\"none\", \"sm\", \"md\", \"lg\"). line (strokes of a drawn line or icon): lineColor, lineWidth (0.5-40 px), dash (\"solid\", \"dash\", \"dot\"; also the border's style). A colour is one of: a theme colour token (ink, ink-soft, ink-muted, ink-on-dark, accent, accent-soft, accent-bg, bg, bg-alt, bg-inverse, border, border-strong, success, warning, danger), which follows the theme; \"palette:<name>\" for an entry of the template's deck palette, which follows that entry; or a direct colour \"#rrggbb\" (no alpha; use fillOpacity for a see-through fill). Palette and direct colours stay when the theme changes, also with a custom theme. Some layout elements are drawn as a picture in the PPTX; colours stored for them are ignored on every output.",
"type": "object",
"properties": {
"size": {
"type": "number"
},
"weight": {
"type": "number"
},
"align": {
"type": "string"
},
"color": {
"description": "A colour is one of: a theme colour token (ink, ink-soft, ink-muted, ink-on-dark, accent, accent-soft, accent-bg, bg, bg-alt, bg-inverse, border, border-strong, success, warning, danger), which follows the theme; \"palette:<name>\" for an entry of the template's deck palette, which follows that entry; or a direct colour \"#rrggbb\" (no alpha; use fillOpacity for a see-through fill). Palette and direct colours stay when the theme changes, also with a custom theme.",
"type": "string"
}
},
"additionalProperties": {}
}
},
"required": [
"type",
"x",
"y",
"w",
"h",
"z"
],
"additionalProperties": {}
}
},
"overrides": {
"description": "Changes to the layout's own elements, by element key: { \"top-accent-bar\": { \"deleted\": true }, \"title\": { \"x\": 40, \"y\": 62, \"color\": \"#c8102e\", \"italic\": true } }. Only the values that changed are given; x, y, w, h are pixels on the 1920x1080 slide and the rest stays as the layout draws it. Look fields (colour, fill, border, line spacing...) sit in the same entry; see the entry schema. Resend the overrides you got from get_template or they are removed. Requires Pro.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "object",
"properties": {
"deleted": {
"description": "true: the element is not drawn on this slide (not in the export either).",
"type": "boolean"
},
"locked": {
"description": "true: the user locked the element on the web (no effect on the look or the export); keep it when you resend.",
"type": "boolean"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"w": {
"type": "number"
},
"h": {
"type": "number"
},
"fontSize": {
"description": "Text size in px, 8 to 400.",
"type": "number"
},
"color": {
"description": "A colour is one of: a theme colour token (ink, ink-soft, ink-muted, ink-on-dark, accent, accent-soft, accent-bg, bg, bg-alt, bg-inverse, border, border-strong, success, warning, danger), which follows the theme; \"palette:<name>\" for an entry of the template's deck palette, which follows that entry; or a direct colour \"#rrggbb\" (no alpha; use fillOpacity for a see-through fill). Palette and direct colours stay when the theme changes, also with a custom theme.",
"type": "string"
},
"fill": {
"description": "Box fill: a colour, or \"none\".",
"type": "string"
},
"runs": {
"description": "For a text slot element. Formatting of part of the text: [{ start, end, bold?, italic?, underline?, color?, link? }]. start and end are UTF-16 offsets into the text (JavaScript string indices: a Korean syllable counts 1, an emoji outside the basic plane 2), end exclusive, start < end. bold, italic, underline are true or false (false undoes a look the whole text has); color takes the colour forms below; link is kept for a later version and not drawn yet. The text itself stays plain. Ranges must fit the text, else the call fails with invalid_input. Shown in the editor, the PPTX (one text run per piece) and the HTML export. Changing the text without sending runs moves the stored runs with it (text before a range shifts it; a range whose characters are all deleted is dropped); send runs with the text to set them yourself, null (update_objects) or [] to remove them. Fields you do not know on a run are kept.",
"type": "array",
"items": {
"type": "object",
"properties": {
"start": {
"type": "number"
},
"end": {
"type": "number"
}
},
"required": [
"start",
"end"
],
"additionalProperties": {}
}
}
},
"additionalProperties": {},
"description": "Only what changed. Look fields (all optional; send null to take one away and go back to the default): text: size (8-400 px; in an override entry it is called fontSize), weight (400 or 700), italic, underline, strike (true/false), align (\"left\", \"center\", \"right\"), lineHeight (multiple of the size, 0.5-4), vAlign (\"top\", \"middle\", \"bottom\"; text boxes only), color. box: fill (a colour or \"none\"), fillOpacity (0-1), borderColor, borderWidth (0-40 px), radius (0-540 px), shadow (\"none\", \"sm\", \"md\", \"lg\"). line (strokes of a drawn line or icon): lineColor, lineWidth (0.5-40 px), dash (\"solid\", \"dash\", \"dot\"; also the border's style). A colour is one of: a theme colour token (ink, ink-soft, ink-muted, ink-on-dark, accent, accent-soft, accent-bg, bg, bg-alt, bg-inverse, border, border-strong, success, warning, danger), which follows the theme; \"palette:<name>\" for an entry of the template's deck palette, which follows that entry; or a direct colour \"#rrggbb\" (no alpha; use fillOpacity for a see-through fill). Palette and direct colours stay when the theme changes, also with a custom theme. Some layout elements are drawn as a picture in the PPTX; colours stored for them are ignored on every output."
}
}
},
"required": [
"layout"
]
}
},
"append_slides": {
"description": "Slides added to the end. Existing slides stay.",
"minItems": 1,
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"description": "The slide's id from get_template. Keep it when you resend a slide; leave it out for a new slide and the server assigns one.",
"type": "string"
},
"layout": {
"type": "string",
"description": "Layout id from list_layouts or suggest_deck."
},
"slots": {
"description": "Slot id to text. Ids and their max_chars come from get_layout.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "string"
}
},
"objects": {
"description": "Images and text boxes laid over the slide, in 1920x1080 pixels. Resend the objects you got from get_template or they are removed. At most 50 per slide.",
"type": "array",
"items": {
"type": "object",
"properties": {
"id": {
"type": "string"
},
"type": {
"type": "string",
"description": "\"image\", \"text\" or \"shape\"."
},
"shape": {
"description": "For type \"shape\": \"rect\", \"roundRect\", \"ellipse\", \"line\" or \"arrow\".",
"type": "string"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"w": {
"type": "number"
},
"h": {
"type": "number"
},
"rotate": {
"type": "number"
},
"z": {
"type": "number",
"description": "Stacking order; larger is in front. Each layer (see behind) is ordered on its own."
},
"behind": {
"description": "true: drawn behind the layout's own elements, on top of the slide background. Absent or false: in front of the layout.",
"type": "boolean"
},
"group": {
"description": "Objects with the same group id move and copy together in the web editor; keep it when you resend.",
"type": "string"
},
"locked": {
"description": "true: the user locked it on the web; keep it when you resend.",
"type": "boolean"
},
"asset": {
"description": "For type \"image\": the id of an image in the user's media library.",
"type": "string"
},
"alt": {
"description": "For type \"image\": a short description of the picture for screen readers (up to 300 characters).",
"type": "string"
},
"text": {
"description": "For type \"text\", and a box shape's inner text.",
"type": "string"
},
"runs": {
"description": "For type \"text\". Formatting of part of the text: [{ start, end, bold?, italic?, underline?, color?, link? }]. start and end are UTF-16 offsets into the text (JavaScript string indices: a Korean syllable counts 1, an emoji outside the basic plane 2), end exclusive, start < end. bold, italic, underline are true or false (false undoes a look the whole text has); color takes the colour forms below; link is kept for a later version and not drawn yet. The text itself stays plain. Ranges must fit the text, else the call fails with invalid_input. Shown in the editor, the PPTX (one text run per piece) and the HTML export. Changing the text without sending runs moves the stored runs with it (text before a range shifts it; a range whose characters are all deleted is dropped); send runs with the text to set them yourself, null (update_objects) or [] to remove them. Fields you do not know on a run are kept.",
"type": "array",
"items": {
"type": "object",
"properties": {
"start": {
"type": "number"
},
"end": {
"type": "number"
}
},
"required": [
"start",
"end"
],
"additionalProperties": {}
}
},
"style": {
"description": "For type \"text\" and \"shape\". Look fields (all optional; send null to take one away and go back to the default): text: size (8-400 px; in an override entry it is called fontSize), weight (400 or 700), italic, underline, strike (true/false), align (\"left\", \"center\", \"right\"), lineHeight (multiple of the size, 0.5-4), vAlign (\"top\", \"middle\", \"bottom\"; text boxes only), color. box: fill (a colour or \"none\"), fillOpacity (0-1), borderColor, borderWidth (0-40 px), radius (0-540 px), shadow (\"none\", \"sm\", \"md\", \"lg\"). line (strokes of a drawn line or icon): lineColor, lineWidth (0.5-40 px), dash (\"solid\", \"dash\", \"dot\"; also the border's style). A colour is one of: a theme colour token (ink, ink-soft, ink-muted, ink-on-dark, accent, accent-soft, accent-bg, bg, bg-alt, bg-inverse, border, border-strong, success, warning, danger), which follows the theme; \"palette:<name>\" for an entry of the template's deck palette, which follows that entry; or a direct colour \"#rrggbb\" (no alpha; use fillOpacity for a see-through fill). Palette and direct colours stay when the theme changes, also with a custom theme. Some layout elements are drawn as a picture in the PPTX; colours stored for them are ignored on every output.",
"type": "object",
"properties": {
"size": {
"type": "number"
},
"weight": {
"type": "number"
},
"align": {
"type": "string"
},
"color": {
"description": "A colour is one of: a theme colour token (ink, ink-soft, ink-muted, ink-on-dark, accent, accent-soft, accent-bg, bg, bg-alt, bg-inverse, border, border-strong, success, warning, danger), which follows the theme; \"palette:<name>\" for an entry of the template's deck palette, which follows that entry; or a direct colour \"#rrggbb\" (no alpha; use fillOpacity for a see-through fill). Palette and direct colours stay when the theme changes, also with a custom theme.",
"type": "string"
}
},
"additionalProperties": {}
}
},
"required": [
"type",
"x",
"y",
"w",
"h",
"z"
],
"additionalProperties": {}
}
},
"overrides": {
"description": "Changes to the layout's own elements, by element key: { \"top-accent-bar\": { \"deleted\": true }, \"title\": { \"x\": 40, \"y\": 62, \"color\": \"#c8102e\", \"italic\": true } }. Only the values that changed are given; x, y, w, h are pixels on the 1920x1080 slide and the rest stays as the layout draws it. Look fields (colour, fill, border, line spacing...) sit in the same entry; see the entry schema. Resend the overrides you got from get_template or they are removed. Requires Pro.",
"type": "object",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": "object",
"properties": {
"deleted": {
"description": "true: the element is not drawn on this slide (not in the export either).",
"type": "boolean"
},
"locked": {
"description": "true: the user locked the element on the web (no effect on the look or the export); keep it when you resend.",
"type": "boolean"
},
"x": {
"type": "number"
},
"y": {
"type": "number"
},
"w": {
"type": "number"
},
"h": {
"type": "number"
},
"fontSize": {
"description": "Text size in px, 8 to 400.",
"type": "number"
},
"color": {
"description": "A colour is one of: a theme colour token (ink, ink-soft, ink-muted, ink-on-dark, accent, accent-soft, accent-bg, bg, bg-alt, bg-inverse, border, border-strong, success, warning, danger), which follows the theme; \"palette:<name>\" for an entry of the template's deck palette, which follows that entry; or a direct colour \"#rrggbb\" (no alpha; use fillOpacity for a see-through fill). Palette and direct colours stay when the theme changes, also with a custom theme.",
"type": "string"
},
"fill": {
"description": "Box fill: a colour, or \"none\".",
"type": "string"
},
"runs": {
"description": "For a text slot element. Formatting of part of the text: [{ start, end, bold?, italic?, underline?, color?, link? }]. start and end are UTF-16 offsets into the text (JavaScript string indices: a Korean syllable counts 1, an emoji outside the basic plane 2), end exclusive, start < end. bold, italic, underline are true or false (false undoes a look the whole text has); color takes the colour forms below; link is kept for a later version and not drawn yet. The text itself stays plain. Ranges must fit the text, else the call fails with invalid_input. Shown in the editor, the PPTX (one text run per piece) and the HTML export. Changing the text without sending runs moves the stored runs with it (text before a range shifts it; a range whose characters are all deleted is dropped); send runs with the text to set them yourself, null (update_objects) or [] to remove them. Fields you do not know on a run are kept.",
"type": "array",
"items": {
"type": "object",
"properties": {
"start": {
"type": "number"
},
"end": {
"type": "number"
}
},
"required": [
"start",
"end"
],
"additionalProperties": {}
}
}
},
"additionalProperties": {},
"description": "Only what changed. Look fields (all optional; send null to take one away and go back to the default): text: size (8-400 px; in an override entry it is called fontSize), weight (400 or 700), italic, underline, strike (true/false), align (\"left\", \"center\", \"right\"), lineHeight (multiple of the size, 0.5-4), vAlign (\"top\", \"middle\", \"bottom\"; text boxes only), color. box: fill (a colour or \"none\"), fillOpacity (0-1), borderColor, borderWidth (0-40 px), radius (0-540 px), shadow (\"none\", \"sm\", \"md\", \"lg\"). line (strokes of a drawn line or icon): lineColor, lineWidth (0.5-40 px), dash (\"solid\", \"dash\", \"dot\"; also the border's style). A colour is one of: a theme colour token (ink, ink-soft, ink-muted, ink-on-dark, accent, accent-soft, accent-bg, bg, bg-alt, bg-inverse, border, border-strong, success, warning, danger), which follows the theme; \"palette:<name>\" for an entry of the template's deck palette, which follows that entry; or a direct colour \"#rrggbb\" (no alpha; use fillOpacity for a see-through fill). Palette and direct colours stay when the theme changes, also with a custom theme. Some layout elements are drawn as a picture in the PPTX; colours stored for them are ignored on every output."
}
}
},
"required": [
"layout"
]
}
},
"expected_version": {
"description": "The version from get_template or a previous save. Given, the call fails with conflict if the template changed since.",
"type": "integer",
"minimum": -9007199254740991,
"maximum": 9007199254740991
}
},
"required": [
"id"
],
"$schema": "https://json-schema.org/draft/2020-12/schema"
}