@wevion/cli 1.0.4593 → 1.0.4596
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/openapi.json +1372 -95
- package/package.json +1 -1
package/openapi.json
CHANGED
|
@@ -136936,6 +136936,7 @@
|
|
|
136936
136936
|
"category",
|
|
136937
136937
|
"missing",
|
|
136938
136938
|
"sensitive",
|
|
136939
|
+
"collections",
|
|
136939
136940
|
"currency",
|
|
136940
136941
|
"description",
|
|
136941
136942
|
"price",
|
|
@@ -137081,6 +137082,13 @@
|
|
|
137081
137082
|
"description": "Underwear, swimwear or kids product: excluded from runs (400 sensitive_category).",
|
|
137082
137083
|
"type": "boolean"
|
|
137083
137084
|
},
|
|
137085
|
+
"collections": {
|
|
137086
|
+
"description": "Store collections the product belongs to (from its metadata, no duplicates); empty when none.",
|
|
137087
|
+
"type": "array",
|
|
137088
|
+
"items": {
|
|
137089
|
+
"type": "string"
|
|
137090
|
+
}
|
|
137091
|
+
},
|
|
137084
137092
|
"currency": {
|
|
137085
137093
|
"description": "Currency of `price` (ISO 4217).",
|
|
137086
137094
|
"anyOf": [
|
|
@@ -138920,7 +138928,7 @@
|
|
|
138920
138928
|
],
|
|
138921
138929
|
"properties": {
|
|
138922
138930
|
"id": {
|
|
138923
|
-
"description": "Catalog shot id (`cs_*`, or `
|
|
138931
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
138924
138932
|
"type": "string"
|
|
138925
138933
|
},
|
|
138926
138934
|
"label": {
|
|
@@ -138946,7 +138954,7 @@
|
|
|
138946
138954
|
],
|
|
138947
138955
|
"properties": {
|
|
138948
138956
|
"id": {
|
|
138949
|
-
"description": "Catalog shot id (`cs_*`, or `
|
|
138957
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
138950
138958
|
"type": "string"
|
|
138951
138959
|
},
|
|
138952
138960
|
"label": {
|
|
@@ -138982,7 +138990,7 @@
|
|
|
138982
138990
|
],
|
|
138983
138991
|
"properties": {
|
|
138984
138992
|
"id": {
|
|
138985
|
-
"description": "Catalog shot id (`cs_*`, or `
|
|
138993
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
138986
138994
|
"type": "string"
|
|
138987
138995
|
},
|
|
138988
138996
|
"label": {
|
|
@@ -139008,7 +139016,7 @@
|
|
|
139008
139016
|
],
|
|
139009
139017
|
"properties": {
|
|
139010
139018
|
"id": {
|
|
139011
|
-
"description": "Catalog shot id (`cs_*`, or `
|
|
139019
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
139012
139020
|
"type": "string"
|
|
139013
139021
|
},
|
|
139014
139022
|
"label": {
|
|
@@ -139044,7 +139052,7 @@
|
|
|
139044
139052
|
],
|
|
139045
139053
|
"properties": {
|
|
139046
139054
|
"id": {
|
|
139047
|
-
"description": "Catalog shot id (`cs_*`, or `
|
|
139055
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
139048
139056
|
"type": "string"
|
|
139049
139057
|
},
|
|
139050
139058
|
"label": {
|
|
@@ -139070,7 +139078,7 @@
|
|
|
139070
139078
|
],
|
|
139071
139079
|
"properties": {
|
|
139072
139080
|
"id": {
|
|
139073
|
-
"description": "Catalog shot id (`cs_*`, or `
|
|
139081
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
139074
139082
|
"type": "string"
|
|
139075
139083
|
},
|
|
139076
139084
|
"label": {
|
|
@@ -139106,7 +139114,7 @@
|
|
|
139106
139114
|
],
|
|
139107
139115
|
"properties": {
|
|
139108
139116
|
"id": {
|
|
139109
|
-
"description": "Catalog shot id (`cs_*`, or `
|
|
139117
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
139110
139118
|
"type": "string"
|
|
139111
139119
|
},
|
|
139112
139120
|
"label": {
|
|
@@ -139132,7 +139140,7 @@
|
|
|
139132
139140
|
],
|
|
139133
139141
|
"properties": {
|
|
139134
139142
|
"id": {
|
|
139135
|
-
"description": "Catalog shot id (`cs_*`, or `
|
|
139143
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
139136
139144
|
"type": "string"
|
|
139137
139145
|
},
|
|
139138
139146
|
"label": {
|
|
@@ -139793,7 +139801,7 @@
|
|
|
139793
139801
|
],
|
|
139794
139802
|
"properties": {
|
|
139795
139803
|
"id": {
|
|
139796
|
-
"description": "Catalog shot id (`cs_*`, or `
|
|
139804
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
139797
139805
|
"type": "string"
|
|
139798
139806
|
},
|
|
139799
139807
|
"label": {
|
|
@@ -139819,7 +139827,7 @@
|
|
|
139819
139827
|
],
|
|
139820
139828
|
"properties": {
|
|
139821
139829
|
"id": {
|
|
139822
|
-
"description": "Catalog shot id (`cs_*`, or `
|
|
139830
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
139823
139831
|
"type": "string"
|
|
139824
139832
|
},
|
|
139825
139833
|
"label": {
|
|
@@ -139855,7 +139863,7 @@
|
|
|
139855
139863
|
],
|
|
139856
139864
|
"properties": {
|
|
139857
139865
|
"id": {
|
|
139858
|
-
"description": "Catalog shot id (`cs_*`, or `
|
|
139866
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
139859
139867
|
"type": "string"
|
|
139860
139868
|
},
|
|
139861
139869
|
"label": {
|
|
@@ -139881,7 +139889,7 @@
|
|
|
139881
139889
|
],
|
|
139882
139890
|
"properties": {
|
|
139883
139891
|
"id": {
|
|
139884
|
-
"description": "Catalog shot id (`cs_*`, or `
|
|
139892
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
139885
139893
|
"type": "string"
|
|
139886
139894
|
},
|
|
139887
139895
|
"label": {
|
|
@@ -139917,7 +139925,7 @@
|
|
|
139917
139925
|
],
|
|
139918
139926
|
"properties": {
|
|
139919
139927
|
"id": {
|
|
139920
|
-
"description": "Catalog shot id (`cs_*`, or `
|
|
139928
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
139921
139929
|
"type": "string"
|
|
139922
139930
|
},
|
|
139923
139931
|
"label": {
|
|
@@ -139943,7 +139951,7 @@
|
|
|
139943
139951
|
],
|
|
139944
139952
|
"properties": {
|
|
139945
139953
|
"id": {
|
|
139946
|
-
"description": "Catalog shot id (`cs_*`, or `
|
|
139954
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
139947
139955
|
"type": "string"
|
|
139948
139956
|
},
|
|
139949
139957
|
"label": {
|
|
@@ -139979,7 +139987,7 @@
|
|
|
139979
139987
|
],
|
|
139980
139988
|
"properties": {
|
|
139981
139989
|
"id": {
|
|
139982
|
-
"description": "Catalog shot id (`cs_*`, or `
|
|
139990
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
139983
139991
|
"type": "string"
|
|
139984
139992
|
},
|
|
139985
139993
|
"label": {
|
|
@@ -140005,7 +140013,7 @@
|
|
|
140005
140013
|
],
|
|
140006
140014
|
"properties": {
|
|
140007
140015
|
"id": {
|
|
140008
|
-
"description": "Catalog shot id (`cs_*`, or `
|
|
140016
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
140009
140017
|
"type": "string"
|
|
140010
140018
|
},
|
|
140011
140019
|
"label": {
|
|
@@ -140627,7 +140635,7 @@
|
|
|
140627
140635
|
],
|
|
140628
140636
|
"properties": {
|
|
140629
140637
|
"id": {
|
|
140630
|
-
"description": "Catalog shot id (`cs_*`, or `
|
|
140638
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
140631
140639
|
"type": "string"
|
|
140632
140640
|
},
|
|
140633
140641
|
"label": {
|
|
@@ -140653,7 +140661,7 @@
|
|
|
140653
140661
|
],
|
|
140654
140662
|
"properties": {
|
|
140655
140663
|
"id": {
|
|
140656
|
-
"description": "Catalog shot id (`cs_*`, or `
|
|
140664
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
140657
140665
|
"type": "string"
|
|
140658
140666
|
},
|
|
140659
140667
|
"label": {
|
|
@@ -140689,7 +140697,7 @@
|
|
|
140689
140697
|
],
|
|
140690
140698
|
"properties": {
|
|
140691
140699
|
"id": {
|
|
140692
|
-
"description": "Catalog shot id (`cs_*`, or `
|
|
140700
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
140693
140701
|
"type": "string"
|
|
140694
140702
|
},
|
|
140695
140703
|
"label": {
|
|
@@ -140715,7 +140723,7 @@
|
|
|
140715
140723
|
],
|
|
140716
140724
|
"properties": {
|
|
140717
140725
|
"id": {
|
|
140718
|
-
"description": "Catalog shot id (`cs_*`, or `
|
|
140726
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
140719
140727
|
"type": "string"
|
|
140720
140728
|
},
|
|
140721
140729
|
"label": {
|
|
@@ -140751,7 +140759,7 @@
|
|
|
140751
140759
|
],
|
|
140752
140760
|
"properties": {
|
|
140753
140761
|
"id": {
|
|
140754
|
-
"description": "Catalog shot id (`cs_*`, or `
|
|
140762
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
140755
140763
|
"type": "string"
|
|
140756
140764
|
},
|
|
140757
140765
|
"label": {
|
|
@@ -140777,7 +140785,7 @@
|
|
|
140777
140785
|
],
|
|
140778
140786
|
"properties": {
|
|
140779
140787
|
"id": {
|
|
140780
|
-
"description": "Catalog shot id (`cs_*`, or `
|
|
140788
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
140781
140789
|
"type": "string"
|
|
140782
140790
|
},
|
|
140783
140791
|
"label": {
|
|
@@ -140813,7 +140821,7 @@
|
|
|
140813
140821
|
],
|
|
140814
140822
|
"properties": {
|
|
140815
140823
|
"id": {
|
|
140816
|
-
"description": "Catalog shot id (`cs_*`, or `
|
|
140824
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
140817
140825
|
"type": "string"
|
|
140818
140826
|
},
|
|
140819
140827
|
"label": {
|
|
@@ -140839,7 +140847,7 @@
|
|
|
140839
140847
|
],
|
|
140840
140848
|
"properties": {
|
|
140841
140849
|
"id": {
|
|
140842
|
-
"description": "Catalog shot id (`cs_*`, or `
|
|
140850
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
140843
140851
|
"type": "string"
|
|
140844
140852
|
},
|
|
140845
140853
|
"label": {
|
|
@@ -146616,7 +146624,1101 @@
|
|
|
146616
146624
|
"video"
|
|
146617
146625
|
]
|
|
146618
146626
|
}
|
|
146619
|
-
]
|
|
146627
|
+
]
|
|
146628
|
+
}
|
|
146629
|
+
}
|
|
146630
|
+
}
|
|
146631
|
+
}
|
|
146632
|
+
}
|
|
146633
|
+
},
|
|
146634
|
+
"400": {
|
|
146635
|
+
"description": "Invalid request - schema validation failed",
|
|
146636
|
+
"content": {
|
|
146637
|
+
"application/json": {
|
|
146638
|
+
"schema": {
|
|
146639
|
+
"additionalProperties": false,
|
|
146640
|
+
"type": "object",
|
|
146641
|
+
"required": [
|
|
146642
|
+
"error"
|
|
146643
|
+
],
|
|
146644
|
+
"properties": {
|
|
146645
|
+
"code": {
|
|
146646
|
+
"type": "string"
|
|
146647
|
+
},
|
|
146648
|
+
"error": {
|
|
146649
|
+
"type": "string"
|
|
146650
|
+
},
|
|
146651
|
+
"message": {
|
|
146652
|
+
"type": "string"
|
|
146653
|
+
},
|
|
146654
|
+
"limit": {
|
|
146655
|
+
"description": "wip_limit_reached / regen_limit_reached: the limit that was hit.",
|
|
146656
|
+
"type": "integer"
|
|
146657
|
+
},
|
|
146658
|
+
"required_tier": {
|
|
146659
|
+
"description": "Feed Enhancement tier: base, custom, pro. Which plan gets which tier is a lever of the plan, set in the back-office.",
|
|
146660
|
+
"anyOf": [
|
|
146661
|
+
{
|
|
146662
|
+
"type": "string",
|
|
146663
|
+
"enum": [
|
|
146664
|
+
"base"
|
|
146665
|
+
]
|
|
146666
|
+
},
|
|
146667
|
+
{
|
|
146668
|
+
"type": "string",
|
|
146669
|
+
"enum": [
|
|
146670
|
+
"custom"
|
|
146671
|
+
]
|
|
146672
|
+
},
|
|
146673
|
+
{
|
|
146674
|
+
"type": "string",
|
|
146675
|
+
"enum": [
|
|
146676
|
+
"pro"
|
|
146677
|
+
]
|
|
146678
|
+
}
|
|
146679
|
+
]
|
|
146680
|
+
},
|
|
146681
|
+
"required_credits": {
|
|
146682
|
+
"description": "INSUFFICIENT_CREDITS on a redeem: the total the redeem needs.",
|
|
146683
|
+
"type": "integer"
|
|
146684
|
+
},
|
|
146685
|
+
"available_credits": {
|
|
146686
|
+
"description": "INSUFFICIENT_CREDITS on a redeem: the spendable balance.",
|
|
146687
|
+
"type": "integer"
|
|
146688
|
+
}
|
|
146689
|
+
}
|
|
146690
|
+
}
|
|
146691
|
+
}
|
|
146692
|
+
}
|
|
146693
|
+
},
|
|
146694
|
+
"401": {
|
|
146695
|
+
"description": "Unauthorized - missing or invalid bearer token",
|
|
146696
|
+
"content": {
|
|
146697
|
+
"application/json": {
|
|
146698
|
+
"schema": {
|
|
146699
|
+
"additionalProperties": false,
|
|
146700
|
+
"type": "object",
|
|
146701
|
+
"required": [
|
|
146702
|
+
"error"
|
|
146703
|
+
],
|
|
146704
|
+
"properties": {
|
|
146705
|
+
"code": {
|
|
146706
|
+
"type": "string"
|
|
146707
|
+
},
|
|
146708
|
+
"error": {
|
|
146709
|
+
"type": "string"
|
|
146710
|
+
},
|
|
146711
|
+
"message": {
|
|
146712
|
+
"type": "string"
|
|
146713
|
+
},
|
|
146714
|
+
"limit": {
|
|
146715
|
+
"description": "wip_limit_reached / regen_limit_reached: the limit that was hit.",
|
|
146716
|
+
"type": "integer"
|
|
146717
|
+
},
|
|
146718
|
+
"required_tier": {
|
|
146719
|
+
"description": "Feed Enhancement tier: base, custom, pro. Which plan gets which tier is a lever of the plan, set in the back-office.",
|
|
146720
|
+
"anyOf": [
|
|
146721
|
+
{
|
|
146722
|
+
"type": "string",
|
|
146723
|
+
"enum": [
|
|
146724
|
+
"base"
|
|
146725
|
+
]
|
|
146726
|
+
},
|
|
146727
|
+
{
|
|
146728
|
+
"type": "string",
|
|
146729
|
+
"enum": [
|
|
146730
|
+
"custom"
|
|
146731
|
+
]
|
|
146732
|
+
},
|
|
146733
|
+
{
|
|
146734
|
+
"type": "string",
|
|
146735
|
+
"enum": [
|
|
146736
|
+
"pro"
|
|
146737
|
+
]
|
|
146738
|
+
}
|
|
146739
|
+
]
|
|
146740
|
+
},
|
|
146741
|
+
"required_credits": {
|
|
146742
|
+
"description": "INSUFFICIENT_CREDITS on a redeem: the total the redeem needs.",
|
|
146743
|
+
"type": "integer"
|
|
146744
|
+
},
|
|
146745
|
+
"available_credits": {
|
|
146746
|
+
"description": "INSUFFICIENT_CREDITS on a redeem: the spendable balance.",
|
|
146747
|
+
"type": "integer"
|
|
146748
|
+
},
|
|
146749
|
+
"request_id": {
|
|
146750
|
+
"type": "string",
|
|
146751
|
+
"description": "Fastify request id, propagated for support correlation."
|
|
146752
|
+
}
|
|
146753
|
+
}
|
|
146754
|
+
}
|
|
146755
|
+
}
|
|
146756
|
+
}
|
|
146757
|
+
},
|
|
146758
|
+
"402": {
|
|
146759
|
+
"description": "Payment required - the plan quota or the credit balance does not allow the operation",
|
|
146760
|
+
"content": {
|
|
146761
|
+
"application/json": {
|
|
146762
|
+
"schema": {
|
|
146763
|
+
"additionalProperties": false,
|
|
146764
|
+
"type": "object",
|
|
146765
|
+
"required": [
|
|
146766
|
+
"error"
|
|
146767
|
+
],
|
|
146768
|
+
"properties": {
|
|
146769
|
+
"code": {
|
|
146770
|
+
"type": "string"
|
|
146771
|
+
},
|
|
146772
|
+
"error": {
|
|
146773
|
+
"type": "string"
|
|
146774
|
+
},
|
|
146775
|
+
"message": {
|
|
146776
|
+
"type": "string"
|
|
146777
|
+
},
|
|
146778
|
+
"limit": {
|
|
146779
|
+
"description": "wip_limit_reached / regen_limit_reached: the limit that was hit.",
|
|
146780
|
+
"type": "integer"
|
|
146781
|
+
},
|
|
146782
|
+
"required_tier": {
|
|
146783
|
+
"description": "Feed Enhancement tier: base, custom, pro. Which plan gets which tier is a lever of the plan, set in the back-office.",
|
|
146784
|
+
"anyOf": [
|
|
146785
|
+
{
|
|
146786
|
+
"type": "string",
|
|
146787
|
+
"enum": [
|
|
146788
|
+
"base"
|
|
146789
|
+
]
|
|
146790
|
+
},
|
|
146791
|
+
{
|
|
146792
|
+
"type": "string",
|
|
146793
|
+
"enum": [
|
|
146794
|
+
"custom"
|
|
146795
|
+
]
|
|
146796
|
+
},
|
|
146797
|
+
{
|
|
146798
|
+
"type": "string",
|
|
146799
|
+
"enum": [
|
|
146800
|
+
"pro"
|
|
146801
|
+
]
|
|
146802
|
+
}
|
|
146803
|
+
]
|
|
146804
|
+
},
|
|
146805
|
+
"required_credits": {
|
|
146806
|
+
"description": "INSUFFICIENT_CREDITS on a redeem: the total the redeem needs.",
|
|
146807
|
+
"type": "integer"
|
|
146808
|
+
},
|
|
146809
|
+
"available_credits": {
|
|
146810
|
+
"description": "INSUFFICIENT_CREDITS on a redeem: the spendable balance.",
|
|
146811
|
+
"type": "integer"
|
|
146812
|
+
}
|
|
146813
|
+
}
|
|
146814
|
+
}
|
|
146815
|
+
}
|
|
146816
|
+
}
|
|
146817
|
+
},
|
|
146818
|
+
"403": {
|
|
146819
|
+
"description": "Forbidden - caller lacks the required role/permission",
|
|
146820
|
+
"content": {
|
|
146821
|
+
"application/json": {
|
|
146822
|
+
"schema": {
|
|
146823
|
+
"additionalProperties": false,
|
|
146824
|
+
"type": "object",
|
|
146825
|
+
"required": [
|
|
146826
|
+
"error"
|
|
146827
|
+
],
|
|
146828
|
+
"properties": {
|
|
146829
|
+
"code": {
|
|
146830
|
+
"type": "string"
|
|
146831
|
+
},
|
|
146832
|
+
"error": {
|
|
146833
|
+
"type": "string"
|
|
146834
|
+
},
|
|
146835
|
+
"message": {
|
|
146836
|
+
"type": "string"
|
|
146837
|
+
},
|
|
146838
|
+
"limit": {
|
|
146839
|
+
"description": "wip_limit_reached / regen_limit_reached: the limit that was hit.",
|
|
146840
|
+
"type": "integer"
|
|
146841
|
+
},
|
|
146842
|
+
"required_tier": {
|
|
146843
|
+
"description": "Feed Enhancement tier: base, custom, pro. Which plan gets which tier is a lever of the plan, set in the back-office.",
|
|
146844
|
+
"anyOf": [
|
|
146845
|
+
{
|
|
146846
|
+
"type": "string",
|
|
146847
|
+
"enum": [
|
|
146848
|
+
"base"
|
|
146849
|
+
]
|
|
146850
|
+
},
|
|
146851
|
+
{
|
|
146852
|
+
"type": "string",
|
|
146853
|
+
"enum": [
|
|
146854
|
+
"custom"
|
|
146855
|
+
]
|
|
146856
|
+
},
|
|
146857
|
+
{
|
|
146858
|
+
"type": "string",
|
|
146859
|
+
"enum": [
|
|
146860
|
+
"pro"
|
|
146861
|
+
]
|
|
146862
|
+
}
|
|
146863
|
+
]
|
|
146864
|
+
},
|
|
146865
|
+
"required_credits": {
|
|
146866
|
+
"description": "INSUFFICIENT_CREDITS on a redeem: the total the redeem needs.",
|
|
146867
|
+
"type": "integer"
|
|
146868
|
+
},
|
|
146869
|
+
"available_credits": {
|
|
146870
|
+
"description": "INSUFFICIENT_CREDITS on a redeem: the spendable balance.",
|
|
146871
|
+
"type": "integer"
|
|
146872
|
+
}
|
|
146873
|
+
}
|
|
146874
|
+
}
|
|
146875
|
+
}
|
|
146876
|
+
}
|
|
146877
|
+
},
|
|
146878
|
+
"404": {
|
|
146879
|
+
"description": "Resource not found",
|
|
146880
|
+
"content": {
|
|
146881
|
+
"application/json": {
|
|
146882
|
+
"schema": {
|
|
146883
|
+
"additionalProperties": false,
|
|
146884
|
+
"type": "object",
|
|
146885
|
+
"required": [
|
|
146886
|
+
"error"
|
|
146887
|
+
],
|
|
146888
|
+
"properties": {
|
|
146889
|
+
"code": {
|
|
146890
|
+
"type": "string"
|
|
146891
|
+
},
|
|
146892
|
+
"error": {
|
|
146893
|
+
"type": "string"
|
|
146894
|
+
},
|
|
146895
|
+
"message": {
|
|
146896
|
+
"type": "string"
|
|
146897
|
+
},
|
|
146898
|
+
"limit": {
|
|
146899
|
+
"description": "wip_limit_reached / regen_limit_reached: the limit that was hit.",
|
|
146900
|
+
"type": "integer"
|
|
146901
|
+
},
|
|
146902
|
+
"required_tier": {
|
|
146903
|
+
"description": "Feed Enhancement tier: base, custom, pro. Which plan gets which tier is a lever of the plan, set in the back-office.",
|
|
146904
|
+
"anyOf": [
|
|
146905
|
+
{
|
|
146906
|
+
"type": "string",
|
|
146907
|
+
"enum": [
|
|
146908
|
+
"base"
|
|
146909
|
+
]
|
|
146910
|
+
},
|
|
146911
|
+
{
|
|
146912
|
+
"type": "string",
|
|
146913
|
+
"enum": [
|
|
146914
|
+
"custom"
|
|
146915
|
+
]
|
|
146916
|
+
},
|
|
146917
|
+
{
|
|
146918
|
+
"type": "string",
|
|
146919
|
+
"enum": [
|
|
146920
|
+
"pro"
|
|
146921
|
+
]
|
|
146922
|
+
}
|
|
146923
|
+
]
|
|
146924
|
+
},
|
|
146925
|
+
"required_credits": {
|
|
146926
|
+
"description": "INSUFFICIENT_CREDITS on a redeem: the total the redeem needs.",
|
|
146927
|
+
"type": "integer"
|
|
146928
|
+
},
|
|
146929
|
+
"available_credits": {
|
|
146930
|
+
"description": "INSUFFICIENT_CREDITS on a redeem: the spendable balance.",
|
|
146931
|
+
"type": "integer"
|
|
146932
|
+
}
|
|
146933
|
+
}
|
|
146934
|
+
}
|
|
146935
|
+
}
|
|
146936
|
+
}
|
|
146937
|
+
},
|
|
146938
|
+
"429": {
|
|
146939
|
+
"description": "Rate limit or Feed limit exceeded: retry after the `retry-after` header, or free a slot.",
|
|
146940
|
+
"content": {
|
|
146941
|
+
"application/json": {
|
|
146942
|
+
"schema": {
|
|
146943
|
+
"additionalProperties": false,
|
|
146944
|
+
"description": "Rate limit or Feed limit exceeded: retry after the `retry-after` header, or free a slot.",
|
|
146945
|
+
"type": "object",
|
|
146946
|
+
"required": [
|
|
146947
|
+
"statusCode",
|
|
146948
|
+
"error"
|
|
146949
|
+
],
|
|
146950
|
+
"properties": {
|
|
146951
|
+
"statusCode": {
|
|
146952
|
+
"type": "integer"
|
|
146953
|
+
},
|
|
146954
|
+
"error": {
|
|
146955
|
+
"type": "string"
|
|
146956
|
+
},
|
|
146957
|
+
"message": {
|
|
146958
|
+
"type": "string"
|
|
146959
|
+
},
|
|
146960
|
+
"code": {
|
|
146961
|
+
"description": "`API_KEY_RATE_LIMITED` when the exhausted quota is the API key own limit; `wip_limit_reached` / `regen_limit_reached` for the Feed limits.",
|
|
146962
|
+
"type": "string"
|
|
146963
|
+
},
|
|
146964
|
+
"retry_after_seconds": {
|
|
146965
|
+
"description": "Seconds to wait before retrying, mirroring the `retry-after` header.",
|
|
146966
|
+
"type": "integer"
|
|
146967
|
+
},
|
|
146968
|
+
"request_id": {
|
|
146969
|
+
"description": "Request identifier, for support.",
|
|
146970
|
+
"type": "string"
|
|
146971
|
+
},
|
|
146972
|
+
"limit": {
|
|
146973
|
+
"description": "wip_limit_reached / regen_limit_reached: the limit that was hit.",
|
|
146974
|
+
"type": "integer"
|
|
146975
|
+
},
|
|
146976
|
+
"required_tier": {
|
|
146977
|
+
"description": "Feed Enhancement tier: base, custom, pro. Which plan gets which tier is a lever of the plan, set in the back-office.",
|
|
146978
|
+
"anyOf": [
|
|
146979
|
+
{
|
|
146980
|
+
"type": "string",
|
|
146981
|
+
"enum": [
|
|
146982
|
+
"base"
|
|
146983
|
+
]
|
|
146984
|
+
},
|
|
146985
|
+
{
|
|
146986
|
+
"type": "string",
|
|
146987
|
+
"enum": [
|
|
146988
|
+
"custom"
|
|
146989
|
+
]
|
|
146990
|
+
},
|
|
146991
|
+
{
|
|
146992
|
+
"type": "string",
|
|
146993
|
+
"enum": [
|
|
146994
|
+
"pro"
|
|
146995
|
+
]
|
|
146996
|
+
}
|
|
146997
|
+
]
|
|
146998
|
+
}
|
|
146999
|
+
}
|
|
147000
|
+
}
|
|
147001
|
+
}
|
|
147002
|
+
}
|
|
147003
|
+
},
|
|
147004
|
+
"503": {
|
|
147005
|
+
"description": "Service unavailable",
|
|
147006
|
+
"content": {
|
|
147007
|
+
"application/json": {
|
|
147008
|
+
"schema": {
|
|
147009
|
+
"additionalProperties": false,
|
|
147010
|
+
"type": "object",
|
|
147011
|
+
"required": [
|
|
147012
|
+
"error"
|
|
147013
|
+
],
|
|
147014
|
+
"properties": {
|
|
147015
|
+
"code": {
|
|
147016
|
+
"type": "string"
|
|
147017
|
+
},
|
|
147018
|
+
"error": {
|
|
147019
|
+
"type": "string"
|
|
147020
|
+
},
|
|
147021
|
+
"message": {
|
|
147022
|
+
"type": "string"
|
|
147023
|
+
},
|
|
147024
|
+
"limit": {
|
|
147025
|
+
"description": "wip_limit_reached / regen_limit_reached: the limit that was hit.",
|
|
147026
|
+
"type": "integer"
|
|
147027
|
+
},
|
|
147028
|
+
"required_tier": {
|
|
147029
|
+
"description": "Feed Enhancement tier: base, custom, pro. Which plan gets which tier is a lever of the plan, set in the back-office.",
|
|
147030
|
+
"anyOf": [
|
|
147031
|
+
{
|
|
147032
|
+
"type": "string",
|
|
147033
|
+
"enum": [
|
|
147034
|
+
"base"
|
|
147035
|
+
]
|
|
147036
|
+
},
|
|
147037
|
+
{
|
|
147038
|
+
"type": "string",
|
|
147039
|
+
"enum": [
|
|
147040
|
+
"custom"
|
|
147041
|
+
]
|
|
147042
|
+
},
|
|
147043
|
+
{
|
|
147044
|
+
"type": "string",
|
|
147045
|
+
"enum": [
|
|
147046
|
+
"pro"
|
|
147047
|
+
]
|
|
147048
|
+
}
|
|
147049
|
+
]
|
|
147050
|
+
},
|
|
147051
|
+
"required_credits": {
|
|
147052
|
+
"description": "INSUFFICIENT_CREDITS on a redeem: the total the redeem needs.",
|
|
147053
|
+
"type": "integer"
|
|
147054
|
+
},
|
|
147055
|
+
"available_credits": {
|
|
147056
|
+
"description": "INSUFFICIENT_CREDITS on a redeem: the spendable balance.",
|
|
147057
|
+
"type": "integer"
|
|
147058
|
+
}
|
|
147059
|
+
}
|
|
147060
|
+
}
|
|
147061
|
+
}
|
|
147062
|
+
}
|
|
147063
|
+
}
|
|
147064
|
+
}
|
|
147065
|
+
}
|
|
147066
|
+
},
|
|
147067
|
+
"/api/v1/creative-hub/feed-enhancement/pro-analysis": {
|
|
147068
|
+
"get": {
|
|
147069
|
+
"operationId": "creativeHubFeedEnhancementGetProAnalysisPrice",
|
|
147070
|
+
"summary": "Get the price of the Pro analysis",
|
|
147071
|
+
"tags": [
|
|
147072
|
+
"creative-hub",
|
|
147073
|
+
"creative-generation"
|
|
147074
|
+
],
|
|
147075
|
+
"description": "What one Pro analysis costs per product, shown before the user starts it. 503 FEATURE_DISABLED when the flag feed_pro_analysis_enabled is off for the caller.",
|
|
147076
|
+
"security": [
|
|
147077
|
+
{
|
|
147078
|
+
"bearerAuth": []
|
|
147079
|
+
},
|
|
147080
|
+
{
|
|
147081
|
+
"apiKeyAuth": []
|
|
147082
|
+
}
|
|
147083
|
+
],
|
|
147084
|
+
"responses": {
|
|
147085
|
+
"200": {
|
|
147086
|
+
"description": "Successful response",
|
|
147087
|
+
"content": {
|
|
147088
|
+
"application/json": {
|
|
147089
|
+
"schema": {
|
|
147090
|
+
"additionalProperties": false,
|
|
147091
|
+
"type": "object",
|
|
147092
|
+
"required": [
|
|
147093
|
+
"credits_per_product",
|
|
147094
|
+
"max_products"
|
|
147095
|
+
],
|
|
147096
|
+
"properties": {
|
|
147097
|
+
"credits_per_product": {
|
|
147098
|
+
"description": "Credits (internal unit) one Pro analysis costs per product the model really read.",
|
|
147099
|
+
"minimum": 0,
|
|
147100
|
+
"type": "integer"
|
|
147101
|
+
},
|
|
147102
|
+
"max_products": {
|
|
147103
|
+
"description": "Products one Pro analysis reads at most.",
|
|
147104
|
+
"minimum": 1,
|
|
147105
|
+
"type": "integer"
|
|
147106
|
+
}
|
|
147107
|
+
}
|
|
147108
|
+
}
|
|
147109
|
+
}
|
|
147110
|
+
}
|
|
147111
|
+
},
|
|
147112
|
+
"401": {
|
|
147113
|
+
"description": "Unauthorized - missing or invalid bearer token",
|
|
147114
|
+
"content": {
|
|
147115
|
+
"application/json": {
|
|
147116
|
+
"schema": {
|
|
147117
|
+
"additionalProperties": false,
|
|
147118
|
+
"type": "object",
|
|
147119
|
+
"required": [
|
|
147120
|
+
"error"
|
|
147121
|
+
],
|
|
147122
|
+
"properties": {
|
|
147123
|
+
"code": {
|
|
147124
|
+
"type": "string"
|
|
147125
|
+
},
|
|
147126
|
+
"error": {
|
|
147127
|
+
"type": "string"
|
|
147128
|
+
},
|
|
147129
|
+
"message": {
|
|
147130
|
+
"type": "string"
|
|
147131
|
+
},
|
|
147132
|
+
"limit": {
|
|
147133
|
+
"description": "wip_limit_reached / regen_limit_reached: the limit that was hit.",
|
|
147134
|
+
"type": "integer"
|
|
147135
|
+
},
|
|
147136
|
+
"required_tier": {
|
|
147137
|
+
"description": "Feed Enhancement tier: base, custom, pro. Which plan gets which tier is a lever of the plan, set in the back-office.",
|
|
147138
|
+
"anyOf": [
|
|
147139
|
+
{
|
|
147140
|
+
"type": "string",
|
|
147141
|
+
"enum": [
|
|
147142
|
+
"base"
|
|
147143
|
+
]
|
|
147144
|
+
},
|
|
147145
|
+
{
|
|
147146
|
+
"type": "string",
|
|
147147
|
+
"enum": [
|
|
147148
|
+
"custom"
|
|
147149
|
+
]
|
|
147150
|
+
},
|
|
147151
|
+
{
|
|
147152
|
+
"type": "string",
|
|
147153
|
+
"enum": [
|
|
147154
|
+
"pro"
|
|
147155
|
+
]
|
|
147156
|
+
}
|
|
147157
|
+
]
|
|
147158
|
+
},
|
|
147159
|
+
"required_credits": {
|
|
147160
|
+
"description": "INSUFFICIENT_CREDITS on a redeem: the total the redeem needs.",
|
|
147161
|
+
"type": "integer"
|
|
147162
|
+
},
|
|
147163
|
+
"available_credits": {
|
|
147164
|
+
"description": "INSUFFICIENT_CREDITS on a redeem: the spendable balance.",
|
|
147165
|
+
"type": "integer"
|
|
147166
|
+
},
|
|
147167
|
+
"request_id": {
|
|
147168
|
+
"type": "string",
|
|
147169
|
+
"description": "Fastify request id, propagated for support correlation."
|
|
147170
|
+
}
|
|
147171
|
+
}
|
|
147172
|
+
}
|
|
147173
|
+
}
|
|
147174
|
+
}
|
|
147175
|
+
},
|
|
147176
|
+
"429": {
|
|
147177
|
+
"description": "Too many requests - rate limit exceeded. Reachable on every API-key operation: the per-key cap sold with the plan answers `code: API_KEY_RATE_LIMITED` with `retry_after_seconds` and the `Retry-After` header. The global per-IP limiter can answer here too, with the same status and only `statusCode`, `error` and `message`.",
|
|
147178
|
+
"content": {
|
|
147179
|
+
"application/json": {
|
|
147180
|
+
"schema": {
|
|
147181
|
+
"$ref": "#/components/schemas/RateLimitedResponse"
|
|
147182
|
+
}
|
|
147183
|
+
}
|
|
147184
|
+
}
|
|
147185
|
+
},
|
|
147186
|
+
"503": {
|
|
147187
|
+
"description": "Service unavailable",
|
|
147188
|
+
"content": {
|
|
147189
|
+
"application/json": {
|
|
147190
|
+
"schema": {
|
|
147191
|
+
"additionalProperties": false,
|
|
147192
|
+
"type": "object",
|
|
147193
|
+
"required": [
|
|
147194
|
+
"error"
|
|
147195
|
+
],
|
|
147196
|
+
"properties": {
|
|
147197
|
+
"code": {
|
|
147198
|
+
"type": "string"
|
|
147199
|
+
},
|
|
147200
|
+
"error": {
|
|
147201
|
+
"type": "string"
|
|
147202
|
+
},
|
|
147203
|
+
"message": {
|
|
147204
|
+
"type": "string"
|
|
147205
|
+
},
|
|
147206
|
+
"limit": {
|
|
147207
|
+
"description": "wip_limit_reached / regen_limit_reached: the limit that was hit.",
|
|
147208
|
+
"type": "integer"
|
|
147209
|
+
},
|
|
147210
|
+
"required_tier": {
|
|
147211
|
+
"description": "Feed Enhancement tier: base, custom, pro. Which plan gets which tier is a lever of the plan, set in the back-office.",
|
|
147212
|
+
"anyOf": [
|
|
147213
|
+
{
|
|
147214
|
+
"type": "string",
|
|
147215
|
+
"enum": [
|
|
147216
|
+
"base"
|
|
147217
|
+
]
|
|
147218
|
+
},
|
|
147219
|
+
{
|
|
147220
|
+
"type": "string",
|
|
147221
|
+
"enum": [
|
|
147222
|
+
"custom"
|
|
147223
|
+
]
|
|
147224
|
+
},
|
|
147225
|
+
{
|
|
147226
|
+
"type": "string",
|
|
147227
|
+
"enum": [
|
|
147228
|
+
"pro"
|
|
147229
|
+
]
|
|
147230
|
+
}
|
|
147231
|
+
]
|
|
147232
|
+
},
|
|
147233
|
+
"required_credits": {
|
|
147234
|
+
"description": "INSUFFICIENT_CREDITS on a redeem: the total the redeem needs.",
|
|
147235
|
+
"type": "integer"
|
|
147236
|
+
},
|
|
147237
|
+
"available_credits": {
|
|
147238
|
+
"description": "INSUFFICIENT_CREDITS on a redeem: the spendable balance.",
|
|
147239
|
+
"type": "integer"
|
|
147240
|
+
}
|
|
147241
|
+
}
|
|
147242
|
+
}
|
|
147243
|
+
}
|
|
147244
|
+
}
|
|
147245
|
+
}
|
|
147246
|
+
}
|
|
147247
|
+
},
|
|
147248
|
+
"post": {
|
|
147249
|
+
"operationId": "creativeHubFeedEnhancementProAnalysis",
|
|
147250
|
+
"summary": "Analyse products in the Pro mode",
|
|
147251
|
+
"tags": [
|
|
147252
|
+
"creative-hub",
|
|
147253
|
+
"creative-generation"
|
|
147254
|
+
],
|
|
147255
|
+
"description": "Pro mode only (flag feed_pro_analysis_enabled, else 503 FEATURE_DISABLED). Reads the photos of each product with the big vision model and compares them with the best-practice checklist of its category (the P1 and P2 shots of its packaging format, built from the shot taxonomy): each checklist photo says whether the product photos already show it, and the missing ones come back as the suggested shots of each card. What Feed Enhancement already generated does not count. Charged to the caller: `credits_per_product` for each product the model really read (a failed read falls back to rules and is not charged). Errors: 400 selection_invalid (1 to 5 products), 402 INSUFFICIENT_CREDITS before any model call, 404 product_not_found.",
|
|
147256
|
+
"requestBody": {
|
|
147257
|
+
"required": true,
|
|
147258
|
+
"content": {
|
|
147259
|
+
"application/json": {
|
|
147260
|
+
"schema": {
|
|
147261
|
+
"additionalProperties": false,
|
|
147262
|
+
"type": "object",
|
|
147263
|
+
"required": [
|
|
147264
|
+
"product_ids"
|
|
147265
|
+
],
|
|
147266
|
+
"properties": {
|
|
147267
|
+
"lang": {
|
|
147268
|
+
"anyOf": [
|
|
147269
|
+
{
|
|
147270
|
+
"type": "string",
|
|
147271
|
+
"enum": [
|
|
147272
|
+
"en"
|
|
147273
|
+
]
|
|
147274
|
+
},
|
|
147275
|
+
{
|
|
147276
|
+
"type": "string",
|
|
147277
|
+
"enum": [
|
|
147278
|
+
"it"
|
|
147279
|
+
]
|
|
147280
|
+
}
|
|
147281
|
+
]
|
|
147282
|
+
},
|
|
147283
|
+
"product_ids": {
|
|
147284
|
+
"description": "The products to analyse (workspace products: a link, a photo or a store product).",
|
|
147285
|
+
"maxItems": 5,
|
|
147286
|
+
"minItems": 1,
|
|
147287
|
+
"type": "array",
|
|
147288
|
+
"items": {
|
|
147289
|
+
"format": "uuid",
|
|
147290
|
+
"type": "string"
|
|
147291
|
+
}
|
|
147292
|
+
}
|
|
147293
|
+
}
|
|
147294
|
+
}
|
|
147295
|
+
}
|
|
147296
|
+
}
|
|
147297
|
+
},
|
|
147298
|
+
"security": [
|
|
147299
|
+
{
|
|
147300
|
+
"bearerAuth": []
|
|
147301
|
+
},
|
|
147302
|
+
{
|
|
147303
|
+
"apiKeyAuth": []
|
|
147304
|
+
}
|
|
147305
|
+
],
|
|
147306
|
+
"responses": {
|
|
147307
|
+
"200": {
|
|
147308
|
+
"description": "Successful response",
|
|
147309
|
+
"content": {
|
|
147310
|
+
"application/json": {
|
|
147311
|
+
"schema": {
|
|
147312
|
+
"additionalProperties": false,
|
|
147313
|
+
"type": "object",
|
|
147314
|
+
"required": [
|
|
147315
|
+
"credits_charged",
|
|
147316
|
+
"credits_per_product",
|
|
147317
|
+
"products"
|
|
147318
|
+
],
|
|
147319
|
+
"properties": {
|
|
147320
|
+
"credits_charged": {
|
|
147321
|
+
"description": "Credits charged to the caller (internal unit).",
|
|
147322
|
+
"minimum": 0,
|
|
147323
|
+
"type": "integer"
|
|
147324
|
+
},
|
|
147325
|
+
"credits_per_product": {
|
|
147326
|
+
"minimum": 0,
|
|
147327
|
+
"type": "integer"
|
|
147328
|
+
},
|
|
147329
|
+
"products": {
|
|
147330
|
+
"type": "array",
|
|
147331
|
+
"items": {
|
|
147332
|
+
"additionalProperties": false,
|
|
147333
|
+
"type": "object",
|
|
147334
|
+
"required": [
|
|
147335
|
+
"analyzed",
|
|
147336
|
+
"checklist",
|
|
147337
|
+
"format_id",
|
|
147338
|
+
"product_id",
|
|
147339
|
+
"shots",
|
|
147340
|
+
"vertical"
|
|
147341
|
+
],
|
|
147342
|
+
"properties": {
|
|
147343
|
+
"analyzed": {
|
|
147344
|
+
"description": "Whether the model really read the photos (else rules only, and not charged).",
|
|
147345
|
+
"type": "boolean"
|
|
147346
|
+
},
|
|
147347
|
+
"checklist": {
|
|
147348
|
+
"description": "The best-practice photos of the category (P1 and P2 of the format), no video.",
|
|
147349
|
+
"type": "array",
|
|
147350
|
+
"items": {
|
|
147351
|
+
"additionalProperties": false,
|
|
147352
|
+
"type": "object",
|
|
147353
|
+
"required": [
|
|
147354
|
+
"card",
|
|
147355
|
+
"id",
|
|
147356
|
+
"label",
|
|
147357
|
+
"label_key",
|
|
147358
|
+
"present"
|
|
147359
|
+
],
|
|
147360
|
+
"properties": {
|
|
147361
|
+
"card": {
|
|
147362
|
+
"anyOf": [
|
|
147363
|
+
{
|
|
147364
|
+
"type": "string",
|
|
147365
|
+
"enum": [
|
|
147366
|
+
"complete_catalog"
|
|
147367
|
+
]
|
|
147368
|
+
},
|
|
147369
|
+
{
|
|
147370
|
+
"type": "string",
|
|
147371
|
+
"enum": [
|
|
147372
|
+
"with_model"
|
|
147373
|
+
]
|
|
147374
|
+
},
|
|
147375
|
+
{
|
|
147376
|
+
"type": "string",
|
|
147377
|
+
"enum": [
|
|
147378
|
+
"details"
|
|
147379
|
+
]
|
|
147380
|
+
},
|
|
147381
|
+
{
|
|
147382
|
+
"type": "string",
|
|
147383
|
+
"enum": [
|
|
147384
|
+
"video"
|
|
147385
|
+
]
|
|
147386
|
+
}
|
|
147387
|
+
]
|
|
147388
|
+
},
|
|
147389
|
+
"id": {
|
|
147390
|
+
"type": "string"
|
|
147391
|
+
},
|
|
147392
|
+
"label": {
|
|
147393
|
+
"type": "string"
|
|
147394
|
+
},
|
|
147395
|
+
"label_key": {
|
|
147396
|
+
"type": "string"
|
|
147397
|
+
},
|
|
147398
|
+
"present": {
|
|
147399
|
+
"description": "The product photos already show it.",
|
|
147400
|
+
"type": "boolean"
|
|
147401
|
+
}
|
|
147402
|
+
}
|
|
147403
|
+
}
|
|
147404
|
+
},
|
|
147405
|
+
"format_id": {
|
|
147406
|
+
"type": "string"
|
|
147407
|
+
},
|
|
147408
|
+
"product_id": {
|
|
147409
|
+
"format": "uuid",
|
|
147410
|
+
"type": "string"
|
|
147411
|
+
},
|
|
147412
|
+
"shots": {
|
|
147413
|
+
"additionalProperties": false,
|
|
147414
|
+
"description": "Per card of the page: the suggested shots and all the others.",
|
|
147415
|
+
"type": "object",
|
|
147416
|
+
"required": [
|
|
147417
|
+
"complete_catalog",
|
|
147418
|
+
"details",
|
|
147419
|
+
"video",
|
|
147420
|
+
"with_model"
|
|
147421
|
+
],
|
|
147422
|
+
"properties": {
|
|
147423
|
+
"complete_catalog": {
|
|
147424
|
+
"additionalProperties": false,
|
|
147425
|
+
"type": "object",
|
|
147426
|
+
"required": [
|
|
147427
|
+
"others",
|
|
147428
|
+
"suggested"
|
|
147429
|
+
],
|
|
147430
|
+
"properties": {
|
|
147431
|
+
"others": {
|
|
147432
|
+
"type": "array",
|
|
147433
|
+
"items": {
|
|
147434
|
+
"additionalProperties": false,
|
|
147435
|
+
"type": "object",
|
|
147436
|
+
"required": [
|
|
147437
|
+
"id",
|
|
147438
|
+
"label",
|
|
147439
|
+
"label_key"
|
|
147440
|
+
],
|
|
147441
|
+
"properties": {
|
|
147442
|
+
"id": {
|
|
147443
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
147444
|
+
"type": "string"
|
|
147445
|
+
},
|
|
147446
|
+
"label": {
|
|
147447
|
+
"description": "The shot name in the requested language.",
|
|
147448
|
+
"type": "string"
|
|
147449
|
+
},
|
|
147450
|
+
"label_key": {
|
|
147451
|
+
"description": "i18n key `feedEnhancement.shots.<id>`.",
|
|
147452
|
+
"type": "string"
|
|
147453
|
+
}
|
|
147454
|
+
}
|
|
147455
|
+
}
|
|
147456
|
+
},
|
|
147457
|
+
"suggested": {
|
|
147458
|
+
"type": "array",
|
|
147459
|
+
"items": {
|
|
147460
|
+
"additionalProperties": false,
|
|
147461
|
+
"type": "object",
|
|
147462
|
+
"required": [
|
|
147463
|
+
"id",
|
|
147464
|
+
"label",
|
|
147465
|
+
"label_key"
|
|
147466
|
+
],
|
|
147467
|
+
"properties": {
|
|
147468
|
+
"id": {
|
|
147469
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
147470
|
+
"type": "string"
|
|
147471
|
+
},
|
|
147472
|
+
"label": {
|
|
147473
|
+
"description": "The shot name in the requested language.",
|
|
147474
|
+
"type": "string"
|
|
147475
|
+
},
|
|
147476
|
+
"label_key": {
|
|
147477
|
+
"description": "i18n key `feedEnhancement.shots.<id>`.",
|
|
147478
|
+
"type": "string"
|
|
147479
|
+
}
|
|
147480
|
+
}
|
|
147481
|
+
}
|
|
147482
|
+
}
|
|
147483
|
+
}
|
|
147484
|
+
},
|
|
147485
|
+
"details": {
|
|
147486
|
+
"additionalProperties": false,
|
|
147487
|
+
"type": "object",
|
|
147488
|
+
"required": [
|
|
147489
|
+
"others",
|
|
147490
|
+
"suggested"
|
|
147491
|
+
],
|
|
147492
|
+
"properties": {
|
|
147493
|
+
"others": {
|
|
147494
|
+
"type": "array",
|
|
147495
|
+
"items": {
|
|
147496
|
+
"additionalProperties": false,
|
|
147497
|
+
"type": "object",
|
|
147498
|
+
"required": [
|
|
147499
|
+
"id",
|
|
147500
|
+
"label",
|
|
147501
|
+
"label_key"
|
|
147502
|
+
],
|
|
147503
|
+
"properties": {
|
|
147504
|
+
"id": {
|
|
147505
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
147506
|
+
"type": "string"
|
|
147507
|
+
},
|
|
147508
|
+
"label": {
|
|
147509
|
+
"description": "The shot name in the requested language.",
|
|
147510
|
+
"type": "string"
|
|
147511
|
+
},
|
|
147512
|
+
"label_key": {
|
|
147513
|
+
"description": "i18n key `feedEnhancement.shots.<id>`.",
|
|
147514
|
+
"type": "string"
|
|
147515
|
+
}
|
|
147516
|
+
}
|
|
147517
|
+
}
|
|
147518
|
+
},
|
|
147519
|
+
"suggested": {
|
|
147520
|
+
"type": "array",
|
|
147521
|
+
"items": {
|
|
147522
|
+
"additionalProperties": false,
|
|
147523
|
+
"type": "object",
|
|
147524
|
+
"required": [
|
|
147525
|
+
"id",
|
|
147526
|
+
"label",
|
|
147527
|
+
"label_key"
|
|
147528
|
+
],
|
|
147529
|
+
"properties": {
|
|
147530
|
+
"id": {
|
|
147531
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
147532
|
+
"type": "string"
|
|
147533
|
+
},
|
|
147534
|
+
"label": {
|
|
147535
|
+
"description": "The shot name in the requested language.",
|
|
147536
|
+
"type": "string"
|
|
147537
|
+
},
|
|
147538
|
+
"label_key": {
|
|
147539
|
+
"description": "i18n key `feedEnhancement.shots.<id>`.",
|
|
147540
|
+
"type": "string"
|
|
147541
|
+
}
|
|
147542
|
+
}
|
|
147543
|
+
}
|
|
147544
|
+
}
|
|
147545
|
+
}
|
|
147546
|
+
},
|
|
147547
|
+
"video": {
|
|
147548
|
+
"additionalProperties": false,
|
|
147549
|
+
"type": "object",
|
|
147550
|
+
"required": [
|
|
147551
|
+
"others",
|
|
147552
|
+
"suggested"
|
|
147553
|
+
],
|
|
147554
|
+
"properties": {
|
|
147555
|
+
"others": {
|
|
147556
|
+
"type": "array",
|
|
147557
|
+
"items": {
|
|
147558
|
+
"additionalProperties": false,
|
|
147559
|
+
"type": "object",
|
|
147560
|
+
"required": [
|
|
147561
|
+
"id",
|
|
147562
|
+
"label",
|
|
147563
|
+
"label_key"
|
|
147564
|
+
],
|
|
147565
|
+
"properties": {
|
|
147566
|
+
"id": {
|
|
147567
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
147568
|
+
"type": "string"
|
|
147569
|
+
},
|
|
147570
|
+
"label": {
|
|
147571
|
+
"description": "The shot name in the requested language.",
|
|
147572
|
+
"type": "string"
|
|
147573
|
+
},
|
|
147574
|
+
"label_key": {
|
|
147575
|
+
"description": "i18n key `feedEnhancement.shots.<id>`.",
|
|
147576
|
+
"type": "string"
|
|
147577
|
+
}
|
|
147578
|
+
}
|
|
147579
|
+
}
|
|
147580
|
+
},
|
|
147581
|
+
"suggested": {
|
|
147582
|
+
"type": "array",
|
|
147583
|
+
"items": {
|
|
147584
|
+
"additionalProperties": false,
|
|
147585
|
+
"type": "object",
|
|
147586
|
+
"required": [
|
|
147587
|
+
"id",
|
|
147588
|
+
"label",
|
|
147589
|
+
"label_key"
|
|
147590
|
+
],
|
|
147591
|
+
"properties": {
|
|
147592
|
+
"id": {
|
|
147593
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
147594
|
+
"type": "string"
|
|
147595
|
+
},
|
|
147596
|
+
"label": {
|
|
147597
|
+
"description": "The shot name in the requested language.",
|
|
147598
|
+
"type": "string"
|
|
147599
|
+
},
|
|
147600
|
+
"label_key": {
|
|
147601
|
+
"description": "i18n key `feedEnhancement.shots.<id>`.",
|
|
147602
|
+
"type": "string"
|
|
147603
|
+
}
|
|
147604
|
+
}
|
|
147605
|
+
}
|
|
147606
|
+
}
|
|
147607
|
+
}
|
|
147608
|
+
},
|
|
147609
|
+
"with_model": {
|
|
147610
|
+
"additionalProperties": false,
|
|
147611
|
+
"type": "object",
|
|
147612
|
+
"required": [
|
|
147613
|
+
"others",
|
|
147614
|
+
"suggested"
|
|
147615
|
+
],
|
|
147616
|
+
"properties": {
|
|
147617
|
+
"others": {
|
|
147618
|
+
"type": "array",
|
|
147619
|
+
"items": {
|
|
147620
|
+
"additionalProperties": false,
|
|
147621
|
+
"type": "object",
|
|
147622
|
+
"required": [
|
|
147623
|
+
"id",
|
|
147624
|
+
"label",
|
|
147625
|
+
"label_key"
|
|
147626
|
+
],
|
|
147627
|
+
"properties": {
|
|
147628
|
+
"id": {
|
|
147629
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
147630
|
+
"type": "string"
|
|
147631
|
+
},
|
|
147632
|
+
"label": {
|
|
147633
|
+
"description": "The shot name in the requested language.",
|
|
147634
|
+
"type": "string"
|
|
147635
|
+
},
|
|
147636
|
+
"label_key": {
|
|
147637
|
+
"description": "i18n key `feedEnhancement.shots.<id>`.",
|
|
147638
|
+
"type": "string"
|
|
147639
|
+
}
|
|
147640
|
+
}
|
|
147641
|
+
}
|
|
147642
|
+
},
|
|
147643
|
+
"suggested": {
|
|
147644
|
+
"type": "array",
|
|
147645
|
+
"items": {
|
|
147646
|
+
"additionalProperties": false,
|
|
147647
|
+
"type": "object",
|
|
147648
|
+
"required": [
|
|
147649
|
+
"id",
|
|
147650
|
+
"label",
|
|
147651
|
+
"label_key"
|
|
147652
|
+
],
|
|
147653
|
+
"properties": {
|
|
147654
|
+
"id": {
|
|
147655
|
+
"description": "Catalog shot id (`cs_*`, `video_6s` or `video_avatar`).",
|
|
147656
|
+
"type": "string"
|
|
147657
|
+
},
|
|
147658
|
+
"label": {
|
|
147659
|
+
"description": "The shot name in the requested language.",
|
|
147660
|
+
"type": "string"
|
|
147661
|
+
},
|
|
147662
|
+
"label_key": {
|
|
147663
|
+
"description": "i18n key `feedEnhancement.shots.<id>`.",
|
|
147664
|
+
"type": "string"
|
|
147665
|
+
}
|
|
147666
|
+
}
|
|
147667
|
+
}
|
|
147668
|
+
}
|
|
147669
|
+
}
|
|
147670
|
+
}
|
|
147671
|
+
}
|
|
147672
|
+
},
|
|
147673
|
+
"vertical": {
|
|
147674
|
+
"description": "A placeholder vertical, or `generic` (the default set).",
|
|
147675
|
+
"anyOf": [
|
|
147676
|
+
{
|
|
147677
|
+
"type": "string",
|
|
147678
|
+
"enum": [
|
|
147679
|
+
"accessory"
|
|
147680
|
+
]
|
|
147681
|
+
},
|
|
147682
|
+
{
|
|
147683
|
+
"type": "string",
|
|
147684
|
+
"enum": [
|
|
147685
|
+
"apparel"
|
|
147686
|
+
]
|
|
147687
|
+
},
|
|
147688
|
+
{
|
|
147689
|
+
"type": "string",
|
|
147690
|
+
"enum": [
|
|
147691
|
+
"beauty"
|
|
147692
|
+
]
|
|
147693
|
+
},
|
|
147694
|
+
{
|
|
147695
|
+
"type": "string",
|
|
147696
|
+
"enum": [
|
|
147697
|
+
"food"
|
|
147698
|
+
]
|
|
147699
|
+
},
|
|
147700
|
+
{
|
|
147701
|
+
"type": "string",
|
|
147702
|
+
"enum": [
|
|
147703
|
+
"footwear"
|
|
147704
|
+
]
|
|
147705
|
+
},
|
|
147706
|
+
{
|
|
147707
|
+
"type": "string",
|
|
147708
|
+
"enum": [
|
|
147709
|
+
"generic"
|
|
147710
|
+
]
|
|
147711
|
+
},
|
|
147712
|
+
{
|
|
147713
|
+
"type": "string",
|
|
147714
|
+
"enum": [
|
|
147715
|
+
"nutra"
|
|
147716
|
+
]
|
|
147717
|
+
}
|
|
147718
|
+
]
|
|
147719
|
+
}
|
|
147720
|
+
}
|
|
147721
|
+
}
|
|
146620
147722
|
}
|
|
146621
147723
|
}
|
|
146622
147724
|
}
|
|
@@ -146928,67 +148030,11 @@
|
|
|
146928
148030
|
}
|
|
146929
148031
|
},
|
|
146930
148032
|
"429": {
|
|
146931
|
-
"description": "
|
|
148033
|
+
"description": "Too many requests - rate limit exceeded. Reachable on every API-key operation: the per-key cap sold with the plan answers `code: API_KEY_RATE_LIMITED` with `retry_after_seconds` and the `Retry-After` header. The global per-IP limiter can answer here too, with the same status and only `statusCode`, `error` and `message`.",
|
|
146932
148034
|
"content": {
|
|
146933
148035
|
"application/json": {
|
|
146934
148036
|
"schema": {
|
|
146935
|
-
"
|
|
146936
|
-
"description": "Rate limit or Feed limit exceeded: retry after the `retry-after` header, or free a slot.",
|
|
146937
|
-
"type": "object",
|
|
146938
|
-
"required": [
|
|
146939
|
-
"statusCode",
|
|
146940
|
-
"error"
|
|
146941
|
-
],
|
|
146942
|
-
"properties": {
|
|
146943
|
-
"statusCode": {
|
|
146944
|
-
"type": "integer"
|
|
146945
|
-
},
|
|
146946
|
-
"error": {
|
|
146947
|
-
"type": "string"
|
|
146948
|
-
},
|
|
146949
|
-
"message": {
|
|
146950
|
-
"type": "string"
|
|
146951
|
-
},
|
|
146952
|
-
"code": {
|
|
146953
|
-
"description": "`API_KEY_RATE_LIMITED` when the exhausted quota is the API key own limit; `wip_limit_reached` / `regen_limit_reached` for the Feed limits.",
|
|
146954
|
-
"type": "string"
|
|
146955
|
-
},
|
|
146956
|
-
"retry_after_seconds": {
|
|
146957
|
-
"description": "Seconds to wait before retrying, mirroring the `retry-after` header.",
|
|
146958
|
-
"type": "integer"
|
|
146959
|
-
},
|
|
146960
|
-
"request_id": {
|
|
146961
|
-
"description": "Request identifier, for support.",
|
|
146962
|
-
"type": "string"
|
|
146963
|
-
},
|
|
146964
|
-
"limit": {
|
|
146965
|
-
"description": "wip_limit_reached / regen_limit_reached: the limit that was hit.",
|
|
146966
|
-
"type": "integer"
|
|
146967
|
-
},
|
|
146968
|
-
"required_tier": {
|
|
146969
|
-
"description": "Feed Enhancement tier: base, custom, pro. Which plan gets which tier is a lever of the plan, set in the back-office.",
|
|
146970
|
-
"anyOf": [
|
|
146971
|
-
{
|
|
146972
|
-
"type": "string",
|
|
146973
|
-
"enum": [
|
|
146974
|
-
"base"
|
|
146975
|
-
]
|
|
146976
|
-
},
|
|
146977
|
-
{
|
|
146978
|
-
"type": "string",
|
|
146979
|
-
"enum": [
|
|
146980
|
-
"custom"
|
|
146981
|
-
]
|
|
146982
|
-
},
|
|
146983
|
-
{
|
|
146984
|
-
"type": "string",
|
|
146985
|
-
"enum": [
|
|
146986
|
-
"pro"
|
|
146987
|
-
]
|
|
146988
|
-
}
|
|
146989
|
-
]
|
|
146990
|
-
}
|
|
146991
|
-
}
|
|
148037
|
+
"$ref": "#/components/schemas/RateLimitedResponse"
|
|
146992
148038
|
}
|
|
146993
148039
|
}
|
|
146994
148040
|
}
|
|
@@ -147136,7 +148182,7 @@
|
|
|
147136
148182
|
]
|
|
147137
148183
|
},
|
|
147138
148184
|
"wip_limit": {
|
|
147139
|
-
"description": "
|
|
148185
|
+
"description": "Open drafts at the same time (one per «Genera anteprime», any number of products); null = unlimited.",
|
|
147140
148186
|
"anyOf": [
|
|
147141
148187
|
{
|
|
147142
148188
|
"type": "integer"
|
|
@@ -147392,7 +148438,8 @@
|
|
|
147392
148438
|
"gender",
|
|
147393
148439
|
"needs_format_choice",
|
|
147394
148440
|
"shots",
|
|
147395
|
-
"formats_to_choose"
|
|
148441
|
+
"formats_to_choose",
|
|
148442
|
+
"taxonomy"
|
|
147396
148443
|
],
|
|
147397
148444
|
"properties": {
|
|
147398
148445
|
"product_id": {
|
|
@@ -147541,13 +148588,15 @@
|
|
|
147541
148588
|
"credits",
|
|
147542
148589
|
"needs_avatar",
|
|
147543
148590
|
"needs_feature",
|
|
147544
|
-
"auto_preview"
|
|
148591
|
+
"auto_preview",
|
|
148592
|
+
"card",
|
|
148593
|
+
"taxonomy_shot"
|
|
147545
148594
|
],
|
|
147546
148595
|
"properties": {
|
|
147547
148596
|
"id": {
|
|
147548
148597
|
"minLength": 1,
|
|
147549
148598
|
"maxLength": 64,
|
|
147550
|
-
"description": "A catalog shot id (`cs_*`) or `
|
|
148599
|
+
"description": "A catalog shot id (`cs_*`), `video_6s` (product-only video) or `video_avatar` (video with the avatar).",
|
|
147551
148600
|
"type": "string"
|
|
147552
148601
|
},
|
|
147553
148602
|
"label": {
|
|
@@ -147665,6 +148714,46 @@
|
|
|
147665
148714
|
"auto_preview": {
|
|
147666
148715
|
"description": "Suggested shot among the first 3: generated automatically as a preview when selected.",
|
|
147667
148716
|
"type": "boolean"
|
|
148717
|
+
},
|
|
148718
|
+
"card": {
|
|
148719
|
+
"description": "The card the shot is made in. Food: serving suggestion and hand in use belong to with_model, as in the shot taxonomy.",
|
|
148720
|
+
"anyOf": [
|
|
148721
|
+
{
|
|
148722
|
+
"type": "string",
|
|
148723
|
+
"enum": [
|
|
148724
|
+
"complete_catalog"
|
|
148725
|
+
]
|
|
148726
|
+
},
|
|
148727
|
+
{
|
|
148728
|
+
"type": "string",
|
|
148729
|
+
"enum": [
|
|
148730
|
+
"details"
|
|
148731
|
+
]
|
|
148732
|
+
},
|
|
148733
|
+
{
|
|
148734
|
+
"type": "string",
|
|
148735
|
+
"enum": [
|
|
148736
|
+
"with_model"
|
|
148737
|
+
]
|
|
148738
|
+
},
|
|
148739
|
+
{
|
|
148740
|
+
"type": "string",
|
|
148741
|
+
"enum": [
|
|
148742
|
+
"video"
|
|
148743
|
+
]
|
|
148744
|
+
}
|
|
148745
|
+
]
|
|
148746
|
+
},
|
|
148747
|
+
"taxonomy_shot": {
|
|
148748
|
+
"description": "The shot of the taxonomy this one makes for the product category (front_pack, pour_glass…); null when the category has no taxonomy plan.",
|
|
148749
|
+
"anyOf": [
|
|
148750
|
+
{
|
|
148751
|
+
"type": "string"
|
|
148752
|
+
},
|
|
148753
|
+
{
|
|
148754
|
+
"type": "null"
|
|
148755
|
+
}
|
|
148756
|
+
]
|
|
147668
148757
|
}
|
|
147669
148758
|
}
|
|
147670
148759
|
}
|
|
@@ -147687,6 +148776,73 @@
|
|
|
147687
148776
|
}
|
|
147688
148777
|
}
|
|
147689
148778
|
}
|
|
148779
|
+
},
|
|
148780
|
+
"taxonomy": {
|
|
148781
|
+
"additionalProperties": false,
|
|
148782
|
+
"description": "What the recommended shots follow: the taxonomy category and why it was chosen.",
|
|
148783
|
+
"type": "object",
|
|
148784
|
+
"required": [
|
|
148785
|
+
"id",
|
|
148786
|
+
"name",
|
|
148787
|
+
"source",
|
|
148788
|
+
"keyword"
|
|
148789
|
+
],
|
|
148790
|
+
"properties": {
|
|
148791
|
+
"id": {
|
|
148792
|
+
"description": "One of the 35 categories of the shot taxonomy (packaged_food, apparel_tops…).",
|
|
148793
|
+
"type": "string"
|
|
148794
|
+
},
|
|
148795
|
+
"name": {
|
|
148796
|
+
"description": "The category name in the asked language.",
|
|
148797
|
+
"type": "string"
|
|
148798
|
+
},
|
|
148799
|
+
"source": {
|
|
148800
|
+
"description": "Which product text named the category; default = none did, the sector default.",
|
|
148801
|
+
"anyOf": [
|
|
148802
|
+
{
|
|
148803
|
+
"type": "string",
|
|
148804
|
+
"enum": [
|
|
148805
|
+
"name"
|
|
148806
|
+
]
|
|
148807
|
+
},
|
|
148808
|
+
{
|
|
148809
|
+
"type": "string",
|
|
148810
|
+
"enum": [
|
|
148811
|
+
"product_type"
|
|
148812
|
+
]
|
|
148813
|
+
},
|
|
148814
|
+
{
|
|
148815
|
+
"type": "string",
|
|
148816
|
+
"enum": [
|
|
148817
|
+
"tags"
|
|
148818
|
+
]
|
|
148819
|
+
},
|
|
148820
|
+
{
|
|
148821
|
+
"type": "string",
|
|
148822
|
+
"enum": [
|
|
148823
|
+
"description"
|
|
148824
|
+
]
|
|
148825
|
+
},
|
|
148826
|
+
{
|
|
148827
|
+
"type": "string",
|
|
148828
|
+
"enum": [
|
|
148829
|
+
"default"
|
|
148830
|
+
]
|
|
148831
|
+
}
|
|
148832
|
+
]
|
|
148833
|
+
},
|
|
148834
|
+
"keyword": {
|
|
148835
|
+
"description": "The word found in that text; null for default.",
|
|
148836
|
+
"anyOf": [
|
|
148837
|
+
{
|
|
148838
|
+
"type": "string"
|
|
148839
|
+
},
|
|
148840
|
+
{
|
|
148841
|
+
"type": "null"
|
|
148842
|
+
}
|
|
148843
|
+
]
|
|
148844
|
+
}
|
|
148845
|
+
}
|
|
147690
148846
|
}
|
|
147691
148847
|
}
|
|
147692
148848
|
}
|
|
@@ -148498,6 +149654,7 @@
|
|
|
148498
149654
|
"type": "object",
|
|
148499
149655
|
"required": [
|
|
148500
149656
|
"id",
|
|
149657
|
+
"batch_id",
|
|
148501
149658
|
"status",
|
|
148502
149659
|
"error_code",
|
|
148503
149660
|
"catalog_source_id",
|
|
@@ -148508,13 +149665,26 @@
|
|
|
148508
149665
|
"regen_used",
|
|
148509
149666
|
"regen_limit",
|
|
148510
149667
|
"created_at",
|
|
148511
|
-
"updated_at"
|
|
149668
|
+
"updated_at",
|
|
149669
|
+
"item_counts"
|
|
148512
149670
|
],
|
|
148513
149671
|
"properties": {
|
|
148514
149672
|
"id": {
|
|
148515
149673
|
"format": "uuid",
|
|
148516
149674
|
"type": "string"
|
|
148517
149675
|
},
|
|
149676
|
+
"batch_id": {
|
|
149677
|
+
"description": "The job this work belongs to (`batch_id` of POST /works); null for works created without it.",
|
|
149678
|
+
"anyOf": [
|
|
149679
|
+
{
|
|
149680
|
+
"format": "uuid",
|
|
149681
|
+
"type": "string"
|
|
149682
|
+
},
|
|
149683
|
+
{
|
|
149684
|
+
"type": "null"
|
|
149685
|
+
}
|
|
149686
|
+
]
|
|
149687
|
+
},
|
|
148518
149688
|
"status": {
|
|
148519
149689
|
"anyOf": [
|
|
148520
149690
|
{
|
|
@@ -148643,12 +149813,51 @@
|
|
|
148643
149813
|
},
|
|
148644
149814
|
"updated_at": {
|
|
148645
149815
|
"type": "string"
|
|
149816
|
+
},
|
|
149817
|
+
"item_counts": {
|
|
149818
|
+
"additionalProperties": false,
|
|
149819
|
+
"description": "The live shots of the work by state (latest per card, product and shot; the video start frame excluded).",
|
|
149820
|
+
"type": "object",
|
|
149821
|
+
"required": [
|
|
149822
|
+
"queued",
|
|
149823
|
+
"processing",
|
|
149824
|
+
"failed",
|
|
149825
|
+
"previews_ready",
|
|
149826
|
+
"produced"
|
|
149827
|
+
],
|
|
149828
|
+
"properties": {
|
|
149829
|
+
"queued": {
|
|
149830
|
+
"minimum": 0,
|
|
149831
|
+
"description": "Shots waiting for a generation slot.",
|
|
149832
|
+
"type": "integer"
|
|
149833
|
+
},
|
|
149834
|
+
"processing": {
|
|
149835
|
+
"minimum": 0,
|
|
149836
|
+
"description": "Shots being generated.",
|
|
149837
|
+
"type": "integer"
|
|
149838
|
+
},
|
|
149839
|
+
"failed": {
|
|
149840
|
+
"minimum": 0,
|
|
149841
|
+
"description": "Shots that failed (retry from the work).",
|
|
149842
|
+
"type": "integer"
|
|
149843
|
+
},
|
|
149844
|
+
"previews_ready": {
|
|
149845
|
+
"minimum": 0,
|
|
149846
|
+
"description": "Free low-resolution previews ready and not yet sent to production (redeemed).",
|
|
149847
|
+
"type": "integer"
|
|
149848
|
+
},
|
|
149849
|
+
"produced": {
|
|
149850
|
+
"minimum": 0,
|
|
149851
|
+
"description": "Full-resolution shots: redeemed previews and paid shots.",
|
|
149852
|
+
"type": "integer"
|
|
149853
|
+
}
|
|
149854
|
+
}
|
|
148646
149855
|
}
|
|
148647
149856
|
}
|
|
148648
149857
|
}
|
|
148649
149858
|
},
|
|
148650
149859
|
"count": {
|
|
148651
|
-
"description": "
|
|
149860
|
+
"description": "Open drafts of the caller in this workspace (the records of one batch_id count once).",
|
|
148652
149861
|
"type": "integer"
|
|
148653
149862
|
},
|
|
148654
149863
|
"limit": {
|
|
@@ -148990,7 +150199,7 @@
|
|
|
148990
150199
|
"creative-hub",
|
|
148991
150200
|
"creative-generation"
|
|
148992
150201
|
],
|
|
148993
|
-
"description": "«Analizza e genera»: creates a work in progress for the selected products and analyzes them right away (photo count per variant, file names, variants, category, what Feed Enhancement already made, and an AI vision check of the photos when available, else rules only). The answer lists the proposed cards (complete_catalog, details, with_model, video), each only when needed, with reasons, suggested shots and verified statistics with their source. With mode manual the cards picked in `types` are marked chosen, and added as user cards (no statistics) when the analysis did not propose them and some product can have them. No credits are used. The
|
|
150202
|
+
"description": "«Analizza e genera»: creates a work in progress for the selected products and analyzes them right away (photo count per variant, file names, variants, category, what Feed Enhancement already made, and an AI vision check of the photos when available, else rules only). The answer lists the proposed cards (complete_catalog, details, with_model, video), each only when needed, with reasons, suggested shots and verified statistics with their source. With mode manual the cards picked in `types` are marked chosen, and added as user cards (no statistics) when the analysis did not propose them and some product can have them. No credits are used. The open drafts per user and workspace are limited by tier (a draft is the records sharing one batch_id, one per product; a record joining an open draft takes no new place): 409 wip_limit_reached (with limit) until one is deleted. 400 selection_invalid on contradictory mode/types/avatar_id, model_profile_invalid on an unknown age range or look. Each product gets its taxonomy category, its shots with name and why, and the ratio of its store photo (frames). Without model_profile the work inherits the last one of the same store (source store_last).",
|
|
148994
150203
|
"requestBody": {
|
|
148995
150204
|
"required": true,
|
|
148996
150205
|
"content": {
|
|
@@ -149002,6 +150211,11 @@
|
|
|
149002
150211
|
"product_ids"
|
|
149003
150212
|
],
|
|
149004
150213
|
"properties": {
|
|
150214
|
+
"batch_id": {
|
|
150215
|
+
"format": "uuid",
|
|
150216
|
+
"description": "The same id on every work created by one «Generate previews» (one work per product): the Drafts list groups them as one job. Stored on the work and returned as `batch_id`.",
|
|
150217
|
+
"type": "string"
|
|
150218
|
+
},
|
|
149005
150219
|
"product_ids": {
|
|
149006
150220
|
"minItems": 1,
|
|
149007
150221
|
"maxItems": 50,
|
|
@@ -149053,7 +150267,7 @@
|
|
|
149053
150267
|
"properties": {}
|
|
149054
150268
|
},
|
|
149055
150269
|
"product_shots": {
|
|
149056
|
-
"description": "Shot catalog selection (flag feed_shot_catalog_enabled, else 503): the shots the customer chose per product (ids from GET /shot-catalog, `video_6s` included). At most 3 photo previews per product are generated automatically (best priority first); the others are returned in `catalog.deferred` and generated when asked via POST /works/:workId/cards/:card/generate with shot_ids. Excludes mode, types, product_types and avatar_id (400 selection_invalid). 400 shot_not_applicable for an unknown shot or a shot with no recipe for the product category.",
|
|
150270
|
+
"description": "Shot catalog selection (flag feed_shot_catalog_enabled, else 503): the shots the customer chose per product (ids from GET /shot-catalog, `video_6s` and `video_avatar` included). At most 3 photo previews per product are generated automatically (best priority first); the others are returned in `catalog.deferred` and generated when asked via POST /works/:workId/cards/:card/generate with shot_ids. Excludes mode, types, product_types and avatar_id (400 selection_invalid). 400 shot_not_applicable for an unknown shot or a shot with no recipe for the product category.",
|
|
149057
150271
|
"type": "object",
|
|
149058
150272
|
"additionalProperties": {
|
|
149059
150273
|
"maxItems": 24,
|
|
@@ -149062,7 +150276,7 @@
|
|
|
149062
150276
|
"items": {
|
|
149063
150277
|
"minLength": 1,
|
|
149064
150278
|
"maxLength": 64,
|
|
149065
|
-
"description": "A catalog shot id (`cs_*`) or `
|
|
150279
|
+
"description": "A catalog shot id (`cs_*`), `video_6s` (product-only video) or `video_avatar` (video with the avatar).",
|
|
149066
150280
|
"type": "string"
|
|
149067
150281
|
}
|
|
149068
150282
|
}
|
|
@@ -149199,6 +150413,23 @@
|
|
|
149199
150413
|
}
|
|
149200
150414
|
}
|
|
149201
150415
|
},
|
|
150416
|
+
"output_mode": {
|
|
150417
|
+
"description": "Output mode of the work. `standard` (default) is the usual analysis; `pro` reads the product photos and directs the video with a larger model, slower and more accurate. Credits are the same in both modes.",
|
|
150418
|
+
"anyOf": [
|
|
150419
|
+
{
|
|
150420
|
+
"type": "string",
|
|
150421
|
+
"enum": [
|
|
150422
|
+
"standard"
|
|
150423
|
+
]
|
|
150424
|
+
},
|
|
150425
|
+
{
|
|
150426
|
+
"type": "string",
|
|
150427
|
+
"enum": [
|
|
150428
|
+
"pro"
|
|
150429
|
+
]
|
|
150430
|
+
}
|
|
150431
|
+
]
|
|
150432
|
+
},
|
|
149202
150433
|
"types": {
|
|
149203
150434
|
"minItems": 1,
|
|
149204
150435
|
"maxItems": 4,
|
|
@@ -149274,6 +150505,7 @@
|
|
|
149274
150505
|
"type": "object",
|
|
149275
150506
|
"required": [
|
|
149276
150507
|
"id",
|
|
150508
|
+
"batch_id",
|
|
149277
150509
|
"status",
|
|
149278
150510
|
"error_code",
|
|
149279
150511
|
"catalog_source_id",
|
|
@@ -149301,6 +150533,18 @@
|
|
|
149301
150533
|
"format": "uuid",
|
|
149302
150534
|
"type": "string"
|
|
149303
150535
|
},
|
|
150536
|
+
"batch_id": {
|
|
150537
|
+
"description": "The job this work belongs to (`batch_id` of POST /works); null for works created without it.",
|
|
150538
|
+
"anyOf": [
|
|
150539
|
+
{
|
|
150540
|
+
"format": "uuid",
|
|
150541
|
+
"type": "string"
|
|
150542
|
+
},
|
|
150543
|
+
{
|
|
150544
|
+
"type": "null"
|
|
150545
|
+
}
|
|
150546
|
+
]
|
|
150547
|
+
},
|
|
149304
150548
|
"status": {
|
|
149305
150549
|
"anyOf": [
|
|
149306
150550
|
{
|
|
@@ -151159,6 +152403,14 @@
|
|
|
151159
152403
|
}
|
|
151160
152404
|
},
|
|
151161
152405
|
"video": {
|
|
152406
|
+
"description": "Per product, the product-only 5 s video (video_6s) was chosen.",
|
|
152407
|
+
"type": "object",
|
|
152408
|
+
"additionalProperties": {
|
|
152409
|
+
"type": "boolean"
|
|
152410
|
+
}
|
|
152411
|
+
},
|
|
152412
|
+
"video_avatar": {
|
|
152413
|
+
"description": "Per product, the 5 s video with the avatar (video_avatar) was chosen: generated with the avatar the user picks (400 avatar_required without one), next to the product-only video.",
|
|
151162
152414
|
"type": "object",
|
|
151163
152415
|
"additionalProperties": {
|
|
151164
152416
|
"type": "boolean"
|
|
@@ -155376,6 +156628,7 @@
|
|
|
155376
156628
|
"type": "object",
|
|
155377
156629
|
"required": [
|
|
155378
156630
|
"id",
|
|
156631
|
+
"batch_id",
|
|
155379
156632
|
"status",
|
|
155380
156633
|
"error_code",
|
|
155381
156634
|
"catalog_source_id",
|
|
@@ -155403,6 +156656,18 @@
|
|
|
155403
156656
|
"format": "uuid",
|
|
155404
156657
|
"type": "string"
|
|
155405
156658
|
},
|
|
156659
|
+
"batch_id": {
|
|
156660
|
+
"description": "The job this work belongs to (`batch_id` of POST /works); null for works created without it.",
|
|
156661
|
+
"anyOf": [
|
|
156662
|
+
{
|
|
156663
|
+
"format": "uuid",
|
|
156664
|
+
"type": "string"
|
|
156665
|
+
},
|
|
156666
|
+
{
|
|
156667
|
+
"type": "null"
|
|
156668
|
+
}
|
|
156669
|
+
]
|
|
156670
|
+
},
|
|
155406
156671
|
"status": {
|
|
155407
156672
|
"anyOf": [
|
|
155408
156673
|
{
|
|
@@ -157261,6 +158526,14 @@
|
|
|
157261
158526
|
}
|
|
157262
158527
|
},
|
|
157263
158528
|
"video": {
|
|
158529
|
+
"description": "Per product, the product-only 5 s video (video_6s) was chosen.",
|
|
158530
|
+
"type": "object",
|
|
158531
|
+
"additionalProperties": {
|
|
158532
|
+
"type": "boolean"
|
|
158533
|
+
}
|
|
158534
|
+
},
|
|
158535
|
+
"video_avatar": {
|
|
158536
|
+
"description": "Per product, the 5 s video with the avatar (video_avatar) was chosen: generated with the avatar the user picks (400 avatar_required without one), next to the product-only video.",
|
|
157264
158537
|
"type": "object",
|
|
157265
158538
|
"additionalProperties": {
|
|
157266
158539
|
"type": "boolean"
|
|
@@ -158560,7 +159833,7 @@
|
|
|
158560
159833
|
"creative-hub",
|
|
158561
159834
|
"creative-generation"
|
|
158562
159835
|
],
|
|
158563
|
-
"description": "Generates a card of the work. complete_catalog, details and with_model: ONE low-res PREVIEW per product (the first chosen shot), free; the other chosen shots wait on the preview and are generated, as paid shots, when it is redeemed (POST /works/:workId/redeem). with_model takes the chosen suggested shots (shot_ids, default all: the 5 lookbook shots for worn products, up to 4 use actions for the others, e.g. tasting a spread with a spoon) with
|
|
159836
|
+
"description": "Generates a card of the work. complete_catalog, details and with_model: ONE low-res PREVIEW per product (the first chosen shot), free; the other chosen shots wait on the preview and are generated, as paid shots, when it is redeemed (POST /works/:workId/redeem). with_model takes the chosen suggested shots (shot_ids, default all: the 5 lookbook shots for worn products, up to 4 use actions for the others, e.g. tasting a spread with a spoon) with the avatar the user picked (400 avatar_required when a product that shows a person has none: no avatar is ever chosen automatically), and the model profile (model_profile, stored on the work; 400 model_profile_required when the work has none). video: paid at generation, one video per product (a generated start frame, then a 5 s clip from it), worn by the picked avatar or, with none picked, the product alone: the wallet must cover frame + clip of every product before anything starts (402 INSUFFICIENT_CREDITS, nothing charged). Every image comes in the ratio of the product store photo unless aspect_ratio is given; add_shots needs the custom tier (403 plan_required add_shot) and reference_urls too (add_reference); every added shot is checked here (400 custom_prompt_invalid, custom_reference_invalid) before anything starts. A card generates once (409 card_already_generated): then use regenerate. A card the analysis did not propose can be generated too: it is added to the work as a user card (source user, standard shots of the category, no statistics); 400 card_not_applicable when no product can have it. Of several avatars (avatar_ids, or those of the work selection) one that no longer exists is skipped and the others share the products; with_model and video answer 404 avatar_not_found only when none of them is left. Errors: 404 work_not_found, avatar_not_found; 400 shot_not_suggested, card_options_invalid, card_not_applicable, avatar_required, model_profile_required, model_profile_invalid; 409 work_not_ready; 409 card_generation_in_progress while another request is generating the same card (atomic claim, 10-minute lease: no second generation and no second hold); 402 INSUFFICIENT_CREDITS (video).",
|
|
158564
159837
|
"requestBody": {
|
|
158565
159838
|
"required": true,
|
|
158566
159839
|
"content": {
|
|
@@ -158754,6 +160027,10 @@
|
|
|
158754
160027
|
}
|
|
158755
160028
|
}
|
|
158756
160029
|
},
|
|
160030
|
+
"production": {
|
|
160031
|
+
"description": "Photo cards: straight to production, no preview. Every selected shot of the card starts now in full resolution, credits held at generation (402 INSUFFICIENT_CREDITS before anything starts). Ignored on video.",
|
|
160032
|
+
"type": "boolean"
|
|
160033
|
+
},
|
|
158757
160034
|
"shot_ids": {
|
|
158758
160035
|
"maxItems": 10,
|
|
158759
160036
|
"description": "with_model: subset of the suggested shots (400 shot_not_suggested). Absent = all (up to 5 per product: the lookbook set for worn products, the use actions for the others).",
|
|
@@ -162400,12 +163677,12 @@
|
|
|
162400
163677
|
"/api/v1/creative-hub/feed-enhancement/site-audit": {
|
|
162401
163678
|
"post": {
|
|
162402
163679
|
"operationId": "creativeHubFeedEnhancementSiteAudit",
|
|
162403
|
-
"summary": "
|
|
163680
|
+
"summary": "Find the products of a website from its link (with Wavo analysis)",
|
|
162404
163681
|
"tags": [
|
|
162405
163682
|
"creative-hub",
|
|
162406
163683
|
"creative-generation"
|
|
162407
163684
|
],
|
|
162408
|
-
"description": "
|
|
163685
|
+
"description": "Available only with «Fai analizzare a Wavo» (runtime flag feed_pro_analysis_enabled, global or per user): without it, 503 SITE_AUDIT_SUSPENDED. Feed Enrichment audit from the public pages of a website (no store app needed): finds the product pages (Shopify products.json, WooCommerce Store API, else sitemap + JSON-LD Product), counts the photos and videos of each page by content type and says what is missing, with the estimated credits. Only public data of the site, never sales figures. The first 50 physical products (gift cards, digital goods and kids products left out) become Creative Hub products (source url, external_ref <domain>:<handle>) so a Feed work can take them; vision (paid by the platform, free for the caller) classifies their photos within the request time, the rest stays estimated and `verification.pending` says how many a further call verifies. A site read less than 24 hours ago by the team answers from the cache (cache.hit) without reading the site and without using the daily limits; `refresh: true` reads it again. Daily limits per user (Europe/Rome day): 5 different sites, 3 reads of the same site, 10 failed audits (429 with code and resets_at); 5 requests per minute. Errors: 400 url_invalid, 409 site_audit_in_progress (the same site is being read), 422 site_unreadable (anti-bot protection or no answer), no_products_found, platform_unsupported, 504 timeout. With the emergency brake on, the audit runs on rules only.",
|
|
162409
163686
|
"requestBody": {
|
|
162410
163687
|
"required": true,
|
|
162411
163688
|
"content": {
|