@shotstack/schemas 1.9.7 → 1.9.9

package/dist/api.bundled.json

@@ -1896,7 +1896,7 @@
                 "example": "uppercase"
               },
               "size": {
-                "description": "The font size of the active word in pixels. Overrides the scale property when set.",
+                "description": "The font size in pixels. Can be used as an alternative to font.size.",
                 "type": "number",
                 "minimum": 1,
                 "maximum": 500,
@@ -1974,6 +1974,15 @@
         "description": "Font properties for the active/highlighted word.",
         "type": "object",
         "properties": {
+          "family": {
+            "description": "The font family for the active word. Inherits from the base font.family when not set.",
+            "type": "string",
+            "example": "Roboto"
+          },
+          "weight": {
+            "description": "The weight of the font for the active word. Can be a number (100-900) or a string. Inherits from the base font.weight when not set.\n",
+            "default": "400"
+          },
           "color": {
             "description": "The active word color using hexadecimal color notation.",
             "type": "string",
@@ -1995,7 +2004,7 @@
             "example": 1
           },
           "size": {
-            "description": "The font size of the active word in pixels. Overrides the scale property when set.",
+            "description": "The font size of the active word in pixels.",
             "type": "number",
             "minimum": 1,
             "maximum": 500,
@@ -2050,14 +2059,6 @@
                 ]
               }
             ]
-          },
-          "scale": {
-            "description": "Scale multiplier for the active word. 1.0 is normal size, 1.2 is 20% larger.",
-            "type": "number",
-            "minimum": 0.5,
-            "maximum": 2,
-            "default": 1,
-            "example": 1.2
           }
         },
         "additionalProperties": false
@@ -2263,938 +2264,187 @@
               "fadeIn",
               "fadeOut",
               "fadeInFadeOut"
-            ],
-            "type": "string"
-          }
-        },
-        "additionalProperties": false,
-        "required": [
-          "type",
-          "text",
-          "voice"
-        ]
-      },
-      "HtmlAsset": {
-        "deprecated": true,
-        "description": "**Notice: The HtmlAsset is deprecated, use the [TextAsset](#tocs_textasset) instead.**\n\nThe HtmlAsset clip type lets you create text based layout and formatting using\nHTML and CSS. You can also set the height and width of a bounding box for the HTML\ncontent to sit within. Text and elements will wrap within the bounding box.\n",
-        "type": "object",
-        "properties": {
-          "type": {
-            "enum": [
-              "html"
-            ],
-            "default": "html",
-            "description": "The type of asset - set to `html` for HTML.",
-            "type": "string"
-          },
-          "html": {
-            "description": "The HTML text string. See list of [supported HTML tags](https://shotstack.io/docs/guide/architecting-an-application/html-support/#supported-html-tags).",
-            "type": "string",
-            "example": "<p>Hello <b>World</b></p>"
-          },
-          "css": {
-            "description": "The CSS text string to apply styling to the HTML. See list of  [support CSS properties](https://shotstack.io/docs/guide/architecting-an-application/html-support/#supported-css-properties).",
-            "type": "string",
-            "example": "p { color: #ffffff; } b { color: #ffff00; }"
-          },
-          "width": {
-            "description": "Set the width of the HTML asset bounding box in pixels. Text will wrap to fill the bounding box.",
-            "type": "integer",
-            "example": 400
-          },
-          "height": {
-            "description": "Set the width of the HTML asset bounding box in pixels. Text and elements will be masked if they exceed the  height of the bounding box.",
-            "type": "integer",
-            "example": 200
-          },
-          "background": {
-            "description": "Apply a background color behind the HTML bounding box using. Set the text color using hexadecimal  color notation. Transparency is supported by setting the first two characters of the hex string  (opposite to HTML), i.e. #80ffffff will be white with 50% transparency.",
-            "type": "string"
-          },
-          "position": {
-            "description": "Place the HTML in one of nine predefined positions within the HTML area. <ul>\n  <li>`top` - top (center)</li>\n  <li>`topRight` - top right</li>\n  <li>`right` - right (center)</li>\n  <li>`bottomRight` - bottom right</li>\n  <li>`bottom` - bottom (center)</li>\n  <li>`bottomLeft` - bottom left</li>\n  <li>`left` - left (center)</li>\n  <li>`topLeft` - top left</li>\n  <li>`center` - center</li>\n</ul>",
-            "enum": [
-              "top",
-              "topRight",
-              "right",
-              "bottomRight",
-              "bottom",
-              "bottomLeft",
-              "left",
-              "topLeft",
-              "center"
-            ],
-            "type": "string"
-          }
-        },
-        "additionalProperties": false,
-        "required": [
-          "type",
-          "html"
-        ]
-      },
-      "TitleAsset": {
-        "deprecated": true,
-        "description": "**Notice: The TitleAsset is deprecated, use the [TextAsset](#tocs_textasset) instead.**\n\nThe TitleAsset clip type lets you create video titles from a text string and apply styling and positioning.\n",
-        "type": "object",
-        "properties": {
-          "type": {
-            "enum": [
-              "title"
-            ],
-            "default": "title",
-            "description": "The type of asset - set to `title` for titles.",
-            "type": "string"
-          },
-          "text": {
-            "description": "The title text string - i.e. \"My Title\".",
-            "type": "string",
-            "example": "Hello World"
-          },
-          "style": {
-            "description": "Uses a preset to apply font properties and styling to the title. <ul>\n  <li>`minimal`</li>\n  <li>`blockbuster`</li>\n  <li>`vogue`</li>\n  <li>`sketchy`</li>\n  <li>`skinny`</li>\n  <li>`chunk`</li>\n  <li>`chunkLight`</li>\n  <li>`marker`</li>\n  <li>`future`</li>\n  <li>`subtitle`</li>\n</ul>",
-            "enum": [
-              "minimal",
-              "blockbuster",
-              "vogue",
-              "sketchy",
-              "skinny",
-              "chunk",
-              "chunkLight",
-              "marker",
-              "future",
-              "subtitle"
-            ],
-            "type": "string"
-          },
-          "color": {
-            "description": "Set the text color using hexadecimal color notation. Transparency is supported by setting the first two characters of the hex string (opposite to HTML),  i.e. #80ffffff will be white with  50% transparency.",
-            "type": "string"
-          },
-          "size": {
-            "description": "Set the relative size of the text using predefined sizes from xx-small to xx-large. <ul>\n  <li>`xx-small`</li>\n  <li>`x-small`</li>\n  <li>`small`</li>\n  <li>`medium`</li>\n  <li>`large`</li>\n  <li>`x-large`</li>\n  <li>`xx-large`</li>\n</ul>",
-            "enum": [
-              "xx-small",
-              "x-small",
-              "small",
-              "medium",
-              "large",
-              "x-large",
-              "xx-large"
-            ],
-            "type": "string"
-          },
-          "background": {
-            "description": "Apply a background color behind the text. Set the text color using hexadecimal color notation. Transparency is supported by setting the first two characters of the hex string (opposite to HTML),  i.e. #80ffffff will be white with 50% transparency. Omit to use transparent background.",
-            "type": "string",
-            "example": "#000000"
-          },
-          "position": {
-            "description": "Place the title in one of nine predefined positions of the viewport. <ul>\n  <li>`top` - top (center)</li>\n  <li>`topRight` - top right</li>\n  <li>`right` - right (center)</li>\n  <li>`bottomRight` - bottom right</li>\n  <li>`bottom` - bottom (center)</li>\n  <li>`bottomLeft` - bottom left</li>\n  <li>`left` - left (center)</li>\n  <li>`topLeft` - top left</li>\n  <li>`center` - center</li>\n</ul>",
-            "enum": [
-              "top",
-              "topRight",
-              "right",
-              "bottomRight",
-              "bottom",
-              "bottomLeft",
-              "left",
-              "topLeft",
-              "center"
-            ],
-            "type": "string"
-          },
-          "offset": {
-            "description": "Offset the location of the title relative to its position on the screen.",
-            "$ref": "#/components/schemas/Offset"
-          }
-        },
-        "additionalProperties": false,
-        "required": [
-          "type",
-          "text"
-        ]
-      },
-      "SvgAsset": {
-        "description": "The SvgAsset is used to add scalable vector graphics (SVG) to a video using raw SVG markup.\n\n```json\n{\n  \"type\": \"svg\",\n  \"src\": \"<svg width=\\\"100\\\" height=\\\"100\\\"><circle cx=\\\"50\\\" cy=\\\"50\\\" r=\\\"40\\\" fill=\\\"#FF0000\\\"/></svg>\"\n}\n```\n\n**Supported elements:** `<path>`, `<rect>`, `<circle>`, `<ellipse>`,\n`<line>`, `<polygon>`, `<polyline>`\n\n**Automatically extracted from SVG markup:**\n- Path data (converted to a single combined path)\n- Fill color (from `fill` attribute or `style`)\n- Stroke color and width (from attributes or `style`)\n- Dimensions (from `width`/`height` or `viewBox`)\n- Opacity (from `opacity` attribute)\n\nSee [W3C SVG 2 Specification](https://www.w3.org/TR/SVG2/) for path data syntax.\n",
-        "type": "object",
-        "properties": {
-          "type": {
-            "description": "The asset type - set to `svg` for SVG assets.",
-            "type": "string",
-            "enum": [
-              "svg"
-            ],
-            "default": "svg",
-            "example": "svg"
-          },
-          "src": {
-            "description": "Raw SVG markup string. The shape, fill, stroke, dimensions and opacity\nare automatically extracted from the SVG content.\n",
-            "type": "string",
-            "minLength": 1,
-            "maxLength": 500000,
-            "example": "<svg width=\"100\" height=\"100\"><circle cx=\"50\" cy=\"50\" r=\"40\" fill=\"#3498db\"/></svg>"
-          }
-        },
-        "additionalProperties": false,
-        "required": [
-          "type",
-          "src"
-        ],
-        "example": {
-          "type": "svg",
-          "src": "<svg width=\"200\" height=\"200\"><rect x=\"10\" y=\"10\" width=\"180\" height=\"180\" rx=\"20\" fill=\"#3498db\" stroke=\"#2C3E50\" stroke-width=\"3\"/></svg>"
-        }
-      },
-      "SvgShape": {
-        "description": "The shape definition for an SVG asset. Each shape type has its own specific\nproperties. The `type` field determines which shape is rendered.\n",
-        "oneOf": [
-          {
-            "$ref": "#/components/schemas/SvgRectangleShape"
-          },
-          {
-            "$ref": "#/components/schemas/SvgCircleShape"
-          },
-          {
-            "$ref": "#/components/schemas/SvgEllipseShape"
-          },
-          {
-            "$ref": "#/components/schemas/SvgLineShape"
-          },
-          {
-            "$ref": "#/components/schemas/SvgPolygonShape"
-          },
-          {
-            "$ref": "#/components/schemas/SvgStarShape"
-          },
-          {
-            "$ref": "#/components/schemas/SvgArrowShape"
-          },
-          {
-            "$ref": "#/components/schemas/SvgHeartShape"
-          },
-          {
-            "$ref": "#/components/schemas/SvgCrossShape"
-          },
-          {
-            "$ref": "#/components/schemas/SvgRingShape"
-          },
-          {
-            "$ref": "#/components/schemas/SvgPathShape"
-          }
-        ],
-        "discriminator": {
-          "propertyName": "type",
-          "mapping": {
-            "rectangle": "#/components/schemas/SvgRectangleShape",
-            "circle": "#/components/schemas/SvgCircleShape",
-            "ellipse": "#/components/schemas/SvgEllipseShape",
-            "line": "#/components/schemas/SvgLineShape",
-            "polygon": "#/components/schemas/SvgPolygonShape",
-            "star": "#/components/schemas/SvgStarShape",
-            "arrow": "#/components/schemas/SvgArrowShape",
-            "heart": "#/components/schemas/SvgHeartShape",
-            "cross": "#/components/schemas/SvgCrossShape",
-            "ring": "#/components/schemas/SvgRingShape",
-            "path": "#/components/schemas/SvgPathShape"
-          }
-        }
-      },
-      "SvgRectangleShape": {
-        "description": "A rectangle shape with optional rounded corners.\nThe rectangle is defined by its width and height dimensions.\n",
-        "type": "object",
-        "additionalProperties": false,
-        "properties": {
-          "type": {
-            "description": "The shape type - set to `rectangle`.",
-            "type": "string",
-            "enum": [
-              "rectangle"
-            ]
-          },
-          "width": {
-            "description": "The width of the rectangle in pixels.",
-            "type": "number",
-            "minimum": 1,
-            "maximum": 4096,
-            "example": 200
-          },
-          "height": {
-            "description": "The height of the rectangle in pixels.",
-            "type": "number",
-            "minimum": 1,
-            "maximum": 4096,
-            "example": 100
-          },
-          "cornerRadius": {
-            "description": "The corner radius for rounded corners in pixels.\nSet to `0` for sharp corners. The radius is automatically clamped\nto half of the smallest dimension.\n",
-            "type": "number",
-            "minimum": 0,
-            "maximum": 2048,
-            "default": 0,
-            "example": 10
-          }
-        },
-        "required": [
-          "type",
-          "width",
-          "height"
-        ]
-      },
-      "SvgCircleShape": {
-        "description": "A perfect circle shape defined by its radius.\nThe circle is centered at the shape's position.\n",
-        "type": "object",
-        "additionalProperties": false,
-        "properties": {
-          "type": {
-            "description": "The shape type - set to `circle`.",
-            "type": "string",
-            "enum": [
-              "circle"
-            ]
-          },
-          "radius": {
-            "description": "The radius of the circle in pixels.",
-            "type": "number",
-            "minimum": 1,
-            "maximum": 2048,
-            "example": 50
-          }
-        },
-        "required": [
-          "type",
-          "radius"
-        ]
-      },
-      "SvgEllipseShape": {
-        "description": "An ellipse (oval) shape with separate horizontal and vertical radii.\nThe ellipse is centered at the shape's position.\n",
-        "type": "object",
-        "additionalProperties": false,
-        "properties": {
-          "type": {
-            "description": "The shape type - set to `ellipse`.",
-            "type": "string",
-            "enum": [
-              "ellipse"
-            ]
-          },
-          "radiusX": {
-            "description": "The horizontal radius (semi-major axis) in pixels.",
-            "type": "number",
-            "minimum": 1,
-            "maximum": 2048,
-            "example": 80
-          },
-          "radiusY": {
-            "description": "The vertical radius (semi-minor axis) in pixels.",
-            "type": "number",
-            "minimum": 1,
-            "maximum": 2048,
-            "example": 50
-          }
-        },
-        "required": [
-          "type",
-          "radiusX",
-          "radiusY"
-        ]
-      },
-      "SvgLineShape": {
-        "description": "A straight line shape with a specified length and thickness.\nThe line is drawn horizontally by default and can be rotated using transform.\n",
-        "type": "object",
-        "additionalProperties": false,
-        "properties": {
-          "type": {
-            "description": "The shape type - set to `line`.",
-            "type": "string",
-            "enum": [
-              "line"
-            ]
-          },
-          "length": {
-            "description": "The length of the line in pixels.",
-            "type": "number",
-            "minimum": 1,
-            "maximum": 4096,
-            "example": 100
-          },
-          "thickness": {
-            "description": "The thickness of the line in pixels.",
-            "type": "number",
-            "minimum": 1,
-            "maximum": 500,
-            "example": 4
-          }
-        },
-        "required": [
-          "type",
-          "length",
-          "thickness"
-        ]
-      },
-      "SvgPolygonShape": {
-        "description": "A regular polygon shape with a specified number of sides.\nExamples: triangle (3), square (4), pentagon (5), hexagon (6), etc.\nThe polygon is inscribed in a circle of the given radius.\n",
-        "type": "object",
-        "additionalProperties": false,
-        "properties": {
-          "type": {
-            "description": "The shape type - set to `polygon`.",
-            "type": "string",
-            "enum": [
-              "polygon"
-            ]
-          },
-          "sides": {
-            "description": "The number of sides of the polygon.\nMinimum 3 (triangle), maximum 100 for practical use.\n",
-            "type": "integer",
-            "minimum": 3,
-            "maximum": 100,
-            "example": 6
-          },
-          "radius": {
-            "description": "The radius of the circumscribed circle in pixels.\nThis determines the size of the polygon.\n",
-            "type": "number",
-            "minimum": 1,
-            "maximum": 2048,
-            "example": 50
-          }
-        },
-        "required": [
-          "type",
-          "sides",
-          "radius"
-        ]
-      },
-      "SvgStarShape": {
-        "description": "A star shape with a specified number of points.\nThe star is defined by outer and inner radii, creating the characteristic\npointed appearance.\n",
-        "type": "object",
-        "additionalProperties": false,
-        "properties": {
-          "type": {
-            "description": "The shape type - set to `star`.",
-            "type": "string",
-            "enum": [
-              "star"
-            ]
-          },
-          "points": {
-            "description": "The number of points on the star.\nMinimum 3 for a triangle-like star, typically 5 for a classic star.\n",
-            "type": "integer",
-            "minimum": 3,
-            "maximum": 100,
-            "example": 5
-          },
-          "outerRadius": {
-            "description": "The outer radius in pixels - the distance from center to the tips of the points.\n",
-            "type": "number",
-            "minimum": 1,
-            "maximum": 2048,
-            "example": 50
-          },
-          "innerRadius": {
-            "description": "The inner radius in pixels - the distance from center to the inner vertices.\nShould be smaller than outerRadius for a star effect.\n",
-            "type": "number",
-            "minimum": 1,
-            "maximum": 2048,
-            "example": 25
-          }
-        },
-        "required": [
-          "type",
-          "points",
-          "outerRadius",
-          "innerRadius"
-        ]
-      },
-      "SvgArrowShape": {
-        "description": "An arrow shape pointing to the right by default.\nUse transform rotation to change direction.\n",
-        "type": "object",
-        "additionalProperties": false,
-        "properties": {
-          "type": {
-            "description": "The shape type - set to `arrow`.",
-            "type": "string",
-            "enum": [
-              "arrow"
-            ]
-          },
-          "length": {
-            "description": "The total length of the arrow from tail to tip in pixels.",
-            "type": "number",
-            "minimum": 1,
-            "maximum": 4096,
-            "example": 100
-          },
-          "headWidth": {
-            "description": "The width of the arrow head (the widest part) in pixels.",
-            "type": "number",
-            "minimum": 1,
-            "maximum": 1000,
-            "example": 40
-          },
-          "headLength": {
-            "description": "The length of the arrow head portion in pixels.",
-            "type": "number",
-            "minimum": 1,
-            "maximum": 1000,
-            "example": 30
-          },
-          "shaftWidth": {
-            "description": "The width of the arrow shaft (body) in pixels.",
-            "type": "number",
-            "minimum": 1,
-            "maximum": 1000,
-            "example": 20
-          }
-        },
-        "required": [
-          "type",
-          "length",
-          "headWidth",
-          "headLength",
-          "shaftWidth"
-        ]
-      },
-      "SvgHeartShape": {
-        "description": "A heart shape commonly used for love/like icons.\nThe heart is defined by a single size parameter.\n",
-        "type": "object",
-        "additionalProperties": false,
-        "properties": {
-          "type": {
-            "description": "The shape type - set to `heart`.",
-            "type": "string",
-            "enum": [
-              "heart"
-            ]
-          },
-          "size": {
-            "description": "The size of the heart in pixels.\nThis determines both the width and height proportionally.\n",
-            "type": "number",
-            "minimum": 1,
-            "maximum": 4096,
-            "example": 100
-          }
-        },
-        "required": [
-          "type",
-          "size"
-        ]
-      },
-      "SvgCrossShape": {
-        "description": "A cross or plus shape with equal or different arm lengths.\nCan be styled as a plus sign (+) or a cross (x with rotation).\n",
-        "type": "object",
-        "additionalProperties": false,
-        "properties": {
-          "type": {
-            "description": "The shape type - set to `cross`.",
-            "type": "string",
-            "enum": [
-              "cross"
-            ]
-          },
-          "width": {
-            "description": "The total width of the cross in pixels.",
-            "type": "number",
-            "minimum": 1,
-            "maximum": 4096,
-            "example": 100
-          },
-          "height": {
-            "description": "The total height of the cross in pixels.",
-            "type": "number",
-            "minimum": 1,
-            "maximum": 4096,
-            "example": 100
-          },
-          "thickness": {
-            "description": "The thickness of the cross arms in pixels.",
-            "type": "number",
-            "minimum": 1,
-            "maximum": 500,
-            "example": 20
-          }
-        },
-        "required": [
-          "type",
-          "width",
-          "height",
-          "thickness"
-        ]
-      },
-      "SvgRingShape": {
-        "description": "A ring (donut/annulus) shape - a circle with a circular hole in the center.\nThe ring is defined by outer and inner radii.\n",
-        "type": "object",
-        "additionalProperties": false,
-        "properties": {
-          "type": {
-            "description": "The shape type - set to `ring`.",
-            "type": "string",
-            "enum": [
-              "ring"
-            ]
-          },
-          "outerRadius": {
-            "description": "The outer radius of the ring in pixels.",
-            "type": "number",
-            "minimum": 1,
-            "maximum": 2048,
-            "example": 50
-          },
-          "innerRadius": {
-            "description": "The inner radius (hole) of the ring in pixels.\nMust be smaller than outerRadius.\n",
-            "type": "number",
-            "minimum": 0,
-            "maximum": 2048,
-            "example": 30
-          }
-        },
-        "required": [
-          "type",
-          "outerRadius",
-          "innerRadius"
-        ]
-      },
-      "SvgPathShape": {
-        "description": "A custom shape defined by SVG path data.\nSupports all standard SVG path commands for creating complex shapes.\n\n**Path Commands:**\n- `M x y` / `m dx dy` - Move to (absolute/relative)\n- `L x y` / `l dx dy` - Line to\n- `H x` / `h dx` - Horizontal line to\n- `V y` / `v dy` - Vertical line to\n- `C x1 y1 x2 y2 x y` / `c` - Cubic Bezier curve\n- `S x2 y2 x y` / `s` - Smooth cubic Bezier\n- `Q x1 y1 x y` / `q` - Quadratic Bezier curve\n- `T x y` / `t` - Smooth quadratic Bezier\n- `A rx ry angle large-arc sweep x y` / `a` - Elliptical arc\n- `Z` / `z` - Close path\n",
-        "type": "object",
-        "additionalProperties": false,
-        "properties": {
-          "type": {
-            "description": "The shape type - set to `path`.",
-            "type": "string",
-            "enum": [
-              "path"
-            ]
-          },
-          "d": {
-            "description": "The SVG path data string defining the shape.\nUses standard SVG path commands (M, L, C, Q, A, Z, etc.).\nExample: `M 0 0 L 100 0 L 100 100 L 0 100 Z` draws a square.\n",
-            "type": "string",
-            "minLength": 1,
-            "maxLength": 100000,
-            "example": "M 0 0 L 100 0 L 50 86.6 Z"
-          }
-        },
-        "required": [
-          "type",
-          "d"
-        ]
-      },
-      "SvgFill": {
-        "description": "Fill properties for SVG shapes. Supports solid colors and gradients.\nThe fill defines how the interior of a shape is painted.\n",
-        "oneOf": [
-          {
-            "$ref": "#/components/schemas/SvgSolidFill"
-          },
-          {
-            "$ref": "#/components/schemas/SvgLinearGradientFill"
-          },
-          {
-            "$ref": "#/components/schemas/SvgRadialGradientFill"
-          }
-        ],
-        "discriminator": {
-          "propertyName": "type",
-          "mapping": {
-            "solid": "#/components/schemas/SvgSolidFill",
-            "linear": "#/components/schemas/SvgLinearGradientFill",
-            "radial": "#/components/schemas/SvgRadialGradientFill"
-          }
-        }
-      },
-      "SvgSolidFill": {
-        "description": "A solid color fill for SVG shapes.",
-        "type": "object",
-        "additionalProperties": false,
-        "properties": {
-          "type": {
-            "description": "The fill type - set to `solid` for a single color fill.",
-            "type": "string",
-            "enum": [
-              "solid"
-            ],
-            "default": "solid"
-          },
-          "color": {
-            "description": "The fill color using hexadecimal color notation (e.g., `#FF0000` for red).\nMust be a 6-digit hex color code prefixed with `#`.\n",
-            "type": "string",
-            "pattern": "^#[A-Fa-f0-9]{6}$",
-            "default": "#000000",
-            "example": "#3498db"
-          },
-          "opacity": {
-            "description": "The opacity of the fill where `1` is fully opaque and `0` is fully transparent.\nValues between 0 and 1 create semi-transparent fills.\n",
-            "type": "number",
-            "minimum": 0,
-            "maximum": 1,
-            "default": 1,
-            "example": 0.8
-          }
-        },
-        "required": [
-          "type",
-          "color"
-        ]
-      },
-      "SvgLinearGradientFill": {
-        "description": "A linear gradient fill that transitions colors along a straight line.\nThe gradient direction is controlled by the `angle` property.\n",
-        "type": "object",
-        "additionalProperties": false,
-        "properties": {
-          "type": {
-            "description": "The fill type - set to `linear` for a linear gradient fill.",
-            "type": "string",
-            "enum": [
-              "linear"
-            ]
-          },
-          "angle": {
-            "description": "The angle of the gradient in degrees. `0` is horizontal (left to right),\n`90` is vertical (bottom to top), `180` is right to left, etc.\n",
-            "type": "number",
-            "minimum": 0,
-            "maximum": 360,
-            "default": 0,
-            "example": 45
-          },
-          "stops": {
-            "description": "Array of color stops that define the gradient colors and their positions.\nMust have at least 2 stops. Offsets should increase from 0 to 1.\n",
-            "type": "array",
-            "minItems": 2,
-            "items": {
-              "$ref": "#/components/schemas/SvgGradientStop"
-            }
-          },
-          "opacity": {
-            "description": "The overall opacity of the gradient where `1` is fully opaque and `0` is fully transparent.\n",
-            "type": "number",
-            "minimum": 0,
-            "maximum": 1,
-            "default": 1,
-            "example": 1
-          }
-        },
-        "required": [
-          "type",
-          "stops"
-        ]
-      },
-      "SvgRadialGradientFill": {
-        "description": "A radial gradient fill that transitions colors radiating outward from a center point.\nThe gradient creates a circular or elliptical color transition.\n",
-        "type": "object",
-        "additionalProperties": false,
-        "properties": {
-          "type": {
-            "description": "The fill type - set to `radial` for a radial gradient fill.",
-            "type": "string",
-            "enum": [
-              "radial"
-            ]
-          },
-          "stops": {
-            "description": "Array of color stops that define the gradient colors and their positions.\nMust have at least 2 stops. Offset `0` is the center, `1` is the outer edge.\n",
-            "type": "array",
-            "minItems": 2,
-            "items": {
-              "$ref": "#/components/schemas/SvgGradientStop"
-            }
-          },
-          "opacity": {
-            "description": "The overall opacity of the gradient where `1` is fully opaque and `0` is fully transparent.\n",
-            "type": "number",
-            "minimum": 0,
-            "maximum": 1,
-            "default": 1,
-            "example": 1
+            ],
+            "type": "string"
           }
         },
+        "additionalProperties": false,
         "required": [
           "type",
-          "stops"
+          "text",
+          "voice"
         ]
       },
-      "SvgGradientStop": {
-        "description": "A color stop in a gradient. Each stop defines a color at a specific position\nalong the gradient vector. Gradients require at least 2 stops.\n",
+      "HtmlAsset": {
+        "deprecated": true,
+        "description": "**Notice: The HtmlAsset is deprecated, use the [TextAsset](#tocs_textasset) instead.**\n\nThe HtmlAsset clip type lets you create text based layout and formatting using\nHTML and CSS. You can also set the height and width of a bounding box for the HTML\ncontent to sit within. Text and elements will wrap within the bounding box.\n",
         "type": "object",
-        "additionalProperties": false,
         "properties": {
-          "offset": {
-            "description": "Position of the color stop along the gradient vector.\n`0` represents the start and `1` represents the end of the gradient.\n",
-            "type": "number",
-            "minimum": 0,
-            "maximum": 1,
-            "example": 0.5
+          "type": {
+            "enum": [
+              "html"
+            ],
+            "default": "html",
+            "description": "The type of asset - set to `html` for HTML.",
+            "type": "string"
           },
-          "color": {
-            "description": "The color at this stop using hexadecimal color notation.",
+          "html": {
+            "description": "The HTML text string. See list of [supported HTML tags](https://shotstack.io/docs/guide/architecting-an-application/html-support/#supported-html-tags).",
             "type": "string",
-            "pattern": "^#[A-Fa-f0-9]{6}$",
-            "example": "#e74c3c"
+            "example": "<p>Hello <b>World</b></p>"
+          },
+          "css": {
+            "description": "The CSS text string to apply styling to the HTML. See list of  [support CSS properties](https://shotstack.io/docs/guide/architecting-an-application/html-support/#supported-css-properties).",
+            "type": "string",
+            "example": "p { color: #ffffff; } b { color: #ffff00; }"
+          },
+          "width": {
+            "description": "Set the width of the HTML asset bounding box in pixels. Text will wrap to fill the bounding box.",
+            "type": "integer",
+            "example": 400
+          },
+          "height": {
+            "description": "Set the width of the HTML asset bounding box in pixels. Text and elements will be masked if they exceed the  height of the bounding box.",
+            "type": "integer",
+            "example": 200
+          },
+          "background": {
+            "description": "Apply a background color behind the HTML bounding box using. Set the text color using hexadecimal  color notation. Transparency is supported by setting the first two characters of the hex string  (opposite to HTML), i.e. #80ffffff will be white with 50% transparency.",
+            "type": "string"
+          },
+          "position": {
+            "description": "Place the HTML in one of nine predefined positions within the HTML area. <ul>\n  <li>`top` - top (center)</li>\n  <li>`topRight` - top right</li>\n  <li>`right` - right (center)</li>\n  <li>`bottomRight` - bottom right</li>\n  <li>`bottom` - bottom (center)</li>\n  <li>`bottomLeft` - bottom left</li>\n  <li>`left` - left (center)</li>\n  <li>`topLeft` - top left</li>\n  <li>`center` - center</li>\n</ul>",
+            "enum": [
+              "top",
+              "topRight",
+              "right",
+              "bottomRight",
+              "bottom",
+              "bottomLeft",
+              "left",
+              "topLeft",
+              "center"
+            ],
+            "type": "string"
           }
         },
+        "additionalProperties": false,
         "required": [
-          "offset",
-          "color"
+          "type",
+          "html"
         ]
       },
-      "SvgStroke": {
-        "description": "Stroke (outline) properties for SVG shapes. The stroke defines how the outline\nof a shape is painted, including its color, width, and line style.\n",
+      "TitleAsset": {
+        "deprecated": true,
+        "description": "**Notice: The TitleAsset is deprecated, use the [TextAsset](#tocs_textasset) instead.**\n\nThe TitleAsset clip type lets you create video titles from a text string and apply styling and positioning.\n",
         "type": "object",
-        "additionalProperties": false,
         "properties": {
-          "color": {
-            "description": "The stroke color using hexadecimal color notation.",
+          "type": {
+            "enum": [
+              "title"
+            ],
+            "default": "title",
+            "description": "The type of asset - set to `title` for titles.",
+            "type": "string"
+          },
+          "text": {
+            "description": "The title text string - i.e. \"My Title\".",
             "type": "string",
-            "pattern": "^#[A-Fa-f0-9]{6}$",
-            "default": "#000000",
-            "example": "#2c3e50"
+            "example": "Hello World"
           },
-          "width": {
-            "description": "The width of the stroke in pixels. Must be greater than 0.\nLarger values create thicker outlines.\n",
-            "type": "number",
-            "minimum": 0,
-            "maximum": 100,
-            "default": 1,
-            "example": 2
+          "style": {
+            "description": "Uses a preset to apply font properties and styling to the title. <ul>\n  <li>`minimal`</li>\n  <li>`blockbuster`</li>\n  <li>`vogue`</li>\n  <li>`sketchy`</li>\n  <li>`skinny`</li>\n  <li>`chunk`</li>\n  <li>`chunkLight`</li>\n  <li>`marker`</li>\n  <li>`future`</li>\n  <li>`subtitle`</li>\n</ul>",
+            "enum": [
+              "minimal",
+              "blockbuster",
+              "vogue",
+              "sketchy",
+              "skinny",
+              "chunk",
+              "chunkLight",
+              "marker",
+              "future",
+              "subtitle"
+            ],
+            "type": "string"
           },
-          "opacity": {
-            "description": "The opacity of the stroke where `1` is opaque and `0` is transparent.",
-            "type": "number",
-            "minimum": 0,
-            "maximum": 1,
-            "default": 1,
-            "example": 1
+          "color": {
+            "description": "Set the text color using hexadecimal color notation. Transparency is supported by setting the first two characters of the hex string (opposite to HTML),  i.e. #80ffffff will be white with  50% transparency.",
+            "type": "string"
           },
-          "lineCap": {
-            "description": "The shape at the end of open paths (lines, polylines, unclosed paths).\n<ul>\n  <li>`butt` - flat edge perpendicular to the line (default)</li>\n  <li>`round` - semicircular cap extending beyond the endpoint</li>\n  <li>`square` - rectangular cap extending beyond the endpoint</li>\n</ul>\n",
-            "type": "string",
+          "size": {
+            "description": "Set the relative size of the text using predefined sizes from xx-small to xx-large. <ul>\n  <li>`xx-small`</li>\n  <li>`x-small`</li>\n  <li>`small`</li>\n  <li>`medium`</li>\n  <li>`large`</li>\n  <li>`x-large`</li>\n  <li>`xx-large`</li>\n</ul>",
             "enum": [
-              "butt",
-              "round",
-              "square"
+              "xx-small",
+              "x-small",
+              "small",
+              "medium",
+              "large",
+              "x-large",
+              "xx-large"
             ],
-            "default": "butt",
-            "example": "round"
+            "type": "string"
           },
-          "lineJoin": {
-            "description": "The shape at the corners where two lines meet.\n<ul>\n  <li>`miter` - sharp corner (default)</li>\n  <li>`round` - rounded corner</li>\n  <li>`bevel` - flattened corner</li>\n</ul>\n",
+          "background": {
+            "description": "Apply a background color behind the text. Set the text color using hexadecimal color notation. Transparency is supported by setting the first two characters of the hex string (opposite to HTML),  i.e. #80ffffff will be white with 50% transparency. Omit to use transparent background.",
             "type": "string",
+            "example": "#000000"
+          },
+          "position": {
+            "description": "Place the title in one of nine predefined positions of the viewport. <ul>\n  <li>`top` - top (center)</li>\n  <li>`topRight` - top right</li>\n  <li>`right` - right (center)</li>\n  <li>`bottomRight` - bottom right</li>\n  <li>`bottom` - bottom (center)</li>\n  <li>`bottomLeft` - bottom left</li>\n  <li>`left` - left (center)</li>\n  <li>`topLeft` - top left</li>\n  <li>`center` - center</li>\n</ul>",
             "enum": [
-              "miter",
-              "round",
-              "bevel"
+              "top",
+              "topRight",
+              "right",
+              "bottomRight",
+              "bottom",
+              "bottomLeft",
+              "left",
+              "topLeft",
+              "center"
             ],
-            "default": "miter",
-            "example": "round"
-          },
-          "dashArray": {
-            "description": "Pattern of dashes and gaps for the stroke. An array of numbers where\nodd indices are dash lengths and even indices are gap lengths.\nFor example, `[10, 5]` creates 10px dashes with 5px gaps.\n`[10, 5, 2, 5]` creates alternating 10px and 2px dashes with 5px gaps.\n",
-            "type": "array",
-            "items": {
-              "type": "number",
-              "minimum": 0
-            },
-            "example": [
-              10,
-              5
-            ]
+            "type": "string"
           },
-          "dashOffset": {
-            "description": "Offset for the dash pattern. Positive values shift the pattern\nforward along the path, negative values shift it backward.\n",
-            "type": "number",
-            "default": 0,
-            "example": 5
+          "offset": {
+            "description": "Offset the location of the title relative to its position on the screen.",
+            "$ref": "#/components/schemas/Offset"
           }
-        }
+        },
+        "additionalProperties": false,
+        "required": [
+          "type",
+          "text"
+        ]
       },
-      "SvgShadow": {
-        "description": "Drop shadow properties for SVG shapes. Creates a shadow effect behind the shape.\n",
+      "SvgAsset": {
+        "description": "The SvgAsset is used to add scalable vector graphics (SVG) to a video using raw SVG markup.\n\n```json\n{\n  \"type\": \"svg\",\n  \"src\": \"<svg width=\\\"100\\\" height=\\\"100\\\"><circle cx=\\\"50\\\" cy=\\\"50\\\" r=\\\"40\\\" fill=\\\"#FF0000\\\"/></svg>\"\n}\n```\n\n**Supported elements:** `<path>`, `<rect>`, `<circle>`, `<ellipse>`,\n`<line>`, `<polygon>`, `<polyline>`\n\n**Automatically extracted from SVG markup:**\n- Path data (converted to a single combined path)\n- Fill color (from `fill` attribute or `style`)\n- Stroke color and width (from attributes or `style`)\n- Dimensions (from `width`/`height` or `viewBox`)\n- Opacity (from `opacity` attribute)\n\nSee [W3C SVG 2 Specification](https://www.w3.org/TR/SVG2/) for path data syntax.\n",
         "type": "object",
-        "additionalProperties": false,
         "properties": {
-          "offsetX": {
-            "description": "Horizontal offset of the shadow in pixels.\nPositive values move the shadow to the right, negative to the left.\n",
-            "type": "number",
-            "default": 0,
-            "example": 4
-          },
-          "offsetY": {
-            "description": "Vertical offset of the shadow in pixels.\nPositive values move the shadow down, negative values move it up.\n",
-            "type": "number",
-            "default": 0,
-            "example": 4
-          },
-          "blur": {
-            "description": "The blur radius of the shadow in pixels. Must be 0 or greater.",
-            "type": "number",
-            "minimum": 0,
-            "default": 0,
-            "example": 8
-          },
-          "color": {
-            "description": "The shadow color using hexadecimal color notation.",
+          "type": {
+            "description": "The asset type - set to `svg` for SVG assets.",
             "type": "string",
-            "pattern": "^#[A-Fa-f0-9]{6}$",
-            "default": "#000000",
-            "example": "#000000"
+            "enum": [
+              "svg"
+            ],
+            "default": "svg",
+            "example": "svg"
           },
-          "opacity": {
-            "description": "The opacity of the shadow where `1` is opaque and `0` is transparent.",
-            "type": "number",
-            "minimum": 0,
-            "maximum": 1,
-            "default": 0.5,
-            "example": 0.3
+          "src": {
+            "description": "Raw SVG markup string. The shape, fill, stroke, dimensions and opacity\nare automatically extracted from the SVG content.\n",
+            "type": "string",
+            "minLength": 1,
+            "maxLength": 500000,
+            "example": "<svg width=\"100\" height=\"100\"><circle cx=\"50\" cy=\"50\" r=\"40\" fill=\"#3498db\"/></svg>"
           }
-        }
-      },
-      "SvgTransform": {
-        "description": "Transformation properties for positioning, rotating, and scaling SVG shapes.\n",
-        "type": "object",
+        },
         "additionalProperties": false,
-        "properties": {
-          "x": {
-            "description": "The x-coordinate position of the shape in pixels.\nRelative to the top-left corner of the viewport.\n",
-            "type": "number",
-            "default": 0,
-            "example": 100
-          },
-          "y": {
-            "description": "The y-coordinate position of the shape in pixels.\nRelative to the top-left corner of the viewport.\n",
-            "type": "number",
-            "default": 0,
-            "example": 100
-          },
-          "rotation": {
-            "description": "Rotation angle in degrees. Positive values rotate clockwise,\nnegative values rotate counter-clockwise. Range: -360 to 360.\n",
-            "type": "number",
-            "minimum": -360,
-            "maximum": 360,
-            "default": 0,
-            "example": 45
-          },
-          "scale": {
-            "description": "Scale factor for the shape. `1` is original size, `2` is double size,\n`0.5` is half size. Must be greater than 0.\n",
-            "type": "number",
-            "minimum": 0.01,
-            "maximum": 100,
-            "default": 1,
-            "example": 1.5
-          },
-          "originX": {
-            "description": "The x-coordinate of the transformation origin as a value from 0 to 1.\n`0` is the left edge, `0.5` is the center, `1` is the right edge.\n",
-            "type": "number",
-            "minimum": 0,
-            "maximum": 1,
-            "default": 0.5,
-            "example": 0.5
-          },
-          "originY": {
-            "description": "The y-coordinate of the transformation origin as a value from 0 to 1.\n`0` is the top edge, `0.5` is the center, `1` is the bottom edge.\n",
-            "type": "number",
-            "minimum": 0,
-            "maximum": 1,
-            "default": 0.5,
-            "example": 0.5
-          }
+        "required": [
+          "type",
+          "src"
+        ],
+        "example": {
+          "type": "svg",
+          "src": "<svg width=\"200\" height=\"200\"><rect x=\"10\" y=\"10\" width=\"180\" height=\"180\" rx=\"20\" fill=\"#3498db\" stroke=\"#2C3E50\" stroke-width=\"3\"/></svg>"
         }
       },
       "Transition": {
@@ -4477,18 +3727,14 @@
                   },
                   "path": {
                     "description": "A remote directory path/prefix for the file being sent, i.e. `videos` or `customerId/videos`.",
-                    "type": [
-                      "string",
-                      "null"
-                    ],
+                    "type": "string",
+                    "nullable": true,
                     "example": "videos"
                   },
                   "filename": {
                     "description": "Use your own filename instead of the default filenames generated by Shotstack. Note: omit the file extension as this will be appended depending on the output format. Also `-poster.jpg` and `-thumb.jpg` will be appended for poster and thumbnail images.",
-                    "type": [
-                      "string",
-                      "null"
-                    ],
+                    "type": "string",
+                    "nullable": true,
                     "example": "my-file"
                   }
                 },
@@ -4527,18 +3773,14 @@
                   },
                   "prefix": {
                     "description": "A virtual directory prefix for the blob being sent, i.e. `videos` or `customerId/videos`.",
-                    "type": [
-                      "string",
-                      "null"
-                    ],
+                    "type": "string",
+                    "nullable": true,
                     "example": "videos"
                   },
                   "filename": {
                     "description": "Use your own filename instead of the default filenames generated by Shotstack. Note: omit the file extension as this will be appended depending on the output format. Also `-poster.jpg` and `-thumb.jpg` will be appended for poster and thumbnail images.",
-                    "type": [
-                      "string",
-                      "null"
-                    ],
+                    "type": "string",
+                    "nullable": true,
                     "example": "my-file"
                   }
                 },