@shotstack/schemas 1.9.5 → 1.9.7

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 +83 -1263
  2. package/dist/json-schema/asset.json +3 -858
  3. package/dist/json-schema/clip.json +3 -858
  4. package/dist/json-schema/edit.json +3 -858
  5. package/dist/json-schema/rich-caption-active-font.json +1 -4
  6. package/dist/json-schema/rich-caption-active.json +1 -4
  7. package/dist/json-schema/rich-caption-asset.json +1 -4
  8. package/dist/json-schema/schemas.json +6 -954
  9. package/dist/json-schema/svg-asset.json +6 -857
  10. package/dist/json-schema/timeline.json +3 -858
  11. package/dist/json-schema/track.json +3 -858
  12. package/dist/schema.d.ts +15 -1040
  13. package/dist/zod/zod.gen.cjs +36 -726
  14. package/dist/zod/zod.gen.d.ts +542 -11591
  15. package/dist/zod/zod.gen.js +29 -718
  16. package/dist/zod/zod.gen.ts +31 -711
  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
package/dist/schema.d.ts CHANGED
@@ -371,55 +371,6 @@ export interface paths {
371
371
  patch?: never;
372
372
  trace?: never;
373
373
  };
374
- "/path_alias_createassets": {
375
- parameters: {
376
- query?: never;
377
- header?: never;
378
- path?: never;
379
- cookie?: never;
380
- };
381
- get?: never;
382
- put?: never;
383
- /**
384
- * Generate Asset
385
- * @description Generate an asset using a Shotstack or third party provider. Chose the provider, type of asset and provide prompts,
386
- * inputs and options to generate the asset. Once generated the asset can be used with the [Edit](#tocs_edit) API or
387
- * downloaded.
388
- *
389
- * **Base URL:** <a href="#">https://api.shotstack.io/create/{version}</a>
390
- */
391
- post: operations["postGenerateAsset"];
392
- delete?: never;
393
- options?: never;
394
- head?: never;
395
- patch?: never;
396
- trace?: never;
397
- };
398
- "/path_alias_createassets/{id}": {
399
- parameters: {
400
- query?: never;
401
- header?: never;
402
- path: {
403
- /** @description The id of the source file in [KSUID](https://github.com/segmentio/ksuid#what-is-a-ksuid) format. */
404
- id: string;
405
- };
406
- cookie?: never;
407
- };
408
- /**
409
- * Get Generated Asset
410
- * @description Get the generated assets status, url and details by ID.
411
- *
412
- * **Base URL:** <a href="#">https://api.shotstack.io/create/{version}</a>
413
- */
414
- get: operations["getGeneratedAsset"];
415
- put?: never;
416
- post?: never;
417
- delete?: never;
418
- options?: never;
419
- head?: never;
420
- patch?: never;
421
- trace?: never;
422
- };
423
374
  }
424
375
  export type webhooks = Record<string, never>;
425
376
  export interface components {
@@ -1088,8 +1039,7 @@ export interface components {
1088
1039
  RichCaptionActiveFont: {
1089
1040
  /**
1090
1041
  * @description The active word color using hexadecimal color notation.
1091
- * @default #ffff00
1092
- * @example #ffff00
1042
+ * @example #C96741
1093
1043
  */
1094
1044
  color?: string;
1095
1045
  /**
@@ -1383,175 +1333,43 @@ export interface components {
1383
1333
  offset?: components["schemas"]["Offset"];
1384
1334
  };
1385
1335
  /**
1386
- * @description The SvgAsset is used to add scalable vector graphics (SVG) shapes to a video.
1387
- * It provides two mutually exclusive ways to define shapes:
1336
+ * @description The SvgAsset is used to add scalable vector graphics (SVG) to a video using raw SVG markup.
1388
1337
  *
1389
- * **Option 1: Import SVG markup using `src`**
1390
1338
  * ```json
1391
1339
  * {
1392
1340
  * "type": "svg",
1393
1341
  * "src": "<svg width=\"100\" height=\"100\"><circle cx=\"50\" cy=\"50\" r=\"40\" fill=\"#FF0000\"/></svg>"
1394
1342
  * }
1395
1343
  * ```
1396
- * When using `src`, no other properties are allowed. The fill, stroke, and dimensions
1397
- * are automatically extracted from the SVG markup.
1398
- *
1399
- * **Option 2: Define shapes programmatically using `shape`**
1400
- * ```json
1401
- * {
1402
- * "type": "svg",
1403
- * "shape": { "type": "circle", "radius": 50 },
1404
- * "fill": { "type": "solid", "color": "#FF0000" }
1405
- * }
1406
- * ```
1407
- * When using `shape`, you can customize fill, stroke, shadow, transform, and other properties.
1408
- * The `src` property is not allowed in this mode.
1409
1344
  *
1410
- * **Important:** You must provide either `src` OR `shape`, but not both.
1411
- * These two modes are mutually exclusive.
1345
+ * **Supported elements:** `<path>`, `<rect>`, `<circle>`, `<ellipse>`,
1346
+ * `<line>`, `<polygon>`, `<polyline>`
1412
1347
  *
1413
- * **Available Shapes (Option 2 only):**
1414
- * - `rectangle` - Rectangles with optional rounded corners
1415
- * - `circle` - Perfect circles
1416
- * - `ellipse` - Ellipses/ovals with separate x and y radii
1417
- * - `line` - Straight lines with configurable thickness
1418
- * - `polygon` - Regular polygons (triangle, pentagon, hexagon, etc.)
1419
- * - `star` - Multi-pointed stars
1420
- * - `arrow` - Directional arrows
1421
- * - `heart` - Heart shapes
1422
- * - `cross` - Plus/cross shapes
1423
- * - `ring` - Donut/ring shapes
1424
- * - `path` - Custom shapes using SVG path data
1348
+ * **Automatically extracted from SVG markup:**
1349
+ * - Path data (converted to a single combined path)
1350
+ * - Fill color (from `fill` attribute or `style`)
1351
+ * - Stroke color and width (from attributes or `style`)
1352
+ * - Dimensions (from `width`/`height` or `viewBox`)
1353
+ * - Opacity (from `opacity` attribute)
1425
1354
  *
1426
1355
  * See [W3C SVG 2 Specification](https://www.w3.org/TR/SVG2/) for path data syntax.
1427
1356
  * @example {
1428
1357
  * "type": "svg",
1429
- * "shape": {
1430
- * "type": "star",
1431
- * "points": 5,
1432
- * "outerRadius": 100,
1433
- * "innerRadius": 50
1434
- * },
1435
- * "fill": {
1436
- * "type": "linear",
1437
- * "angle": 45,
1438
- * "stops": [
1439
- * {
1440
- * "offset": 0,
1441
- * "color": "#FFD700"
1442
- * },
1443
- * {
1444
- * "offset": 1,
1445
- * "color": "#FF6B6B"
1446
- * }
1447
- * ],
1448
- * "opacity": 1
1449
- * },
1450
- * "stroke": {
1451
- * "color": "#2C3E50",
1452
- * "width": 3,
1453
- * "opacity": 1,
1454
- * "lineCap": "round",
1455
- * "lineJoin": "round"
1456
- * },
1457
- * "transform": {
1458
- * "x": 200,
1459
- * "y": 150,
1460
- * "rotation": 0,
1461
- * "scale": 1
1462
- * },
1463
- * "opacity": 1
1358
+ * "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>"
1464
1359
  * }
1465
1360
  */
1466
1361
  SvgAsset: {
1467
1362
  /**
1468
- * @description The asset type - set to `svg` for SVG shapes. (enum property replaced by openapi-typescript)
1363
+ * @description The asset type - set to `svg` for SVG assets. (enum property replaced by openapi-typescript)
1469
1364
  * @enum {string}
1470
1365
  */
1471
1366
  type: "svg";
1472
1367
  /**
1473
- * @description Raw SVG markup string to import. When provided, the shape is extracted
1474
- * automatically from the SVG content.
1475
- *
1476
- * **Supported elements:** `<path>`, `<rect>`, `<circle>`, `<ellipse>`,
1477
- * `<line>`, `<polygon>`, `<polyline>`
1478
- *
1479
- * **Automatically extracted:**
1480
- * - Path data (converted to a single combined path)
1481
- * - Fill color (from `fill` attribute or `style`)
1482
- * - Stroke color and width (from attributes or `style`)
1483
- * - Dimensions (from `width`/`height` or `viewBox`)
1484
- * - Opacity (from `opacity` attribute)
1485
- *
1486
- * **Important:** When using `src`, no other properties (shape, fill, stroke, etc.)
1487
- * are allowed. All styling must be defined within the SVG markup itself.
1368
+ * @description Raw SVG markup string. The shape, fill, stroke, dimensions and opacity
1369
+ * are automatically extracted from the SVG content.
1488
1370
  * @example <svg width="100" height="100"><circle cx="50" cy="50" r="40" fill="#3498db"/></svg>
1489
1371
  */
1490
- src?: string;
1491
- /**
1492
- * @description The shape definition using primitives. The `type` property within determines
1493
- * the shape kind and its specific properties.
1494
- *
1495
- * **Important:** When using `shape`, the `src` property is not allowed.
1496
- */
1497
- shape?: components["schemas"]["SvgShape"];
1498
- /**
1499
- * @description Fill properties for the shape interior.
1500
- * Can be a solid color or a gradient (linear/radial).
1501
- * If omitted, the shape will have no fill (transparent interior).
1502
- *
1503
- * **Note:** Only allowed when using `shape`, not with `src`.
1504
- */
1505
- fill?: components["schemas"]["SvgFill"];
1506
- /**
1507
- * @description Stroke (outline) properties for the shape.
1508
- * If omitted, the shape will have no stroke (no outline).
1509
- *
1510
- * **Note:** Only allowed when using `shape`, not with `src`.
1511
- */
1512
- stroke?: components["schemas"]["SvgStroke"];
1513
- /**
1514
- * @description Drop shadow properties for the shape.
1515
- * Creates a shadow effect behind the shape.
1516
- *
1517
- * **Note:** Only allowed when using `shape`, not with `src`.
1518
- */
1519
- shadow?: components["schemas"]["SvgShadow"];
1520
- /**
1521
- * @description Transform properties for positioning, rotating, and scaling the shape.
1522
- * The transform is applied relative to the transformation origin.
1523
- *
1524
- * **Note:** Only allowed when using `shape`, not with `src`.
1525
- */
1526
- transform?: components["schemas"]["SvgTransform"];
1527
- /**
1528
- * @description The overall opacity of the entire shape (including fill, stroke, and shadow).
1529
- * `1` is fully opaque, `0` is fully transparent.
1530
- * This is applied on top of individual fill/stroke/shadow opacity values.
1531
- *
1532
- * **Note:** Only allowed when using `shape`, not with `src`.
1533
- * @default 1
1534
- * @example 1
1535
- */
1536
- opacity?: number;
1537
- /**
1538
- * @description The width of the bounding box in pixels.
1539
- * If specified, the shape may be scaled to fit within this width.
1540
- * If omitted, the shape uses its natural dimensions.
1541
- *
1542
- * **Note:** Only allowed when using `shape`, not with `src`.
1543
- * @example 400
1544
- */
1545
- width?: number;
1546
- /**
1547
- * @description The height of the bounding box in pixels.
1548
- * If specified, the shape may be scaled to fit within this height.
1549
- * If omitted, the shape uses its natural dimensions.
1550
- *
1551
- * **Note:** Only allowed when using `shape`, not with `src`.
1552
- * @example 300
1553
- */
1554
- height?: number;
1372
+ src: string;
1555
1373
  };
1556
1374
  /**
1557
1375
  * @description The shape definition for an SVG asset. Each shape type has its own specific
@@ -3326,704 +3144,6 @@ export interface components {
3326
3144
  /** @description Specify the storage locations and hosting services to send the file to. */
3327
3145
  destinations: components["schemas"]["Destinations"][];
3328
3146
  };
3329
- /** @description A generated asset is a media asset created by the Create API. You can use native or third party providers to generate video, audio and image files using Generative AI services like text-to-speech and text-to-avatar. */
3330
- GeneratedAsset: components["schemas"]["ShotstackGeneratedAsset"] | components["schemas"]["DIDGeneratedAsset"] | components["schemas"]["ElevenLabsGeneratedAsset"] | components["schemas"]["HeyGenGeneratedAsset"] | components["schemas"]["OpenAiGeneratedAsset"] | components["schemas"]["StabilityAiGeneratedAsset"];
3331
- /** @description Generate assets using the native Shotstack provider. Shotstack provides a text-to-speech and a text-to-image service. The Shotstack provider works natively with your existing API key, no additional credentials are required. */
3332
- ShotstackGeneratedAsset: {
3333
- /**
3334
- * @description The name of the provider - set to `shotstack` for Shotstack. (enum property replaced by openapi-typescript)
3335
- * @enum {string}
3336
- */
3337
- provider: "ShotstackGeneratedAsset";
3338
- /** @description Options and configuration for the native Shotstack services. */
3339
- options: components["schemas"]["ShotstackGeneratedAssetOptions"];
3340
- };
3341
- /** @description Generate assets using the native Shotstack provider AI services. */
3342
- ShotstackGeneratedAssetOptions: components["schemas"]["ShotstackTextToSpeechOptions"] | components["schemas"]["ShotstackTextToImageOptions"] | components["schemas"]["ShotstackTextGeneratorOptions"] | components["schemas"]["ShotstackImageToVideoOptions"];
3343
- /** @description Options for the Shotstack text-to-speech service. Set the text to be converted to speech and choose a voice to set the speaking style. The output will be generated as an MP3 audio file available at the URL returned in the response. */
3344
- ShotstackTextToSpeechOptions: {
3345
- /**
3346
- * @description The type of asset to generate - set to `text-to-speech` for text-to-speech.
3347
- * @default text-to-speech
3348
- * @enum {string}
3349
- */
3350
- type: "text-to-speech";
3351
- /**
3352
- * @description The text to convert to speech.
3353
- * @example This is a text to speech example generated by Shotstack
3354
- */
3355
- text: string;
3356
- /**
3357
- * @description The voice to use for the text-to-speech conversion. You must pair the correct voice with the correct language. For each language there is a language code that must be set in the `language` property. The voice must be available for the language code or the conversion will fail. i.e. To use the voice `Zeina` for Arabic you must set the `language` to `arb`.
3358
- * Select a voice from the list of available voices, the language code is in brackets: <ul>
3359
- * <li>Arabic - Gulf (ar-AE)</li>
3360
- * <ul>
3361
- * <li>`Hala`</li>
3362
- * </ul>
3363
- * <li>Dutch - Belgian (nl-BE)</li>
3364
- * <ul>
3365
- * <li>`Lisa`</li>
3366
- * </ul>
3367
- * <li>Catalan (ca-ES)</li>
3368
- * <ul>
3369
- * <li>`Arlet`</li>
3370
- * </ul>
3371
- * <li>Chinese - Cantonese (yue-CN)</li>
3372
- * <ul>
3373
- * <li>`Hiujin`</li>
3374
- * </ul>
3375
- * <li>Chinese - Mandarin (cmn-CN)</li>
3376
- * <ul>
3377
- * <li>`Zhiyu`</li>
3378
- * </ul>
3379
- * <li>Danish (da-DK)</li>
3380
- * <ul>
3381
- * <li>`Sofie`</li>
3382
- * </ul>
3383
- * <li>Dutch (nl-NL)</li>
3384
- * <ul>
3385
- * <li>`Laura`</li>
3386
- * </ul>
3387
- * <li>English - Australian (en-AU)</li>
3388
- * <ul>
3389
- * <li>`Olivia`</li>
3390
- * </ul>
3391
- * <li>English - British (en-GB)</li>
3392
- * <ul>
3393
- * <li>`Amy`</li>
3394
- * <li>`Emma`</li>
3395
- * <li>`Brian`</li>
3396
- * <li>`Arthur`</li>
3397
- * </ul>
3398
- * <li>English - Indian (en-IN)</li>
3399
- * <ul>
3400
- * <li>`Kajal`</li>
3401
- * </ul>
3402
- * <li>English - Ireland (en-IE)</li>
3403
- * <ul>
3404
- * <li>`Niamh`</li>
3405
- * </ul>
3406
- * <li>English - New Zealand (en-NZ)</li>
3407
- * <ul>
3408
- * <li>`Aria`</li>
3409
- * </ul>
3410
- * <li>English - South African (en-ZA)</li>
3411
- * <ul>
3412
- * <li>`Ayanda`</li>
3413
- * </ul>
3414
- * <li>English - US (en-US)</li>
3415
- * <ul>
3416
- * <li>`Ivy`</li>
3417
- * <li>`Joanna`</li>
3418
- * <li>`Kendra`</li>
3419
- * <li>`Kimberly`</li>
3420
- * <li>`Salli`</li>
3421
- * <li>`Joey`</li>
3422
- * <li>`Justin`</li>
3423
- * <li>`Kevin`</li>
3424
- * <li>`Matthew`</li>
3425
- * <li>`Ruth`</li>
3426
- * <li>`Stephen`</li>
3427
- * </ul>
3428
- * <li>Finnish (fi-FI)</li>
3429
- * <ul>
3430
- * <li>`Suvi`</li>
3431
- * </ul>
3432
- * <li>French (fr-FR)</li>
3433
- * <ul>
3434
- * <li>`Léa`</li>
3435
- * <li>`Rémi`</li>
3436
- * </ul>
3437
- * <li>French - Canadian (fr-CA)</li>
3438
- * <ul>
3439
- * <li>`Gabrielle`</li>
3440
- * <li>`Liam`</li>
3441
- * </ul>
3442
- * <li>German (de-DE)</li>
3443
- * <ul>
3444
- * <li>`Vicki`</li>
3445
- * <li>`Daniel`</li>
3446
- * </ul>
3447
- * <li>German - Austrian (de-AT)</li>
3448
- * <ul>
3449
- * <li>`Hannah`</li>
3450
- * </ul>
3451
- * <li>Hindi (hi-IN)</li>
3452
- * <ul>
3453
- * <li>`Kajal`</li>
3454
- * </ul>
3455
- * <li>Italian (it-IT)</li>
3456
- * <ul>
3457
- * <li>`Bianca`</li>
3458
- * <li>`Adriano`</li>
3459
- * </ul>
3460
- * <li>Japanese (ja-JP)</li>
3461
- * <ul>
3462
- * <li>`Takumi`</li>
3463
- * <li>`Kazuha`</li>
3464
- * <li>`Tomoko`</li>
3465
- * </ul>
3466
- * <li>Korean (ko-KR)</li>
3467
- * <ul>
3468
- * <li>`Seoyeon`</li>
3469
- * </ul>
3470
- * <li>Norwegian (nb-NO)</li>
3471
- * <ul>
3472
- * <li>`Ida`</li>
3473
- * </ul>
3474
- * <li>Polish (pl-PL)</li>
3475
- * <ul>
3476
- * <li>`Ola`</li>
3477
- * </ul>
3478
- * <li>Portuguese - Brazilian (pt-BR)</li>
3479
- * <ul>
3480
- * <li>`Camila`</li>
3481
- * <li>`Vitória` or `Vitoria`</li>
3482
- * <li>`Thiago`</li>
3483
- * </ul>
3484
- * <li>Portuguese - European (pt-PT)</li>
3485
- * <ul>
3486
- * <li>`Inês` or `Ines`</li>
3487
- * </ul>
3488
- * <li>Spanish (es-ES)</li>
3489
- * <ul>
3490
- * <li>`Lucia`</li>
3491
- * <li>`Sergio`</li>
3492
- * </ul>
3493
- * <li>Spanish - Mexican (es-MX)</li>
3494
- * <ul>
3495
- * <li>`Mia`</li>
3496
- * <li>`Andrés`</li>
3497
- * </ul>
3498
- * <li>Spanish - US (es-US)</li>
3499
- * <ul>
3500
- * <li>`Lupe`</li>
3501
- * <li>`Pedro`</li>
3502
- * </ul>
3503
- * <li>Swedish (sv-SE)</li>
3504
- * <ul>
3505
- * <li>`Elin`</li>
3506
- * </ul>
3507
- * </ul>
3508
- * @example Matthew
3509
- * @enum {string}
3510
- */
3511
- voice: "Hala" | "Lisa" | "Arlet" | "Hiujin" | "Zhiyu" | "Sofie" | "Laura" | "Olivia" | "Amy" | "Emma" | "Brian" | "Arthur" | "Kajal" | "Niamh" | "Aria" | "Ayanda" | "Ivy" | "Joanna" | "Kendra" | "Kimberly" | "Salli" | "Joey" | "Justin" | "Kevin" | "Matthew" | "Ruth" | "Stephen" | "Suvi" | "Léa" | "Rémi" | "Gabrielle" | "Liam" | "Vicki" | "Daniel" | "Hannah" | "Kajal" | "Bianca" | "Adriano" | "Takumi" | "Kazuha" | "Tomoko" | "Seoyeon" | "Ida" | "Ola" | "Camila" | "Vitória" | "Vitoria" | "Thiago" | "Inês" | "Ines" | "Lucia" | "Sergio" | "Mia" | "Andrés" | "Lupe" | "Pedro" | "Elin";
3512
- /**
3513
- * @description The language code for the text-to-speech conversion. You must pair the correct language with the correct voice (see voice parameter above).
3514
- * Select a language from the list of available languages: <ul>
3515
- * <li>`cmn-CN`</li>
3516
- * <li>`da-DK`</li>
3517
- * <li>`de-DE`</li>
3518
- * <li>`en-AU`</li>
3519
- * <li>`en-GB`</li>
3520
- * <li>`en-IN`</li>
3521
- * <li>`en-US`</li>
3522
- * <li>`es-ES`</li>
3523
- * <li>`es-MX`</li>
3524
- * <li>`es-US`</li>
3525
- * <li>`fr-CA`</li>
3526
- * <li>`fr-FR`</li>
3527
- * <li>`it-IT`</li>
3528
- * <li>`ja-JP`</li>
3529
- * <li>`hi-IN`</li>
3530
- * <li>`ko-KR`</li>
3531
- * <li>`nb-NO`</li>
3532
- * <li>`nl-NL`</li>
3533
- * <li>`pl-PL`</li>
3534
- * <li>`pt-BR`</li>
3535
- * <li>`pt-PT`</li>
3536
- * <li>`sv-SE`</li>
3537
- * <li>`en-NZ`</li>
3538
- * <li>`en-ZA`</li>
3539
- * <li>`ca-ES`</li>
3540
- * <li>`de-AT`</li>
3541
- * <li>`yue-CN`</li>
3542
- * <li>`ar-AE`</li>
3543
- * <li>`fi-FI`</li>
3544
- * </ul>
3545
- * @default en-US
3546
- * @enum {string}
3547
- */
3548
- language?: "cmn-CN" | "da-DK" | "de-DE" | "en-AU" | "en-GB" | "en-IN" | "en-US" | "es-ES" | "es-MX" | "es-US" | "fr-CA" | "fr-FR" | "it-IT" | "ja-JP" | "hi-IN" | "ko-KR" | "nb-NO" | "nl-NL" | "pl-PL" | "pt-BR" | "pt-PT" | "sv-SE" | "en-NZ" | "en-ZA" | "ca-ES" | "de-AT" | "yue-CN" | "ar-AE" | "fi-FI";
3549
- /**
3550
- * @description Set the voice to newscaster mode.<br /><br /> *Only Matthew and Joanna for US English (en-US), Lupe for US Spanish (es-US), and Amy for British English (en-GB) are available in the newscaster voice.
3551
- * @default false
3552
- */
3553
- newscaster?: boolean;
3554
- };
3555
- /** @description Options for the Shotstack text-to-image service. Set a text prompt to generate an image from. The output will be generated as a PNG file available at the URL returned in the response. */
3556
- ShotstackTextToImageOptions: {
3557
- /**
3558
- * @description The type of asset to generate - set to `text-to-image` for text-to-image.
3559
- * @default text-to-image
3560
- * @enum {string}
3561
- */
3562
- type: "text-to-image";
3563
- /**
3564
- * @description The text prompt to generate an image from.
3565
- * @example A detailed photograph of Mars, showcasing its orange-red surface
3566
- */
3567
- prompt: string;
3568
- /**
3569
- * @description The width of the image in pixels.
3570
- * @example 512
3571
- */
3572
- width: number;
3573
- /**
3574
- * @description The height of the image in pixels.
3575
- * @example 512
3576
- */
3577
- height: number;
3578
- };
3579
- /** @description Options for the Shotstack image-to-video service. Set the URL of an image to convert in to a video. The output will be generated as an MP4 file available at the URL returned in the response. */
3580
- ShotstackImageToVideoOptions: {
3581
- /**
3582
- * @description The type of asset to generate - set to `image-to-video` for image-to-video.
3583
- * @default image-to-video
3584
- * @enum {string}
3585
- */
3586
- type: "image-to-video";
3587
- /**
3588
- * @description The URL of the image to convert to video. The URL must be publicly accessible or include credentials. The image dimensions must exactly match one of the following: 1024px x 576px, 576px x 1024px or 768px x 768px.
3589
- * @example https://s3-ap-northeast-1.amazonaws.com/my-bucket/image.jpg
3590
- */
3591
- imageUrl: string;
3592
- /**
3593
- * @description The guidance scale determines how closely the generated video will match the image. Lower numbers allow for more creative freedom. A number between 0 and 10.
3594
- * @default 1.8
3595
- * @example 1.8
3596
- */
3597
- guidanceScale?: number;
3598
- /**
3599
- * @description The amount of motion in the video. A number between 1 and 255.
3600
- * @default 127
3601
- * @example 127
3602
- */
3603
- motion?: number;
3604
- };
3605
- /** @description Options for the Shotstack text-generator service. Set a text prompt that will be used to generate a new body of text. The output will be generated as a text (txt) file available at the URL returned in the response. */
3606
- ShotstackTextGeneratorOptions: {
3607
- /**
3608
- * @description The type of asset to generate - set to `text-generator` for text generation.
3609
- * @default text-generator
3610
- * @enum {string}
3611
- */
3612
- type: "text-generator";
3613
- /**
3614
- * @description The text prompt to generate text from.
3615
- * @example Generate a short script for a 15 second video describing the benefits of the Shotstack API
3616
- */
3617
- prompt: string;
3618
- };
3619
- /** @description Generate assets using D-ID. D-ID provide a text-to-avatar service. The D-ID provider works on a bring-your-own-key basis, credentials are required and must be added via the [dashboard](https://dashboard.shotstack.io/integrations/d-id), not in the request. */
3620
- DIDGeneratedAsset: {
3621
- /**
3622
- * @description The name of the provider - set to `d-id` for D-ID. (enum property replaced by openapi-typescript)
3623
- * @enum {string}
3624
- */
3625
- provider: "DIDGeneratedAsset";
3626
- /** @description Options and configuration for the D-ID text-to-avatar service. */
3627
- options: components["schemas"]["DIDGeneratedAssetOptions"];
3628
- };
3629
- /**
3630
- * @description Generate assets using the third party D-ID provider AI services.
3631
- *
3632
- * The following AI generation services are available: <ul>
3633
- * <li><a href="#tocs_didtexttoavataroptions">DidTextToAvatarOptions</a></li>
3634
- * </ul>
3635
- */
3636
- DIDGeneratedAssetOptions: components["schemas"]["DIDTextToAvatarOptions"];
3637
- /** @description Options for the D-ID text-to-avatar service. Set the text to be converted to an avatar and configure the avatar and background. The output will be generated as an MP4 video file. */
3638
- DIDTextToAvatarOptions: {
3639
- /**
3640
- * @description The type of asset to generate - set to `text-to-avatar` for text-to-avatar.
3641
- * @enum {string}
3642
- */
3643
- type: "text-to-avatar";
3644
- /**
3645
- * @description The text or script that the avatar will narrate.
3646
- * @example I am an avatar generated by D-ID using a text prompt
3647
- */
3648
- text: string;
3649
- /**
3650
- * @description The avatar character to generate. Select from the list of available avatars: <ul>
3651
- * <li>`jack`</li>
3652
- * <li>`lana`</li>
3653
- * <li>`lily`</li>
3654
- * <li>`matt`</li>
3655
- * <li>`rian`</li>
3656
- * </ul>
3657
- * @enum {string}
3658
- */
3659
- avatar: "jack" | "lana" | "lily" | "matt" | "rian";
3660
- /**
3661
- * @description The background color of the video.
3662
- * @example #ffffff
3663
- */
3664
- background?: string;
3665
- };
3666
- /** @description Generate assets using ElevenLabs. ElevenLabs provide a text-to-speech service. The ElevenLabs provider works on a bring-your-own-key basis, credentials are required and must be added via the [dashboard](https://dashboard.shotstack.io/integrations/elevenlabs), not in the request. */
3667
- ElevenLabsGeneratedAsset: {
3668
- /**
3669
- * @description The name of the provider - set to `elevenlabs` for ElevenLabs. (enum property replaced by openapi-typescript)
3670
- * @enum {string}
3671
- */
3672
- provider: "ElevenLabsGeneratedAsset";
3673
- /** @description Options and configuration for the ElevenLabs text-to-speech service. */
3674
- options: components["schemas"]["ElevenLabsGeneratedAssetOptions"];
3675
- };
3676
- /**
3677
- * @description Generate assets using the third party ElevenLabs provider AI services.
3678
- *
3679
- * The following AI generation services are available: <ul>
3680
- * <li><a href="#tocs_elevenlabstexttospeechoptions">ElevenLabsTextToSpeechOptions</a></li>
3681
- * </ul>
3682
- */
3683
- ElevenLabsGeneratedAssetOptions: components["schemas"]["ElevenLabsTextToSpeechOptions"];
3684
- /** @description Options for the ElevenLabs text-to-speech service. Set the text to be converted to speech and choose a voice to set the speaking style. The output will be generated as an MP3 audio file available at the URL returned in the response. */
3685
- ElevenLabsTextToSpeechOptions: {
3686
- /**
3687
- * @description The type of asset to generate - set to `text-to-speech` for text-to-speech.
3688
- * @enum {string}
3689
- */
3690
- type: "text-to-speech";
3691
- /**
3692
- * @description The text to convert to speech.
3693
- * @example This is a text to speech example generated by ElevenLabs
3694
- */
3695
- text: string;
3696
- /**
3697
- * @description The voice to use for the text-to-speech conversion. Select a voice from the list of available voices: <ul>
3698
- * <li>`Adam`</li>
3699
- * <li>`Antoni`</li>
3700
- * <li>`Arnold`</li>
3701
- * <li>`Bella`</li>
3702
- * <li>`Domi`</li>
3703
- * <li>`Elli`</li>
3704
- * <li>`Josh`</li>
3705
- * <li>`Rachel`</li>
3706
- * <li>`Sam`</li>
3707
- * </ul>
3708
- * @enum {string}
3709
- */
3710
- voice: "Adam" | "Antoni" | "Arnold" | "Bella" | "Domi" | "Elli" | "Josh" | "Rachel" | "Sam";
3711
- };
3712
- /** @description Generate assets using HeyGen. HeyGen provide a text-to-avatar service. The HeyGen provider works on a bring-your-own-key basis, credentials are required and must be added via the [dashboard](https://dashboard.shotstack.io/integrations/heygen), not in the request. */
3713
- HeyGenGeneratedAsset: {
3714
- /**
3715
- * @description The name of the provider - set to `heygen` for HeyGen. (enum property replaced by openapi-typescript)
3716
- * @enum {string}
3717
- */
3718
- provider: "HeyGenGeneratedAsset";
3719
- /** @description Options and configuration for the HeyGen text-to-avatar service. */
3720
- options: components["schemas"]["HeyGenGeneratedAssetOptions"];
3721
- };
3722
- /**
3723
- * @description Generate assets using the third party HeyGen provider AI services.
3724
- *
3725
- * The following AI generation services are available: <ul>
3726
- * <li><a href="#tocs_heygentexttoavataroptions">HeyGenTextToAvatarOptions</a></li>
3727
- * </ul>
3728
- */
3729
- HeyGenGeneratedAssetOptions: components["schemas"]["HeyGenTextToAvatarOptions"];
3730
- /** @description Options for the HeyGen text-to-avatar service. Set the text to be converted to an avatar and configure the avatars voice, speaking style, appearance and background. The output will be generated as an MP4 video file available at the URL returned in the response. */
3731
- HeyGenTextToAvatarOptions: {
3732
- /**
3733
- * @description The type of asset to generate - set to `text-to-avatar` for text-to-avatar.
3734
- * @enum {string}
3735
- */
3736
- type: "text-to-avatar";
3737
- /**
3738
- * @description The text or script that the avatar will narrate.
3739
- * @example I am an avatar generated by HeyGen using a text prompt
3740
- */
3741
- text: string;
3742
- /**
3743
- * @description The avatar character to generate. Select from the list of available avatars: <ul>
3744
- * <li>`Angela`</li>
3745
- * <li>`Bill`</li>
3746
- * <li>`Daisy`</li>
3747
- * <li>`Derek`</li>
3748
- * <li>`Eva`</li>
3749
- * <li>`Jake`</li>
3750
- * <li>`Jeff`</li>
3751
- * <li>`Jerome`</li>
3752
- * <li>`Joon`</li>
3753
- * <li>`Kayla`</li>
3754
- * <li>`Kent`</li>
3755
- * <li>`Luna`</li>
3756
- * <li>`Mark`</li>
3757
- * <li>`Matthew`</li>
3758
- * <li>`Monica`</li>
3759
- * <li>`Peter`</li>
3760
- * <li>`Selina`</li>
3761
- * <li>`Tanya`</li>
3762
- * <li>`Thomas`</li>
3763
- * <li>`Tina`</li>
3764
- * <li>`Tyler`</li>
3765
- * <li>`Vanessa`</li>
3766
- * <li>`Vera`</li>
3767
- * <li>`Wilson`</li>
3768
- * <li>`Zoey`</li>
3769
- * </ul>
3770
- * @enum {string}
3771
- */
3772
- avatar: "Angela" | "Bill" | "Daisy" | "Derek" | "Eva" | "Jake" | "Jeff" | "Jerome" | "Joon" | "Kayla" | "Kent" | "Luna" | "Mark" | "Matthew" | "Monica" | "Peter" | "Selina" | "Tanya" | "Thomas" | "Tina" | "Tyler" | "Vanessa" | "Vera" | "Wilson" | "Zoey";
3773
- /**
3774
- * @description The avatars voice and speaking style. Select from the list of available voices: <ul>
3775
- * <li>`Abb- - Natural`</li>
3776
- * <li>`Adam - Natural`</li>
3777
- * <li>`Aiston - Friendly`</li>
3778
- * <li>`Alice - Newscaster`</li>
3779
- * <li>`Alison - Cheerful`</li>
3780
- * <li>`Amber - Friendly`</li>
3781
- * <li>`Amy - Warm`</li>
3782
- * <li>`Ana - Cheerful`</li>
3783
- * <li>`Antoni - Friendly`</li>
3784
- * <li>`Aria - Newscaster`</li>
3785
- * <li>`Arnold - Cheerful`</li>
3786
- * <li>`Arthur - Natural`</li>
3787
- * <li>`Bella - Friendly`</li>
3788
- * <li>`Belle - Natural`</li>
3789
- * <li>`Brandon - Warm`</li>
3790
- * <li>`Brian - Natural`</li>
3791
- * <li>`Bruce - Natural`</li>
3792
- * <li>`Cerise - Cheerful`</li>
3793
- * <li>`Christopher - Calm`</li>
3794
- * <li>`Clara - Professional`</li>
3795
- * <li>`Connor - Natural`</li>
3796
- * <li>`Dahlia - Friendly`</li>
3797
- * <li>`Davis - Professional`</li>
3798
- * <li>`Dean - Natural`</li>
3799
- * <li>`Delbert - Cheerful`</li>
3800
- * <li>`Edward - Friendly`</li>
3801
- * <li>`Elaine - Calm`</li>
3802
- * <li>`Emily - Natural`</li>
3803
- * <li>`Emma - Newscaster`</li>
3804
- * <li>`Eric - Newscaster`</li>
3805
- * <li>`Grace - Natural`</li>
3806
- * <li>`Hailey - Calm`</li>
3807
- * <li>`Indira - Cheerful`</li>
3808
- * <li>`Isabella - Cheerful`</li>
3809
- * <li>`Jacob - Natural`</li>
3810
- * <li>`Jahmai - Friendly`</li>
3811
- * <li>`Jane - Serious`</li>
3812
- * <li>`Jason - Serious`</li>
3813
- * <li>`Jelle - Friendly`</li>
3814
- * <li>`Jen - Natural`</li>
3815
- * <li>`Jenny - Professional`</li>
3816
- * <li>`Jodi - Cheerful`</li>
3817
- * <li>`Joey - Calm`</li>
3818
- * <li>`Johan - Friendly`</li>
3819
- * <li>`Josie - Cheerful`</li>
3820
- * <li>`Keanan - Natural`</li>
3821
- * <li>`Keith - Cheerful`</li>
3822
- * <li>`Kellie - Friendly`</li>
3823
- * <li>`Lauren - Friendly`</li>
3824
- * <li>`Leah - Natural`</li>
3825
- * <li>`Liam - Professional`</li>
3826
- * <li>`Libby - Natural`</li>
3827
- * <li>`Lily - Professional`</li>
3828
- * <li>`Lucas - Natural`</li>
3829
- * <li>`Luke - Professional`</li>
3830
- * <li>`Luna - Natural`</li>
3831
- * <li>`Marieke - Natural`</li>
3832
- * <li>`Matthew - Professional`</li>
3833
- * <li>`Michelle - Natural`</li>
3834
- * <li>`Mitchell - Natural`</li>
3835
- * <li>`Molly - Newscaster`</li>
3836
- * <li>`Monica - Calm`</li>
3837
- * <li>`Natasha - Professional`</li>
3838
- * <li>`Neerja - Newscaster`</li>
3839
- * <li>`Noah - Serious`</li>
3840
- * <li>`Oliver - Newscaster`</li>
3841
- * <li>`Olivia - Calm`</li>
3842
- * <li>`Paul - Natural`</li>
3843
- * <li>`Prabhat - Natural`</li>
3844
- * <li>`Raveena - Natural`</li>
3845
- * <li>`Rudi - Friendly`</li>
3846
- * <li>`Ryan - Professional`</li>
3847
- * <li>`Sam - Natural`</li>
3848
- * <li>`Sara - Cheerful`</li>
3849
- * <li>`Sherry - Friendly`</li>
3850
- * <li>`Sonia - Warm`</li>
3851
- * <li>`Thomas - Natural`</li>
3852
- * <li>`Todd - Professional`</li>
3853
- * <li>`Tony - Professional`</li>
3854
- * <li>`Tracy - Cheerful`</li>
3855
- * <li>`Wayne - Natural`</li>
3856
- * <li>`Wilder - Natural`</li>
3857
- * <li>`Wille - Natural`</li>
3858
- * <li>`William - Friendly`</li>
3859
- * </ul>
3860
- * @enum {string}
3861
- */
3862
- voice: "Abbi - Natural" | "Adam - Natural" | "Aiston - Friendly" | "Alice - Newscaster" | "Alison - Cheerful" | "Amber - Friendly" | "Amy - Warm" | "Ana - Cheerful" | "Antoni - Friendly" | "Aria - Newscaster" | "Arnold - Cheerful" | "Arthur - Natural" | "Bella - Friendly" | "Belle - Natural" | "Brandon - Warm" | "Brian - Natural" | "Bruce - Natural" | "Cerise - Cheerful" | "Christopher - Calm" | "Clara - Professional" | "Connor - Natural" | "Dahlia - Friendly" | "Davis - Professional" | "Dean - Natural" | "Delbert - Cheerful" | "Edward - Friendly" | "Elaine - Calm" | "Emily - Natural" | "Emma - Newscaster" | "Eric - Newscaster" | "Grace - Natural" | "Hailey - Calm" | "Indira - Cheerful" | "Isabella - Cheerful" | "Jacob - Natural" | "Jahmai - Friendly" | "Jane - Serious" | "Jason - Serious" | "Jelle - Friendly" | "Jen - Natural" | "Jenny - Professional" | "Jodi - Cheerful" | "Joey - Calm" | "Johan - Friendly" | "Josie - Cheerful" | "Keanan - Natural" | "Keith - Cheerful" | "Kellie - Friendly" | "Lauren - Friendly" | "Leah - Natural" | "Liam - Professional" | "Libby - Natural" | "Lily - Professional" | "Lucas - Natural" | "Luke - Professional" | "Luna - Natural" | "Marieke - Natural" | "Matthew - Professional" | "Michelle - Natural" | "Mitchell - Natural" | "Molly - Newscaster" | "Monica - Calm" | "Natasha - Professional" | "Neerja - Newscaster" | "Noah - Serious" | "Oliver - Newscaster" | "Olivia - Calm" | "Paul - Natural" | "Prabhat - Natural" | "Raveena - Natural" | "Rudi - Friendly" | "Ryan - Professional" | "Sam - Natural" | "Sara - Cheerful" | "Sherry - Friendly" | "Sonia - Warm" | "Thomas - Natural" | "Todd - Professional" | "Tony - Professional" | "Tracy - Cheerful" | "Wayne - Natural" | "Wilder - Natural" | "Wille - Natural" | "William - Friendly";
3863
- /**
3864
- * @description The display style of the avatar, a rectangle `normal` or circular `circle` background. Defaults to `normal`.
3865
- * @enum {string}
3866
- */
3867
- avatarStyle?: "normal" | "circle";
3868
- /**
3869
- * @description The background color of the video. Defaults to `#ffffff`.
3870
- * @example #ffffff
3871
- */
3872
- background?: string;
3873
- /**
3874
- * @description The aspect ratio of the video, `16:9` horizontal or `9:16` vertical. Defaults to `16:9`.
3875
- * @enum {string}
3876
- */
3877
- ratio?: "16:9" | "9:16";
3878
- /**
3879
- * @description A boolean flag indicating whether the video is for testing purposes. See the "test" parameter in [HeyGen](https://docs.heygen.com/reference/generate-video) for more details.
3880
- * @example true
3881
- */
3882
- test?: boolean;
3883
- };
3884
- /** @description Generate assets using OpenAI. OpenAI provide a text generation service using ChatGPT 3.5 and 4. The OpenAI provider works on a bring-your-own-key basis, credentials are required and must be added via the [dashboard](https://dashboard.shotstack.io/integrations/openai), not in the request. */
3885
- OpenAiGeneratedAsset: {
3886
- /**
3887
- * @description The name of the provider - set to `openai` for OpenAI. (enum property replaced by openapi-typescript)
3888
- * @enum {string}
3889
- */
3890
- provider: "OpenAiGeneratedAsset";
3891
- /** @description Options and configuration for the OpenAI text-generator service. */
3892
- options: components["schemas"]["OpenAiGeneratedAssetOptions"];
3893
- };
3894
- /**
3895
- * @description Generate assets using OpenAI provider AI services.
3896
- *
3897
- * The following AI generation services are available: <ul>
3898
- * <li><a href="#tocs_openaitextgeneratoroptions">OpenAiTextGeneratorOptions</a></li>
3899
- * </ul>
3900
- */
3901
- OpenAiGeneratedAssetOptions: components["schemas"]["OpenAiTextGeneratorOptions"];
3902
- /** @description Options for the OpenAI text-generator service. Set a text prompt that will be used to generate a new body of text. The output will be generated as a text (txt) file available at the URL returned in the response. */
3903
- OpenAiTextGeneratorOptions: {
3904
- /**
3905
- * @description The type of asset to generate - set to `text-generator` for text generation.
3906
- * @default text-generator
3907
- * @enum {string}
3908
- */
3909
- type: "text-generator";
3910
- /**
3911
- * @description The text prompt to generate text from.
3912
- * @example Generate a short script for a 15 second video describing the benefits of the Shotstack API
3913
- */
3914
- prompt: string;
3915
- /**
3916
- * @description The model to use for generating the text. Select from the list of available models: <ul>
3917
- * <li>`gpt-3.5-turbo`</li>
3918
- * <li>`gpt-4`</li>
3919
- * </ul>
3920
- * @example gpt-4
3921
- * @enum {string}
3922
- */
3923
- model: "gpt-3.5-turbo" | "gpt-4";
3924
- /**
3925
- * @description The system prompt to use for generating the text. This is an optional prompt that can be used to provide context or additional information to the model.
3926
- * @example You are a professional script writer and film maker
3927
- */
3928
- systemPrompt?: string;
3929
- };
3930
- /** @description Generate assets using Stability AI. Stability AI provide a text-to-image service using Stable Diffusion. The Stability AI provider works on a bring-your-own-key basis, credentials are required and must be added via the [dashboard](https://dashboard.shotstack.io/integrations/stability-ai), not in the request. */
3931
- StabilityAiGeneratedAsset: {
3932
- /**
3933
- * @description The name of the provider - set to `stability-ai` for Stability AI. (enum property replaced by openapi-typescript)
3934
- * @enum {string}
3935
- */
3936
- provider: "StabilityAiGeneratedAsset";
3937
- /** @description Options and configuration for the Stability AI text-to-image service. */
3938
- options: components["schemas"]["StabilityAiGeneratedAssetOptions"];
3939
- };
3940
- /**
3941
- * @description Generate assets using Stability AI provider AI services.
3942
- *
3943
- * The following AI generation services are available: <ul>
3944
- * <li><a href="#tocs_stabilityaitexttoimageoptions">StabilityAiTextToImageOptions</a></li>
3945
- * </ul>
3946
- */
3947
- StabilityAiGeneratedAssetOptions: components["schemas"]["StabilityAiTextToImageOptions"];
3948
- /** @description Options for the Stability AI text-to-image service. Set a text prompt to generate an image from plus other engine and configuration options. The output will be generated as a JPG file available at the URL returned in the response. */
3949
- StabilityAiTextToImageOptions: {
3950
- /**
3951
- * @description The type of asset to generate - set to `text-to-image` for text-to-image.
3952
- * @default text-to-image
3953
- * @enum {string}
3954
- */
3955
- type: "text-to-image";
3956
- /**
3957
- * @description The text prompt to generate an image from.
3958
- * @example A detailed photograph of Mars, showcasing its orange-red surface
3959
- */
3960
- prompt: string;
3961
- /**
3962
- * @description The engine (model) to use for generating the image. Select from the list of available engines: <ul>
3963
- * <li>`stable-diffusion-xl-1024-v0-9`</li>
3964
- * <li>`stable-diffusion-xl-1024-v1-0`</li>
3965
- * <li>`stable-diffusion-v1-6`</li>
3966
- * <li>`stable-diffusion-512-v2-1`</li>
3967
- * <li>`stable-diffusion-xl-beta-v2-2-2`</li>
3968
- * </ul>
3969
- * @default stable-diffusion-xl-1024-v1-0
3970
- * @example stable-diffusion-xl-1024-v1-0
3971
- * @enum {string}
3972
- */
3973
- engine?: "stable-diffusion-xl-1024-v0-9" | "stable-diffusion-xl-1024-v1-0" | "stable-diffusion-v1-6" | "stable-diffusion-512-v2-1" | "stable-diffusion-xl-beta-v2-2-2";
3974
- /**
3975
- * @description The width of the image in pixels. Must be divisible by 64.
3976
- * @example 512
3977
- */
3978
- width: number;
3979
- /**
3980
- * @description The height of the image in pixels. Must be divisible by 64.
3981
- * @example 512
3982
- */
3983
- height: number;
3984
- /**
3985
- * @description The number of iterative diffusion steps to run. A number between 10 and 50.
3986
- * @default 30
3987
- * @example 30
3988
- */
3989
- steps?: number;
3990
- /**
3991
- * @description Using the same seed can help you create images that look similar. Set to 0 for a random seed. A number between 0 and 4294967295.
3992
- * @default 0
3993
- * @example 0
3994
- */
3995
- seed?: number;
3996
- /**
3997
- * @description Determines how closely the generated image will match the prompt. Lower numbers allow for more creative freedom. A number between 0 and 35.
3998
- * @default 7
3999
- * @example 7
4000
- */
4001
- cfgScale?: number;
4002
- /**
4003
- * @description Apply a preset to generate an image in a particular style. Select from the list of available presets: <ul>
4004
- * <li>`3d-model`</li>
4005
- * <li>`analog-film`</li>
4006
- * <li>`anime`</li>
4007
- * <li>`cinematic`</li>
4008
- * <li>`comic-book`</li>
4009
- * <li>`digital-art`</li>
4010
- * <li>`enhance`</li>
4011
- * <li>`fantasy-art`</li>
4012
- * <li>`isometric`</li>
4013
- * <li>`line-art`</li>
4014
- * <li>`low-poly`</li>
4015
- * <li>`modeling-compound`</li>
4016
- * <li>`neon-punk`</li>
4017
- * <li>`origami`</li>
4018
- * <li>`photographic`</li>
4019
- * <li>`pixel-art`</li>
4020
- * <li>`tile-texture`</li>
4021
- * </ul>
4022
- * @example photographic
4023
- * @enum {string}
4024
- */
4025
- stylePreset?: "3d-model" | "analog-film" | "anime" | "cinematic" | "comic-book" | "digital-art" | "enhance" | "fantasy-art" | "isometric" | "line-art" | "low-poly" | "modeling-compound" | "neon-punk" | "origami" | "photographic" | "pixel-art" | "tile-texture";
4026
- };
4027
3147
  /** @description The response received after a [render request](#render-asset) or [template render](#render-template) is submitted. The render task is queued for rendering and a unique render id is returned. */
4028
3148
  QueuedResponse: {
4029
3149
  /**
@@ -4627,94 +3747,6 @@ export interface components {
4627
3747
  */
4628
3748
  detail: string;
4629
3749
  };
4630
- /** @description The response returned by the Create API [generate asset](#generate-asset) and [get generated asset](#get-generated-asset) requests. Includes status and details of the generated asset. The response follows the [json:api](https://jsonapi.org/) specification. */
4631
- GeneratedAssetResponse: {
4632
- /** @description A generated asset resource. */
4633
- data: components["schemas"]["GeneratedAssetResponseData"];
4634
- };
4635
- /** @description The type of resource (an asset), it's id and attributes of the generated file. */
4636
- GeneratedAssetResponseData: {
4637
- /**
4638
- * @description The type of resource, in this case it is an asset.
4639
- * @example asset
4640
- */
4641
- type: string;
4642
- /**
4643
- * @description The generated asset id.
4644
- * @example 01gz0-tj679-xj30t-hr8zk-3hasvk
4645
- */
4646
- id: string;
4647
- /** @description The generated asset attributes including its url, status, provider, type, etc... */
4648
- attributes: components["schemas"]["GeneratedAssetResponseAttributes"];
4649
- };
4650
- /** @description The id and attributes of the generated asset. */
4651
- GeneratedAssetResponseAttributes: {
4652
- /**
4653
- * @description The owner id of the asset.
4654
- * @example 5ca6hu7s9k
4655
- */
4656
- owner: string;
4657
- /**
4658
- * @description The native or third party provider that generated the asset, `shotstack`, `elevenlabs`, `heygen` or `d-id`.
4659
- * @enum {string}
4660
- */
4661
- provider: "shotstack" | "elevenlabs" | "heygen" | "d-id";
4662
- /**
4663
- * @description The type of service used to generate the asset, `text-to-speech` or `text-to-avatar`.
4664
- * @enum {string}
4665
- */
4666
- type: "text-to-speech" | "text-to-avatar";
4667
- /**
4668
- * @description The URL of the asset file hosted by Shotstack. The file at the URL can be used by the Edit API. Generated asset file URL's consist of a base URL (AWS bucket), owner id, asset id and extension. The extension varies depending on the type of file generated.
4669
- * @example https://shotstack-create-api-v1-assets.s3.amazonaws.com/5ca6hu7s9k/01gz0-tj679-xj30t-hr8zk-3hasvk.mp3
4670
- */
4671
- url?: string;
4672
- /**
4673
- * @description The status of the asset file generation task. <ul>
4674
- * <li>`queued` - generation task is queued waiting to be processed</li>
4675
- * <li>`processing` - the asset is being generated by the provider</li>
4676
- * <li>`saving` - the asset is being saved to Shotstack</li>
4677
- * <li>`done` - the asset has been generated and stored</li>
4678
- * <li>`failed` - there was an error generating the asset</li>
4679
- * </ul>
4680
- * @example done
4681
- * @enum {string}
4682
- */
4683
- status: "queued" | "processing" | "saving" | "done" | "failed";
4684
- /**
4685
- * @description The time the generate asset task was initially queued.
4686
- * @example 2023-01-02T01:47:18.973Z
4687
- */
4688
- created: string;
4689
- /**
4690
- * @description The time the asset status was last updated.
4691
- * @example 2023-01-02T01:47:37.260Z
4692
- */
4693
- updated: string;
4694
- };
4695
- /** @description Error response data for validation and other errors returned by the Create API. */
4696
- GeneratedAssetErrorResponse: {
4697
- /** @description An array of errors. */
4698
- errors: components["schemas"]["GeneratedAssetErrorResponseData"][];
4699
- };
4700
- /** @description Individual errors returned by the Create API. */
4701
- GeneratedAssetErrorResponseData: {
4702
- /**
4703
- * @description The http status code.
4704
- * @example 400
4705
- */
4706
- status: string;
4707
- /**
4708
- * @description A short summary of the error.
4709
- * @example Bad Request
4710
- */
4711
- title: string;
4712
- /**
4713
- * @description A detailed description of the error.
4714
- * @example "body/options/text" is required.
4715
- */
4716
- detail: string;
4717
- };
4718
3750
  };
4719
3751
  responses: never;
4720
3752
  parameters: never;
@@ -5261,61 +4293,4 @@ export interface operations {
5261
4293
  };
5262
4294
  };
5263
4295
  };
5264
- postGenerateAsset: {
5265
- parameters: {
5266
- query?: never;
5267
- header?: never;
5268
- path?: never;
5269
- cookie?: never;
5270
- };
5271
- /** @description Generate an asset using the specified provider, type and options. */
5272
- requestBody: {
5273
- content: {
5274
- "application/json": components["schemas"]["GeneratedAsset"];
5275
- };
5276
- };
5277
- responses: {
5278
- /** @description The generated asset details */
5279
- 201: {
5280
- headers: {
5281
- [name: string]: unknown;
5282
- };
5283
- content: {
5284
- "application/json": components["schemas"]["GeneratedAssetResponse"];
5285
- };
5286
- };
5287
- /** @description A list of validation and other errors */
5288
- 400: {
5289
- headers: {
5290
- [name: string]: unknown;
5291
- };
5292
- content: {
5293
- "application/json": components["schemas"]["GeneratedAssetErrorResponse"];
5294
- };
5295
- };
5296
- };
5297
- };
5298
- getGeneratedAsset: {
5299
- parameters: {
5300
- query?: never;
5301
- header?: never;
5302
- path: {
5303
- /** @description The id of the source file in [KSUID](https://github.com/segmentio/ksuid#what-is-a-ksuid) format. */
5304
- id: string;
5305
- };
5306
- cookie?: never;
5307
- };
5308
- requestBody?: never;
5309
- responses: {
5310
- /** @description The generated asset details */
5311
- 200: {
5312
- headers: {
5313
- [name: string]: unknown;
5314
- };
5315
- content: {
5316
- "application/json": components["schemas"]["GeneratedAssetResponse"];
5317
- };
5318
- };
5319
- };
5320
- };
5321
4296
  }