@shotstack/schemas 1.19.0 → 1.20.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.
@@ -484,43 +484,11 @@
484
484
  "post": {
485
485
  "responses": {
486
486
  "200": {
487
- "description": "The generated asset was already cached and is immediately available.",
487
+ "description": "The asset was generated before: `done` with its URL, or `failed` with the error that ended it.",
488
488
  "content": {
489
489
  "application/json": {
490
490
  "schema": {
491
- "description": "The status of an on-demand asset generation job. Completed jobs include the public URL of the generated asset.",
492
- "type": "object",
493
- "properties": {
494
- "id": {
495
- "description": "The generation job id. Deterministic for a given owner and asset payload (or idempotency key), so identical requests return the same job and cached result.",
496
- "type": "string",
497
- "example": "8a1f2c3d-4e5b-5a6c-9d7e-1f2a3b4c5d6e"
498
- },
499
- "status": {
500
- "description": "The status of the generation job.",
501
- "type": "string",
502
- "enum": [
503
- "queued",
504
- "processing",
505
- "done",
506
- "failed"
507
- ],
508
- "example": "done"
509
- },
510
- "url": {
511
- "description": "The public URL of the generated asset. Present only when `status` is `done`.",
512
- "type": "string",
513
- "example": "https://shotstack-api-v1-output.s3-ap-southeast-2.amazonaws.com/owner/8a1f2c3d.png"
514
- },
515
- "error": {
516
- "description": "A human readable error message. Present only when `status` is `failed`.",
517
- "type": "string"
518
- }
519
- },
520
- "required": [
521
- "id",
522
- "status"
523
- ]
491
+ "$ref": "#/components/schemas/GenerationResponse"
524
492
  }
525
493
  }
526
494
  }
@@ -544,7 +512,75 @@
544
512
  "content": {
545
513
  "application/json": {
546
514
  "schema": {
547
- "$ref": "#/paths/~1generate/post/responses/200/content/application~1json/schema"
515
+ "$ref": "#/components/schemas/GenerationResponse"
516
+ }
517
+ }
518
+ }
519
+ },
520
+ "400": {
521
+ "description": "The request is invalid, for example a missing asset or prompt, a disallowed URL or a `length` that is not positive.",
522
+ "content": {
523
+ "application/json": {
524
+ "schema": {
525
+ "$ref": "#/components/schemas/GenerationErrorResponse"
526
+ }
527
+ }
528
+ }
529
+ },
530
+ "402": {
531
+ "description": "The account has too few credits for this generation. `available` holds how many it has.",
532
+ "content": {
533
+ "application/json": {
534
+ "schema": {
535
+ "$ref": "#/components/schemas/GenerationErrorResponse"
536
+ }
537
+ }
538
+ }
539
+ },
540
+ "403": {
541
+ "description": "The account cannot use this generation. `code` says why.",
542
+ "content": {
543
+ "application/json": {
544
+ "schema": {
545
+ "$ref": "#/components/schemas/GenerationErrorResponse"
546
+ }
547
+ }
548
+ }
549
+ },
550
+ "409": {
551
+ "description": "The `Idempotency-Key` was already used for a different asset.",
552
+ "content": {
553
+ "application/json": {
554
+ "schema": {
555
+ "$ref": "#/components/schemas/GenerationErrorResponse"
556
+ }
557
+ }
558
+ }
559
+ },
560
+ "429": {
561
+ "description": "The account has reached its generation quota.",
562
+ "content": {
563
+ "application/json": {
564
+ "schema": {
565
+ "$ref": "#/components/schemas/GenerationErrorResponse"
566
+ }
567
+ }
568
+ }
569
+ },
570
+ "503": {
571
+ "description": "A service the request depends on is temporarily unavailable. `code` is `AiAccessUnavailable` when access to AI generation could not be confirmed.",
572
+ "headers": {
573
+ "Retry-After": {
574
+ "description": "Suggested seconds to wait before retrying.",
575
+ "schema": {
576
+ "type": "integer"
577
+ }
578
+ }
579
+ },
580
+ "content": {
581
+ "application/json": {
582
+ "schema": {
583
+ "$ref": "#/components/schemas/GenerationErrorResponse"
548
584
  }
549
585
  }
550
586
  }
@@ -553,6 +589,17 @@
553
589
  "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",
554
590
  "summary": "Generate Asset",
555
591
  "operationId": "postGenerate",
592
+ "parameters": [
593
+ {
594
+ "in": "header",
595
+ "name": "Idempotency-Key",
596
+ "required": false,
597
+ "description": "A key that makes this request its own generation. Retrying with the same key returns the job it first created instead of generating and billing again, and a new key generates afresh even when the asset matches an earlier one. Without a key, identical assets share one cached result. For 24 hours a key reused for a different asset is rejected; after that it returns its first result.",
598
+ "schema": {
599
+ "type": "string"
600
+ }
601
+ }
602
+ ],
556
603
  "requestBody": {
557
604
  "description": "A prompt-bearing image, video or audio asset to generate.",
558
605
  "content": {
@@ -572,6 +619,13 @@
572
619
  "$ref": "#/components/schemas/AudioAsset"
573
620
  }
574
621
  ]
622
+ },
623
+ "length": {
624
+ "description": "The length, in seconds, of the clip the asset fills. A model that generates to a duration takes it from this value in place of its own duration option. Other models ignore it.",
625
+ "type": "number",
626
+ "minimum": 0,
627
+ "exclusiveMinimum": true,
628
+ "example": 5
575
629
  }
576
630
  },
577
631
  "required": [
@@ -599,17 +653,35 @@
599
653
  "content": {
600
654
  "application/json": {
601
655
  "schema": {
602
- "$ref": "#/paths/~1generate/post/responses/200/content/application~1json/schema"
656
+ "$ref": "#/components/schemas/GenerationResponse"
603
657
  }
604
658
  }
605
659
  }
606
660
  },
607
661
  "202": {
608
662
  "description": "The generation job is still processing.",
663
+ "headers": {
664
+ "Retry-After": {
665
+ "description": "Suggested seconds to wait before polling again.",
666
+ "schema": {
667
+ "type": "integer"
668
+ }
669
+ }
670
+ },
609
671
  "content": {
610
672
  "application/json": {
611
673
  "schema": {
612
- "$ref": "#/paths/~1generate/post/responses/200/content/application~1json/schema"
674
+ "$ref": "#/components/schemas/GenerationResponse"
675
+ }
676
+ }
677
+ }
678
+ },
679
+ "404": {
680
+ "description": "No generation job with this id exists for the calling account.",
681
+ "content": {
682
+ "application/json": {
683
+ "schema": {
684
+ "$ref": "#/components/schemas/GenerationErrorResponse"
613
685
  }
614
686
  }
615
687
  }
@@ -650,20 +722,7 @@
650
722
  "content": {
651
723
  "application/json": {
652
724
  "schema": {
653
- "description": "The generation models available to this account.",
654
- "properties": {
655
- "models": {
656
- "description": "The available models.",
657
- "type": "array",
658
- "items": {
659
- "$ref": "#/paths/~1models~1%7Bid%7D/get/responses/200/content/application~1json/schema"
660
- }
661
- }
662
- },
663
- "required": [
664
- "models"
665
- ],
666
- "type": "object"
725
+ "$ref": "#/components/schemas/GenerationModelListResponse"
667
726
  }
668
727
  }
669
728
  }
@@ -705,162 +764,20 @@
705
764
  "content": {
706
765
  "application/json": {
707
766
  "schema": {
708
- "description": "A generation model available to `prompt`-bearing image, video and audio assets, with the options it accepts and what it costs. 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.",
709
- "properties": {
710
- "model": {
711
- "description": "The identifier to set as the asset `model`. Carries no provider name, so routing can change without a public rename.",
712
- "type": "string",
713
- "example": "seedance-2.0-text-to-video"
714
- },
715
- "type": {
716
- "description": "The asset type this model generates.",
717
- "type": "string",
718
- "enum": [
719
- "image",
720
- "video",
721
- "audio"
722
- ],
723
- "example": "video"
724
- },
725
- "name": {
726
- "description": "The model's display name, for a model picker.",
727
- "type": "string",
728
- "example": "Seedance 2.0 · Text to video"
729
- },
730
- "description": {
731
- "description": "What the model is suited to, in a sentence or two.",
732
- "type": "string",
733
- "example": "Generate cinematic video with realistic motion, prompt-directed camera movement and optional synchronised audio."
734
- },
735
- "pricing": {
736
- "description": "What one generation with this model costs.",
737
- "properties": {
738
- "credits": {
739
- "description": "Credits per unit. A number when the rate is flat, or an object keyed by the values of the option named in `tieredBy`.",
740
- "oneOf": [
741
- {
742
- "type": "number"
743
- },
744
- {
745
- "type": "object",
746
- "additionalProperties": true
747
- }
748
- ],
749
- "example": {
750
- "480p": 0.9375,
751
- "720p": 1.8962,
752
- "1080p": 4.2625
753
- }
754
- },
755
- "tieredBy": {
756
- "description": "The option whose value selects the rate, and the value assumed when the option is absent. Present only when `credits` is keyed.",
757
- "type": "object",
758
- "properties": {
759
- "option": {
760
- "type": "string",
761
- "example": "resolution"
762
- },
763
- "default": {
764
- "type": "string",
765
- "example": "720p"
766
- }
767
- },
768
- "required": [
769
- "option",
770
- "default"
771
- ]
772
- },
773
- "quantity": {
774
- "description": "How many units a generation consumes. Take the value `measure` names, or `default` when the request carries none, hold it within `min` and `max`, divide by `per`, and round up when `round` is `up`. Absent when one generation is one unit.",
775
- "type": "object",
776
- "properties": {
777
- "measure": {
778
- "description": "What the count is taken from, and the scale it is measured in.",
779
- "type": "string",
780
- "enum": [
781
- "clipSeconds",
782
- "promptCharacters"
783
- ],
784
- "example": "clipSeconds"
785
- },
786
- "per": {
787
- "description": "How many of `measure` make one billable unit.",
788
- "type": "number",
789
- "example": 60
790
- },
791
- "min": {
792
- "description": "Fewest accepted. A smaller request is charged at this.",
793
- "type": "number",
794
- "example": 3
795
- },
796
- "max": {
797
- "description": "Most accepted. A larger request is charged at this.",
798
- "type": "number",
799
- "example": 600
800
- },
801
- "default": {
802
- "description": "Assumed when the request carries no value.",
803
- "type": "number",
804
- "example": 30
805
- },
806
- "round": {
807
- "description": "Present when a partial unit is charged as a whole one. A 61 second track on a per-minute rate is charged as two minutes.",
808
- "type": "string",
809
- "enum": [
810
- "up"
811
- ],
812
- "example": "up"
813
- }
814
- },
815
- "required": [
816
- "measure",
817
- "per"
818
- ]
819
- },
820
- "effectiveFrom": {
821
- "description": "The date this rate took effect, or `legacy` for a rate that predates dated pricing.",
822
- "type": "string",
823
- "example": "2026-08-13"
824
- }
825
- },
826
- "required": [
827
- "credits",
828
- "effectiveFrom"
829
- ],
830
- "type": "object"
831
- },
832
- "options": {
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
- "type": "object",
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"
851
- }
852
- },
853
- "required": [
854
- "model",
855
- "type"
856
- ],
857
- "type": "object"
767
+ "$ref": "#/components/schemas/GenerationModel"
858
768
  }
859
769
  }
860
770
  }
861
771
  },
862
772
  "404": {
863
- "description": "No model exists with that identifier."
773
+ "description": "No listed model has that identifier. `error.name` tells an unknown model from one that has been withdrawn.",
774
+ "content": {
775
+ "application/json": {
776
+ "schema": {
777
+ "$ref": "#/components/schemas/GenerationModelErrorResponse"
778
+ }
779
+ }
780
+ }
864
781
  }
865
782
  },
866
783
  "security": [
@@ -1676,12 +1593,24 @@
1676
1593
  "type": "string"
1677
1594
  },
1678
1595
  "speed": {
1679
- "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).",
1680
- "type": "number",
1681
- "format": "float",
1682
- "minimum": 0,
1683
- "maximum": 10,
1684
- "example": 1
1596
+ "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.",
1597
+ "oneOf": [
1598
+ {
1599
+ "type": "number",
1600
+ "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).",
1601
+ "format": "float",
1602
+ "minimum": 0,
1603
+ "maximum": 10,
1604
+ "example": 1
1605
+ },
1606
+ {
1607
+ "type": "array",
1608
+ "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.",
1609
+ "items": {
1610
+ "$ref": "#/components/schemas/Tween"
1611
+ }
1612
+ }
1613
+ ]
1685
1614
  },
1686
1615
  "crop": {
1687
1616
  "$ref": "#/components/schemas/Crop"
@@ -4940,6 +4869,271 @@
4940
4869
  ],
4941
4870
  "type": "object"
4942
4871
  },
4872
+ "GenerationModel": {
4873
+ "description": "A generation model available to `prompt`-bearing image, video and audio assets, with the options it accepts and what it costs. 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.",
4874
+ "properties": {
4875
+ "model": {
4876
+ "description": "The identifier to set as the asset `model`. Carries no provider name, so routing can change without a public rename.",
4877
+ "type": "string",
4878
+ "example": "seedance-2.0-text-to-video"
4879
+ },
4880
+ "type": {
4881
+ "description": "The asset type this model generates.",
4882
+ "type": "string",
4883
+ "enum": [
4884
+ "image",
4885
+ "video",
4886
+ "audio"
4887
+ ],
4888
+ "example": "video"
4889
+ },
4890
+ "name": {
4891
+ "description": "The model's display name, for a model picker.",
4892
+ "type": "string",
4893
+ "example": "Seedance 2.0 · Text to video"
4894
+ },
4895
+ "description": {
4896
+ "description": "What the model is suited to, in a sentence or two.",
4897
+ "type": "string",
4898
+ "example": "Generate cinematic video with realistic motion, prompt-directed camera movement and optional synchronised audio."
4899
+ },
4900
+ "pricing": {
4901
+ "description": "What one generation with this model costs.",
4902
+ "$ref": "#/components/schemas/GenerationModelPricing"
4903
+ },
4904
+ "options": {
4905
+ "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.",
4906
+ "type": "object",
4907
+ "additionalProperties": true
4908
+ },
4909
+ "available": {
4910
+ "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.",
4911
+ "type": "boolean",
4912
+ "example": false
4913
+ },
4914
+ "unavailableReason": {
4915
+ "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.",
4916
+ "type": "string",
4917
+ "enum": [
4918
+ "AiCapabilityNotIncluded",
4919
+ "AiDisabled",
4920
+ "AiAccessUnavailable"
4921
+ ],
4922
+ "example": "AiCapabilityNotIncluded"
4923
+ }
4924
+ },
4925
+ "required": [
4926
+ "model",
4927
+ "type"
4928
+ ],
4929
+ "type": "object"
4930
+ },
4931
+ "GenerationModelPricing": {
4932
+ "description": "What one generation costs, in credits: the rate multiplied by the units consumed. `quantity` says how to count the units, and is absent when one generation is one unit. Where a model charges differently per option value, `credits` is an object keyed by that value and `tieredBy` names the option that selects it.",
4933
+ "properties": {
4934
+ "credits": {
4935
+ "description": "Credits per unit. A number when the rate is flat, or an object keyed by the values of the option named in `tieredBy`.",
4936
+ "oneOf": [
4937
+ {
4938
+ "type": "number"
4939
+ },
4940
+ {
4941
+ "type": "object",
4942
+ "additionalProperties": {
4943
+ "type": "number"
4944
+ }
4945
+ }
4946
+ ],
4947
+ "example": {
4948
+ "480p": 0.9375,
4949
+ "720p": 1.8962,
4950
+ "1080p": 4.2625
4951
+ }
4952
+ },
4953
+ "tieredBy": {
4954
+ "description": "The option whose value selects the rate, and the value assumed when the option is absent. Present only when `credits` is keyed.",
4955
+ "type": "object",
4956
+ "properties": {
4957
+ "option": {
4958
+ "type": "string",
4959
+ "example": "resolution"
4960
+ },
4961
+ "default": {
4962
+ "type": "string",
4963
+ "example": "720p"
4964
+ }
4965
+ },
4966
+ "required": [
4967
+ "option",
4968
+ "default"
4969
+ ]
4970
+ },
4971
+ "quantity": {
4972
+ "description": "How many units a generation consumes. Take the value `measure` names, or `default` when the request carries none, hold it within `min` and `max`, divide by `per`, and round up when `round` is `up`. Absent when one generation is one unit.",
4973
+ "type": "object",
4974
+ "properties": {
4975
+ "measure": {
4976
+ "description": "What the count is taken from, and the scale it is measured in.",
4977
+ "type": "string",
4978
+ "enum": [
4979
+ "clipSeconds",
4980
+ "promptCharacters"
4981
+ ],
4982
+ "example": "clipSeconds"
4983
+ },
4984
+ "per": {
4985
+ "description": "How many of `measure` make one billable unit.",
4986
+ "type": "number",
4987
+ "example": 60
4988
+ },
4989
+ "min": {
4990
+ "description": "Fewest accepted. A smaller request is charged at this.",
4991
+ "type": "number",
4992
+ "example": 3
4993
+ },
4994
+ "max": {
4995
+ "description": "Most accepted. A larger request is charged at this.",
4996
+ "type": "number",
4997
+ "example": 600
4998
+ },
4999
+ "default": {
5000
+ "description": "Assumed when the request carries no value.",
5001
+ "type": "number",
5002
+ "example": 30
5003
+ },
5004
+ "round": {
5005
+ "description": "Present when a partial unit is charged as a whole one. A 61 second track on a per-minute rate is charged as two minutes.",
5006
+ "type": "string",
5007
+ "enum": [
5008
+ "up"
5009
+ ],
5010
+ "example": "up"
5011
+ }
5012
+ },
5013
+ "required": [
5014
+ "measure",
5015
+ "per"
5016
+ ]
5017
+ },
5018
+ "effectiveFrom": {
5019
+ "description": "The date this rate took effect, or `legacy` for a rate that predates dated pricing.",
5020
+ "type": "string",
5021
+ "example": "2026-08-13"
5022
+ }
5023
+ },
5024
+ "required": [
5025
+ "credits",
5026
+ "effectiveFrom"
5027
+ ],
5028
+ "type": "object"
5029
+ },
5030
+ "GenerationModelListResponse": {
5031
+ "description": "The generation models available to this account.",
5032
+ "properties": {
5033
+ "models": {
5034
+ "description": "The available models.",
5035
+ "type": "array",
5036
+ "items": {
5037
+ "$ref": "#/components/schemas/GenerationModel"
5038
+ }
5039
+ }
5040
+ },
5041
+ "required": [
5042
+ "models"
5043
+ ],
5044
+ "type": "object"
5045
+ },
5046
+ "GenerationResponse": {
5047
+ "description": "The status of an on-demand asset generation job. Completed jobs include the public URL of the generated asset.",
5048
+ "type": "object",
5049
+ "properties": {
5050
+ "id": {
5051
+ "description": "The generation job id. Deterministic for a given owner and asset payload (or idempotency key), so identical requests return the same job and cached result.",
5052
+ "type": "string",
5053
+ "example": "8a1f2c3d-4e5b-5a6c-9d7e-1f2a3b4c5d6e"
5054
+ },
5055
+ "status": {
5056
+ "description": "The status of the generation job.",
5057
+ "type": "string",
5058
+ "enum": [
5059
+ "queued",
5060
+ "processing",
5061
+ "done",
5062
+ "failed"
5063
+ ],
5064
+ "example": "done"
5065
+ },
5066
+ "url": {
5067
+ "description": "The public URL of the generated asset. Present only when `status` is `done`.",
5068
+ "type": "string",
5069
+ "example": "https://shotstack-api-v1-output.s3-ap-southeast-2.amazonaws.com/owner/8a1f2c3d.png"
5070
+ },
5071
+ "error": {
5072
+ "description": "A human readable error message. Present only when `status` is `failed`.",
5073
+ "type": "string"
5074
+ }
5075
+ },
5076
+ "required": [
5077
+ "id",
5078
+ "status"
5079
+ ]
5080
+ },
5081
+ "GenerationErrorResponse": {
5082
+ "description": "Why a generation request was not accepted or a job could not be found.",
5083
+ "type": "object",
5084
+ "properties": {
5085
+ "error": {
5086
+ "description": "A human readable error message.",
5087
+ "type": "string",
5088
+ "example": "Insufficient generation credits."
5089
+ },
5090
+ "code": {
5091
+ "description": "Why access to AI generation was refused. `AiCapabilityNotIncluded`: the account's plan does not include this kind of generation. `FeatureNotIncluded`: the plan does not include a feature the asset uses. `AiDisabled`: AI generation is turned off for the account. `AiAccessUnavailable`: access could not be confirmed; try again later.",
5092
+ "type": "string",
5093
+ "example": "AiCapabilityNotIncluded"
5094
+ },
5095
+ "available": {
5096
+ "description": "The credits the account has available. Present when it has too few.",
5097
+ "type": "number",
5098
+ "example": 1.5
5099
+ }
5100
+ },
5101
+ "required": [
5102
+ "error"
5103
+ ]
5104
+ },
5105
+ "GenerationModelErrorResponse": {
5106
+ "description": "Why a generation model could not be returned.",
5107
+ "type": "object",
5108
+ "properties": {
5109
+ "error": {
5110
+ "type": "object",
5111
+ "properties": {
5112
+ "name": {
5113
+ "description": "`UnknownGenerationModel`: no model has this identifier. `WithdrawnGenerationModel`: the model is no longer listed, but edits that already use it still validate, bill and render.",
5114
+ "type": "string",
5115
+ "enum": [
5116
+ "UnknownGenerationModel",
5117
+ "WithdrawnGenerationModel"
5118
+ ],
5119
+ "example": "UnknownGenerationModel"
5120
+ },
5121
+ "message": {
5122
+ "description": "A human readable error message.",
5123
+ "type": "string",
5124
+ "example": "Unknown generation model \"seedance-9\"."
5125
+ }
5126
+ },
5127
+ "required": [
5128
+ "name",
5129
+ "message"
5130
+ ]
5131
+ }
5132
+ },
5133
+ "required": [
5134
+ "error"
5135
+ ]
5136
+ },
4943
5137
  "QueuedResponse": {
4944
5138
  "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.",
4945
5139
  "properties": {