@shotstack/schemas 1.18.4 → 1.20.0

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.
@@ -641,7 +641,7 @@
641
641
  },
642
642
  "/models": {
643
643
  "get": {
644
- "description": "List the generation models available for `prompt`-bearing image, video and audio\nassets, with the options each accepts and what it costs in credits.\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\n**Base URL:** <a href=\"#\">https://api.shotstack.io/edit/{version}</a>\n",
644
+ "description": "List the generation models available for `prompt`-bearing image, video and audio\nassets, with the options each accepts and what it costs in credits.\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",
645
645
  "summary": "List Generation Models",
646
646
  "operationId": "getModels",
647
647
  "responses": {
@@ -833,6 +833,21 @@
833
833
  "description": "JSON Schema for the model's `options` object. Only returned for a single model, or for a list requested with `expand=options`. Values outside this schema are rejected.",
834
834
  "type": "object",
835
835
  "additionalProperties": true
836
+ },
837
+ "available": {
838
+ "description": "Whether the account behind the calling API key can generate with this model. Omitted when that cannot be determined; treat a missing value as unknown, not as available. Generation requests are checked either way.",
839
+ "type": "boolean",
840
+ "example": false
841
+ },
842
+ "unavailableReason": {
843
+ "description": "Why `available` is false. `AiCapabilityNotIncluded`: the account's plan does not include this kind of generation. `AiDisabled`: AI generation is turned off for the account. `AiAccessUnavailable`: access could not be confirmed; try again later.",
844
+ "type": "string",
845
+ "enum": [
846
+ "AiCapabilityNotIncluded",
847
+ "AiDisabled",
848
+ "AiAccessUnavailable"
849
+ ],
850
+ "example": "AiCapabilityNotIncluded"
836
851
  }
837
852
  },
838
853
  "required": [
@@ -1661,12 +1676,24 @@
1661
1676
  "type": "string"
1662
1677
  },
1663
1678
  "speed": {
1664
- "description": "Adjust the playback speed of the video clip between 0 (paused) and 10 (10x normal speed) where 1 is normal speed (defaults to 1). Adjusting the speed will also adjust the duration of the clip and may require you to adjust the Clip length. For example, if you set speed to 0.5, the clip will need to be 2x as long to play the entire video (i.e. original length / 0.5). If you set speed to 2, the clip will need to be half as long to play the entire video (i.e. original length / 2).",
1665
- "type": "number",
1666
- "format": "float",
1667
- "minimum": 0,
1668
- "maximum": 10,
1669
- "example": 1
1679
+ "description": "Adjust the playback speed of the video clip. Use a number for a constant speed or an array of [Tween](./#tocs_tween) objects to change speed over time, for example easing from normal speed up to 3x.",
1680
+ "oneOf": [
1681
+ {
1682
+ "type": "number",
1683
+ "description": "The playback speed between 0 (paused) and 10 (10x normal speed) where 1 is normal speed (defaults to 1). Adjusting the speed will also adjust the duration of the clip and may require you to adjust the Clip length. For example, if you set speed to 0.5, the clip will need to be 2x as long to play the entire video (i.e. original length / 0.5). If you set speed to 2, the clip will need to be half as long to play the entire video (i.e. original length / 2).",
1684
+ "format": "float",
1685
+ "minimum": 0,
1686
+ "maximum": 10,
1687
+ "example": 1
1688
+ },
1689
+ {
1690
+ "type": "array",
1691
+ "description": "An array of [Tween](./#tocs_tween) objects that change the playback speed over time. A speed of 0 holds the current frame. The clip length is not adjusted, so set it to cover the footage you want to play.",
1692
+ "items": {
1693
+ "$ref": "#/components/schemas/Tween"
1694
+ }
1695
+ }
1696
+ ]
1670
1697
  },
1671
1698
  "crop": {
1672
1699
  "$ref": "#/components/schemas/Crop"
@@ -3769,12 +3769,24 @@
3769
3769
  "type": "string"
3770
3770
  },
3771
3771
  "speed": {
3772
- "description": "Adjust the playback speed of the video clip between 0 (paused) and 10 (10x normal speed) where 1 is normal speed (defaults to 1). Adjusting the speed will also adjust the duration of the clip and may require you to adjust the Clip length. For example, if you set speed to 0.5, the clip will need to be 2x as long to play the entire video (i.e. original length / 0.5). If you set speed to 2, the clip will need to be half as long to play the entire video (i.e. original length / 2).",
3773
- "type": "number",
3774
- "minimum": 0,
3775
- "maximum": 10,
3776
- "examples": [
3777
- 1
3772
+ "description": "Adjust the playback speed of the video clip. Use a number for a constant speed or an array of [Tween](./#tocs_tween) objects to change speed over time, for example easing from normal speed up to 3x.",
3773
+ "oneOf": [
3774
+ {
3775
+ "type": "number",
3776
+ "description": "The playback speed between 0 (paused) and 10 (10x normal speed) where 1 is normal speed (defaults to 1). Adjusting the speed will also adjust the duration of the clip and may require you to adjust the Clip length. For example, if you set speed to 0.5, the clip will need to be 2x as long to play the entire video (i.e. original length / 0.5). If you set speed to 2, the clip will need to be half as long to play the entire video (i.e. original length / 2).",
3777
+ "minimum": 0,
3778
+ "maximum": 10,
3779
+ "examples": [
3780
+ 1
3781
+ ]
3782
+ },
3783
+ {
3784
+ "type": "array",
3785
+ "description": "An array of [Tween](./#tocs_tween) objects that change the playback speed over time. A speed of 0 holds the current frame. The clip length is not adjusted, so set it to cover the footage you want to play.",
3786
+ "items": {
3787
+ "$ref": "#/$defs/Tween"
3788
+ }
3789
+ }
3778
3790
  ]
3779
3791
  },
3780
3792
  "crop": {