@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.
- package/dist/api.bundled.json +83 -1263
- package/dist/json-schema/asset.json +3 -858
- package/dist/json-schema/clip.json +3 -858
- package/dist/json-schema/edit.json +3 -858
- package/dist/json-schema/rich-caption-active-font.json +1 -4
- package/dist/json-schema/rich-caption-active.json +1 -4
- package/dist/json-schema/rich-caption-asset.json +1 -4
- package/dist/json-schema/schemas.json +6 -954
- package/dist/json-schema/svg-asset.json +6 -857
- package/dist/json-schema/timeline.json +3 -858
- package/dist/json-schema/track.json +3 -858
- package/dist/schema.d.ts +15 -1040
- package/dist/zod/zod.gen.cjs +36 -726
- package/dist/zod/zod.gen.d.ts +542 -11591
- package/dist/zod/zod.gen.js +29 -718
- package/dist/zod/zod.gen.ts +31 -711
- package/package.json +1 -1
- package/dist/json-schema/svg-arrow-shape.json +0 -49
- package/dist/json-schema/svg-circle-shape.json +0 -28
- package/dist/json-schema/svg-cross-shape.json +0 -42
- package/dist/json-schema/svg-ellipse-shape.json +0 -35
- package/dist/json-schema/svg-fill.json +0 -169
- package/dist/json-schema/svg-gradient-stop.json +0 -25
- package/dist/json-schema/svg-heart-shape.json +0 -28
- package/dist/json-schema/svg-line-shape.json +0 -35
- package/dist/json-schema/svg-linear-gradient-fill.json +0 -80
- package/dist/json-schema/svg-path-shape.json +0 -26
- package/dist/json-schema/svg-polygon-shape.json +0 -35
- package/dist/json-schema/svg-radial-gradient-fill.json +0 -66
- package/dist/json-schema/svg-rectangle-shape.json +0 -49
- package/dist/json-schema/svg-ring-shape.json +0 -35
- package/dist/json-schema/svg-shadow.json +0 -79
- package/dist/json-schema/svg-shape.json +0 -404
- package/dist/json-schema/svg-solid-fill.json +0 -40
- package/dist/json-schema/svg-star-shape.json +0 -42
- package/dist/json-schema/svg-stroke.json +0 -115
- package/dist/json-schema/svg-transform.json +0 -93
package/dist/api.bundled.json
CHANGED
|
@@ -3,7 +3,7 @@
|
|
|
3
3
|
"info": {
|
|
4
4
|
"title": "Shotstack",
|
|
5
5
|
"version": "v1",
|
|
6
|
-
"description": "Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API.\n\nYou arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete.\n\nFor more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation.\n\nThere are three API's, one for editing and generating assets (Edit API), one for managing hosted assets (Serve API) and one for ingesting and transforming source assets (Ingest API).\n\nEach API has it's own base URL and collection of endpoints. Each API uses the same set of API keys.\n\n**[Edit API](#shotstack-edit)** - [https://api.shotstack.io/edit/{version}](#)<br>\nEdit videos, images and audio assets in the cloud using a simple JSON schema and templates.\n\n**[Serve API](#shotstack-serve)** - [https://api.shotstack.io/serve/{version}](#)<br>\nInspect and manage the hosting of assets generated by the Edit and Ingest APIs.\n\n**[Ingest API](#shotstack-ingest)** - [https://api.shotstack.io/ingest/{version}](#)<br>\nIngest (upload, store and transform) source footage, images, audio and fonts to be used by the Edit API.\n
|
|
6
|
+
"description": "Shotstack is a video, image and audio editing service that allows for the automated generation of videos, images and audio using JSON and a RESTful API.\n\nYou arrange and configure an edit and POST it to the API which will render your media and provide a file location when complete.\n\nFor more details visit [shotstack.io](https://shotstack.io) or checkout our [getting started](https://shotstack.io/docs/guide/) documentation.\n\nThere are three API's, one for editing and generating assets (Edit API), one for managing hosted assets (Serve API) and one for ingesting and transforming source assets (Ingest API).\n\nEach API has it's own base URL and collection of endpoints. Each API uses the same set of API keys.\n\n**[Edit API](#shotstack-edit)** - [https://api.shotstack.io/edit/{version}](#)<br>\nEdit videos, images and audio assets in the cloud using a simple JSON schema and templates.\n\n**[Serve API](#shotstack-serve)** - [https://api.shotstack.io/serve/{version}](#)<br>\nInspect and manage the hosting of assets generated by the Edit and Ingest APIs.\n\n**[Ingest API](#shotstack-ingest)** - [https://api.shotstack.io/ingest/{version}](#)<br>\nIngest (upload, store and transform) source footage, images, audio and fonts to be used by the Edit API.\n"
|
|
7
7
|
},
|
|
8
8
|
"servers": [
|
|
9
9
|
{
|
|
@@ -44,19 +44,6 @@
|
|
|
44
44
|
"default": "v1"
|
|
45
45
|
}
|
|
46
46
|
}
|
|
47
|
-
},
|
|
48
|
-
{
|
|
49
|
-
"url": "https://api.shotstack.io/create/{version}",
|
|
50
|
-
"variables": {
|
|
51
|
-
"version": {
|
|
52
|
-
"description": "Set the stage to **v1** for production usage. Set to **stage** to use the development sandbox.",
|
|
53
|
-
"enum": [
|
|
54
|
-
"v1",
|
|
55
|
-
"stage"
|
|
56
|
-
],
|
|
57
|
-
"default": "v1"
|
|
58
|
-
}
|
|
59
|
-
}
|
|
60
47
|
}
|
|
61
48
|
],
|
|
62
49
|
"tags": [
|
|
@@ -71,10 +58,6 @@
|
|
|
71
58
|
{
|
|
72
59
|
"name": "Ingest",
|
|
73
60
|
"description": "The Ingest API lets you upload and store your source footage and user generated content in close proximity to the Edit API. Instead of hosting your own assets or building your own uploader you can use the Ingest API. The Ingest API provides endpoints to fetch and upload files and check their status and URLs. All ingested files are available directly from an S3 bucket URL or via CDN (Serve API)."
|
|
74
|
-
},
|
|
75
|
-
{
|
|
76
|
-
"name": "Create",
|
|
77
|
-
"description": "The Create API generates assets and media files using Generative AI services like text-to-speech and text-to-avatar. A native text-to-speech service is included as well as integrations with third party providers. Third party services include [HeyGen](https://www.heygen.com/) text-to-avatar, [ElevenLabs](https://elevenlabs.io/) text-to-speech and [D-ID](https://www.d-id.com/) text-to-avatar. Assets can be used with the Edit API or downloaded and used independently."
|
|
78
61
|
}
|
|
79
62
|
],
|
|
80
63
|
"paths": {
|
|
@@ -790,93 +773,6 @@
|
|
|
790
773
|
"Ingest"
|
|
791
774
|
]
|
|
792
775
|
}
|
|
793
|
-
},
|
|
794
|
-
"/path_alias_createassets": {
|
|
795
|
-
"post": {
|
|
796
|
-
"description": "Generate an asset using a Shotstack or third party provider. Chose the provider, type of asset and provide prompts,\ninputs and options to generate the asset. Once generated the asset can be used with the [Edit](#tocs_edit) API or\ndownloaded.\n\n**Base URL:** <a href=\"#\">https://api.shotstack.io/create/{version}</a>\n",
|
|
797
|
-
"summary": "Generate Asset",
|
|
798
|
-
"operationId": "postGenerateAsset",
|
|
799
|
-
"requestBody": {
|
|
800
|
-
"description": "Generate an asset using the specified provider, type and options.",
|
|
801
|
-
"content": {
|
|
802
|
-
"application/json": {
|
|
803
|
-
"schema": {
|
|
804
|
-
"$ref": "#/components/schemas/GeneratedAsset"
|
|
805
|
-
}
|
|
806
|
-
}
|
|
807
|
-
},
|
|
808
|
-
"required": true
|
|
809
|
-
},
|
|
810
|
-
"responses": {
|
|
811
|
-
"201": {
|
|
812
|
-
"description": "The generated asset details",
|
|
813
|
-
"content": {
|
|
814
|
-
"application/json": {
|
|
815
|
-
"schema": {
|
|
816
|
-
"$ref": "#/components/schemas/GeneratedAssetResponse"
|
|
817
|
-
}
|
|
818
|
-
}
|
|
819
|
-
}
|
|
820
|
-
},
|
|
821
|
-
"400": {
|
|
822
|
-
"description": "A list of validation and other errors",
|
|
823
|
-
"content": {
|
|
824
|
-
"application/json": {
|
|
825
|
-
"schema": {
|
|
826
|
-
"$ref": "#/components/schemas/GeneratedAssetErrorResponse"
|
|
827
|
-
}
|
|
828
|
-
}
|
|
829
|
-
}
|
|
830
|
-
}
|
|
831
|
-
},
|
|
832
|
-
"security": [
|
|
833
|
-
{
|
|
834
|
-
"DeveloperKey": []
|
|
835
|
-
}
|
|
836
|
-
],
|
|
837
|
-
"tags": [
|
|
838
|
-
"Create"
|
|
839
|
-
]
|
|
840
|
-
}
|
|
841
|
-
},
|
|
842
|
-
"/path_alias_createassets/{id}": {
|
|
843
|
-
"get": {
|
|
844
|
-
"description": "Get the generated assets status, url and details by ID.\n\n**Base URL:** <a href=\"#\">https://api.shotstack.io/create/{version}</a>\n",
|
|
845
|
-
"summary": "Get Generated Asset",
|
|
846
|
-
"operationId": "getGeneratedAsset",
|
|
847
|
-
"responses": {
|
|
848
|
-
"200": {
|
|
849
|
-
"description": "The generated asset details",
|
|
850
|
-
"content": {
|
|
851
|
-
"application/json": {
|
|
852
|
-
"schema": {
|
|
853
|
-
"$ref": "#/components/schemas/GeneratedAssetResponse"
|
|
854
|
-
}
|
|
855
|
-
}
|
|
856
|
-
}
|
|
857
|
-
}
|
|
858
|
-
},
|
|
859
|
-
"security": [
|
|
860
|
-
{
|
|
861
|
-
"DeveloperKey": []
|
|
862
|
-
}
|
|
863
|
-
],
|
|
864
|
-
"tags": [
|
|
865
|
-
"Create"
|
|
866
|
-
]
|
|
867
|
-
},
|
|
868
|
-
"parameters": [
|
|
869
|
-
{
|
|
870
|
-
"name": "id",
|
|
871
|
-
"in": "path",
|
|
872
|
-
"required": true,
|
|
873
|
-
"schema": {
|
|
874
|
-
"pattern": "^[0-9a-zA-Z]{8}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{4}-[0-9a-zA-Z]{12}$",
|
|
875
|
-
"type": "string"
|
|
876
|
-
},
|
|
877
|
-
"description": "The id of the source file in [KSUID](https://github.com/segmentio/ksuid#what-is-a-ksuid) format."
|
|
878
|
-
}
|
|
879
|
-
]
|
|
880
776
|
}
|
|
881
777
|
},
|
|
882
778
|
"components": {
|
|
@@ -2082,8 +1978,7 @@
|
|
|
2082
1978
|
"description": "The active word color using hexadecimal color notation.",
|
|
2083
1979
|
"type": "string",
|
|
2084
1980
|
"pattern": "^#[A-Fa-f0-9]{6}$",
|
|
2085
|
-
"
|
|
2086
|
-
"example": "#ffff00"
|
|
1981
|
+
"example": "#C96741"
|
|
2087
1982
|
},
|
|
2088
1983
|
"background": {
|
|
2089
1984
|
"description": "The background color behind the active word using hexadecimal color notation.",
|
|
@@ -2521,11 +2416,11 @@
|
|
|
2521
2416
|
]
|
|
2522
2417
|
},
|
|
2523
2418
|
"SvgAsset": {
|
|
2524
|
-
"description": "The SvgAsset is used to add scalable vector graphics (SVG)
|
|
2419
|
+
"description": "The SvgAsset is used to add scalable vector graphics (SVG) to a video using raw SVG markup.\n\n```json\n{\n \"type\": \"svg\",\n \"src\": \"<svg width=\\\"100\\\" height=\\\"100\\\"><circle cx=\\\"50\\\" cy=\\\"50\\\" r=\\\"40\\\" fill=\\\"#FF0000\\\"/></svg>\"\n}\n```\n\n**Supported elements:** `<path>`, `<rect>`, `<circle>`, `<ellipse>`,\n`<line>`, `<polygon>`, `<polyline>`\n\n**Automatically extracted from SVG markup:**\n- Path data (converted to a single combined path)\n- Fill color (from `fill` attribute or `style`)\n- Stroke color and width (from attributes or `style`)\n- Dimensions (from `width`/`height` or `viewBox`)\n- Opacity (from `opacity` attribute)\n\nSee [W3C SVG 2 Specification](https://www.w3.org/TR/SVG2/) for path data syntax.\n",
|
|
2525
2420
|
"type": "object",
|
|
2526
2421
|
"properties": {
|
|
2527
2422
|
"type": {
|
|
2528
|
-
"description": "The asset type - set to `svg` for SVG
|
|
2423
|
+
"description": "The asset type - set to `svg` for SVG assets.",
|
|
2529
2424
|
"type": "string",
|
|
2530
2425
|
"enum": [
|
|
2531
2426
|
"svg"
|
|
@@ -2534,96 +2429,21 @@
|
|
|
2534
2429
|
"example": "svg"
|
|
2535
2430
|
},
|
|
2536
2431
|
"src": {
|
|
2537
|
-
"description": "Raw SVG markup string
|
|
2432
|
+
"description": "Raw SVG markup string. The shape, fill, stroke, dimensions and opacity\nare automatically extracted from the SVG content.\n",
|
|
2538
2433
|
"type": "string",
|
|
2539
2434
|
"minLength": 1,
|
|
2540
2435
|
"maxLength": 500000,
|
|
2541
2436
|
"example": "<svg width=\"100\" height=\"100\"><circle cx=\"50\" cy=\"50\" r=\"40\" fill=\"#3498db\"/></svg>"
|
|
2542
|
-
},
|
|
2543
|
-
"shape": {
|
|
2544
|
-
"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",
|
|
2545
|
-
"$ref": "#/components/schemas/SvgShape"
|
|
2546
|
-
},
|
|
2547
|
-
"fill": {
|
|
2548
|
-
"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",
|
|
2549
|
-
"$ref": "#/components/schemas/SvgFill"
|
|
2550
|
-
},
|
|
2551
|
-
"stroke": {
|
|
2552
|
-
"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",
|
|
2553
|
-
"$ref": "#/components/schemas/SvgStroke"
|
|
2554
|
-
},
|
|
2555
|
-
"shadow": {
|
|
2556
|
-
"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",
|
|
2557
|
-
"$ref": "#/components/schemas/SvgShadow"
|
|
2558
|
-
},
|
|
2559
|
-
"transform": {
|
|
2560
|
-
"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",
|
|
2561
|
-
"$ref": "#/components/schemas/SvgTransform"
|
|
2562
|
-
},
|
|
2563
|
-
"opacity": {
|
|
2564
|
-
"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",
|
|
2565
|
-
"type": "number",
|
|
2566
|
-
"minimum": 0,
|
|
2567
|
-
"maximum": 1,
|
|
2568
|
-
"default": 1,
|
|
2569
|
-
"example": 1
|
|
2570
|
-
},
|
|
2571
|
-
"width": {
|
|
2572
|
-
"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",
|
|
2573
|
-
"type": "integer",
|
|
2574
|
-
"minimum": 1,
|
|
2575
|
-
"maximum": 4096,
|
|
2576
|
-
"example": 400
|
|
2577
|
-
},
|
|
2578
|
-
"height": {
|
|
2579
|
-
"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",
|
|
2580
|
-
"type": "integer",
|
|
2581
|
-
"minimum": 1,
|
|
2582
|
-
"maximum": 4096,
|
|
2583
|
-
"example": 300
|
|
2584
2437
|
}
|
|
2585
2438
|
},
|
|
2586
2439
|
"additionalProperties": false,
|
|
2587
2440
|
"required": [
|
|
2588
|
-
"type"
|
|
2441
|
+
"type",
|
|
2442
|
+
"src"
|
|
2589
2443
|
],
|
|
2590
2444
|
"example": {
|
|
2591
2445
|
"type": "svg",
|
|
2592
|
-
"
|
|
2593
|
-
"type": "star",
|
|
2594
|
-
"points": 5,
|
|
2595
|
-
"outerRadius": 100,
|
|
2596
|
-
"innerRadius": 50
|
|
2597
|
-
},
|
|
2598
|
-
"fill": {
|
|
2599
|
-
"type": "linear",
|
|
2600
|
-
"angle": 45,
|
|
2601
|
-
"stops": [
|
|
2602
|
-
{
|
|
2603
|
-
"offset": 0,
|
|
2604
|
-
"color": "#FFD700"
|
|
2605
|
-
},
|
|
2606
|
-
{
|
|
2607
|
-
"offset": 1,
|
|
2608
|
-
"color": "#FF6B6B"
|
|
2609
|
-
}
|
|
2610
|
-
],
|
|
2611
|
-
"opacity": 1
|
|
2612
|
-
},
|
|
2613
|
-
"stroke": {
|
|
2614
|
-
"color": "#2C3E50",
|
|
2615
|
-
"width": 3,
|
|
2616
|
-
"opacity": 1,
|
|
2617
|
-
"lineCap": "round",
|
|
2618
|
-
"lineJoin": "round"
|
|
2619
|
-
},
|
|
2620
|
-
"transform": {
|
|
2621
|
-
"x": 200,
|
|
2622
|
-
"y": 150,
|
|
2623
|
-
"rotation": 0,
|
|
2624
|
-
"scale": 1
|
|
2625
|
-
},
|
|
2626
|
-
"opacity": 1
|
|
2446
|
+
"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>"
|
|
2627
2447
|
}
|
|
2628
2448
|
},
|
|
2629
2449
|
"SvgShape": {
|
|
@@ -5328,964 +5148,107 @@
|
|
|
5328
5148
|
],
|
|
5329
5149
|
"type": "object"
|
|
5330
5150
|
},
|
|
5331
|
-
"
|
|
5332
|
-
"
|
|
5333
|
-
"
|
|
5334
|
-
|
|
5335
|
-
|
|
5336
|
-
|
|
5337
|
-
|
|
5338
|
-
{
|
|
5339
|
-
"$ref": "#/components/schemas/ShotstackGeneratedAsset"
|
|
5340
|
-
},
|
|
5341
|
-
{
|
|
5342
|
-
"$ref": "#/components/schemas/DIDGeneratedAsset"
|
|
5343
|
-
},
|
|
5344
|
-
{
|
|
5345
|
-
"$ref": "#/components/schemas/ElevenLabsGeneratedAsset"
|
|
5346
|
-
},
|
|
5347
|
-
{
|
|
5348
|
-
"$ref": "#/components/schemas/HeyGenGeneratedAsset"
|
|
5151
|
+
"QueuedResponse": {
|
|
5152
|
+
"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.",
|
|
5153
|
+
"properties": {
|
|
5154
|
+
"success": {
|
|
5155
|
+
"description": "`true` if successfully queued, else `false`.",
|
|
5156
|
+
"type": "boolean",
|
|
5157
|
+
"example": true
|
|
5349
5158
|
},
|
|
5350
|
-
{
|
|
5351
|
-
"
|
|
5159
|
+
"message": {
|
|
5160
|
+
"description": "`Created`, `Bad Request` or an error message.",
|
|
5161
|
+
"type": "string",
|
|
5162
|
+
"example": "Created"
|
|
5352
5163
|
},
|
|
5353
|
-
{
|
|
5354
|
-
"
|
|
5164
|
+
"response": {
|
|
5165
|
+
"description": "`QueuedResponseData` or an error message.",
|
|
5166
|
+
"$ref": "#/components/schemas/QueuedResponseData"
|
|
5355
5167
|
}
|
|
5168
|
+
},
|
|
5169
|
+
"required": [
|
|
5170
|
+
"success",
|
|
5171
|
+
"message",
|
|
5172
|
+
"response"
|
|
5356
5173
|
],
|
|
5357
|
-
"
|
|
5174
|
+
"type": "object"
|
|
5358
5175
|
},
|
|
5359
|
-
"
|
|
5360
|
-
"description": "
|
|
5361
|
-
"type": "object",
|
|
5176
|
+
"QueuedResponseData": {
|
|
5177
|
+
"description": "The response data returned with the [QueuedResponse](#tocs_queuedresponse).",
|
|
5362
5178
|
"properties": {
|
|
5363
|
-
"
|
|
5179
|
+
"message": {
|
|
5180
|
+
"description": "Success response message or error details.",
|
|
5364
5181
|
"type": "string",
|
|
5365
|
-
"
|
|
5366
|
-
"enum": [
|
|
5367
|
-
"shotstack"
|
|
5368
|
-
],
|
|
5369
|
-
"default": "shotstack"
|
|
5182
|
+
"example": "Render Successfully Queued"
|
|
5370
5183
|
},
|
|
5371
|
-
"
|
|
5372
|
-
"description": "
|
|
5373
|
-
"
|
|
5184
|
+
"id": {
|
|
5185
|
+
"description": "The id of the render task in UUID format.",
|
|
5186
|
+
"type": "string",
|
|
5187
|
+
"example": "2abd5c11-0f3d-4c6d-ba20-235fc9b8e8b7"
|
|
5374
5188
|
}
|
|
5375
5189
|
},
|
|
5376
5190
|
"required": [
|
|
5377
|
-
"
|
|
5378
|
-
"
|
|
5379
|
-
]
|
|
5191
|
+
"message",
|
|
5192
|
+
"id"
|
|
5193
|
+
],
|
|
5194
|
+
"type": "object"
|
|
5380
5195
|
},
|
|
5381
|
-
"
|
|
5382
|
-
"
|
|
5383
|
-
"
|
|
5384
|
-
|
|
5385
|
-
|
|
5386
|
-
"
|
|
5387
|
-
|
|
5388
|
-
{
|
|
5389
|
-
"$ref": "#/components/schemas/ShotstackTextToImageOptions"
|
|
5196
|
+
"RenderResponse": {
|
|
5197
|
+
"description": "The response received after a [render status request](#get-render-status) is submitted. The response includes details about status of a render and the output URL.",
|
|
5198
|
+
"properties": {
|
|
5199
|
+
"success": {
|
|
5200
|
+
"description": "`true` if status available, else `false`.",
|
|
5201
|
+
"type": "boolean",
|
|
5202
|
+
"example": true
|
|
5390
5203
|
},
|
|
5391
|
-
{
|
|
5392
|
-
"
|
|
5204
|
+
"message": {
|
|
5205
|
+
"description": "`OK` or an error message.",
|
|
5206
|
+
"type": "string",
|
|
5207
|
+
"example": "OK"
|
|
5393
5208
|
},
|
|
5394
|
-
{
|
|
5395
|
-
"
|
|
5396
|
-
|
|
5397
|
-
],
|
|
5398
|
-
"discriminator": {
|
|
5399
|
-
"propertyName": "type",
|
|
5400
|
-
"mapping": {
|
|
5401
|
-
"text-to-speech": "#/components/schemas/ShotstackTextToSpeechOptions",
|
|
5402
|
-
"text-to-image": "#/components/schemas/ShotstackTextToImageOptions",
|
|
5403
|
-
"image-to-video": "#/components/schemas/ShotstackImageToVideoOptions",
|
|
5404
|
-
"text-generator": "#/components/schemas/ShotstackTextToImageOptions"
|
|
5209
|
+
"response": {
|
|
5210
|
+
"description": "`RenderResponse` or an error message.",
|
|
5211
|
+
"$ref": "#/components/schemas/RenderResponseData"
|
|
5405
5212
|
}
|
|
5406
5213
|
},
|
|
5407
|
-
"
|
|
5214
|
+
"required": [
|
|
5215
|
+
"success",
|
|
5216
|
+
"message",
|
|
5217
|
+
"response"
|
|
5218
|
+
],
|
|
5219
|
+
"type": "object"
|
|
5408
5220
|
},
|
|
5409
|
-
"
|
|
5410
|
-
"description": "
|
|
5221
|
+
"RenderResponseData": {
|
|
5222
|
+
"description": "The response data returned with the [RenderResponse](#tocs_renderresponse) including status and URL.",
|
|
5411
5223
|
"properties": {
|
|
5412
|
-
"
|
|
5224
|
+
"id": {
|
|
5225
|
+
"description": "The id of the render task in UUID format.",
|
|
5413
5226
|
"type": "string",
|
|
5414
|
-
"
|
|
5415
|
-
"enum": [
|
|
5416
|
-
"text-to-speech"
|
|
5417
|
-
],
|
|
5418
|
-
"default": "text-to-speech"
|
|
5227
|
+
"example": "2abd5c11-0f3d-4c6d-ba20-235fc9b8e8b7"
|
|
5419
5228
|
},
|
|
5420
|
-
"
|
|
5229
|
+
"owner": {
|
|
5230
|
+
"description": "The owner id of the render task.",
|
|
5421
5231
|
"type": "string",
|
|
5422
|
-
"
|
|
5423
|
-
"example": "This is a text to speech example generated by Shotstack"
|
|
5232
|
+
"example": "5ca6hu7s9k"
|
|
5424
5233
|
},
|
|
5425
|
-
"
|
|
5234
|
+
"plan": {
|
|
5235
|
+
"description": "The customer subscription plan.",
|
|
5426
5236
|
"type": "string",
|
|
5427
|
-
"
|
|
5428
|
-
"example": "Matthew",
|
|
5429
|
-
"enum": [
|
|
5430
|
-
"Hala",
|
|
5431
|
-
"Lisa",
|
|
5432
|
-
"Arlet",
|
|
5433
|
-
"Hiujin",
|
|
5434
|
-
"Zhiyu",
|
|
5435
|
-
"Sofie",
|
|
5436
|
-
"Laura",
|
|
5437
|
-
"Olivia",
|
|
5438
|
-
"Amy",
|
|
5439
|
-
"Emma",
|
|
5440
|
-
"Brian",
|
|
5441
|
-
"Arthur",
|
|
5442
|
-
"Kajal",
|
|
5443
|
-
"Niamh",
|
|
5444
|
-
"Aria",
|
|
5445
|
-
"Ayanda",
|
|
5446
|
-
"Ivy",
|
|
5447
|
-
"Joanna",
|
|
5448
|
-
"Kendra",
|
|
5449
|
-
"Kimberly",
|
|
5450
|
-
"Salli",
|
|
5451
|
-
"Joey",
|
|
5452
|
-
"Justin",
|
|
5453
|
-
"Kevin",
|
|
5454
|
-
"Matthew",
|
|
5455
|
-
"Ruth",
|
|
5456
|
-
"Stephen",
|
|
5457
|
-
"Suvi",
|
|
5458
|
-
"Léa",
|
|
5459
|
-
"Rémi",
|
|
5460
|
-
"Gabrielle",
|
|
5461
|
-
"Liam",
|
|
5462
|
-
"Vicki",
|
|
5463
|
-
"Daniel",
|
|
5464
|
-
"Hannah",
|
|
5465
|
-
"Kajal",
|
|
5466
|
-
"Bianca",
|
|
5467
|
-
"Adriano",
|
|
5468
|
-
"Takumi",
|
|
5469
|
-
"Kazuha",
|
|
5470
|
-
"Tomoko",
|
|
5471
|
-
"Seoyeon",
|
|
5472
|
-
"Ida",
|
|
5473
|
-
"Ola",
|
|
5474
|
-
"Camila",
|
|
5475
|
-
"Vitória",
|
|
5476
|
-
"Vitoria",
|
|
5477
|
-
"Thiago",
|
|
5478
|
-
"Inês",
|
|
5479
|
-
"Ines",
|
|
5480
|
-
"Lucia",
|
|
5481
|
-
"Sergio",
|
|
5482
|
-
"Mia",
|
|
5483
|
-
"Andrés",
|
|
5484
|
-
"Lupe",
|
|
5485
|
-
"Pedro",
|
|
5486
|
-
"Elin"
|
|
5487
|
-
]
|
|
5237
|
+
"example": "basic"
|
|
5488
5238
|
},
|
|
5489
|
-
"
|
|
5490
|
-
"
|
|
5491
|
-
"description": "The language code for the text-to-speech conversion. You must pair the correct language with the correct voice (see voice parameter above).\nSelect a language from the list of available languages: <ul>\n <li>`cmn-CN`</li>\n <li>`da-DK`</li>\n <li>`de-DE`</li>\n <li>`en-AU`</li>\n <li>`en-GB`</li>\n <li>`en-IN`</li>\n <li>`en-US`</li>\n <li>`es-ES`</li>\n <li>`es-MX`</li>\n <li>`es-US`</li>\n <li>`fr-CA`</li>\n <li>`fr-FR`</li>\n <li>`it-IT`</li>\n <li>`ja-JP`</li>\n <li>`hi-IN`</li>\n <li>`ko-KR`</li>\n <li>`nb-NO`</li>\n <li>`nl-NL`</li>\n <li>`pl-PL`</li>\n <li>`pt-BR`</li>\n <li>`pt-PT`</li>\n <li>`sv-SE`</li>\n <li>`en-NZ`</li>\n <li>`en-ZA`</li>\n <li>`ca-ES`</li>\n <li>`de-AT`</li>\n <li>`yue-CN`</li>\n <li>`ar-AE`</li>\n <li>`fi-FI`</li>\n</ul>",
|
|
5239
|
+
"status": {
|
|
5240
|
+
"description": "The status of the render task. <ul>\n <li>`queued` - render is queued waiting to be rendered</li>\n <li>`fetching` - assets are being fetched</li>\n <li>`preprocessing` - video assets are being processed for compatibility</li>\n <li>`rendering` - the asset is being rendered</li>\n <li>`saving` - the final asset is being saved to storage</li>\n <li>`done` - the asset is ready to be downloaded</li>\n <li>`failed` - there was an error rendering the asset</li>\n</ul>",
|
|
5492
5241
|
"enum": [
|
|
5493
|
-
"
|
|
5494
|
-
"
|
|
5495
|
-
"
|
|
5496
|
-
"
|
|
5497
|
-
"
|
|
5498
|
-
"
|
|
5499
|
-
"
|
|
5500
|
-
"es-ES",
|
|
5501
|
-
"es-MX",
|
|
5502
|
-
"es-US",
|
|
5503
|
-
"fr-CA",
|
|
5504
|
-
"fr-FR",
|
|
5505
|
-
"it-IT",
|
|
5506
|
-
"ja-JP",
|
|
5507
|
-
"hi-IN",
|
|
5508
|
-
"ko-KR",
|
|
5509
|
-
"nb-NO",
|
|
5510
|
-
"nl-NL",
|
|
5511
|
-
"pl-PL",
|
|
5512
|
-
"pt-BR",
|
|
5513
|
-
"pt-PT",
|
|
5514
|
-
"sv-SE",
|
|
5515
|
-
"en-NZ",
|
|
5516
|
-
"en-ZA",
|
|
5517
|
-
"ca-ES",
|
|
5518
|
-
"de-AT",
|
|
5519
|
-
"yue-CN",
|
|
5520
|
-
"ar-AE",
|
|
5521
|
-
"fi-FI"
|
|
5242
|
+
"queued",
|
|
5243
|
+
"fetching",
|
|
5244
|
+
"preprocessing",
|
|
5245
|
+
"rendering",
|
|
5246
|
+
"saving",
|
|
5247
|
+
"done",
|
|
5248
|
+
"failed"
|
|
5522
5249
|
],
|
|
5523
|
-
"
|
|
5524
|
-
|
|
5525
|
-
"newscaster": {
|
|
5526
|
-
"type": "boolean",
|
|
5527
|
-
"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.",
|
|
5528
|
-
"default": false
|
|
5529
|
-
}
|
|
5530
|
-
},
|
|
5531
|
-
"required": [
|
|
5532
|
-
"type",
|
|
5533
|
-
"text",
|
|
5534
|
-
"voice"
|
|
5535
|
-
]
|
|
5536
|
-
},
|
|
5537
|
-
"ShotstackTextToImageOptions": {
|
|
5538
|
-
"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.",
|
|
5539
|
-
"properties": {
|
|
5540
|
-
"type": {
|
|
5541
|
-
"type": "string",
|
|
5542
|
-
"description": "The type of asset to generate - set to `text-to-image` for text-to-image.",
|
|
5543
|
-
"enum": [
|
|
5544
|
-
"text-to-image"
|
|
5545
|
-
],
|
|
5546
|
-
"default": "text-to-image"
|
|
5547
|
-
},
|
|
5548
|
-
"prompt": {
|
|
5549
|
-
"type": "string",
|
|
5550
|
-
"description": "The text prompt to generate an image from.",
|
|
5551
|
-
"example": "A detailed photograph of Mars, showcasing its orange-red surface"
|
|
5552
|
-
},
|
|
5553
|
-
"width": {
|
|
5554
|
-
"type": "integer",
|
|
5555
|
-
"description": "The width of the image in pixels.",
|
|
5556
|
-
"example": 512
|
|
5557
|
-
},
|
|
5558
|
-
"height": {
|
|
5559
|
-
"type": "integer",
|
|
5560
|
-
"description": "The height of the image in pixels.",
|
|
5561
|
-
"example": 512
|
|
5562
|
-
}
|
|
5563
|
-
},
|
|
5564
|
-
"required": [
|
|
5565
|
-
"type",
|
|
5566
|
-
"prompt",
|
|
5567
|
-
"width",
|
|
5568
|
-
"height"
|
|
5569
|
-
]
|
|
5570
|
-
},
|
|
5571
|
-
"ShotstackImageToVideoOptions": {
|
|
5572
|
-
"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.",
|
|
5573
|
-
"properties": {
|
|
5574
|
-
"type": {
|
|
5575
|
-
"type": "string",
|
|
5576
|
-
"description": "The type of asset to generate - set to `image-to-video` for image-to-video.",
|
|
5577
|
-
"enum": [
|
|
5578
|
-
"image-to-video"
|
|
5579
|
-
],
|
|
5580
|
-
"default": "image-to-video"
|
|
5581
|
-
},
|
|
5582
|
-
"imageUrl": {
|
|
5583
|
-
"type": "string",
|
|
5584
|
-
"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.",
|
|
5585
|
-
"example": "https://s3-ap-northeast-1.amazonaws.com/my-bucket/image.jpg"
|
|
5586
|
-
},
|
|
5587
|
-
"guidanceScale": {
|
|
5588
|
-
"type": "number",
|
|
5589
|
-
"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.",
|
|
5590
|
-
"example": 1.8,
|
|
5591
|
-
"default": 1.8
|
|
5592
|
-
},
|
|
5593
|
-
"motion": {
|
|
5594
|
-
"type": "integer",
|
|
5595
|
-
"description": "The amount of motion in the video. A number between 1 and 255.",
|
|
5596
|
-
"example": 127,
|
|
5597
|
-
"default": 127
|
|
5598
|
-
}
|
|
5599
|
-
},
|
|
5600
|
-
"required": [
|
|
5601
|
-
"type",
|
|
5602
|
-
"imageUrl"
|
|
5603
|
-
]
|
|
5604
|
-
},
|
|
5605
|
-
"ShotstackTextGeneratorOptions": {
|
|
5606
|
-
"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.",
|
|
5607
|
-
"properties": {
|
|
5608
|
-
"type": {
|
|
5609
|
-
"type": "string",
|
|
5610
|
-
"description": "The type of asset to generate - set to `text-generator` for text generation.",
|
|
5611
|
-
"enum": [
|
|
5612
|
-
"text-generator"
|
|
5613
|
-
],
|
|
5614
|
-
"default": "text-generator"
|
|
5615
|
-
},
|
|
5616
|
-
"prompt": {
|
|
5617
|
-
"type": "string",
|
|
5618
|
-
"description": "The text prompt to generate text from.",
|
|
5619
|
-
"example": "Generate a short script for a 15 second video describing the benefits of the Shotstack API"
|
|
5620
|
-
}
|
|
5621
|
-
},
|
|
5622
|
-
"required": [
|
|
5623
|
-
"type",
|
|
5624
|
-
"prompt"
|
|
5625
|
-
]
|
|
5626
|
-
},
|
|
5627
|
-
"DIDGeneratedAsset": {
|
|
5628
|
-
"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.",
|
|
5629
|
-
"type": "object",
|
|
5630
|
-
"properties": {
|
|
5631
|
-
"provider": {
|
|
5632
|
-
"type": "string",
|
|
5633
|
-
"description": "The name of the provider - set to `d-id` for D-ID.",
|
|
5634
|
-
"enum": [
|
|
5635
|
-
"d-id"
|
|
5636
|
-
],
|
|
5637
|
-
"default": "d-id"
|
|
5638
|
-
},
|
|
5639
|
-
"options": {
|
|
5640
|
-
"description": "Options and configuration for the D-ID text-to-avatar service.",
|
|
5641
|
-
"$ref": "#/components/schemas/DIDGeneratedAssetOptions"
|
|
5642
|
-
}
|
|
5643
|
-
},
|
|
5644
|
-
"required": [
|
|
5645
|
-
"provider",
|
|
5646
|
-
"options"
|
|
5647
|
-
]
|
|
5648
|
-
},
|
|
5649
|
-
"DIDGeneratedAssetOptions": {
|
|
5650
|
-
"type": "object",
|
|
5651
|
-
"description": "Generate assets using the third party D-ID provider AI services.\n\nThe following AI generation services are available: <ul>\n <li><a href=\"#tocs_didtexttoavataroptions\">DidTextToAvatarOptions</a></li>\n</ul>",
|
|
5652
|
-
"oneOf": [
|
|
5653
|
-
{
|
|
5654
|
-
"$ref": "#/components/schemas/DIDTextToAvatarOptions"
|
|
5655
|
-
}
|
|
5656
|
-
],
|
|
5657
|
-
"discriminator": {
|
|
5658
|
-
"propertyName": "type",
|
|
5659
|
-
"mapping": {
|
|
5660
|
-
"text-to-avatar": "#/components/schemas/DIDTextToAvatarOptions"
|
|
5661
|
-
}
|
|
5662
|
-
},
|
|
5663
|
-
"additionalProperties": false
|
|
5664
|
-
},
|
|
5665
|
-
"DIDTextToAvatarOptions": {
|
|
5666
|
-
"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.",
|
|
5667
|
-
"properties": {
|
|
5668
|
-
"type": {
|
|
5669
|
-
"type": "string",
|
|
5670
|
-
"description": "The type of asset to generate - set to `text-to-avatar` for text-to-avatar.",
|
|
5671
|
-
"enum": [
|
|
5672
|
-
"text-to-avatar"
|
|
5673
|
-
]
|
|
5674
|
-
},
|
|
5675
|
-
"text": {
|
|
5676
|
-
"type": "string",
|
|
5677
|
-
"description": "The text or script that the avatar will narrate.",
|
|
5678
|
-
"example": "I am an avatar generated by D-ID using a text prompt"
|
|
5679
|
-
},
|
|
5680
|
-
"avatar": {
|
|
5681
|
-
"type": "string",
|
|
5682
|
-
"description": "The avatar character to generate. Select from the list of available avatars: <ul>\n <li>`jack`</li>\n <li>`lana`</li>\n <li>`lily`</li>\n <li>`matt`</li>\n <li>`rian`</li>\n</ul>",
|
|
5683
|
-
"enum": [
|
|
5684
|
-
"jack",
|
|
5685
|
-
"lana",
|
|
5686
|
-
"lily",
|
|
5687
|
-
"matt",
|
|
5688
|
-
"rian"
|
|
5689
|
-
]
|
|
5690
|
-
},
|
|
5691
|
-
"background": {
|
|
5692
|
-
"type": "string",
|
|
5693
|
-
"description": "The background color of the video.",
|
|
5694
|
-
"example": "#ffffff"
|
|
5695
|
-
}
|
|
5696
|
-
},
|
|
5697
|
-
"required": [
|
|
5698
|
-
"type",
|
|
5699
|
-
"text",
|
|
5700
|
-
"avatar"
|
|
5701
|
-
]
|
|
5702
|
-
},
|
|
5703
|
-
"ElevenLabsGeneratedAsset": {
|
|
5704
|
-
"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.",
|
|
5705
|
-
"type": "object",
|
|
5706
|
-
"properties": {
|
|
5707
|
-
"provider": {
|
|
5708
|
-
"type": "string",
|
|
5709
|
-
"description": "The name of the provider - set to `elevenlabs` for ElevenLabs.",
|
|
5710
|
-
"enum": [
|
|
5711
|
-
"elevenlabs"
|
|
5712
|
-
],
|
|
5713
|
-
"default": "elevenlabs"
|
|
5714
|
-
},
|
|
5715
|
-
"options": {
|
|
5716
|
-
"description": "Options and configuration for the ElevenLabs text-to-speech service.",
|
|
5717
|
-
"$ref": "#/components/schemas/ElevenLabsGeneratedAssetOptions"
|
|
5718
|
-
}
|
|
5719
|
-
},
|
|
5720
|
-
"required": [
|
|
5721
|
-
"provider",
|
|
5722
|
-
"options"
|
|
5723
|
-
]
|
|
5724
|
-
},
|
|
5725
|
-
"ElevenLabsGeneratedAssetOptions": {
|
|
5726
|
-
"type": "object",
|
|
5727
|
-
"description": "Generate assets using the third party ElevenLabs provider AI services.\n\nThe following AI generation services are available: <ul>\n <li><a href=\"#tocs_elevenlabstexttospeechoptions\">ElevenLabsTextToSpeechOptions</a></li>\n</ul>",
|
|
5728
|
-
"oneOf": [
|
|
5729
|
-
{
|
|
5730
|
-
"$ref": "#/components/schemas/ElevenLabsTextToSpeechOptions"
|
|
5731
|
-
}
|
|
5732
|
-
],
|
|
5733
|
-
"discriminator": {
|
|
5734
|
-
"propertyName": "type",
|
|
5735
|
-
"mapping": {
|
|
5736
|
-
"text-to-speech": "#/components/schemas/ElevenLabsTextToSpeechOptions"
|
|
5737
|
-
}
|
|
5738
|
-
},
|
|
5739
|
-
"additionalProperties": false
|
|
5740
|
-
},
|
|
5741
|
-
"ElevenLabsTextToSpeechOptions": {
|
|
5742
|
-
"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.",
|
|
5743
|
-
"properties": {
|
|
5744
|
-
"type": {
|
|
5745
|
-
"type": "string",
|
|
5746
|
-
"description": "The type of asset to generate - set to `text-to-speech` for text-to-speech.",
|
|
5747
|
-
"enum": [
|
|
5748
|
-
"text-to-speech"
|
|
5749
|
-
]
|
|
5750
|
-
},
|
|
5751
|
-
"text": {
|
|
5752
|
-
"type": "string",
|
|
5753
|
-
"description": "The text to convert to speech.",
|
|
5754
|
-
"example": "This is a text to speech example generated by ElevenLabs"
|
|
5755
|
-
},
|
|
5756
|
-
"voice": {
|
|
5757
|
-
"type": "string",
|
|
5758
|
-
"description": "The voice to use for the text-to-speech conversion. Select a voice from the list of available voices: <ul>\n <li>`Adam`</li>\n <li>`Antoni`</li>\n <li>`Arnold`</li>\n <li>`Bella`</li>\n <li>`Domi`</li>\n <li>`Elli`</li>\n <li>`Josh`</li>\n <li>`Rachel`</li>\n <li>`Sam`</li>\n</ul>",
|
|
5759
|
-
"enum": [
|
|
5760
|
-
"Adam",
|
|
5761
|
-
"Antoni",
|
|
5762
|
-
"Arnold",
|
|
5763
|
-
"Bella",
|
|
5764
|
-
"Domi",
|
|
5765
|
-
"Elli",
|
|
5766
|
-
"Josh",
|
|
5767
|
-
"Rachel",
|
|
5768
|
-
"Sam"
|
|
5769
|
-
]
|
|
5770
|
-
}
|
|
5771
|
-
},
|
|
5772
|
-
"required": [
|
|
5773
|
-
"type",
|
|
5774
|
-
"text",
|
|
5775
|
-
"voice"
|
|
5776
|
-
]
|
|
5777
|
-
},
|
|
5778
|
-
"HeyGenGeneratedAsset": {
|
|
5779
|
-
"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.",
|
|
5780
|
-
"type": "object",
|
|
5781
|
-
"properties": {
|
|
5782
|
-
"provider": {
|
|
5783
|
-
"type": "string",
|
|
5784
|
-
"description": "The name of the provider - set to `heygen` for HeyGen.",
|
|
5785
|
-
"enum": [
|
|
5786
|
-
"heygen"
|
|
5787
|
-
],
|
|
5788
|
-
"default": "heygen"
|
|
5789
|
-
},
|
|
5790
|
-
"options": {
|
|
5791
|
-
"description": "Options and configuration for the HeyGen text-to-avatar service.",
|
|
5792
|
-
"$ref": "#/components/schemas/HeyGenGeneratedAssetOptions"
|
|
5793
|
-
}
|
|
5794
|
-
},
|
|
5795
|
-
"required": [
|
|
5796
|
-
"provider",
|
|
5797
|
-
"options"
|
|
5798
|
-
]
|
|
5799
|
-
},
|
|
5800
|
-
"HeyGenGeneratedAssetOptions": {
|
|
5801
|
-
"type": "object",
|
|
5802
|
-
"description": "Generate assets using the third party HeyGen provider AI services.\n\nThe following AI generation services are available: <ul>\n <li><a href=\"#tocs_heygentexttoavataroptions\">HeyGenTextToAvatarOptions</a></li>\n</ul>",
|
|
5803
|
-
"oneOf": [
|
|
5804
|
-
{
|
|
5805
|
-
"$ref": "#/components/schemas/HeyGenTextToAvatarOptions"
|
|
5806
|
-
}
|
|
5807
|
-
],
|
|
5808
|
-
"discriminator": {
|
|
5809
|
-
"propertyName": "type",
|
|
5810
|
-
"mapping": {
|
|
5811
|
-
"text-to-avatar": "#/components/schemas/HeyGenTextToAvatarOptions"
|
|
5812
|
-
}
|
|
5813
|
-
},
|
|
5814
|
-
"additionalProperties": false
|
|
5815
|
-
},
|
|
5816
|
-
"HeyGenTextToAvatarOptions": {
|
|
5817
|
-
"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.",
|
|
5818
|
-
"properties": {
|
|
5819
|
-
"type": {
|
|
5820
|
-
"type": "string",
|
|
5821
|
-
"description": "The type of asset to generate - set to `text-to-avatar` for text-to-avatar.",
|
|
5822
|
-
"enum": [
|
|
5823
|
-
"text-to-avatar"
|
|
5824
|
-
]
|
|
5825
|
-
},
|
|
5826
|
-
"text": {
|
|
5827
|
-
"type": "string",
|
|
5828
|
-
"description": "The text or script that the avatar will narrate.",
|
|
5829
|
-
"example": "I am an avatar generated by HeyGen using a text prompt"
|
|
5830
|
-
},
|
|
5831
|
-
"avatar": {
|
|
5832
|
-
"type": "string",
|
|
5833
|
-
"description": "The avatar character to generate. Select from the list of available avatars: <ul>\n <li>`Angela`</li>\n <li>`Bill`</li>\n <li>`Daisy`</li>\n <li>`Derek`</li>\n <li>`Eva`</li>\n <li>`Jake`</li>\n <li>`Jeff`</li>\n <li>`Jerome`</li>\n <li>`Joon`</li>\n <li>`Kayla`</li>\n <li>`Kent`</li>\n <li>`Luna`</li>\n <li>`Mark`</li>\n <li>`Matthew`</li>\n <li>`Monica`</li>\n <li>`Peter`</li>\n <li>`Selina`</li>\n <li>`Tanya`</li>\n <li>`Thomas`</li>\n <li>`Tina`</li>\n <li>`Tyler`</li>\n <li>`Vanessa`</li>\n <li>`Vera`</li>\n <li>`Wilson`</li>\n <li>`Zoey`</li>\n</ul>",
|
|
5834
|
-
"enum": [
|
|
5835
|
-
"Angela",
|
|
5836
|
-
"Bill",
|
|
5837
|
-
"Daisy",
|
|
5838
|
-
"Derek",
|
|
5839
|
-
"Eva",
|
|
5840
|
-
"Jake",
|
|
5841
|
-
"Jeff",
|
|
5842
|
-
"Jerome",
|
|
5843
|
-
"Joon",
|
|
5844
|
-
"Kayla",
|
|
5845
|
-
"Kent",
|
|
5846
|
-
"Luna",
|
|
5847
|
-
"Mark",
|
|
5848
|
-
"Matthew",
|
|
5849
|
-
"Monica",
|
|
5850
|
-
"Peter",
|
|
5851
|
-
"Selina",
|
|
5852
|
-
"Tanya",
|
|
5853
|
-
"Thomas",
|
|
5854
|
-
"Tina",
|
|
5855
|
-
"Tyler",
|
|
5856
|
-
"Vanessa",
|
|
5857
|
-
"Vera",
|
|
5858
|
-
"Wilson",
|
|
5859
|
-
"Zoey"
|
|
5860
|
-
]
|
|
5861
|
-
},
|
|
5862
|
-
"voice": {
|
|
5863
|
-
"type": "string",
|
|
5864
|
-
"description": "The avatars voice and speaking style. Select from the list of available voices: <ul>\n <li>`Abb- - Natural`</li>\n <li>`Adam - Natural`</li>\n <li>`Aiston - Friendly`</li>\n <li>`Alice - Newscaster`</li>\n <li>`Alison - Cheerful`</li>\n <li>`Amber - Friendly`</li>\n <li>`Amy - Warm`</li>\n <li>`Ana - Cheerful`</li>\n <li>`Antoni - Friendly`</li>\n <li>`Aria - Newscaster`</li>\n <li>`Arnold - Cheerful`</li>\n <li>`Arthur - Natural`</li>\n <li>`Bella - Friendly`</li>\n <li>`Belle - Natural`</li>\n <li>`Brandon - Warm`</li>\n <li>`Brian - Natural`</li>\n <li>`Bruce - Natural`</li>\n <li>`Cerise - Cheerful`</li>\n <li>`Christopher - Calm`</li>\n <li>`Clara - Professional`</li>\n <li>`Connor - Natural`</li>\n <li>`Dahlia - Friendly`</li>\n <li>`Davis - Professional`</li>\n <li>`Dean - Natural`</li>\n <li>`Delbert - Cheerful`</li>\n <li>`Edward - Friendly`</li>\n <li>`Elaine - Calm`</li>\n <li>`Emily - Natural`</li>\n <li>`Emma - Newscaster`</li>\n <li>`Eric - Newscaster`</li>\n <li>`Grace - Natural`</li>\n <li>`Hailey - Calm`</li>\n <li>`Indira - Cheerful`</li>\n <li>`Isabella - Cheerful`</li>\n <li>`Jacob - Natural`</li>\n <li>`Jahmai - Friendly`</li>\n <li>`Jane - Serious`</li>\n <li>`Jason - Serious`</li>\n <li>`Jelle - Friendly`</li>\n <li>`Jen - Natural`</li>\n <li>`Jenny - Professional`</li>\n <li>`Jodi - Cheerful`</li>\n <li>`Joey - Calm`</li>\n <li>`Johan - Friendly`</li>\n <li>`Josie - Cheerful`</li>\n <li>`Keanan - Natural`</li>\n <li>`Keith - Cheerful`</li>\n <li>`Kellie - Friendly`</li>\n <li>`Lauren - Friendly`</li>\n <li>`Leah - Natural`</li>\n <li>`Liam - Professional`</li>\n <li>`Libby - Natural`</li>\n <li>`Lily - Professional`</li>\n <li>`Lucas - Natural`</li>\n <li>`Luke - Professional`</li>\n <li>`Luna - Natural`</li>\n <li>`Marieke - Natural`</li>\n <li>`Matthew - Professional`</li>\n <li>`Michelle - Natural`</li>\n <li>`Mitchell - Natural`</li>\n <li>`Molly - Newscaster`</li>\n <li>`Monica - Calm`</li>\n <li>`Natasha - Professional`</li>\n <li>`Neerja - Newscaster`</li>\n <li>`Noah - Serious`</li>\n <li>`Oliver - Newscaster`</li>\n <li>`Olivia - Calm`</li>\n <li>`Paul - Natural`</li>\n <li>`Prabhat - Natural`</li>\n <li>`Raveena - Natural`</li>\n <li>`Rudi - Friendly`</li>\n <li>`Ryan - Professional`</li>\n <li>`Sam - Natural`</li>\n <li>`Sara - Cheerful`</li>\n <li>`Sherry - Friendly`</li>\n <li>`Sonia - Warm`</li>\n <li>`Thomas - Natural`</li>\n <li>`Todd - Professional`</li>\n <li>`Tony - Professional`</li>\n <li>`Tracy - Cheerful`</li>\n <li>`Wayne - Natural`</li>\n <li>`Wilder - Natural`</li>\n <li>`Wille - Natural`</li>\n <li>`William - Friendly`</li>\n</ul>",
|
|
5865
|
-
"enum": [
|
|
5866
|
-
"Abbi - Natural",
|
|
5867
|
-
"Adam - Natural",
|
|
5868
|
-
"Aiston - Friendly",
|
|
5869
|
-
"Alice - Newscaster",
|
|
5870
|
-
"Alison - Cheerful",
|
|
5871
|
-
"Amber - Friendly",
|
|
5872
|
-
"Amy - Warm",
|
|
5873
|
-
"Ana - Cheerful",
|
|
5874
|
-
"Antoni - Friendly",
|
|
5875
|
-
"Aria - Newscaster",
|
|
5876
|
-
"Arnold - Cheerful",
|
|
5877
|
-
"Arthur - Natural",
|
|
5878
|
-
"Bella - Friendly",
|
|
5879
|
-
"Belle - Natural",
|
|
5880
|
-
"Brandon - Warm",
|
|
5881
|
-
"Brian - Natural",
|
|
5882
|
-
"Bruce - Natural",
|
|
5883
|
-
"Cerise - Cheerful",
|
|
5884
|
-
"Christopher - Calm",
|
|
5885
|
-
"Clara - Professional",
|
|
5886
|
-
"Connor - Natural",
|
|
5887
|
-
"Dahlia - Friendly",
|
|
5888
|
-
"Davis - Professional",
|
|
5889
|
-
"Dean - Natural",
|
|
5890
|
-
"Delbert - Cheerful",
|
|
5891
|
-
"Edward - Friendly",
|
|
5892
|
-
"Elaine - Calm",
|
|
5893
|
-
"Emily - Natural",
|
|
5894
|
-
"Emma - Newscaster",
|
|
5895
|
-
"Eric - Newscaster",
|
|
5896
|
-
"Grace - Natural",
|
|
5897
|
-
"Hailey - Calm",
|
|
5898
|
-
"Indira - Cheerful",
|
|
5899
|
-
"Isabella - Cheerful",
|
|
5900
|
-
"Jacob - Natural",
|
|
5901
|
-
"Jahmai - Friendly",
|
|
5902
|
-
"Jane - Serious",
|
|
5903
|
-
"Jason - Serious",
|
|
5904
|
-
"Jelle - Friendly",
|
|
5905
|
-
"Jen - Natural",
|
|
5906
|
-
"Jenny - Professional",
|
|
5907
|
-
"Jodi - Cheerful",
|
|
5908
|
-
"Joey - Calm",
|
|
5909
|
-
"Johan - Friendly",
|
|
5910
|
-
"Josie - Cheerful",
|
|
5911
|
-
"Keanan - Natural",
|
|
5912
|
-
"Keith - Cheerful",
|
|
5913
|
-
"Kellie - Friendly",
|
|
5914
|
-
"Lauren - Friendly",
|
|
5915
|
-
"Leah - Natural",
|
|
5916
|
-
"Liam - Professional",
|
|
5917
|
-
"Libby - Natural",
|
|
5918
|
-
"Lily - Professional",
|
|
5919
|
-
"Lucas - Natural",
|
|
5920
|
-
"Luke - Professional",
|
|
5921
|
-
"Luna - Natural",
|
|
5922
|
-
"Marieke - Natural",
|
|
5923
|
-
"Matthew - Professional",
|
|
5924
|
-
"Michelle - Natural",
|
|
5925
|
-
"Mitchell - Natural",
|
|
5926
|
-
"Molly - Newscaster",
|
|
5927
|
-
"Monica - Calm",
|
|
5928
|
-
"Natasha - Professional",
|
|
5929
|
-
"Neerja - Newscaster",
|
|
5930
|
-
"Noah - Serious",
|
|
5931
|
-
"Oliver - Newscaster",
|
|
5932
|
-
"Olivia - Calm",
|
|
5933
|
-
"Paul - Natural",
|
|
5934
|
-
"Prabhat - Natural",
|
|
5935
|
-
"Raveena - Natural",
|
|
5936
|
-
"Rudi - Friendly",
|
|
5937
|
-
"Ryan - Professional",
|
|
5938
|
-
"Sam - Natural",
|
|
5939
|
-
"Sara - Cheerful",
|
|
5940
|
-
"Sherry - Friendly",
|
|
5941
|
-
"Sonia - Warm",
|
|
5942
|
-
"Thomas - Natural",
|
|
5943
|
-
"Todd - Professional",
|
|
5944
|
-
"Tony - Professional",
|
|
5945
|
-
"Tracy - Cheerful",
|
|
5946
|
-
"Wayne - Natural",
|
|
5947
|
-
"Wilder - Natural",
|
|
5948
|
-
"Wille - Natural",
|
|
5949
|
-
"William - Friendly"
|
|
5950
|
-
]
|
|
5951
|
-
},
|
|
5952
|
-
"avatarStyle": {
|
|
5953
|
-
"type": "string",
|
|
5954
|
-
"description": "The display style of the avatar, a rectangle `normal` or circular `circle` background. Defaults to `normal`.",
|
|
5955
|
-
"enum": [
|
|
5956
|
-
"normal",
|
|
5957
|
-
"circle"
|
|
5958
|
-
]
|
|
5959
|
-
},
|
|
5960
|
-
"background": {
|
|
5961
|
-
"type": "string",
|
|
5962
|
-
"description": "The background color of the video. Defaults to `#ffffff`.",
|
|
5963
|
-
"example": "#ffffff"
|
|
5964
|
-
},
|
|
5965
|
-
"ratio": {
|
|
5966
|
-
"type": "string",
|
|
5967
|
-
"description": "The aspect ratio of the video, `16:9` horizontal or `9:16` vertical. Defaults to `16:9`.",
|
|
5968
|
-
"enum": [
|
|
5969
|
-
"16:9",
|
|
5970
|
-
"9:16"
|
|
5971
|
-
]
|
|
5972
|
-
},
|
|
5973
|
-
"test": {
|
|
5974
|
-
"type": "boolean",
|
|
5975
|
-
"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.",
|
|
5976
|
-
"example": true
|
|
5977
|
-
}
|
|
5978
|
-
},
|
|
5979
|
-
"required": [
|
|
5980
|
-
"type",
|
|
5981
|
-
"text",
|
|
5982
|
-
"avatar",
|
|
5983
|
-
"voice"
|
|
5984
|
-
]
|
|
5985
|
-
},
|
|
5986
|
-
"OpenAiGeneratedAsset": {
|
|
5987
|
-
"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.",
|
|
5988
|
-
"type": "object",
|
|
5989
|
-
"properties": {
|
|
5990
|
-
"provider": {
|
|
5991
|
-
"type": "string",
|
|
5992
|
-
"description": "The name of the provider - set to `openai` for OpenAI.",
|
|
5993
|
-
"enum": [
|
|
5994
|
-
"openai"
|
|
5995
|
-
],
|
|
5996
|
-
"default": "openai"
|
|
5997
|
-
},
|
|
5998
|
-
"options": {
|
|
5999
|
-
"description": "Options and configuration for the OpenAI text-generator service.",
|
|
6000
|
-
"$ref": "#/components/schemas/OpenAiGeneratedAssetOptions"
|
|
6001
|
-
}
|
|
6002
|
-
},
|
|
6003
|
-
"required": [
|
|
6004
|
-
"provider",
|
|
6005
|
-
"options"
|
|
6006
|
-
]
|
|
6007
|
-
},
|
|
6008
|
-
"OpenAiGeneratedAssetOptions": {
|
|
6009
|
-
"type": "object",
|
|
6010
|
-
"description": "Generate assets using OpenAI provider AI services.\n\nThe following AI generation services are available: <ul>\n <li><a href=\"#tocs_openaitextgeneratoroptions\">OpenAiTextGeneratorOptions</a></li>\n</ul>",
|
|
6011
|
-
"oneOf": [
|
|
6012
|
-
{
|
|
6013
|
-
"$ref": "#/components/schemas/OpenAiTextGeneratorOptions"
|
|
6014
|
-
}
|
|
6015
|
-
],
|
|
6016
|
-
"discriminator": {
|
|
6017
|
-
"propertyName": "type",
|
|
6018
|
-
"mapping": {
|
|
6019
|
-
"text-generator": "#/components/schemas/OpenAiTextGeneratorOptions"
|
|
6020
|
-
}
|
|
6021
|
-
},
|
|
6022
|
-
"additionalProperties": false
|
|
6023
|
-
},
|
|
6024
|
-
"OpenAiTextGeneratorOptions": {
|
|
6025
|
-
"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.",
|
|
6026
|
-
"properties": {
|
|
6027
|
-
"type": {
|
|
6028
|
-
"type": "string",
|
|
6029
|
-
"description": "The type of asset to generate - set to `text-generator` for text generation.",
|
|
6030
|
-
"enum": [
|
|
6031
|
-
"text-generator"
|
|
6032
|
-
],
|
|
6033
|
-
"default": "text-generator"
|
|
6034
|
-
},
|
|
6035
|
-
"prompt": {
|
|
6036
|
-
"type": "string",
|
|
6037
|
-
"description": "The text prompt to generate text from.",
|
|
6038
|
-
"example": "Generate a short script for a 15 second video describing the benefits of the Shotstack API"
|
|
6039
|
-
},
|
|
6040
|
-
"model": {
|
|
6041
|
-
"type": "string",
|
|
6042
|
-
"description": "The model to use for generating the text. Select from the list of available models: <ul>\n <li>`gpt-3.5-turbo`</li>\n <li>`gpt-4`</li>\n</ul>",
|
|
6043
|
-
"enum": [
|
|
6044
|
-
"gpt-3.5-turbo",
|
|
6045
|
-
"gpt-4"
|
|
6046
|
-
],
|
|
6047
|
-
"example": "gpt-4"
|
|
6048
|
-
},
|
|
6049
|
-
"systemPrompt": {
|
|
6050
|
-
"type": "string",
|
|
6051
|
-
"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.",
|
|
6052
|
-
"example": "You are a professional script writer and film maker"
|
|
6053
|
-
}
|
|
6054
|
-
},
|
|
6055
|
-
"required": [
|
|
6056
|
-
"type",
|
|
6057
|
-
"prompt",
|
|
6058
|
-
"model"
|
|
6059
|
-
]
|
|
6060
|
-
},
|
|
6061
|
-
"StabilityAiGeneratedAsset": {
|
|
6062
|
-
"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.",
|
|
6063
|
-
"type": "object",
|
|
6064
|
-
"properties": {
|
|
6065
|
-
"provider": {
|
|
6066
|
-
"type": "string",
|
|
6067
|
-
"description": "The name of the provider - set to `stability-ai` for Stability AI.",
|
|
6068
|
-
"enum": [
|
|
6069
|
-
"stability-ai"
|
|
6070
|
-
],
|
|
6071
|
-
"default": "stability-ai"
|
|
6072
|
-
},
|
|
6073
|
-
"options": {
|
|
6074
|
-
"description": "Options and configuration for the Stability AI text-to-image service.",
|
|
6075
|
-
"$ref": "#/components/schemas/StabilityAiGeneratedAssetOptions"
|
|
6076
|
-
}
|
|
6077
|
-
},
|
|
6078
|
-
"required": [
|
|
6079
|
-
"provider",
|
|
6080
|
-
"options"
|
|
6081
|
-
]
|
|
6082
|
-
},
|
|
6083
|
-
"StabilityAiGeneratedAssetOptions": {
|
|
6084
|
-
"type": "object",
|
|
6085
|
-
"description": "Generate assets using Stability AI provider AI services.\n\nThe following AI generation services are available: <ul>\n <li><a href=\"#tocs_stabilityaitexttoimageoptions\">StabilityAiTextToImageOptions</a></li>\n</ul>",
|
|
6086
|
-
"oneOf": [
|
|
6087
|
-
{
|
|
6088
|
-
"$ref": "#/components/schemas/StabilityAiTextToImageOptions"
|
|
6089
|
-
}
|
|
6090
|
-
],
|
|
6091
|
-
"discriminator": {
|
|
6092
|
-
"propertyName": "type",
|
|
6093
|
-
"mapping": {
|
|
6094
|
-
"text-to-image": "#/components/schemas/StabilityAiTextToImageOptions"
|
|
6095
|
-
}
|
|
6096
|
-
},
|
|
6097
|
-
"additionalProperties": false
|
|
6098
|
-
},
|
|
6099
|
-
"StabilityAiTextToImageOptions": {
|
|
6100
|
-
"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.",
|
|
6101
|
-
"properties": {
|
|
6102
|
-
"type": {
|
|
6103
|
-
"type": "string",
|
|
6104
|
-
"description": "The type of asset to generate - set to `text-to-image` for text-to-image.",
|
|
6105
|
-
"enum": [
|
|
6106
|
-
"text-to-image"
|
|
6107
|
-
],
|
|
6108
|
-
"default": "text-to-image"
|
|
6109
|
-
},
|
|
6110
|
-
"prompt": {
|
|
6111
|
-
"type": "string",
|
|
6112
|
-
"description": "The text prompt to generate an image from.",
|
|
6113
|
-
"example": "A detailed photograph of Mars, showcasing its orange-red surface"
|
|
6114
|
-
},
|
|
6115
|
-
"engine": {
|
|
6116
|
-
"type": "string",
|
|
6117
|
-
"description": "The engine (model) to use for generating the image. Select from the list of available engines: <ul>\n <li>`stable-diffusion-xl-1024-v0-9`</li>\n <li>`stable-diffusion-xl-1024-v1-0`</li>\n <li>`stable-diffusion-v1-6`</li>\n <li>`stable-diffusion-512-v2-1`</li>\n <li>`stable-diffusion-xl-beta-v2-2-2`</li>\n</ul>",
|
|
6118
|
-
"enum": [
|
|
6119
|
-
"stable-diffusion-xl-1024-v0-9",
|
|
6120
|
-
"stable-diffusion-xl-1024-v1-0",
|
|
6121
|
-
"stable-diffusion-v1-6",
|
|
6122
|
-
"stable-diffusion-512-v2-1",
|
|
6123
|
-
"stable-diffusion-xl-beta-v2-2-2"
|
|
6124
|
-
],
|
|
6125
|
-
"default": "stable-diffusion-xl-1024-v1-0",
|
|
6126
|
-
"example": "stable-diffusion-xl-1024-v1-0"
|
|
6127
|
-
},
|
|
6128
|
-
"width": {
|
|
6129
|
-
"type": "integer",
|
|
6130
|
-
"description": "The width of the image in pixels. Must be divisible by 64.",
|
|
6131
|
-
"example": 512
|
|
6132
|
-
},
|
|
6133
|
-
"height": {
|
|
6134
|
-
"type": "integer",
|
|
6135
|
-
"description": "The height of the image in pixels. Must be divisible by 64.",
|
|
6136
|
-
"example": 512
|
|
6137
|
-
},
|
|
6138
|
-
"steps": {
|
|
6139
|
-
"type": "integer",
|
|
6140
|
-
"description": "The number of iterative diffusion steps to run. A number between 10 and 50.",
|
|
6141
|
-
"example": 30,
|
|
6142
|
-
"default": 30
|
|
6143
|
-
},
|
|
6144
|
-
"seed": {
|
|
6145
|
-
"type": "integer",
|
|
6146
|
-
"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.",
|
|
6147
|
-
"example": 0,
|
|
6148
|
-
"default": 0
|
|
6149
|
-
},
|
|
6150
|
-
"cfgScale": {
|
|
6151
|
-
"type": "number",
|
|
6152
|
-
"description": "Determines how closely the generated image will match the prompt. Lower numbers allow for more creative freedom. A number between 0 and 35.",
|
|
6153
|
-
"example": 7,
|
|
6154
|
-
"default": 7
|
|
6155
|
-
},
|
|
6156
|
-
"stylePreset": {
|
|
6157
|
-
"type": "string",
|
|
6158
|
-
"description": "Apply a preset to generate an image in a particular style. Select from the list of available presets: <ul>\n <li>`3d-model`</li>\n <li>`analog-film`</li>\n <li>`anime`</li>\n <li>`cinematic`</li>\n <li>`comic-book`</li>\n <li>`digital-art`</li>\n <li>`enhance`</li>\n <li>`fantasy-art`</li>\n <li>`isometric`</li>\n <li>`line-art`</li>\n <li>`low-poly`</li>\n <li>`modeling-compound`</li>\n <li>`neon-punk`</li>\n <li>`origami`</li>\n <li>`photographic`</li>\n <li>`pixel-art`</li>\n <li>`tile-texture`</li>\n</ul>",
|
|
6159
|
-
"enum": [
|
|
6160
|
-
"3d-model",
|
|
6161
|
-
"analog-film",
|
|
6162
|
-
"anime",
|
|
6163
|
-
"cinematic",
|
|
6164
|
-
"comic-book",
|
|
6165
|
-
"digital-art",
|
|
6166
|
-
"enhance",
|
|
6167
|
-
"fantasy-art",
|
|
6168
|
-
"isometric",
|
|
6169
|
-
"line-art",
|
|
6170
|
-
"low-poly",
|
|
6171
|
-
"modeling-compound",
|
|
6172
|
-
"neon-punk",
|
|
6173
|
-
"origami",
|
|
6174
|
-
"photographic",
|
|
6175
|
-
"pixel-art",
|
|
6176
|
-
"tile-texture"
|
|
6177
|
-
],
|
|
6178
|
-
"example": "photographic"
|
|
6179
|
-
}
|
|
6180
|
-
},
|
|
6181
|
-
"required": [
|
|
6182
|
-
"type",
|
|
6183
|
-
"prompt",
|
|
6184
|
-
"width",
|
|
6185
|
-
"height"
|
|
6186
|
-
]
|
|
6187
|
-
},
|
|
6188
|
-
"QueuedResponse": {
|
|
6189
|
-
"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.",
|
|
6190
|
-
"properties": {
|
|
6191
|
-
"success": {
|
|
6192
|
-
"description": "`true` if successfully queued, else `false`.",
|
|
6193
|
-
"type": "boolean",
|
|
6194
|
-
"example": true
|
|
6195
|
-
},
|
|
6196
|
-
"message": {
|
|
6197
|
-
"description": "`Created`, `Bad Request` or an error message.",
|
|
6198
|
-
"type": "string",
|
|
6199
|
-
"example": "Created"
|
|
6200
|
-
},
|
|
6201
|
-
"response": {
|
|
6202
|
-
"description": "`QueuedResponseData` or an error message.",
|
|
6203
|
-
"$ref": "#/components/schemas/QueuedResponseData"
|
|
6204
|
-
}
|
|
6205
|
-
},
|
|
6206
|
-
"required": [
|
|
6207
|
-
"success",
|
|
6208
|
-
"message",
|
|
6209
|
-
"response"
|
|
6210
|
-
],
|
|
6211
|
-
"type": "object"
|
|
6212
|
-
},
|
|
6213
|
-
"QueuedResponseData": {
|
|
6214
|
-
"description": "The response data returned with the [QueuedResponse](#tocs_queuedresponse).",
|
|
6215
|
-
"properties": {
|
|
6216
|
-
"message": {
|
|
6217
|
-
"description": "Success response message or error details.",
|
|
6218
|
-
"type": "string",
|
|
6219
|
-
"example": "Render Successfully Queued"
|
|
6220
|
-
},
|
|
6221
|
-
"id": {
|
|
6222
|
-
"description": "The id of the render task in UUID format.",
|
|
6223
|
-
"type": "string",
|
|
6224
|
-
"example": "2abd5c11-0f3d-4c6d-ba20-235fc9b8e8b7"
|
|
6225
|
-
}
|
|
6226
|
-
},
|
|
6227
|
-
"required": [
|
|
6228
|
-
"message",
|
|
6229
|
-
"id"
|
|
6230
|
-
],
|
|
6231
|
-
"type": "object"
|
|
6232
|
-
},
|
|
6233
|
-
"RenderResponse": {
|
|
6234
|
-
"description": "The response received after a [render status request](#get-render-status) is submitted. The response includes details about status of a render and the output URL.",
|
|
6235
|
-
"properties": {
|
|
6236
|
-
"success": {
|
|
6237
|
-
"description": "`true` if status available, else `false`.",
|
|
6238
|
-
"type": "boolean",
|
|
6239
|
-
"example": true
|
|
6240
|
-
},
|
|
6241
|
-
"message": {
|
|
6242
|
-
"description": "`OK` or an error message.",
|
|
6243
|
-
"type": "string",
|
|
6244
|
-
"example": "OK"
|
|
6245
|
-
},
|
|
6246
|
-
"response": {
|
|
6247
|
-
"description": "`RenderResponse` or an error message.",
|
|
6248
|
-
"$ref": "#/components/schemas/RenderResponseData"
|
|
6249
|
-
}
|
|
6250
|
-
},
|
|
6251
|
-
"required": [
|
|
6252
|
-
"success",
|
|
6253
|
-
"message",
|
|
6254
|
-
"response"
|
|
6255
|
-
],
|
|
6256
|
-
"type": "object"
|
|
6257
|
-
},
|
|
6258
|
-
"RenderResponseData": {
|
|
6259
|
-
"description": "The response data returned with the [RenderResponse](#tocs_renderresponse) including status and URL.",
|
|
6260
|
-
"properties": {
|
|
6261
|
-
"id": {
|
|
6262
|
-
"description": "The id of the render task in UUID format.",
|
|
6263
|
-
"type": "string",
|
|
6264
|
-
"example": "2abd5c11-0f3d-4c6d-ba20-235fc9b8e8b7"
|
|
6265
|
-
},
|
|
6266
|
-
"owner": {
|
|
6267
|
-
"description": "The owner id of the render task.",
|
|
6268
|
-
"type": "string",
|
|
6269
|
-
"example": "5ca6hu7s9k"
|
|
6270
|
-
},
|
|
6271
|
-
"plan": {
|
|
6272
|
-
"description": "The customer subscription plan.",
|
|
6273
|
-
"type": "string",
|
|
6274
|
-
"example": "basic"
|
|
6275
|
-
},
|
|
6276
|
-
"status": {
|
|
6277
|
-
"description": "The status of the render task. <ul>\n <li>`queued` - render is queued waiting to be rendered</li>\n <li>`fetching` - assets are being fetched</li>\n <li>`preprocessing` - video assets are being processed for compatibility</li>\n <li>`rendering` - the asset is being rendered</li>\n <li>`saving` - the final asset is being saved to storage</li>\n <li>`done` - the asset is ready to be downloaded</li>\n <li>`failed` - there was an error rendering the asset</li>\n</ul>",
|
|
6278
|
-
"enum": [
|
|
6279
|
-
"queued",
|
|
6280
|
-
"fetching",
|
|
6281
|
-
"preprocessing",
|
|
6282
|
-
"rendering",
|
|
6283
|
-
"saving",
|
|
6284
|
-
"done",
|
|
6285
|
-
"failed"
|
|
6286
|
-
],
|
|
6287
|
-
"type": "string",
|
|
6288
|
-
"example": "done"
|
|
5250
|
+
"type": "string",
|
|
5251
|
+
"example": "done"
|
|
6289
5252
|
},
|
|
6290
5253
|
"error": {
|
|
6291
5254
|
"description": "An error message, only displayed if an error occurred.",
|
|
@@ -7070,149 +6033,6 @@
|
|
|
7070
6033
|
"detail"
|
|
7071
6034
|
],
|
|
7072
6035
|
"type": "object"
|
|
7073
|
-
},
|
|
7074
|
-
"GeneratedAssetResponse": {
|
|
7075
|
-
"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.",
|
|
7076
|
-
"properties": {
|
|
7077
|
-
"data": {
|
|
7078
|
-
"description": "A generated asset resource.",
|
|
7079
|
-
"$ref": "#/components/schemas/GeneratedAssetResponseData"
|
|
7080
|
-
}
|
|
7081
|
-
},
|
|
7082
|
-
"required": [
|
|
7083
|
-
"data"
|
|
7084
|
-
],
|
|
7085
|
-
"type": "object"
|
|
7086
|
-
},
|
|
7087
|
-
"GeneratedAssetResponseData": {
|
|
7088
|
-
"description": "The type of resource (an asset), it's id and attributes of the generated file.",
|
|
7089
|
-
"properties": {
|
|
7090
|
-
"type": {
|
|
7091
|
-
"description": "The type of resource, in this case it is an asset.",
|
|
7092
|
-
"type": "string",
|
|
7093
|
-
"example": "asset"
|
|
7094
|
-
},
|
|
7095
|
-
"id": {
|
|
7096
|
-
"description": "The generated asset id.",
|
|
7097
|
-
"type": "string",
|
|
7098
|
-
"example": "01gz0-tj679-xj30t-hr8zk-3hasvk"
|
|
7099
|
-
},
|
|
7100
|
-
"attributes": {
|
|
7101
|
-
"description": "The generated asset attributes including its url, status, provider, type, etc...",
|
|
7102
|
-
"$ref": "#/components/schemas/GeneratedAssetResponseAttributes"
|
|
7103
|
-
}
|
|
7104
|
-
},
|
|
7105
|
-
"required": [
|
|
7106
|
-
"type",
|
|
7107
|
-
"id",
|
|
7108
|
-
"attributes"
|
|
7109
|
-
],
|
|
7110
|
-
"type": "object"
|
|
7111
|
-
},
|
|
7112
|
-
"GeneratedAssetResponseAttributes": {
|
|
7113
|
-
"description": "The id and attributes of the generated asset.",
|
|
7114
|
-
"properties": {
|
|
7115
|
-
"owner": {
|
|
7116
|
-
"description": "The owner id of the asset.",
|
|
7117
|
-
"type": "string",
|
|
7118
|
-
"example": "5ca6hu7s9k"
|
|
7119
|
-
},
|
|
7120
|
-
"provider": {
|
|
7121
|
-
"description": "The native or third party provider that generated the asset, `shotstack`, `elevenlabs`, `heygen` or `d-id`.",
|
|
7122
|
-
"type": "string",
|
|
7123
|
-
"enum": [
|
|
7124
|
-
"shotstack",
|
|
7125
|
-
"elevenlabs",
|
|
7126
|
-
"heygen",
|
|
7127
|
-
"d-id"
|
|
7128
|
-
]
|
|
7129
|
-
},
|
|
7130
|
-
"type": {
|
|
7131
|
-
"description": "The type of service used to generate the asset, `text-to-speech` or `text-to-avatar`.",
|
|
7132
|
-
"type": "string",
|
|
7133
|
-
"enum": [
|
|
7134
|
-
"text-to-speech",
|
|
7135
|
-
"text-to-avatar"
|
|
7136
|
-
]
|
|
7137
|
-
},
|
|
7138
|
-
"url": {
|
|
7139
|
-
"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.",
|
|
7140
|
-
"type": "string",
|
|
7141
|
-
"example": "https://shotstack-create-api-v1-assets.s3.amazonaws.com/5ca6hu7s9k/01gz0-tj679-xj30t-hr8zk-3hasvk.mp3"
|
|
7142
|
-
},
|
|
7143
|
-
"status": {
|
|
7144
|
-
"description": "The status of the asset file generation task. <ul>\n <li>`queued` - generation task is queued waiting to be processed</li>\n <li>`processing` - the asset is being generated by the provider</li>\n <li>`saving` - the asset is being saved to Shotstack</li>\n <li>`done` - the asset has been generated and stored</li>\n <li>`failed` - there was an error generating the asset</li>\n</ul>",
|
|
7145
|
-
"type": "string",
|
|
7146
|
-
"enum": [
|
|
7147
|
-
"queued",
|
|
7148
|
-
"processing",
|
|
7149
|
-
"saving",
|
|
7150
|
-
"done",
|
|
7151
|
-
"failed"
|
|
7152
|
-
],
|
|
7153
|
-
"example": "done"
|
|
7154
|
-
},
|
|
7155
|
-
"created": {
|
|
7156
|
-
"description": "The time the generate asset task was initially queued.",
|
|
7157
|
-
"type": "string",
|
|
7158
|
-
"example": "2023-01-02T01:47:18.973Z"
|
|
7159
|
-
},
|
|
7160
|
-
"updated": {
|
|
7161
|
-
"description": "The time the asset status was last updated.",
|
|
7162
|
-
"type": "string",
|
|
7163
|
-
"example": "2023-01-02T01:47:37.260Z"
|
|
7164
|
-
}
|
|
7165
|
-
},
|
|
7166
|
-
"required": [
|
|
7167
|
-
"owner",
|
|
7168
|
-
"provider",
|
|
7169
|
-
"type",
|
|
7170
|
-
"status",
|
|
7171
|
-
"created",
|
|
7172
|
-
"updated"
|
|
7173
|
-
]
|
|
7174
|
-
},
|
|
7175
|
-
"GeneratedAssetErrorResponse": {
|
|
7176
|
-
"type": "object",
|
|
7177
|
-
"description": "Error response data for validation and other errors returned by the Create API.",
|
|
7178
|
-
"properties": {
|
|
7179
|
-
"errors": {
|
|
7180
|
-
"description": "An array of errors.",
|
|
7181
|
-
"type": "array",
|
|
7182
|
-
"items": {
|
|
7183
|
-
"$ref": "#/components/schemas/GeneratedAssetErrorResponseData"
|
|
7184
|
-
}
|
|
7185
|
-
}
|
|
7186
|
-
},
|
|
7187
|
-
"required": [
|
|
7188
|
-
"errors"
|
|
7189
|
-
]
|
|
7190
|
-
},
|
|
7191
|
-
"GeneratedAssetErrorResponseData": {
|
|
7192
|
-
"type": "object",
|
|
7193
|
-
"description": "Individual errors returned by the Create API.",
|
|
7194
|
-
"properties": {
|
|
7195
|
-
"status": {
|
|
7196
|
-
"description": "The http status code.",
|
|
7197
|
-
"type": "string",
|
|
7198
|
-
"example": 400
|
|
7199
|
-
},
|
|
7200
|
-
"title": {
|
|
7201
|
-
"description": "A short summary of the error.",
|
|
7202
|
-
"type": "string",
|
|
7203
|
-
"example": "Bad Request"
|
|
7204
|
-
},
|
|
7205
|
-
"detail": {
|
|
7206
|
-
"description": "A detailed description of the error.",
|
|
7207
|
-
"type": "string",
|
|
7208
|
-
"example": "\"body/options/text\" is required."
|
|
7209
|
-
}
|
|
7210
|
-
},
|
|
7211
|
-
"required": [
|
|
7212
|
-
"status",
|
|
7213
|
-
"title",
|
|
7214
|
-
"detail"
|
|
7215
|
-
]
|
|
7216
6036
|
}
|
|
7217
6037
|
},
|
|
7218
6038
|
"responses": {},
|