@shotstack/schemas 1.22.0 → 1.23.1

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.
@@ -801,7 +801,7 @@
801
801
  }
802
802
  }
803
803
  },
804
- "description": "Generate a single image, video or audio asset from a text prompt without\nrendering a full edit. Submit a prompt-bearing asset; the response is\nimmediate when an identical asset has been generated before (results are\ncached by prompt, model and options), otherwise the job is queued and can\nbe polled via the status endpoint.\n\nGeneration is billed in credits per asset. Identical repeat requests\nresolve from the cache at no charge.\n\n**Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>\n",
804
+ "description": "Generate a single image, video or audio asset from a prompt or, for some models, a source file, without\nrendering a full edit. Submit an asset with a prompt or source file; the response is\nimmediate when an identical asset has been generated before (results are\ncached by prompt, model and options), otherwise the job is queued and can\nbe polled via the status endpoint.\n\nGeneration is billed in credits per asset. Identical repeat requests\nresolve from the cache at no charge.\n\n**Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>\n",
805
805
  "summary": "Generate Asset",
806
806
  "operationId": "postGenerate",
807
807
  "parameters": [
@@ -967,7 +967,7 @@
967
967
  },
968
968
  "/models": {
969
969
  "get": {
970
- "description": "List the generation models available for `prompt`-bearing image, video and audio\nassets, with the options each accepts. Use `POST /generate/quote` for a credit estimate.\n\nUse this to populate a model picker and render its option fields, rather than\nhard coding a model list. A newly launched model appears here without any change\non your side. Each entry carries the asset type it generates, so filter the list\nclient side when a picker only needs one kind.\n\nOption schemas are omitted by default. Request them with `expand=options`.\n\nEach model's `available` reflects the plan of the account behind the calling API\nkey, so offer only the models it marks available.\n\n**Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>\n",
970
+ "description": "List the generation models available for `prompt`-bearing image, video and audio\nassets generated from a prompt or, for some models, a source file, with the options each accepts. Use `POST /generate/quote` for a credit estimate.\n\nUse this to populate a model picker and render its option fields, rather than\nhard coding a model list. A newly launched model appears here without any change\non your side. Each entry carries the asset type it generates, so filter the list\nclient side when a picker only needs one kind.\n\nOption schemas are omitted by default. Request them with `expand=options`.\n\nEach model's `available` reflects the plan of the account behind the calling API\nkey, so offer only the models it marks available.\n\n**Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>\n",
971
971
  "summary": "List Generation Models",
972
972
  "operationId": "getModels",
973
973
  "responses": {
@@ -4180,7 +4180,7 @@
4180
4180
  ]
4181
4181
  },
4182
4182
  "Output": {
4183
- "description": "The output format, render range and type of media to generate. For all formats except `mp3`, either `resolution` or `size` (with both `width` and `height`) must be specified.",
4183
+ "description": "The output format, render range and type of media to generate. For all formats except `mp3`, either `resolution` or `size` (with both `width` and `height`) must be specified. A custom `size` can be up to 3840px on each side, or 1920px for `gif`. Video can be up to 3840 × 2160 pixels (8,294,400) in any shape, for example 2160 × 3840 for vertical 4K; larger sizes are rejected. Video above 1920 × 1080 pixels, including the `4k` resolution, needs a plan that includes 4K.",
4184
4184
  "properties": {
4185
4185
  "format": {
4186
4186
  "description": "The output format and type of media file to generate. <ul>\n <li>`mp4` - mp4 video file</li>\n <li>`gif` - animated gif</li>\n <li>`jpg` - jpg image file</li>\n <li>`png` - png image file</li>\n <li>`bmp` - bmp image file</li>\n <li>`mp3` - mp3 audio file (audio only)</li>\n</ul>",
@@ -4304,14 +4304,14 @@
4304
4304
  "description": "Set a custom size for a video or image in pixels. When using a custom size omit the `resolution` and `aspectRatio`. Custom sizes must be divisible by 2 based on the encoder specifications.",
4305
4305
  "properties": {
4306
4306
  "width": {
4307
- "description": "Set a custom width for the video or image file in pixels. Value must be divisible by 2. Maximum video width is 1920px, maximum image width is 4096px.",
4307
+ "description": "Set a custom width for the video or image file in pixels. Value must be divisible by 2.",
4308
4308
  "type": "integer",
4309
4309
  "minimum": 1,
4310
4310
  "maximum": 4096,
4311
4311
  "example": 1200
4312
4312
  },
4313
4313
  "height": {
4314
- "description": "Set a custom height for the video or image file in pixels. Value must be divisible by 2. Maximum video height is 1920px, maximum image height is 4096px.",
4314
+ "description": "Set a custom height for the video or image file in pixels. Value must be divisible by 2.",
4315
4315
  "type": "integer",
4316
4316
  "minimum": 1,
4317
4317
  "maximum": 4096,
@@ -5144,7 +5144,7 @@
5144
5144
  "type": "object"
5145
5145
  },
5146
5146
  "GenerationAsset": {
5147
- "description": "An image, video or audio asset to generate from a text prompt.",
5147
+ "description": "An asset to generate, from a text `prompt` or, for models that take one, a source `src`.",
5148
5148
  "type": "object",
5149
5149
  "properties": {
5150
5150
  "type": {
@@ -5165,6 +5165,11 @@
5165
5165
  "pattern": "\\S",
5166
5166
  "example": "A lighthouse on a rocky coast at sunset, cinematic lighting"
5167
5167
  },
5168
+ "src": {
5169
+ "description": "The source file for models that take one instead of a prompt, such as `shotstack-music-analysis`. A public HTTPS URL.",
5170
+ "type": "string",
5171
+ "format": "uri"
5172
+ },
5168
5173
  "model": {
5169
5174
  "description": "The generation model. Defaults to `nano-banana-2` for images, `seedance-2.0-text-to-video` for video and `elevenlabs-multilingual-v2` for audio. `GET /models` lists the models for each type.",
5170
5175
  "type": "string",
@@ -5181,12 +5186,11 @@
5181
5186
  },
5182
5187
  "additionalProperties": false,
5183
5188
  "required": [
5184
- "type",
5185
- "prompt"
5189
+ "type"
5186
5190
  ]
5187
5191
  },
5188
5192
  "GenerationModel": {
5189
- "description": "A generation model available to `prompt`-bearing image, video and audio assets, with the options it accepts. Use `POST /generate/quote` for a credit estimate. Render a model picker and its option fields from this rather than hard coding a model list, so a newly launched model is available without a client release.",
5193
+ "description": "A generation model available to image, video and audio assets generated from a prompt or, for some models, a source file, with the options it accepts. Use `POST /generate/quote` for a credit estimate. Render a model picker and its option fields from this rather than hard coding a model list, so a newly launched model is available without a client release.",
5190
5194
  "properties": {
5191
5195
  "model": {
5192
5196
  "description": "The identifier to set as the asset `model`. Carries no provider name, so routing can change without a public rename.",
@@ -1367,7 +1367,7 @@
1367
1367
  "type": "object"
1368
1368
  },
1369
1369
  "Output": {
1370
- "description": "The output format, render range and type of media to generate. For all formats except `mp3`, either `resolution` or `size` (with both `width` and `height`) must be specified.",
1370
+ "description": "The output format, render range and type of media to generate. For all formats except `mp3`, either `resolution` or `size` (with both `width` and `height`) must be specified. A custom `size` can be up to 3840px on each side, or 1920px for `gif`. Video can be up to 3840 × 2160 pixels (8,294,400) in any shape, for example 2160 × 3840 for vertical 4K; larger sizes are rejected. Video above 1920 × 1080 pixels, including the `4k` resolution, needs a plan that includes 4K.",
1371
1371
  "properties": {
1372
1372
  "format": {
1373
1373
  "description": "The output format and type of media file to generate.\n\n- `mp4` - mp4 video file\n\n- `gif` - animated gif\n\n- `jpg` - jpg image file\n\n- `png` - png image file\n\n- `bmp` - bmp image file\n\n- `mp3` - mp3 audio file (audio only)",
@@ -2763,7 +2763,7 @@
2763
2763
  "description": "Set a custom size for a video or image in pixels. When using a custom size omit the `resolution` and `aspectRatio`. Custom sizes must be divisible by 2 based on the encoder specifications.",
2764
2764
  "properties": {
2765
2765
  "width": {
2766
- "description": "Set a custom width for the video or image file in pixels. Value must be divisible by 2. Maximum video width is 1920px, maximum image width is 4096px.",
2766
+ "description": "Set a custom width for the video or image file in pixels. Value must be divisible by 2.",
2767
2767
  "type": "integer",
2768
2768
  "minimum": 1,
2769
2769
  "maximum": 4096,
@@ -2772,7 +2772,7 @@
2772
2772
  ]
2773
2773
  },
2774
2774
  "height": {
2775
- "description": "Set a custom height for the video or image file in pixels. Value must be divisible by 2. Maximum video height is 1920px, maximum image height is 4096px.",
2775
+ "description": "Set a custom height for the video or image file in pixels. Value must be divisible by 2.",
2776
2776
  "type": "integer",
2777
2777
  "minimum": 1,
2778
2778
  "maximum": 4096,