@shotstack/schemas 1.8.3 → 1.8.4

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (37) hide show
  1. package/dist/api.bundled.json +204 -972
  2. package/dist/json-schema/asset.json +3 -936
  3. package/dist/json-schema/clip.json +3 -936
  4. package/dist/json-schema/destinations.json +111 -23
  5. package/dist/json-schema/edit.json +256 -1083
  6. package/dist/json-schema/output.json +106 -0
  7. package/dist/json-schema/rich-caption-asset.json +140 -221
  8. package/dist/json-schema/schemas.json +295 -1207
  9. package/dist/json-schema/svg-asset.json +6 -857
  10. package/dist/json-schema/timeline.json +3 -936
  11. package/dist/json-schema/track.json +3 -936
  12. package/dist/schema.d.ts +68 -695
  13. package/dist/zod/zod.gen.cjs +44 -625
  14. package/dist/zod/zod.gen.d.ts +543 -8241
  15. package/dist/zod/zod.gen.js +38 -618
  16. package/dist/zod/zod.gen.ts +50 -382
  17. package/package.json +1 -1
  18. package/dist/json-schema/svg-arrow-shape.json +0 -49
  19. package/dist/json-schema/svg-circle-shape.json +0 -28
  20. package/dist/json-schema/svg-cross-shape.json +0 -42
  21. package/dist/json-schema/svg-ellipse-shape.json +0 -35
  22. package/dist/json-schema/svg-fill.json +0 -169
  23. package/dist/json-schema/svg-gradient-stop.json +0 -25
  24. package/dist/json-schema/svg-heart-shape.json +0 -28
  25. package/dist/json-schema/svg-line-shape.json +0 -35
  26. package/dist/json-schema/svg-linear-gradient-fill.json +0 -80
  27. package/dist/json-schema/svg-path-shape.json +0 -26
  28. package/dist/json-schema/svg-polygon-shape.json +0 -35
  29. package/dist/json-schema/svg-radial-gradient-fill.json +0 -66
  30. package/dist/json-schema/svg-rectangle-shape.json +0 -49
  31. package/dist/json-schema/svg-ring-shape.json +0 -35
  32. package/dist/json-schema/svg-shadow.json +0 -79
  33. package/dist/json-schema/svg-shape.json +0 -404
  34. package/dist/json-schema/svg-solid-fill.json +0 -40
  35. package/dist/json-schema/svg-star-shape.json +0 -42
  36. package/dist/json-schema/svg-stroke.json +0 -115
  37. package/dist/json-schema/svg-transform.json +0 -93
@@ -1934,49 +1934,7 @@
1934
1934
  },
1935
1935
  "font": {
1936
1936
  "description": "Font styling properties for inactive words.",
1937
- "properties": {
1938
- "family": {
1939
- "description": "The font family name. This must be the Family name embedded in the font, i.e. \"Roboto\".",
1940
- "type": "string",
1941
- "example": "Roboto",
1942
- "default": "Roboto"
1943
- },
1944
- "size": {
1945
- "description": "The size of the font in pixels (px). Must be between 1 and 500.",
1946
- "type": "integer",
1947
- "minimum": 1,
1948
- "maximum": 500,
1949
- "default": 24,
1950
- "example": 48
1951
- },
1952
- "weight": {
1953
- "description": "The weight of the font. Can be a number (100-900) or a string ('normal', 'bold', etc.). 100 is lightest, 900 is heaviest (boldest).",
1954
- "default": "400"
1955
- },
1956
- "color": {
1957
- "description": "The text color using hexadecimal color notation.",
1958
- "type": "string",
1959
- "pattern": "^#[A-Fa-f0-9]{6}$",
1960
- "default": "#ffffff",
1961
- "example": "#ffffff"
1962
- },
1963
- "opacity": {
1964
- "description": "The opacity of the text where 1 is opaque and 0 is transparent.",
1965
- "type": "number",
1966
- "minimum": 0,
1967
- "maximum": 1,
1968
- "default": 1,
1969
- "example": 0.9
1970
- },
1971
- "background": {
1972
- "description": "The background color behind the text using hexadecimal color notation.",
1973
- "type": "string",
1974
- "pattern": "^#[A-Fa-f0-9]{6}$",
1975
- "example": "#000000"
1976
- }
1977
- },
1978
- "additionalProperties": false,
1979
- "type": "object"
1937
+ "$ref": "#/components/schemas/RichTextFont"
1980
1938
  },
1981
1939
  "style": {
1982
1940
  "description": "Text style properties including spacing, line height, and transformations.",
@@ -2400,963 +2358,137 @@
2400
2358
  },
2401
2359
  "position": {
2402
2360
  "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>",
2403
- "enum": [
2404
- "top",
2405
- "topRight",
2406
- "right",
2407
- "bottomRight",
2408
- "bottom",
2409
- "bottomLeft",
2410
- "left",
2411
- "topLeft",
2412
- "center"
2413
- ],
2414
- "type": "string"
2415
- }
2416
- },
2417
- "additionalProperties": false,
2418
- "required": [
2419
- "type",
2420
- "html"
2421
- ]
2422
- },
2423
- "TitleAsset": {
2424
- "deprecated": true,
2425
- "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",
2426
- "type": "object",
2427
- "properties": {
2428
- "type": {
2429
- "enum": [
2430
- "title"
2431
- ],
2432
- "default": "title",
2433
- "description": "The type of asset - set to `title` for titles.",
2434
- "type": "string"
2435
- },
2436
- "text": {
2437
- "description": "The title text string - i.e. \"My Title\".",
2438
- "type": "string",
2439
- "example": "Hello World"
2440
- },
2441
- "style": {
2442
- "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>",
2443
- "enum": [
2444
- "minimal",
2445
- "blockbuster",
2446
- "vogue",
2447
- "sketchy",
2448
- "skinny",
2449
- "chunk",
2450
- "chunkLight",
2451
- "marker",
2452
- "future",
2453
- "subtitle"
2454
- ],
2455
- "type": "string"
2456
- },
2457
- "color": {
2458
- "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.",
2459
- "type": "string"
2460
- },
2461
- "size": {
2462
- "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>",
2463
- "enum": [
2464
- "xx-small",
2465
- "x-small",
2466
- "small",
2467
- "medium",
2468
- "large",
2469
- "x-large",
2470
- "xx-large"
2471
- ],
2472
- "type": "string"
2473
- },
2474
- "background": {
2475
- "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.",
2476
- "type": "string",
2477
- "example": "#000000"
2478
- },
2479
- "position": {
2480
- "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>",
2481
- "enum": [
2482
- "top",
2483
- "topRight",
2484
- "right",
2485
- "bottomRight",
2486
- "bottom",
2487
- "bottomLeft",
2488
- "left",
2489
- "topLeft",
2490
- "center"
2491
- ],
2492
- "type": "string"
2493
- },
2494
- "offset": {
2495
- "description": "Offset the location of the title relative to its position on the screen.",
2496
- "$ref": "#/components/schemas/Offset"
2497
- }
2498
- },
2499
- "additionalProperties": false,
2500
- "required": [
2501
- "type",
2502
- "text"
2503
- ]
2504
- },
2505
- "SvgAsset": {
2506
- "description": "The SvgAsset is used to add scalable vector graphics (SVG) shapes to a video.\nIt provides two mutually exclusive ways to define shapes:\n\n**Option 1: Import SVG markup using `src`**\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```\nWhen using `src`, no other properties are allowed. The fill, stroke, and dimensions\nare automatically extracted from the SVG markup.\n\n**Option 2: Define shapes programmatically using `shape`**\n```json\n{\n \"type\": \"svg\",\n \"shape\": { \"type\": \"circle\", \"radius\": 50 },\n \"fill\": { \"type\": \"solid\", \"color\": \"#FF0000\" }\n}\n```\nWhen using `shape`, you can customize fill, stroke, shadow, transform, and other properties.\nThe `src` property is not allowed in this mode.\n\n**Important:** You must provide either `src` OR `shape`, but not both.\nThese two modes are mutually exclusive.\n\n**Available Shapes (Option 2 only):**\n- `rectangle` - Rectangles with optional rounded corners\n- `circle` - Perfect circles\n- `ellipse` - Ellipses/ovals with separate x and y radii\n- `line` - Straight lines with configurable thickness\n- `polygon` - Regular polygons (triangle, pentagon, hexagon, etc.)\n- `star` - Multi-pointed stars\n- `arrow` - Directional arrows\n- `heart` - Heart shapes\n- `cross` - Plus/cross shapes\n- `ring` - Donut/ring shapes\n- `path` - Custom shapes using SVG path data\n\nSee [W3C SVG 2 Specification](https://www.w3.org/TR/SVG2/) for path data syntax.\n",
2507
- "type": "object",
2508
- "properties": {
2509
- "type": {
2510
- "description": "The asset type - set to `svg` for SVG shapes.",
2511
- "type": "string",
2512
- "enum": [
2513
- "svg"
2514
- ],
2515
- "default": "svg",
2516
- "example": "svg"
2517
- },
2518
- "src": {
2519
- "description": "Raw SVG markup string to import. When provided, the shape is extracted\nautomatically from the SVG content.\n\n**Supported elements:** `<path>`, `<rect>`, `<circle>`, `<ellipse>`,\n`<line>`, `<polygon>`, `<polyline>`\n\n**Automatically extracted:**\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\n**Important:** When using `src`, no other properties (shape, fill, stroke, etc.)\nare allowed. All styling must be defined within the SVG markup itself.\n",
2520
- "type": "string",
2521
- "minLength": 1,
2522
- "maxLength": 500000,
2523
- "example": "<svg width=\"100\" height=\"100\"><circle cx=\"50\" cy=\"50\" r=\"40\" fill=\"#3498db\"/></svg>"
2524
- },
2525
- "shape": {
2526
- "description": "The shape definition using primitives. The `type` property within determines\nthe shape kind and its specific properties.\n\n**Important:** When using `shape`, the `src` property is not allowed.\n",
2527
- "$ref": "#/components/schemas/SvgShape"
2528
- },
2529
- "fill": {
2530
- "description": "Fill properties for the shape interior.\nCan be a solid color or a gradient (linear/radial).\nIf omitted, the shape will have no fill (transparent interior).\n\n**Note:** Only allowed when using `shape`, not with `src`.\n",
2531
- "$ref": "#/components/schemas/SvgFill"
2532
- },
2533
- "stroke": {
2534
- "description": "Stroke (outline) properties for the shape.\nIf omitted, the shape will have no stroke (no outline).\n\n**Note:** Only allowed when using `shape`, not with `src`.\n",
2535
- "$ref": "#/components/schemas/SvgStroke"
2536
- },
2537
- "shadow": {
2538
- "description": "Drop shadow properties for the shape.\nCreates a shadow effect behind the shape.\n\n**Note:** Only allowed when using `shape`, not with `src`.\n",
2539
- "$ref": "#/components/schemas/SvgShadow"
2540
- },
2541
- "transform": {
2542
- "description": "Transform properties for positioning, rotating, and scaling the shape.\nThe transform is applied relative to the transformation origin.\n\n**Note:** Only allowed when using `shape`, not with `src`.\n",
2543
- "$ref": "#/components/schemas/SvgTransform"
2544
- },
2545
- "opacity": {
2546
- "description": "The overall opacity of the entire shape (including fill, stroke, and shadow).\n`1` is fully opaque, `0` is fully transparent.\nThis is applied on top of individual fill/stroke/shadow opacity values.\n\n**Note:** Only allowed when using `shape`, not with `src`.\n",
2547
- "type": "number",
2548
- "minimum": 0,
2549
- "maximum": 1,
2550
- "default": 1,
2551
- "example": 1
2552
- },
2553
- "width": {
2554
- "description": "The width of the bounding box in pixels.\nIf specified, the shape may be scaled to fit within this width.\nIf omitted, the shape uses its natural dimensions.\n\n**Note:** Only allowed when using `shape`, not with `src`.\n",
2555
- "type": "integer",
2556
- "minimum": 1,
2557
- "maximum": 4096,
2558
- "example": 400
2559
- },
2560
- "height": {
2561
- "description": "The height of the bounding box in pixels.\nIf specified, the shape may be scaled to fit within this height.\nIf omitted, the shape uses its natural dimensions.\n\n**Note:** Only allowed when using `shape`, not with `src`.\n",
2562
- "type": "integer",
2563
- "minimum": 1,
2564
- "maximum": 4096,
2565
- "example": 300
2566
- }
2567
- },
2568
- "additionalProperties": false,
2569
- "required": [
2570
- "type"
2571
- ],
2572
- "example": {
2573
- "type": "svg",
2574
- "shape": {
2575
- "type": "star",
2576
- "points": 5,
2577
- "outerRadius": 100,
2578
- "innerRadius": 50
2579
- },
2580
- "fill": {
2581
- "type": "linear",
2582
- "angle": 45,
2583
- "stops": [
2584
- {
2585
- "offset": 0,
2586
- "color": "#FFD700"
2587
- },
2588
- {
2589
- "offset": 1,
2590
- "color": "#FF6B6B"
2591
- }
2592
- ],
2593
- "opacity": 1
2594
- },
2595
- "stroke": {
2596
- "color": "#2C3E50",
2597
- "width": 3,
2598
- "opacity": 1,
2599
- "lineCap": "round",
2600
- "lineJoin": "round"
2601
- },
2602
- "transform": {
2603
- "x": 200,
2604
- "y": 150,
2605
- "rotation": 0,
2606
- "scale": 1
2607
- },
2608
- "opacity": 1
2609
- }
2610
- },
2611
- "SvgShape": {
2612
- "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",
2613
- "oneOf": [
2614
- {
2615
- "$ref": "#/components/schemas/SvgRectangleShape"
2616
- },
2617
- {
2618
- "$ref": "#/components/schemas/SvgCircleShape"
2619
- },
2620
- {
2621
- "$ref": "#/components/schemas/SvgEllipseShape"
2622
- },
2623
- {
2624
- "$ref": "#/components/schemas/SvgLineShape"
2625
- },
2626
- {
2627
- "$ref": "#/components/schemas/SvgPolygonShape"
2628
- },
2629
- {
2630
- "$ref": "#/components/schemas/SvgStarShape"
2631
- },
2632
- {
2633
- "$ref": "#/components/schemas/SvgArrowShape"
2634
- },
2635
- {
2636
- "$ref": "#/components/schemas/SvgHeartShape"
2637
- },
2638
- {
2639
- "$ref": "#/components/schemas/SvgCrossShape"
2640
- },
2641
- {
2642
- "$ref": "#/components/schemas/SvgRingShape"
2643
- },
2644
- {
2645
- "$ref": "#/components/schemas/SvgPathShape"
2646
- }
2647
- ],
2648
- "discriminator": {
2649
- "propertyName": "type",
2650
- "mapping": {
2651
- "rectangle": "#/components/schemas/SvgRectangleShape",
2652
- "circle": "#/components/schemas/SvgCircleShape",
2653
- "ellipse": "#/components/schemas/SvgEllipseShape",
2654
- "line": "#/components/schemas/SvgLineShape",
2655
- "polygon": "#/components/schemas/SvgPolygonShape",
2656
- "star": "#/components/schemas/SvgStarShape",
2657
- "arrow": "#/components/schemas/SvgArrowShape",
2658
- "heart": "#/components/schemas/SvgHeartShape",
2659
- "cross": "#/components/schemas/SvgCrossShape",
2660
- "ring": "#/components/schemas/SvgRingShape",
2661
- "path": "#/components/schemas/SvgPathShape"
2662
- }
2663
- }
2664
- },
2665
- "SvgRectangleShape": {
2666
- "description": "A rectangle shape with optional rounded corners.\nThe rectangle is defined by its width and height dimensions.\n",
2667
- "type": "object",
2668
- "additionalProperties": false,
2669
- "properties": {
2670
- "type": {
2671
- "description": "The shape type - set to `rectangle`.",
2672
- "type": "string",
2673
- "enum": [
2674
- "rectangle"
2675
- ]
2676
- },
2677
- "width": {
2678
- "description": "The width of the rectangle in pixels.",
2679
- "type": "number",
2680
- "minimum": 1,
2681
- "maximum": 4096,
2682
- "example": 200
2683
- },
2684
- "height": {
2685
- "description": "The height of the rectangle in pixels.",
2686
- "type": "number",
2687
- "minimum": 1,
2688
- "maximum": 4096,
2689
- "example": 100
2690
- },
2691
- "cornerRadius": {
2692
- "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",
2693
- "type": "number",
2694
- "minimum": 0,
2695
- "maximum": 2048,
2696
- "default": 0,
2697
- "example": 10
2698
- }
2699
- },
2700
- "required": [
2701
- "type",
2702
- "width",
2703
- "height"
2704
- ]
2705
- },
2706
- "SvgCircleShape": {
2707
- "description": "A perfect circle shape defined by its radius.\nThe circle is centered at the shape's position.\n",
2708
- "type": "object",
2709
- "additionalProperties": false,
2710
- "properties": {
2711
- "type": {
2712
- "description": "The shape type - set to `circle`.",
2713
- "type": "string",
2714
- "enum": [
2715
- "circle"
2716
- ]
2717
- },
2718
- "radius": {
2719
- "description": "The radius of the circle in pixels.",
2720
- "type": "number",
2721
- "minimum": 1,
2722
- "maximum": 2048,
2723
- "example": 50
2724
- }
2725
- },
2726
- "required": [
2727
- "type",
2728
- "radius"
2729
- ]
2730
- },
2731
- "SvgEllipseShape": {
2732
- "description": "An ellipse (oval) shape with separate horizontal and vertical radii.\nThe ellipse is centered at the shape's position.\n",
2733
- "type": "object",
2734
- "additionalProperties": false,
2735
- "properties": {
2736
- "type": {
2737
- "description": "The shape type - set to `ellipse`.",
2738
- "type": "string",
2739
- "enum": [
2740
- "ellipse"
2741
- ]
2742
- },
2743
- "radiusX": {
2744
- "description": "The horizontal radius (semi-major axis) in pixels.",
2745
- "type": "number",
2746
- "minimum": 1,
2747
- "maximum": 2048,
2748
- "example": 80
2749
- },
2750
- "radiusY": {
2751
- "description": "The vertical radius (semi-minor axis) in pixels.",
2752
- "type": "number",
2753
- "minimum": 1,
2754
- "maximum": 2048,
2755
- "example": 50
2756
- }
2757
- },
2758
- "required": [
2759
- "type",
2760
- "radiusX",
2761
- "radiusY"
2762
- ]
2763
- },
2764
- "SvgLineShape": {
2765
- "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",
2766
- "type": "object",
2767
- "additionalProperties": false,
2768
- "properties": {
2769
- "type": {
2770
- "description": "The shape type - set to `line`.",
2771
- "type": "string",
2772
- "enum": [
2773
- "line"
2774
- ]
2775
- },
2776
- "length": {
2777
- "description": "The length of the line in pixels.",
2778
- "type": "number",
2779
- "minimum": 1,
2780
- "maximum": 4096,
2781
- "example": 100
2782
- },
2783
- "thickness": {
2784
- "description": "The thickness of the line in pixels.",
2785
- "type": "number",
2786
- "minimum": 1,
2787
- "maximum": 500,
2788
- "example": 4
2789
- }
2790
- },
2791
- "required": [
2792
- "type",
2793
- "length",
2794
- "thickness"
2795
- ]
2796
- },
2797
- "SvgPolygonShape": {
2798
- "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",
2799
- "type": "object",
2800
- "additionalProperties": false,
2801
- "properties": {
2802
- "type": {
2803
- "description": "The shape type - set to `polygon`.",
2804
- "type": "string",
2805
- "enum": [
2806
- "polygon"
2807
- ]
2808
- },
2809
- "sides": {
2810
- "description": "The number of sides of the polygon.\nMinimum 3 (triangle), maximum 100 for practical use.\n",
2811
- "type": "integer",
2812
- "minimum": 3,
2813
- "maximum": 100,
2814
- "example": 6
2815
- },
2816
- "radius": {
2817
- "description": "The radius of the circumscribed circle in pixels.\nThis determines the size of the polygon.\n",
2818
- "type": "number",
2819
- "minimum": 1,
2820
- "maximum": 2048,
2821
- "example": 50
2822
- }
2823
- },
2824
- "required": [
2825
- "type",
2826
- "sides",
2827
- "radius"
2828
- ]
2829
- },
2830
- "SvgStarShape": {
2831
- "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",
2832
- "type": "object",
2833
- "additionalProperties": false,
2834
- "properties": {
2835
- "type": {
2836
- "description": "The shape type - set to `star`.",
2837
- "type": "string",
2838
- "enum": [
2839
- "star"
2840
- ]
2841
- },
2842
- "points": {
2843
- "description": "The number of points on the star.\nMinimum 3 for a triangle-like star, typically 5 for a classic star.\n",
2844
- "type": "integer",
2845
- "minimum": 3,
2846
- "maximum": 100,
2847
- "example": 5
2848
- },
2849
- "outerRadius": {
2850
- "description": "The outer radius in pixels - the distance from center to the tips of the points.\n",
2851
- "type": "number",
2852
- "minimum": 1,
2853
- "maximum": 2048,
2854
- "example": 50
2855
- },
2856
- "innerRadius": {
2857
- "description": "The inner radius in pixels - the distance from center to the inner vertices.\nShould be smaller than outerRadius for a star effect.\n",
2858
- "type": "number",
2859
- "minimum": 1,
2860
- "maximum": 2048,
2861
- "example": 25
2862
- }
2863
- },
2864
- "required": [
2865
- "type",
2866
- "points",
2867
- "outerRadius",
2868
- "innerRadius"
2869
- ]
2870
- },
2871
- "SvgArrowShape": {
2872
- "description": "An arrow shape pointing to the right by default.\nUse transform rotation to change direction.\n",
2873
- "type": "object",
2874
- "additionalProperties": false,
2875
- "properties": {
2876
- "type": {
2877
- "description": "The shape type - set to `arrow`.",
2878
- "type": "string",
2879
- "enum": [
2880
- "arrow"
2881
- ]
2882
- },
2883
- "length": {
2884
- "description": "The total length of the arrow from tail to tip in pixels.",
2885
- "type": "number",
2886
- "minimum": 1,
2887
- "maximum": 4096,
2888
- "example": 100
2889
- },
2890
- "headWidth": {
2891
- "description": "The width of the arrow head (the widest part) in pixels.",
2892
- "type": "number",
2893
- "minimum": 1,
2894
- "maximum": 1000,
2895
- "example": 40
2896
- },
2897
- "headLength": {
2898
- "description": "The length of the arrow head portion in pixels.",
2899
- "type": "number",
2900
- "minimum": 1,
2901
- "maximum": 1000,
2902
- "example": 30
2903
- },
2904
- "shaftWidth": {
2905
- "description": "The width of the arrow shaft (body) in pixels.",
2906
- "type": "number",
2907
- "minimum": 1,
2908
- "maximum": 1000,
2909
- "example": 20
2910
- }
2911
- },
2912
- "required": [
2913
- "type",
2914
- "length",
2915
- "headWidth",
2916
- "headLength",
2917
- "shaftWidth"
2918
- ]
2919
- },
2920
- "SvgHeartShape": {
2921
- "description": "A heart shape commonly used for love/like icons.\nThe heart is defined by a single size parameter.\n",
2922
- "type": "object",
2923
- "additionalProperties": false,
2924
- "properties": {
2925
- "type": {
2926
- "description": "The shape type - set to `heart`.",
2927
- "type": "string",
2928
- "enum": [
2929
- "heart"
2930
- ]
2931
- },
2932
- "size": {
2933
- "description": "The size of the heart in pixels.\nThis determines both the width and height proportionally.\n",
2934
- "type": "number",
2935
- "minimum": 1,
2936
- "maximum": 4096,
2937
- "example": 100
2938
- }
2939
- },
2940
- "required": [
2941
- "type",
2942
- "size"
2943
- ]
2944
- },
2945
- "SvgCrossShape": {
2946
- "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",
2947
- "type": "object",
2948
- "additionalProperties": false,
2949
- "properties": {
2950
- "type": {
2951
- "description": "The shape type - set to `cross`.",
2952
- "type": "string",
2953
- "enum": [
2954
- "cross"
2955
- ]
2956
- },
2957
- "width": {
2958
- "description": "The total width of the cross in pixels.",
2959
- "type": "number",
2960
- "minimum": 1,
2961
- "maximum": 4096,
2962
- "example": 100
2963
- },
2964
- "height": {
2965
- "description": "The total height of the cross in pixels.",
2966
- "type": "number",
2967
- "minimum": 1,
2968
- "maximum": 4096,
2969
- "example": 100
2970
- },
2971
- "thickness": {
2972
- "description": "The thickness of the cross arms in pixels.",
2973
- "type": "number",
2974
- "minimum": 1,
2975
- "maximum": 500,
2976
- "example": 20
2977
- }
2978
- },
2979
- "required": [
2980
- "type",
2981
- "width",
2982
- "height",
2983
- "thickness"
2984
- ]
2985
- },
2986
- "SvgRingShape": {
2987
- "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",
2988
- "type": "object",
2989
- "additionalProperties": false,
2990
- "properties": {
2991
- "type": {
2992
- "description": "The shape type - set to `ring`.",
2993
- "type": "string",
2994
- "enum": [
2995
- "ring"
2996
- ]
2997
- },
2998
- "outerRadius": {
2999
- "description": "The outer radius of the ring in pixels.",
3000
- "type": "number",
3001
- "minimum": 1,
3002
- "maximum": 2048,
3003
- "example": 50
3004
- },
3005
- "innerRadius": {
3006
- "description": "The inner radius (hole) of the ring in pixels.\nMust be smaller than outerRadius.\n",
3007
- "type": "number",
3008
- "minimum": 0,
3009
- "maximum": 2048,
3010
- "example": 30
3011
- }
3012
- },
3013
- "required": [
3014
- "type",
3015
- "outerRadius",
3016
- "innerRadius"
3017
- ]
3018
- },
3019
- "SvgPathShape": {
3020
- "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",
3021
- "type": "object",
3022
- "additionalProperties": false,
3023
- "properties": {
3024
- "type": {
3025
- "description": "The shape type - set to `path`.",
3026
- "type": "string",
3027
- "enum": [
3028
- "path"
3029
- ]
3030
- },
3031
- "d": {
3032
- "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",
3033
- "type": "string",
3034
- "minLength": 1,
3035
- "maxLength": 100000,
3036
- "example": "M 0 0 L 100 0 L 50 86.6 Z"
3037
- }
3038
- },
3039
- "required": [
3040
- "type",
3041
- "d"
3042
- ]
3043
- },
3044
- "SvgFill": {
3045
- "description": "Fill properties for SVG shapes. Supports solid colors and gradients.\nThe fill defines how the interior of a shape is painted.\n",
3046
- "oneOf": [
3047
- {
3048
- "$ref": "#/components/schemas/SvgSolidFill"
3049
- },
3050
- {
3051
- "$ref": "#/components/schemas/SvgLinearGradientFill"
3052
- },
3053
- {
3054
- "$ref": "#/components/schemas/SvgRadialGradientFill"
3055
- }
3056
- ],
3057
- "discriminator": {
3058
- "propertyName": "type",
3059
- "mapping": {
3060
- "solid": "#/components/schemas/SvgSolidFill",
3061
- "linear": "#/components/schemas/SvgLinearGradientFill",
3062
- "radial": "#/components/schemas/SvgRadialGradientFill"
3063
- }
3064
- }
3065
- },
3066
- "SvgSolidFill": {
3067
- "description": "A solid color fill for SVG shapes.",
3068
- "type": "object",
3069
- "additionalProperties": false,
3070
- "properties": {
3071
- "type": {
3072
- "description": "The fill type - set to `solid` for a single color fill.",
3073
- "type": "string",
3074
- "enum": [
3075
- "solid"
3076
- ],
3077
- "default": "solid"
3078
- },
3079
- "color": {
3080
- "description": "The fill color using hexadecimal color notation (e.g., `#FF0000` for red).\nMust be a 6-digit hex color code prefixed with `#`.\n",
3081
- "type": "string",
3082
- "pattern": "^#[A-Fa-f0-9]{6}$",
3083
- "default": "#000000",
3084
- "example": "#3498db"
3085
- },
3086
- "opacity": {
3087
- "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",
3088
- "type": "number",
3089
- "minimum": 0,
3090
- "maximum": 1,
3091
- "default": 1,
3092
- "example": 0.8
3093
- }
3094
- },
3095
- "required": [
3096
- "type",
3097
- "color"
3098
- ]
3099
- },
3100
- "SvgLinearGradientFill": {
3101
- "description": "A linear gradient fill that transitions colors along a straight line.\nThe gradient direction is controlled by the `angle` property.\n",
3102
- "type": "object",
3103
- "additionalProperties": false,
3104
- "properties": {
3105
- "type": {
3106
- "description": "The fill type - set to `linear` for a linear gradient fill.",
3107
- "type": "string",
3108
- "enum": [
3109
- "linear"
3110
- ]
3111
- },
3112
- "angle": {
3113
- "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",
3114
- "type": "number",
3115
- "minimum": 0,
3116
- "maximum": 360,
3117
- "default": 0,
3118
- "example": 45
3119
- },
3120
- "stops": {
3121
- "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",
3122
- "type": "array",
3123
- "minItems": 2,
3124
- "items": {
3125
- "$ref": "#/components/schemas/SvgGradientStop"
3126
- }
3127
- },
3128
- "opacity": {
3129
- "description": "The overall opacity of the gradient where `1` is fully opaque and `0` is fully transparent.\n",
3130
- "type": "number",
3131
- "minimum": 0,
3132
- "maximum": 1,
3133
- "default": 1,
3134
- "example": 1
3135
- }
3136
- },
3137
- "required": [
3138
- "type",
3139
- "stops"
3140
- ]
3141
- },
3142
- "SvgRadialGradientFill": {
3143
- "description": "A radial gradient fill that transitions colors radiating outward from a center point.\nThe gradient creates a circular or elliptical color transition.\n",
3144
- "type": "object",
3145
- "additionalProperties": false,
3146
- "properties": {
3147
- "type": {
3148
- "description": "The fill type - set to `radial` for a radial gradient fill.",
3149
- "type": "string",
3150
- "enum": [
3151
- "radial"
3152
- ]
3153
- },
3154
- "stops": {
3155
- "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",
3156
- "type": "array",
3157
- "minItems": 2,
3158
- "items": {
3159
- "$ref": "#/components/schemas/SvgGradientStop"
3160
- }
3161
- },
3162
- "opacity": {
3163
- "description": "The overall opacity of the gradient where `1` is fully opaque and `0` is fully transparent.\n",
3164
- "type": "number",
3165
- "minimum": 0,
3166
- "maximum": 1,
3167
- "default": 1,
3168
- "example": 1
2361
+ "enum": [
2362
+ "top",
2363
+ "topRight",
2364
+ "right",
2365
+ "bottomRight",
2366
+ "bottom",
2367
+ "bottomLeft",
2368
+ "left",
2369
+ "topLeft",
2370
+ "center"
2371
+ ],
2372
+ "type": "string"
3169
2373
  }
3170
2374
  },
2375
+ "additionalProperties": false,
3171
2376
  "required": [
3172
2377
  "type",
3173
- "stops"
2378
+ "html"
3174
2379
  ]
3175
2380
  },
3176
- "SvgGradientStop": {
3177
- "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",
2381
+ "TitleAsset": {
2382
+ "deprecated": true,
2383
+ "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",
3178
2384
  "type": "object",
3179
- "additionalProperties": false,
3180
2385
  "properties": {
3181
- "offset": {
3182
- "description": "Position of the color stop along the gradient vector.\n`0` represents the start and `1` represents the end of the gradient.\n",
3183
- "type": "number",
3184
- "minimum": 0,
3185
- "maximum": 1,
3186
- "example": 0.5
2386
+ "type": {
2387
+ "enum": [
2388
+ "title"
2389
+ ],
2390
+ "default": "title",
2391
+ "description": "The type of asset - set to `title` for titles.",
2392
+ "type": "string"
3187
2393
  },
3188
- "color": {
3189
- "description": "The color at this stop using hexadecimal color notation.",
3190
- "type": "string",
3191
- "pattern": "^#[A-Fa-f0-9]{6}$",
3192
- "example": "#e74c3c"
3193
- }
3194
- },
3195
- "required": [
3196
- "offset",
3197
- "color"
3198
- ]
3199
- },
3200
- "SvgStroke": {
3201
- "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",
3202
- "type": "object",
3203
- "additionalProperties": false,
3204
- "properties": {
3205
- "color": {
3206
- "description": "The stroke color using hexadecimal color notation.",
2394
+ "text": {
2395
+ "description": "The title text string - i.e. \"My Title\".",
3207
2396
  "type": "string",
3208
- "pattern": "^#[A-Fa-f0-9]{6}$",
3209
- "default": "#000000",
3210
- "example": "#2c3e50"
2397
+ "example": "Hello World"
3211
2398
  },
3212
- "width": {
3213
- "description": "The width of the stroke in pixels. Must be greater than 0.\nLarger values create thicker outlines.\n",
3214
- "type": "number",
3215
- "minimum": 0,
3216
- "maximum": 100,
3217
- "default": 1,
3218
- "example": 2
2399
+ "style": {
2400
+ "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>",
2401
+ "enum": [
2402
+ "minimal",
2403
+ "blockbuster",
2404
+ "vogue",
2405
+ "sketchy",
2406
+ "skinny",
2407
+ "chunk",
2408
+ "chunkLight",
2409
+ "marker",
2410
+ "future",
2411
+ "subtitle"
2412
+ ],
2413
+ "type": "string"
3219
2414
  },
3220
- "opacity": {
3221
- "description": "The opacity of the stroke where `1` is opaque and `0` is transparent.",
3222
- "type": "number",
3223
- "minimum": 0,
3224
- "maximum": 1,
3225
- "default": 1,
3226
- "example": 1
2415
+ "color": {
2416
+ "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.",
2417
+ "type": "string"
3227
2418
  },
3228
- "lineCap": {
3229
- "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",
3230
- "type": "string",
2419
+ "size": {
2420
+ "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>",
3231
2421
  "enum": [
3232
- "butt",
3233
- "round",
3234
- "square"
2422
+ "xx-small",
2423
+ "x-small",
2424
+ "small",
2425
+ "medium",
2426
+ "large",
2427
+ "x-large",
2428
+ "xx-large"
3235
2429
  ],
3236
- "default": "butt",
3237
- "example": "round"
2430
+ "type": "string"
3238
2431
  },
3239
- "lineJoin": {
3240
- "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",
2432
+ "background": {
2433
+ "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.",
3241
2434
  "type": "string",
2435
+ "example": "#000000"
2436
+ },
2437
+ "position": {
2438
+ "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>",
3242
2439
  "enum": [
3243
- "miter",
3244
- "round",
3245
- "bevel"
2440
+ "top",
2441
+ "topRight",
2442
+ "right",
2443
+ "bottomRight",
2444
+ "bottom",
2445
+ "bottomLeft",
2446
+ "left",
2447
+ "topLeft",
2448
+ "center"
3246
2449
  ],
3247
- "default": "miter",
3248
- "example": "round"
3249
- },
3250
- "dashArray": {
3251
- "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",
3252
- "type": "array",
3253
- "items": {
3254
- "type": "number",
3255
- "minimum": 0
3256
- },
3257
- "example": [
3258
- 10,
3259
- 5
3260
- ]
2450
+ "type": "string"
3261
2451
  },
3262
- "dashOffset": {
3263
- "description": "Offset for the dash pattern. Positive values shift the pattern\nforward along the path, negative values shift it backward.\n",
3264
- "type": "number",
3265
- "default": 0,
3266
- "example": 5
2452
+ "offset": {
2453
+ "description": "Offset the location of the title relative to its position on the screen.",
2454
+ "$ref": "#/components/schemas/Offset"
3267
2455
  }
3268
- }
2456
+ },
2457
+ "additionalProperties": false,
2458
+ "required": [
2459
+ "type",
2460
+ "text"
2461
+ ]
3269
2462
  },
3270
- "SvgShadow": {
3271
- "description": "Drop shadow properties for SVG shapes. Creates a shadow effect behind the shape.\n",
2463
+ "SvgAsset": {
2464
+ "description": "The SvgAsset is used to create scalable vector graphic (SVG) assets using\nraw 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\nSee [W3C SVG 2 Specification](https://www.w3.org/TR/SVG2/) for SVG markup syntax.\n",
3272
2465
  "type": "object",
3273
- "additionalProperties": false,
3274
2466
  "properties": {
3275
- "offsetX": {
3276
- "description": "Horizontal offset of the shadow in pixels.\nPositive values move the shadow to the right, negative to the left.\n",
3277
- "type": "number",
3278
- "default": 0,
3279
- "example": 4
3280
- },
3281
- "offsetY": {
3282
- "description": "Vertical offset of the shadow in pixels.\nPositive values move the shadow down, negative values move it up.\n",
3283
- "type": "number",
3284
- "default": 0,
3285
- "example": 4
3286
- },
3287
- "blur": {
3288
- "description": "The blur radius of the shadow in pixels. Must be 0 or greater.",
3289
- "type": "number",
3290
- "minimum": 0,
3291
- "default": 0,
3292
- "example": 8
3293
- },
3294
- "color": {
3295
- "description": "The shadow color using hexadecimal color notation.",
2467
+ "type": {
2468
+ "description": "The asset type - set to `svg` for SVG assets.",
3296
2469
  "type": "string",
3297
- "pattern": "^#[A-Fa-f0-9]{6}$",
3298
- "default": "#000000",
3299
- "example": "#000000"
2470
+ "enum": [
2471
+ "svg"
2472
+ ],
2473
+ "default": "svg",
2474
+ "example": "svg"
3300
2475
  },
3301
- "opacity": {
3302
- "description": "The opacity of the shadow where `1` is opaque and `0` is transparent.",
3303
- "type": "number",
3304
- "minimum": 0,
3305
- "maximum": 1,
3306
- "default": 0.5,
3307
- "example": 0.3
2476
+ "src": {
2477
+ "description": "Raw SVG markup string to import.\n\n**Supported elements:** `<path>`, `<rect>`, `<circle>`, `<ellipse>`,\n`<line>`, `<polygon>`, `<polyline>`\n",
2478
+ "type": "string",
2479
+ "minLength": 1,
2480
+ "maxLength": 500000,
2481
+ "example": "<svg width=\"100\" height=\"100\"><circle cx=\"50\" cy=\"50\" r=\"40\" fill=\"#3498db\"/></svg>"
3308
2482
  }
3309
- }
3310
- },
3311
- "SvgTransform": {
3312
- "description": "Transformation properties for positioning, rotating, and scaling SVG shapes.\n",
3313
- "type": "object",
2483
+ },
3314
2484
  "additionalProperties": false,
3315
- "properties": {
3316
- "x": {
3317
- "description": "The x-coordinate position of the shape in pixels.\nRelative to the top-left corner of the viewport.\n",
3318
- "type": "number",
3319
- "default": 0,
3320
- "example": 100
3321
- },
3322
- "y": {
3323
- "description": "The y-coordinate position of the shape in pixels.\nRelative to the top-left corner of the viewport.\n",
3324
- "type": "number",
3325
- "default": 0,
3326
- "example": 100
3327
- },
3328
- "rotation": {
3329
- "description": "Rotation angle in degrees. Positive values rotate clockwise,\nnegative values rotate counter-clockwise. Range: -360 to 360.\n",
3330
- "type": "number",
3331
- "minimum": -360,
3332
- "maximum": 360,
3333
- "default": 0,
3334
- "example": 45
3335
- },
3336
- "scale": {
3337
- "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",
3338
- "type": "number",
3339
- "minimum": 0.01,
3340
- "maximum": 100,
3341
- "default": 1,
3342
- "example": 1.5
3343
- },
3344
- "originX": {
3345
- "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",
3346
- "type": "number",
3347
- "minimum": 0,
3348
- "maximum": 1,
3349
- "default": 0.5,
3350
- "example": 0.5
3351
- },
3352
- "originY": {
3353
- "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",
3354
- "type": "number",
3355
- "minimum": 0,
3356
- "maximum": 1,
3357
- "default": 0.5,
3358
- "example": 0.5
3359
- }
2485
+ "required": [
2486
+ "type",
2487
+ "src"
2488
+ ],
2489
+ "example": {
2490
+ "type": "svg",
2491
+ "src": "<svg width=\"100\" height=\"100\"><circle cx=\"50\" cy=\"50\" r=\"40\" fill=\"#3498db\"/></svg>"
3360
2492
  }
3361
2493
  },
3362
2494
  "Transition": {
@@ -4614,6 +3746,106 @@
4614
3746
  "required": [
4615
3747
  "provider"
4616
3748
  ]
3749
+ },
3750
+ {
3751
+ "description": "Send videos and assets to [Akamai NetStorage](https://techdocs.akamai.com/netstorage-usage/docs). Send files to your NetStorage upload directory with a custom path and filename. Akamai credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/akamai-netstorage), not in the request.",
3752
+ "properties": {
3753
+ "provider": {
3754
+ "description": "The destination to send assets to - set to `akamai-netstorage` for Akamai NetStorage.",
3755
+ "type": "string",
3756
+ "default": "akamai-netstorage",
3757
+ "example": "akamai-netstorage"
3758
+ },
3759
+ "options": {
3760
+ "description": "Additional Akamai NetStorage configuration options.",
3761
+ "properties": {
3762
+ "host": {
3763
+ "description": "The Akamai NetStorage hostname, i.e. `example-nsu.akamaihd.net`.",
3764
+ "type": "string",
3765
+ "example": "example-nsu.akamaihd.net"
3766
+ },
3767
+ "cpCode": {
3768
+ "description": "The Content Provider code (CP code) for the NetStorage upload directory.",
3769
+ "type": "string",
3770
+ "example": "123456"
3771
+ },
3772
+ "path": {
3773
+ "description": "A remote directory path/prefix for the file being sent, i.e. `videos` or `customerId/videos`.",
3774
+ "type": [
3775
+ "string",
3776
+ "null"
3777
+ ],
3778
+ "example": "videos"
3779
+ },
3780
+ "filename": {
3781
+ "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.",
3782
+ "type": [
3783
+ "string",
3784
+ "null"
3785
+ ],
3786
+ "example": "my-file"
3787
+ }
3788
+ },
3789
+ "required": [
3790
+ "host",
3791
+ "cpCode"
3792
+ ]
3793
+ }
3794
+ },
3795
+ "type": "object",
3796
+ "required": [
3797
+ "provider"
3798
+ ]
3799
+ },
3800
+ {
3801
+ "description": "Send videos and assets to [Azure Blob Storage](https://learn.microsoft.com/en-us/azure/storage/blobs/). Send files to any container with a custom prefix and filename. Azure credentials are required and added via the [dashboard](https://dashboard.shotstack.io/integrations/azure-blob-storage), not in the request.",
3802
+ "properties": {
3803
+ "provider": {
3804
+ "description": "The destination to send assets to - set to `azure-blob-storage` for Azure Blob Storage.",
3805
+ "type": "string",
3806
+ "default": "azure-blob-storage",
3807
+ "example": "azure-blob-storage"
3808
+ },
3809
+ "options": {
3810
+ "description": "Additional Azure Blob Storage configuration options.",
3811
+ "properties": {
3812
+ "accountName": {
3813
+ "description": "The Azure Storage account name.",
3814
+ "type": "string",
3815
+ "example": "mystorageaccount"
3816
+ },
3817
+ "container": {
3818
+ "description": "The Blob container name. The container must exist in the Azure Storage account before files can be sent.",
3819
+ "type": "string",
3820
+ "example": "my-container"
3821
+ },
3822
+ "prefix": {
3823
+ "description": "A virtual directory prefix for the blob being sent, i.e. `videos` or `customerId/videos`.",
3824
+ "type": [
3825
+ "string",
3826
+ "null"
3827
+ ],
3828
+ "example": "videos"
3829
+ },
3830
+ "filename": {
3831
+ "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.",
3832
+ "type": [
3833
+ "string",
3834
+ "null"
3835
+ ],
3836
+ "example": "my-file"
3837
+ }
3838
+ },
3839
+ "required": [
3840
+ "accountName",
3841
+ "container"
3842
+ ]
3843
+ }
3844
+ },
3845
+ "type": "object",
3846
+ "required": [
3847
+ "provider"
3848
+ ]
4617
3849
  }
4618
3850
  ],
4619
3851
  "additionalProperties": false