@civitai/client 0.1.9-beta.9 → 0.2.0-beta.2

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.
Files changed (73) hide show
  1. package/README.md +0 -0
  2. package/dist/client/CivitaiClient.d.ts +2 -1
  3. package/dist/client/CivitaiClient.js +13 -13
  4. package/dist/generated/client/client.d.ts +2 -0
  5. package/dist/generated/client/client.js +145 -0
  6. package/dist/generated/client/index.d.ts +22 -0
  7. package/dist/generated/client/index.js +4 -0
  8. package/dist/generated/client/types.d.ts +185 -0
  9. package/dist/generated/client/utils.d.ts +72 -0
  10. package/dist/generated/client/utils.js +285 -0
  11. package/dist/generated/client.gen.d.ts +14 -0
  12. package/dist/generated/client.gen.js +3 -0
  13. package/dist/generated/core/auth.d.ts +21 -0
  14. package/dist/generated/core/auth.js +13 -0
  15. package/dist/generated/core/bodySerializer.d.ts +17 -0
  16. package/dist/generated/core/bodySerializer.js +53 -0
  17. package/dist/generated/core/params.d.ts +38 -0
  18. package/dist/generated/core/params.js +88 -0
  19. package/dist/generated/core/pathSerializer.d.ts +49 -0
  20. package/dist/generated/core/pathSerializer.js +105 -0
  21. package/dist/generated/core/types.d.ts +89 -0
  22. package/dist/generated/core/types.js +1 -0
  23. package/dist/generated/index.d.ts +1 -2
  24. package/dist/generated/index.js +2 -6
  25. package/dist/generated/schemas.gen.d.ts +2083 -2028
  26. package/dist/generated/schemas.gen.js +2093 -2031
  27. package/dist/generated/sdk.gen.d.ts +370 -0
  28. package/dist/generated/sdk.gen.js +472 -0
  29. package/dist/generated/services.gen.d.ts +88 -90
  30. package/dist/generated/services.gen.js +100 -147
  31. package/dist/generated/types.gen.d.ts +1545 -1982
  32. package/dist/generated/types.gen.js +70 -134
  33. package/dist/index.js +3 -6
  34. package/dist/utils/Air.js +2 -6
  35. package/dist/utils/TimeSpan.js +24 -28
  36. package/dist/utils/handleError.d.ts +2 -0
  37. package/dist/utils/handleError.js +9 -0
  38. package/dist/utils/index.d.ts +1 -0
  39. package/dist/utils/index.js +4 -6
  40. package/dist/utils/patch-json.js +19 -8
  41. package/dist/utils/types.d.ts +3 -0
  42. package/dist/utils/types.js +1 -0
  43. package/package.json +5 -3
  44. package/dist/client/RequestsClient.d.ts +0 -0
  45. package/dist/client/RequestsClient.js +0 -58
  46. package/dist/generated/GeneratedClient.d.ts +0 -22
  47. package/dist/generated/GeneratedClient.js +0 -40
  48. package/dist/generated/core/ApiError.d.ts +0 -10
  49. package/dist/generated/core/ApiError.js +0 -15
  50. package/dist/generated/core/ApiRequestOptions.d.ts +0 -13
  51. package/dist/generated/core/ApiRequestOptions.js +0 -2
  52. package/dist/generated/core/ApiResult.d.ts +0 -7
  53. package/dist/generated/core/ApiResult.js +0 -2
  54. package/dist/generated/core/AxiosHttpRequest.d.ts +0 -14
  55. package/dist/generated/core/AxiosHttpRequest.js +0 -20
  56. package/dist/generated/core/BaseHttpRequest.d.ts +0 -8
  57. package/dist/generated/core/BaseHttpRequest.js +0 -9
  58. package/dist/generated/core/CancelablePromise.d.ts +0 -37
  59. package/dist/generated/core/CancelablePromise.js +0 -93
  60. package/dist/generated/core/FetchHttpRequest.d.ts +0 -14
  61. package/dist/generated/core/FetchHttpRequest.js +0 -20
  62. package/dist/generated/core/OpenAPI.d.ts +0 -27
  63. package/dist/generated/core/OpenAPI.js +0 -33
  64. package/dist/generated/core/request.d.ts +0 -49
  65. package/dist/generated/core/request.js +0 -325
  66. package/dist/generated/enums.gen.d.ts +0 -97
  67. package/dist/generated/enums.gen.js +0 -101
  68. package/dist/utils/CivitaiClientError.d.ts +0 -0
  69. package/dist/utils/CivitaiClientError.js +0 -4
  70. package/dist/utils/CivitaiError.d.ts +0 -5
  71. package/dist/utils/CivitaiError.js +0 -13
  72. package/dist/utils/createClient.js +0 -119
  73. /package/dist/{utils/createClient.d.ts → generated/client/types.js} +0 -0
@@ -4,25 +4,10 @@ export type AgeClassificationInput = {
4
4
  */
5
5
  model?: string | null;
6
6
  /**
7
- * The URL of the media to classify
7
+ * The URL of the media to classify. This can either be a URL to an image or a video or a ZIP containing multiple images
8
8
  */
9
9
  mediaUrl: string;
10
10
  };
11
- export type AgeClassificationJob = Job & {
12
- model?: string | null;
13
- mediaUrl: string;
14
- destinationBlobKey: string;
15
- destinationUrl: string;
16
- failOnMinorDetected: boolean;
17
- readonly claimDuration?: string;
18
- readonly type?: string;
19
- } & {
20
- $type: 'ageClassification';
21
- };
22
- export type $type = 'ageClassification';
23
- export declare const $type: {
24
- readonly AGE_CLASSIFICATION: 'ageClassification';
25
- };
26
11
  export type AgeClassificationOutput = {
27
12
  labels: {
28
13
  [key: string]: Array<AgeClassifierLabel>;
@@ -30,18 +15,29 @@ export type AgeClassificationOutput = {
30
15
  hasMinor: boolean;
31
16
  prediction: AgeClassificationPrediction;
32
17
  };
33
- export type AgeClassificationPrediction = 'pass' | 'fail';
34
18
  export declare const AgeClassificationPrediction: {
35
19
  readonly PASS: 'pass';
36
20
  readonly FAIL: 'fail';
37
21
  };
22
+ export type AgeClassificationPrediction =
23
+ (typeof AgeClassificationPrediction)[keyof typeof AgeClassificationPrediction];
24
+ /**
25
+ * Age classification
26
+ */
38
27
  export type AgeClassificationStep = WorkflowStep & {
28
+ $type: 'ageClassification';
29
+ } & {
39
30
  input: AgeClassificationInput;
40
31
  output?: AgeClassificationOutput;
41
32
  } & {
42
33
  $type: 'ageClassification';
43
34
  };
35
+ /**
36
+ * Age classification
37
+ */
44
38
  export type AgeClassificationStepTemplate = WorkflowStepTemplate & {
39
+ $type: 'ageClassification';
40
+ } & {
45
41
  input: AgeClassificationInput;
46
42
  } & {
47
43
  $type: 'ageClassification';
@@ -51,42 +47,22 @@ export type AgeClassifierLabel = {
51
47
  isMinor: boolean;
52
48
  boundingBox: Array<number>;
53
49
  };
54
- export type BatchOCRSafetyClassificationInput = {
55
- mediaUrls: Array<string>;
56
- };
57
- export type BatchOCRSafetyClassificationJob = Job & {
50
+ export type BatchOcrSafetyClassificationInput = {
58
51
  mediaUrls: Array<string>;
59
- readonly type?: string;
60
- } & {
61
- $type: 'batchOCRSafetyClassification';
62
- };
63
- export type $type2 = 'batchOCRSafetyClassification';
64
- export declare const $type2: {
65
- readonly BATCH_OCRSAFETY_CLASSIFICATION: 'batchOCRSafetyClassification';
66
52
  };
67
- export type BatchOCRSafetyClassificationOutput = {
68
- results: Array<BatchOCRSafetyClassificationResult>;
53
+ export type BatchOcrSafetyClassificationOutput = {
54
+ results: Array<BatchOcrSafetyClassificationResult>;
69
55
  };
70
- export type BatchOCRSafetyClassificationResult = {
56
+ export type BatchOcrSafetyClassificationResult = {
71
57
  mediaUrl: string;
72
58
  classification: string;
73
59
  text?: string | null;
74
60
  };
75
- export type BatchOCRSafetyClassificationStep = WorkflowStep & {
76
- input: BatchOCRSafetyClassificationInput;
77
- output?: BatchOCRSafetyClassificationOutput;
78
- } & {
79
- $type: 'batchOCRSafetyClassification';
80
- };
81
- export type BatchOCRSafetyClassificationStepTemplate = WorkflowStepTemplate & {
82
- input: BatchOCRSafetyClassificationInput;
83
- } & {
84
- $type: 'batchOCRSafetyClassification';
85
- };
86
61
  /**
87
62
  * Represents a blob that gets produced as part of a specific job
88
63
  */
89
64
  export type Blob = {
65
+ type: string;
90
66
  /**
91
67
  * Gets the id of the blob that contains this image.
92
68
  */
@@ -107,13 +83,19 @@ export type Blob = {
107
83
  * Get the id of the job that is associated with this blob.
108
84
  */
109
85
  jobId?: string | null;
110
- nsfwLevel?: NSFWLevel;
86
+ nsfwLevel?: NsfwLevel;
87
+ /**
88
+ * Get an optional reason for why the blob was blocked. This is only set if the blob was blocked.
89
+ */
90
+ blockedReason?: string | null;
111
91
  };
112
- export type BuzzClientAccount = 'user' | 'generation';
113
92
  export declare const BuzzClientAccount: {
114
- readonly USER: 'user';
115
- readonly GENERATION: 'generation';
93
+ readonly YELLOW: 'yellow';
94
+ readonly BLUE: 'blue';
95
+ readonly GREEN: 'green';
96
+ readonly FAKE_RED: 'fakeRed';
116
97
  };
98
+ export type BuzzClientAccount = (typeof BuzzClientAccount)[keyof typeof BuzzClientAccount];
117
99
  export type ComfyInput = {
118
100
  /**
119
101
  * Get the comfy workflow that needs to be executed
@@ -129,44 +111,10 @@ export type ComfyInput = {
129
111
  * External metadata that will be stored with the image
130
112
  */
131
113
  imageMetadata?: string | null;
132
- };
133
- export type ComfyJob = Job & {
134
- /**
135
- * A untyped set of parameters that are associated with this job
136
- */
137
- params: {
138
- [key: string]: ComfyNode;
139
- };
140
- resources?: Array<string> | null;
141
- /**
142
- * Slots for the resulting blob outputs.
143
- */
144
- slots: Array<ComfyJobSlot>;
145
- /**
146
- * Get or set additional metadata that will be embedded with generated images
147
- */
148
- imageMetadata?: string | null;
149
- readonly type?: string;
150
- readonly claimDuration?: string;
151
- } & {
152
- $type: 'comfy';
153
- };
154
- export type $type3 = 'comfy';
155
- export declare const $type3: {
156
- readonly COMFY: 'comfy';
157
- };
158
- /**
159
- * Contains slot information for a blob generated by a ComfyJob.
160
- */
161
- export type ComfyJobSlot = {
162
114
  /**
163
- * The hash for the blob output.
115
+ * Opt-into using the spine controller exclusively
164
116
  */
165
- blobKey: string;
166
- /**
167
- * The destination url for blob upload.
168
- */
169
- destinationUrl: string;
117
+ useSpineComfy?: boolean | null;
170
118
  };
171
119
  export type ComfyNode = {
172
120
  classType: string;
@@ -184,59 +132,36 @@ export type ComfyOutput = {
184
132
  */
185
133
  blobs?: Array<Blob>;
186
134
  };
135
+ /**
136
+ * Comfy workflows
137
+ */
187
138
  export type ComfyStep = WorkflowStep & {
139
+ $type: 'comfy';
140
+ } & {
188
141
  input: ComfyInput;
189
142
  output?: ComfyOutput;
190
143
  } & {
191
144
  $type: 'comfy';
192
145
  };
146
+ /**
147
+ * Comfy workflows
148
+ */
193
149
  export type ComfyStepTemplate = WorkflowStepTemplate & {
150
+ $type: 'comfy';
151
+ } & {
194
152
  input: ComfyInput;
195
153
  } & {
196
154
  $type: 'comfy';
197
155
  };
198
- export type ConfigurationOptions = {
199
- /**
200
- * Get or set the priority of this configuration if multiple configurations apply to the same worker
201
- */
202
- priority?: number;
203
- selector: Expression;
204
- /**
205
- * Get or set the specification associated with this configuration
206
- */
207
- spec: unknown;
208
- };
209
- export type ConfigurationStatus = {
210
- configurationId: string;
211
- assigned?: number;
212
- targeted?: number;
213
- applied?: number;
214
- };
215
- export type ContainerFormat = 'mp4' | 'webM';
216
156
  export declare const ContainerFormat: {
217
157
  readonly MP4: 'mp4';
218
158
  readonly WEB_M: 'webM';
219
159
  };
220
- export type CreateConfigurationResult = {
221
- configurationId: string;
222
- };
223
- export type CreateWorkerResult = {
224
- workerId: string;
225
- };
160
+ export type ContainerFormat = (typeof ContainerFormat)[keyof typeof ContainerFormat];
226
161
  export type CursedArrayOfTelemetryCursorAndWorkflow = {
227
162
  next: string;
228
163
  items: Array<Workflow>;
229
164
  };
230
- export type DownloadSource = 'default' | 'tigris';
231
- export declare const DownloadSource: {
232
- readonly DEFAULT: 'default';
233
- readonly TIGRIS: 'tigris';
234
- };
235
- export type DynamicAssignment = {
236
- fromPath: string;
237
- toPath: string;
238
- defaultValue?: unknown;
239
- };
240
165
  /**
241
166
  * Represents the input information needed for the Echo workflow step.
242
167
  */
@@ -256,26 +181,26 @@ export type EchoOutput = {
256
181
  message: string;
257
182
  };
258
183
  /**
259
- * A workflow step that takes a message string and retuns it.
184
+ * Echo
260
185
  */
261
186
  export type EchoStep = WorkflowStep & {
187
+ $type: 'echo';
188
+ } & {
262
189
  input: EchoInput;
263
190
  output?: EchoOutput;
264
191
  } & {
265
192
  $type: 'echo';
266
193
  };
267
- export type $type4 = 'echo';
268
- export declare const $type4: {
269
- readonly ECHO: 'echo';
270
- };
194
+ /**
195
+ * Echo
196
+ */
271
197
  export type EchoStepTemplate = WorkflowStepTemplate & {
198
+ $type: 'echo';
199
+ } & {
272
200
  input: EchoInput;
273
201
  } & {
274
202
  $type: 'echo';
275
203
  };
276
- export type EcosystemElement = {
277
- [key: string]: EcosystemElement;
278
- };
279
204
  /**
280
205
  * An epock result.
281
206
  */
@@ -298,16 +223,6 @@ export type EpochResult = {
298
223
  */
299
224
  blobUrl: string;
300
225
  };
301
- export type Expression = {
302
- [key: string]: unknown;
303
- };
304
- export type FileFormat =
305
- | 'unknown'
306
- | 'safeTensor'
307
- | 'pickleTensor'
308
- | 'diffusers'
309
- | 'coreML'
310
- | 'onnx';
311
226
  export declare const FileFormat: {
312
227
  readonly UNKNOWN: 'unknown';
313
228
  readonly SAFE_TENSOR: 'safeTensor';
@@ -316,40 +231,58 @@ export declare const FileFormat: {
316
231
  readonly CORE_ML: 'coreML';
317
232
  readonly ONNX: 'onnx';
318
233
  };
319
- export type FluxDevFastImageResourceTrainingInput = ImageResourceTrainingInput & {
320
- [key: string]: unknown;
234
+ export type FileFormat = (typeof FileFormat)[keyof typeof FileFormat];
235
+ export type Flux1KontextDevImageGenInput = Flux1KontextImageGenInput & {
236
+ readonly model: string;
321
237
  } & {
322
- engine: 'flux-dev-fast';
238
+ model: 'dev';
323
239
  };
324
- export type engine = 'flux-dev-fast';
325
- export declare const engine: {
326
- readonly FLUX_DEV_FAST: 'flux-dev-fast';
240
+ export type Flux1KontextImageGenInput = ImageGenInput & {
241
+ engine: 'flux1-kontext';
242
+ } & {
243
+ readonly model: string;
244
+ prompt: string;
245
+ images?: Array<string>;
246
+ aspectRatio?: '21:9' | '16:9' | '4:3' | '3:2' | '1:1' | '2:3' | '3:4' | '9:16' | '9:21';
247
+ outputFormat?: 'jpeg' | 'png';
248
+ guidanceScale?: number;
249
+ quantity?: number;
250
+ seed?: number | null;
251
+ } & {
252
+ engine: 'flux1-kontext';
327
253
  };
328
- export type GateJob = Job & {
329
- readonly type?: string;
254
+ export type Flux1KontextMaxImageGenInput = Flux1KontextImageGenInput & {
255
+ readonly model: string;
330
256
  } & {
331
- $type: 'gate';
257
+ model: 'max';
332
258
  };
333
- export type $type5 = 'gate';
334
- export declare const $type5: {
335
- readonly GATE: 'gate';
259
+ export type Flux1KontextProImageGenInput = Flux1KontextImageGenInput & {
260
+ readonly model: string;
261
+ } & {
262
+ model: 'pro';
336
263
  };
337
- export type HaiperVideoGenAspectRatio = '16:9' | '4:3' | '1:1' | '9:16' | '3:4';
338
- export declare const HaiperVideoGenAspectRatio: {
339
- readonly _16_9: '16:9';
340
- readonly _4_3: '4:3';
341
- readonly _1_1: '1:1';
342
- readonly _9_16: '9:16';
343
- readonly _3_4: '3:4';
264
+ export type FluxDevFastImageResourceTrainingInput = ImageResourceTrainingInput & {
265
+ engine: 'flux-dev-fast';
266
+ } & {} & {
267
+ engine: 'flux-dev-fast';
344
268
  };
345
- export type HaiperVideoGenCameraMovement =
346
- | 'none'
347
- | 'panRight'
348
- | 'panLeft'
349
- | 'tiltUp'
350
- | 'tiltDown'
351
- | 'zoomIn'
352
- | 'zoomOut';
269
+ export type GoogleImageGenInput = ImageGenInput & {
270
+ engine: 'google';
271
+ } & {
272
+ model: string;
273
+ prompt: string;
274
+ } & {
275
+ engine: 'google';
276
+ };
277
+ export declare const HaiperVideoGenAspectRatio: {
278
+ readonly '16:9': '16:9';
279
+ readonly '4:3': '4:3';
280
+ readonly '1:1': '1:1';
281
+ readonly '9:16': '9:16';
282
+ readonly '3:4': '3:4';
283
+ };
284
+ export type HaiperVideoGenAspectRatio =
285
+ (typeof HaiperVideoGenAspectRatio)[keyof typeof HaiperVideoGenAspectRatio];
353
286
  export declare const HaiperVideoGenCameraMovement: {
354
287
  readonly NONE: 'none';
355
288
  readonly PAN_RIGHT: 'panRight';
@@ -359,97 +292,106 @@ export declare const HaiperVideoGenCameraMovement: {
359
292
  readonly ZOOM_IN: 'zoomIn';
360
293
  readonly ZOOM_OUT: 'zoomOut';
361
294
  };
295
+ export type HaiperVideoGenCameraMovement =
296
+ (typeof HaiperVideoGenCameraMovement)[keyof typeof HaiperVideoGenCameraMovement];
362
297
  export type HaiperVideoGenInput = VideoGenInput & {
363
- negativePrompt?: string | null;
364
- cameraMovement?: HaiperVideoGenCameraMovement;
365
- seed?: number;
366
- duration?: number;
367
- aspectRatio?: HaiperVideoGenAspectRatio;
368
- sourceImageUrl?: string | null;
369
- model?: HaiperVideoGenModel;
370
- resolution?: number;
371
- } & {
372
298
  engine: 'haiper';
373
- };
374
- export type engine2 = 'haiper';
375
- export declare const engine2: {
376
- readonly HAIPER: 'haiper';
377
- };
378
- export type HaiperVideoGenJob = Job & {
379
- mediaHash: string;
380
- prompt: string;
299
+ } & {
381
300
  negativePrompt?: string | null;
382
301
  cameraMovement?: HaiperVideoGenCameraMovement;
383
302
  seed?: number;
384
- duration?: number;
303
+ duration?: 2 | 4 | 8;
385
304
  aspectRatio?: HaiperVideoGenAspectRatio;
386
- destinationUrl: string;
387
- sourceImageUrl?: string | null;
388
305
  model?: HaiperVideoGenModel;
389
- resolution?: number;
390
- readonly claimDuration?: string;
391
- readonly type?: string;
306
+ resolution?: 720 | 1080 | 2160;
307
+ enablePromptEnhancer?: boolean;
308
+ /**
309
+ * Either A URL, A DataURL or a Base64 string
310
+ */
311
+ sourceImage?: string | null;
392
312
  } & {
393
- $type: 'haiper';
394
- };
395
- export type $type6 = 'haiper';
396
- export declare const $type6: {
397
- readonly HAIPER: 'haiper';
313
+ engine: 'haiper';
398
314
  };
399
- export type HaiperVideoGenModel = 'v1_5' | 'v2';
400
315
  export declare const HaiperVideoGenModel: {
401
316
  readonly V1_5: 'v1_5';
402
317
  readonly V2: 'v2';
403
318
  };
319
+ export type HaiperVideoGenModel = (typeof HaiperVideoGenModel)[keyof typeof HaiperVideoGenModel];
404
320
  export type HaiperVideoGenOutput = VideoGenOutput & {
405
321
  progress?: number | null;
322
+ externalTOSViolation?: boolean | null;
323
+ message?: string | null;
406
324
  };
407
- export type HumanoidImageMaskCategory = 'dresses' | 'upperBody' | 'lowerBody';
408
325
  export declare const HumanoidImageMaskCategory: {
409
326
  readonly DRESSES: 'dresses';
410
327
  readonly UPPER_BODY: 'upperBody';
411
328
  readonly LOWER_BODY: 'lowerBody';
412
329
  };
330
+ export type HumanoidImageMaskCategory =
331
+ (typeof HumanoidImageMaskCategory)[keyof typeof HumanoidImageMaskCategory];
413
332
  export type HumanoidImageMaskInput = {
414
333
  imageUrl: string;
415
334
  category: HumanoidImageMaskCategory;
416
335
  };
417
- export type HumanoidImageMaskJob = Job & {
418
- imageUrl: string;
419
- category: HumanoidImageMaskCategory;
420
- destinationBlobKey: string;
421
- readonly type?: string;
422
- readonly claimDuration?: string;
423
- } & {
424
- $type: 'humanoidImageMask';
425
- };
426
- export type $type7 = 'humanoidImageMask';
427
- export declare const $type7: {
428
- readonly HUMANOID_IMAGE_MASK: 'humanoidImageMask';
429
- };
430
336
  export type HumanoidImageMaskOutput = {
431
337
  blob: Blob;
432
338
  };
433
- export type HumanoidImageMaskStep = WorkflowStep & {
434
- input: HumanoidImageMaskInput;
435
- output?: HumanoidImageMaskOutput;
339
+ export type HunyuanVdeoGenInput = VideoGenInput & {
340
+ engine: 'hunyuan';
436
341
  } & {
437
- $type: 'humanoidImageMask';
342
+ cfgScale?: number;
343
+ frameRate?: number;
344
+ duration?: number;
345
+ seed?: number | null;
346
+ steps?: number;
347
+ width?: number;
348
+ height?: number;
349
+ loras?: Array<VideoGenInputLora>;
350
+ model?: string | null;
351
+ } & {
352
+ engine: 'hunyuan';
438
353
  };
439
- export type HumanoidImageMaskStepTemplate = WorkflowStepTemplate & {
440
- input: HumanoidImageMaskInput;
354
+ export type ImageBlob = Blob & {
355
+ type: 'image';
441
356
  } & {
442
- $type: 'humanoidImageMask';
357
+ width?: number | null;
358
+ height?: number | null;
359
+ } & {
360
+ type: 'image';
443
361
  };
444
- export type ImageEmbeddingJob = Job & {
445
- imageUrl: string;
446
- readonly type?: string;
362
+ export type ImageGenInput = {
363
+ engine: string;
364
+ };
365
+ export type ImageGenInputLora = {
366
+ air: string;
367
+ strength?: number;
368
+ };
369
+ export type ImageGenOutput = {
370
+ /**
371
+ * A collection of output images.
372
+ */
373
+ images: Array<ImageBlob>;
374
+ };
375
+ /**
376
+ * Image Generation
377
+ */
378
+ export type ImageGenStep = WorkflowStep & {
379
+ $type: 'imageGen';
447
380
  } & {
448
- $type: 'imageEmbedding';
381
+ input: ImageGenInput;
382
+ output?: ImageGenOutput;
383
+ } & {
384
+ $type: 'imageGen';
449
385
  };
450
- export type $type8 = 'imageEmbedding';
451
- export declare const $type8: {
452
- readonly IMAGE_EMBEDDING: 'imageEmbedding';
386
+ /**
387
+ * Image Generation
388
+ */
389
+ export type ImageGenStepTemplate = WorkflowStepTemplate & {
390
+ $type: 'imageGen';
391
+ } & {
392
+ input: ImageGenInput;
393
+ } & {
394
+ $type: 'imageGen';
453
395
  };
454
396
  /**
455
397
  * Information for a controlnet provided for a text to image input.
@@ -483,55 +425,14 @@ export type ImageJobNetworkParams = {
483
425
  */
484
426
  type?: string | null;
485
427
  };
486
- /**
487
- * Parameters for a text to image step.
488
- */
489
- export type ImageJobParams = {
490
- /**
491
- * The prompt for the text to image generation.
492
- */
493
- prompt?: string | null;
494
- /**
495
- * The negative prompt for the text to image generation.
496
- */
497
- negativePrompt?: string | null;
498
- scheduler?: Scheduler;
499
- /**
500
- * The number of steps for the text to image generation.
501
- */
502
- steps?: number;
503
- /**
504
- * The CFG scale value for the text to image generation.
505
- */
506
- cfgScale?: number | null;
507
- /**
508
- * The width for the image to be generated in pixels.
509
- */
510
- width: number;
511
- /**
512
- * The height for the image to be generated in pixels.
513
- */
514
- height: number;
515
- /**
516
- * The seed for the text to image generation.
517
- */
518
- seed?: number;
519
- /**
520
- * The clip skip value for the text to image generation.
521
- */
522
- clipSkip?: number;
523
- };
524
- export type ImageResouceTrainingModerationStatus =
525
- | 'evaluating'
526
- | 'underReview'
527
- | 'approved'
528
- | 'rejected';
529
428
  export declare const ImageResouceTrainingModerationStatus: {
530
429
  readonly EVALUATING: 'evaluating';
531
430
  readonly UNDER_REVIEW: 'underReview';
532
431
  readonly APPROVED: 'approved';
533
432
  readonly REJECTED: 'rejected';
534
433
  };
434
+ export type ImageResouceTrainingModerationStatus =
435
+ (typeof ImageResouceTrainingModerationStatus)[keyof typeof ImageResouceTrainingModerationStatus];
535
436
  /**
536
437
  * Input for an image resource training step.
537
438
  */
@@ -558,45 +459,6 @@ export type ImageResourceTrainingInput = {
558
459
  */
559
460
  samplePrompts?: Array<string>;
560
461
  };
561
- export type ImageResourceTrainingJob = Job & {
562
- /**
563
- * An AIR representing the model to use.
564
- */
565
- model: string;
566
- /**
567
- * A url referring data that needs to be trained upon
568
- */
569
- trainingData: string;
570
- /**
571
- * A untyped set of parameters that are associated with this job
572
- */
573
- params: {
574
- [key: string]: unknown;
575
- };
576
- /**
577
- * An application provided output of the current status of this job
578
- */
579
- output?: string | null;
580
- /**
581
- * The engine that should be used for training
582
- */
583
- engine?: string | null;
584
- /**
585
- * The job type.
586
- */
587
- readonly type?: string;
588
- /**
589
- * Rick: yeah i think for LoRA we need it to be 5-10 minutes.
590
- * lora training has this lame effect where it can't send updates while it is uploading... so we need to give it extra buffer
591
- */
592
- readonly claimDuration?: string;
593
- } & {
594
- $type: 'imageResourceTraining';
595
- };
596
- export type $type9 = 'imageResourceTraining';
597
- export declare const $type9: {
598
- readonly IMAGE_RESOURCE_TRAINING: 'imageResourceTraining';
599
- };
600
462
  export type ImageResourceTrainingOutput = {
601
463
  moderationStatus: ImageResouceTrainingModerationStatus;
602
464
  /**
@@ -607,6 +469,10 @@ export type ImageResourceTrainingOutput = {
607
469
  * The selected prompts for sample images
608
470
  */
609
471
  sampleImagesPrompts: Array<string>;
472
+ /**
473
+ * The selected images for sample images
474
+ */
475
+ sampleInputImages?: Array<string> | null;
610
476
  /**
611
477
  * Get wether the blobs are actually stored as assets
612
478
  * Assets are deprecated and require a different retrieval mechanism
@@ -618,51 +484,26 @@ export type ImageResourceTrainingOutput = {
618
484
  eta?: number | null;
619
485
  };
620
486
  /**
621
- * A workflow step for training image resources.
487
+ * LORA Training
622
488
  */
623
489
  export type ImageResourceTrainingStep = WorkflowStep & {
490
+ $type: 'imageResourceTraining';
491
+ } & {
624
492
  input: ImageResourceTrainingInput;
625
493
  output?: ImageResourceTrainingOutput;
626
494
  } & {
627
495
  $type: 'imageResourceTraining';
628
496
  };
497
+ /**
498
+ * LORA Training
499
+ */
629
500
  export type ImageResourceTrainingStepTemplate = WorkflowStepTemplate & {
501
+ $type: 'imageResourceTraining';
502
+ } & {
630
503
  input: ImageResourceTrainingInput;
631
504
  } & {
632
505
  $type: 'imageResourceTraining';
633
506
  };
634
- export type ImageTransformJob = Job & {
635
- /**
636
- * The url of the image to transform
637
- */
638
- imageUrl?: string;
639
- transformer?: ImageTransformer;
640
- /**
641
- * Get the key of the destination blob to upload the result to
642
- */
643
- destinationBlobKey?: string;
644
- /**
645
- * A untyped set of parameters that are associated with this job
646
- */
647
- params?: {
648
- [key: string]: unknown;
649
- };
650
- /**
651
- * Get or set the URL where the transformed image will be uploaded to
652
- */
653
- destinationUrl?: string | null;
654
- readonly type?: string;
655
- } & {
656
- $type: 'imageTransform';
657
- };
658
- export type $type10 = 'imageTransform';
659
- export declare const $type10: {
660
- readonly IMAGE_TRANSFORM: 'imageTransform';
661
- };
662
- /**
663
- * Available image transformers.
664
- */
665
- export type ImageTransformer = 'canny' | 'depthZoe' | 'softedgePidinet' | 'rembg';
666
507
  /**
667
508
  * Available image transformers.
668
509
  */
@@ -672,146 +513,169 @@ export declare const ImageTransformer: {
672
513
  readonly SOFTEDGE_PIDINET: 'softedgePidinet';
673
514
  readonly REMBG: 'rembg';
674
515
  };
675
- export type Job = {
676
- $type: string;
516
+ /**
517
+ * Available image transformers.
518
+ */
519
+ export type ImageTransformer = (typeof ImageTransformer)[keyof typeof ImageTransformer];
520
+ export type ImageUploadOutput = {
521
+ blob: Blob;
522
+ };
523
+ /**
524
+ * Image upload
525
+ */
526
+ export type ImageUploadStep = WorkflowStep & {
527
+ $type: 'imageUpload';
528
+ } & {
677
529
  /**
678
- * A unique id for this job
530
+ * The workflow's input.
679
531
  */
680
- id?: string;
532
+ input: string;
533
+ output?: ImageUploadOutput;
534
+ } & {
535
+ $type: 'imageUpload';
536
+ };
537
+ /**
538
+ * Image upload
539
+ */
540
+ export type ImageUploadStepTemplate = WorkflowStepTemplate & {
541
+ $type: 'imageUpload';
542
+ } & {
681
543
  /**
682
- * The date when this job got created
544
+ * Input for the ImageUploadStep step.
683
545
  */
684
- createdAt?: string;
546
+ input: string | null;
547
+ } & {
548
+ $type: 'imageUpload';
549
+ };
550
+ export type Imagen4ImageGenInput = GoogleImageGenInput & {
551
+ prompt: string;
552
+ negativePrompt?: string;
553
+ aspectRatio?: '1:1' | '16:9' | '9:16' | '3:4' | '4:3';
554
+ numImages?: number;
555
+ seed?: number | null;
556
+ } & {
557
+ model: 'imagen4';
558
+ };
559
+ /**
560
+ * Available levels of job support.
561
+ */
562
+ export declare const JobSupport: {
563
+ readonly UNSUPPORTED: 'unsupported';
564
+ readonly UNAVAILABLE: 'unavailable';
565
+ readonly AVAILABLE: 'available';
566
+ };
567
+ /**
568
+ * Available levels of job support.
569
+ */
570
+ export type JobSupport = (typeof JobSupport)[keyof typeof JobSupport];
571
+ /**
572
+ * Array of operations to perform
573
+ */
574
+ export type JsonPatchDocument = Array<JsonPatchOperation>;
575
+ /**
576
+ * Describes a single operation in a JSON Patch document. Includes the operation type, the target property path, and the value to be used.
577
+ */
578
+ export type JsonPatchOperation = {
685
579
  /**
686
- * The date for when this job was set to expire
580
+ * The operation type. Allowed values: 'add', 'remove', 'replace', 'move', 'copy', 'test'.
687
581
  */
688
- expireAt?: string | null;
582
+ op: 'add' | 'remove' | 'replace' | 'move' | 'copy' | 'test';
689
583
  /**
690
- * A webhook to be invoked when the job receives a status update
584
+ * The JSON Pointer path to the property in the target document where the operation is to be applied.
691
585
  */
692
- webhook?: string | null;
586
+ path: string;
693
587
  /**
694
- * A set of user defined properties that can be used to index and partition this job
588
+ * Should be a path, required when using move, copy
695
589
  */
696
- properties?: {
697
- [key: string]: unknown;
698
- };
699
- /**
700
- * The type of this job as a string
701
- */
702
- type?: string;
703
- /**
704
- * Get a cost for this job
705
- */
706
- cost?: number;
707
- /**
708
- * The max number of retries before we give up
709
- */
710
- maxRetryAttempt?: number;
590
+ from?: string;
711
591
  /**
712
- * Get or set a list of dependencies that this job has
592
+ * The value to apply for 'add', 'replace', or 'test' operations. Not required for 'remove', 'move', or 'copy'.
713
593
  */
714
- dependencies?: {
715
- [key: string]: Array<DynamicAssignment>;
716
- };
594
+ value?:
595
+ | string
596
+ | number
597
+ | boolean
598
+ | {
599
+ [key: string]: unknown;
600
+ }
601
+ | Array<unknown>
602
+ | null;
603
+ };
604
+ export type KlingCameraControl = {
605
+ config?: KlingCameraControlConfig;
606
+ };
607
+ export type KlingCameraControlConfig = {
717
608
  /**
718
- * Get or set the name of the consumer that issued this job
609
+ * Horizontal, controls the camera's movement along the horizontal axis (translation along the x-axis).
719
610
  */
720
- issuedBy?: string | null;
611
+ horizontal?: number | null;
721
612
  /**
722
- * Get or set the version of this job, this is used to track changes to the job schema
613
+ * Vertical, controls the camera's movement along the vertical axis (translation along the y-axis).
723
614
  */
724
- version?: number;
615
+ vertical?: number | null;
725
616
  /**
726
- * Get or set a list of dependencies that this job has
617
+ * Pan, controls the camera's rotation in the horizontal plane (rotation around the y-axis).
727
618
  */
728
- jobDependencies?: Array<JobDependency>;
619
+ pan?: number | null;
729
620
  /**
730
- * The total duration that the job can be claimed
621
+ * Tilt, controls the camera's rotation in the horizontal plane (rotation around the y-axis).
731
622
  */
732
- claimDuration?: string;
623
+ tilt?: number | null;
733
624
  /**
734
- * Get a list of resources that this job depends on
625
+ * Roll, controls the camera's rolling amount (rotation around the z-axis).
735
626
  */
736
- resources?: Array<string>;
627
+ roll?: number | null;
737
628
  /**
738
- * An internal property to mark that the job has been recovered. We use this to not fiddle with up/down counters as we may have missed other counters
629
+ * Zoom, controls the change in the camera's focal length, affecting the proximity of the field of view.
739
630
  */
740
- recovered?: boolean;
741
- };
742
- export type JobDependency = {
743
- jobId?: string;
744
- onFailure?: JobDependencyContinuation;
745
- onSuccess?: JobDependencyContinuation;
746
- dynamicAssignments?: Array<DynamicAssignment>;
631
+ zoom?: number | null;
747
632
  };
748
- export type JobDependencyContinuation = 'fail' | 'skip' | 'continue';
749
- export declare const JobDependencyContinuation: {
750
- readonly FAIL: 'fail';
751
- readonly SKIP: 'skip';
752
- readonly CONTINUE: 'continue';
633
+ export declare const KlingMode: {
634
+ readonly STANDARD: 'standard';
635
+ readonly PROFESSIONAL: 'professional';
753
636
  };
754
- /**
755
- * Available levels of job support.
756
- */
757
- export type JobSupport = 'unsupported' | 'unavailable' | 'available';
758
- /**
759
- * Available levels of job support.
760
- */
761
- export declare const JobSupport: {
762
- readonly UNSUPPORTED: 'unsupported';
763
- readonly UNAVAILABLE: 'unavailable';
764
- readonly AVAILABLE: 'available';
637
+ export type KlingMode = (typeof KlingMode)[keyof typeof KlingMode];
638
+ export declare const KlingModel: {
639
+ readonly V1: 'v1';
640
+ readonly V1_5: 'v1_5';
641
+ readonly V1_6: 'v1_6';
642
+ readonly V2: 'v2';
765
643
  };
766
- /**
767
- * Array of operations to perform
768
- */
769
- export type JsonPatchDocument = Array<JsonPatchOperation>;
770
- /**
771
- * Describes a single operation in a JSON Patch document. Includes the operation type, the target property path, and the value to be used.
772
- */
773
- export type JsonPatchOperation = {
774
- /**
775
- * The operation type. Allowed values: 'add', 'remove', 'replace', 'move', 'copy', 'test'.
776
- */
777
- op: 'add' | 'remove' | 'replace' | 'move' | 'copy' | 'test';
778
- /**
779
- * The JSON Pointer path to the property in the target document where the operation is to be applied.
780
- */
781
- path: string;
782
- /**
783
- * Should be a path, required when using move, copy
784
- */
785
- from?: string;
644
+ export type KlingModel = (typeof KlingModel)[keyof typeof KlingModel];
645
+ export declare const KlingVideoGenAspectRatio: {
646
+ readonly '16:9': '16:9';
647
+ readonly '9:16': '9:16';
648
+ readonly '1:1': '1:1';
649
+ };
650
+ export type KlingVideoGenAspectRatio =
651
+ (typeof KlingVideoGenAspectRatio)[keyof typeof KlingVideoGenAspectRatio];
652
+ export declare const KlingVideoGenDuration: {
653
+ readonly 5: '5';
654
+ readonly 10: '10';
655
+ };
656
+ export type KlingVideoGenDuration =
657
+ (typeof KlingVideoGenDuration)[keyof typeof KlingVideoGenDuration];
658
+ export type KlingVideoGenInput = VideoGenInput & {
659
+ engine: 'kling';
660
+ } & {
661
+ model?: KlingModel;
662
+ negativePrompt?: string | null;
663
+ cfgScale?: number;
664
+ mode?: KlingMode;
665
+ aspectRatio?: KlingVideoGenAspectRatio;
666
+ duration?: KlingVideoGenDuration;
667
+ cameraControl?: KlingCameraControl;
668
+ sourceImageUrl?: string | null;
786
669
  /**
787
- * The value to apply for 'add', 'replace', or 'test' operations. Not required for 'remove', 'move', or 'copy'.
670
+ * Either A URL, A DataURL or a Base64 string
788
671
  */
789
- value?:
790
- | string
791
- | number
792
- | boolean
793
- | {
794
- [key: string]: unknown;
795
- }
796
- | unknown[]
797
- | null;
798
- };
799
- /**
800
- * The operation type. Allowed values: 'add', 'remove', 'replace', 'move', 'copy', 'test'.
801
- */
802
- export type op = 'add' | 'remove' | 'replace' | 'move' | 'copy' | 'test';
803
- /**
804
- * The operation type. Allowed values: 'add', 'remove', 'replace', 'move', 'copy', 'test'.
805
- */
806
- export declare const op: {
807
- readonly ADD: 'add';
808
- readonly REMOVE: 'remove';
809
- readonly REPLACE: 'replace';
810
- readonly MOVE: 'move';
811
- readonly COPY: 'copy';
812
- readonly TEST: 'test';
672
+ sourceImage?: string | null;
673
+ } & {
674
+ engine: 'kling';
813
675
  };
814
676
  export type KohyaImageResourceTrainingInput = ImageResourceTrainingInput & {
677
+ engine: 'kohya';
678
+ } & {
815
679
  /**
816
680
  * An epoch is one set of learning. By default, we will save a maximum of 20 epochs (evenly distributed), and they are all available for download.
817
681
  */
@@ -861,7 +725,7 @@ export type KohyaImageResourceTrainingInput = ImageResourceTrainingInput & {
861
725
  /**
862
726
  * You can change the learning rate in the middle of learning. A scheduler is a setting for how to change the learning rate.
863
727
  */
864
- lrScheduler?: string | null;
728
+ lrScheduler?: 'constant' | 'cosine' | 'cosine_with_restarts' | 'linear';
865
729
  /**
866
730
  * This option specifies how many cycles the scheduler runs during training. It is only used when "cosine_with_restarts" or "polynomial" is used as the scheduler.
867
731
  */
@@ -901,119 +765,192 @@ export type KohyaImageResourceTrainingInput = ImageResourceTrainingInput & {
901
765
  } & {
902
766
  engine: 'kohya';
903
767
  };
904
- export type engine3 = 'kohya';
905
- export declare const engine3: {
906
- readonly KOHYA: 'kohya';
768
+ export declare const LightricksAspectRatio: {
769
+ readonly '1:1': '1:1';
770
+ readonly '16:9': '16:9';
771
+ readonly '9:16': '9:16';
772
+ readonly '3:2': '3:2';
773
+ readonly '2:3': '2:3';
774
+ };
775
+ export type LightricksAspectRatio =
776
+ (typeof LightricksAspectRatio)[keyof typeof LightricksAspectRatio];
777
+ export type LightricksVideoGenInput = VideoGenInput & {
778
+ engine: 'lightricks';
779
+ } & {
780
+ negativePrompt?: string | null;
781
+ cfgScale?: number;
782
+ frameRate?: number;
783
+ duration?: number;
784
+ seed?: number | null;
785
+ steps?: number;
786
+ aspectRatio?: LightricksAspectRatio;
787
+ /**
788
+ * Either A URL, A DataURL or a Base64 string
789
+ */
790
+ sourceImage?: string | null;
791
+ expandPrompt?: boolean;
792
+ } & {
793
+ engine: 'lightricks';
794
+ };
795
+ export type MiniMaxVideoGenInput = VideoGenInput & {
796
+ engine: 'minimax';
797
+ } & {
798
+ model?: MiniMaxVideoGenModel;
799
+ enablePromptEnhancer?: boolean;
800
+ /**
801
+ * Either A URL, A DataURL or a Base64 string
802
+ */
803
+ sourceImage?: string | null;
804
+ } & {
805
+ engine: 'minimax';
806
+ };
807
+ export declare const MiniMaxVideoGenModel: {
808
+ readonly HAILOU: 'hailou';
907
809
  };
908
- /**
909
- * LLM prompt augmentaition capabilities.
910
- */
911
- export type LLMPromptAugmentationCapabilities = {
912
- [key: string]: unknown;
810
+ export type MiniMaxVideoGenModel = (typeof MiniMaxVideoGenModel)[keyof typeof MiniMaxVideoGenModel];
811
+ export type MochiVideoGenInput = VideoGenInput & {
812
+ engine: 'mochi';
813
+ } & {
814
+ seed?: number;
815
+ enablePromptEnhancer?: boolean;
816
+ } & {
817
+ engine: 'mochi';
913
818
  };
914
- export type LLMPromptAugmentationJob = Job & {
819
+ export type MusubiImageResourceTrainingInput = ImageResourceTrainingInput & {
820
+ engine: 'musubi';
821
+ } & {
915
822
  /**
916
- * The primary model to use.
823
+ * An epoch is one set of learning. By default, we will save a maximum of 20 epochs (evenly distributed), and they are all available for download.
917
824
  */
918
- model: string;
825
+ maxTrainEpochs?: number;
826
+ /**
827
+ * Num Repeats defines how many times each individual image gets put into VRAM. As opposed to batch size, which is how many images are placed into VRAM at once.
828
+ */
829
+ numRepeats?: number;
830
+ /**
831
+ * Batch size is the number of images that will be placed into VRAM at once. A batch size of 2 will train two images at a time, simultaneously.
832
+ */
833
+ trainBatchSize?: number | null;
834
+ /**
835
+ * Specify the maximum resolution of training images. If the training images exceed the resolution specified here, they will be scaled down to this resolution
836
+ */
837
+ resolution?: number | null;
838
+ /**
839
+ * Sorts images into buckets by size for the purposes of training. If your training images are all the same size, you can turn this option off, but leaving it on has no effect.
840
+ */
841
+ enableBucket?: boolean;
842
+ /**
843
+ * Sets the learning rate for U-Net. This is the learning rate when performing additional learning on each attention block (and other blocks depending on the setting) in U-Net
844
+ */
845
+ unetLR?: number;
846
+ /**
847
+ * You can change the learning rate in the middle of learning. A scheduler is a setting for how to change the learning rate.
848
+ */
849
+ lrScheduler?: 'constant' | 'cosine' | 'cosine_with_restarts' | 'linear';
919
850
  /**
920
- * The base prompt.
851
+ * This option specifies how many cycles the scheduler runs during training. It is only used when "cosine_with_restarts" or "polynomial" is used as the scheduler.
921
852
  */
922
- basePrompt?: string | null;
853
+ lrSchedulerNumCycles?: number;
923
854
  /**
924
- * A list of prompts.
855
+ * The larger the Dim setting, the more learning information can be stored, but the possibility of learning unnecessary information other than the learning target increases. A larger Dim also increases LoRA file size.
925
856
  */
926
- prompts?: Array<string>;
857
+ networkDim?: number | null;
927
858
  /**
928
- * The temp.
859
+ * The smaller the Network alpha value, the larger the stored LoRA neural net weights.
860
+ * For example, with an Alpha of 16 and a Dim of 32, the strength of the weight used is 16/32 = 0.5,
861
+ * meaning that the learning rate is only half as powerful as the Learning Rate setting.
862
+ *
863
+ * If Alpha and Dim are the same number, the strength used will be 1 and will have no effect on the learning rate.
929
864
  */
930
- temp?: number;
865
+ networkAlpha?: number | null;
931
866
  /**
932
- * The type.
867
+ * The optimizer determines how to update the neural net weights during training.
868
+ * Various methods have been proposed for smart learning, but the most commonly used in LoRA learning
869
+ * is "AdamW8bit" or "Adafactor" for SDXL.
933
870
  */
934
- readonly type?: string;
871
+ optimizerType?: string | null;
872
+ readonly targetSteps?: number | null;
935
873
  } & {
936
- $type: 'llmPromptAugmentation';
874
+ engine: 'musubi';
937
875
  };
938
- export type $type11 = 'llmPromptAugmentation';
939
- export declare const $type11: {
940
- readonly LLM_PROMPT_AUGMENTATION: 'llmPromptAugmentation';
876
+ export declare const NsfwLevel: {
877
+ readonly PG: 'pg';
878
+ readonly P_G13: 'pG13';
879
+ readonly R: 'r';
880
+ readonly X: 'x';
881
+ readonly XXX: 'xxx';
882
+ readonly NA: 'na';
941
883
  };
942
- export type MediaCaptioningJob = Job & {
943
- model: string;
944
- modelId?: number;
945
- mediaUrl: string;
946
- temperature?: number;
947
- maxNewTokens?: number;
948
- readonly type?: string;
949
- readonly claimDuration?: string;
884
+ export type NsfwLevel = (typeof NsfwLevel)[keyof typeof NsfwLevel];
885
+ export type OpenAiDallE2CreateImageGenInput = OpenAiDallE2ImageGenInput & {
886
+ background?: 'auto' | 'transparent' | 'opaque';
950
887
  } & {
951
- $type: 'mediaCaptioning';
888
+ operation: 'createImage';
952
889
  };
953
- export type $type12 = 'mediaCaptioning';
954
- export declare const $type12: {
955
- readonly MEDIA_CAPTIONING: 'mediaCaptioning';
956
- };
957
- export type MediaTaggingJob = Job & {
958
- modelId?: number;
959
- mediaUrl?: string;
960
- readonly type?: string;
890
+ export type OpenAiDallE2EditImageInput = OpenAiDallE2ImageGenInput & {
891
+ /**
892
+ * Either A URL, A DataURL or a Base64 string
893
+ */
894
+ image: string;
895
+ /**
896
+ * Either A URL, A DataURL or a Base64 string
897
+ */
898
+ mask?: string | null;
961
899
  } & {
962
- $type: 'mediaTagging';
963
- };
964
- export type $type13 = 'mediaTagging';
965
- export declare const $type13: {
966
- readonly MEDIA_TAGGING: 'mediaTagging';
900
+ operation: 'editImage';
967
901
  };
968
- export type MochiVideoGenInput = VideoGenInput & {
969
- seed?: number;
902
+ export type OpenAiDallE2ImageGenInput = OpenApiImageGenInput & {
903
+ operation: string;
904
+ prompt: string;
905
+ size: '256x256' | '512x512' | '1024x1024';
906
+ quantity?: number;
970
907
  } & {
971
- engine: 'mochi';
908
+ model: 'dall-e-2';
972
909
  };
973
- export type engine4 = 'mochi';
974
- export declare const engine4: {
975
- readonly MOCHI: 'mochi';
910
+ export type OpenAiDallE3CreateImageGenInput = OpenAiDallE3ImageGenInput & {
911
+ background?: 'auto' | 'transparent' | 'opaque';
912
+ } & {
913
+ operation: 'createImage';
976
914
  };
977
- export type MochiVideoGenJob = Job & {
915
+ export type OpenAiDallE3ImageGenInput = OpenApiImageGenInput & {
916
+ operation: string;
978
917
  prompt: string;
979
- seed?: number;
980
- mediaHash: string;
981
- destinationUrl: string;
982
- readonly type?: string;
983
- readonly claimDuration?: string;
918
+ size: '1024x1024' | '1792x1024' | '1024x1792';
919
+ style?: 'natural' | 'vivid';
920
+ quality?: 'auto' | 'hd' | 'standard';
984
921
  } & {
985
- $type: 'mochi';
922
+ model: 'dall-e-3';
986
923
  };
987
- export type $type14 = 'mochi';
988
- export declare const $type14: {
989
- readonly MOCHI: 'mochi';
924
+ export type OpenAiGpt1CreateImageInput = OpenAiGpt1ImageGenInput & {} & {
925
+ operation: 'createImage';
990
926
  };
991
- export type MovieRatingJob = Job & {
992
- mediaUrl?: string;
993
- model?: string | null;
994
- blobKey?: string | null;
995
- readonly type?: string;
996
- readonly claimDuration?: string;
927
+ export type OpenAiGpt1EditImageInput = OpenAiGpt1ImageGenInput & {
928
+ images: Array<string>;
929
+ /**
930
+ * Either A URL, A DataURL or a Base64 string
931
+ */
932
+ mask?: string | null;
997
933
  } & {
998
- $type: 'movieRating';
934
+ operation: 'editImage';
999
935
  };
1000
- export type $type15 = 'movieRating';
1001
- export declare const $type15: {
1002
- readonly MOVIE_RATING: 'movieRating';
936
+ export type OpenAiGpt1ImageGenInput = OpenApiImageGenInput & {
937
+ operation: string;
938
+ prompt: string;
939
+ size?: '1024x1024' | '1536x1024' | '1024x1536';
940
+ quantity?: number;
941
+ background?: 'auto' | 'transparent' | 'opaque';
942
+ quality?: 'auto' | 'high' | 'medium' | 'low';
943
+ } & {
944
+ model: 'gpt-image-1';
1003
945
  };
1004
- export type NSFWLevel = 'pg' | 'pG13' | 'r' | 'x' | 'xxx' | 'na';
1005
- export declare const NSFWLevel: {
1006
- readonly PG: 'pg';
1007
- readonly P_G13: 'pG13';
1008
- readonly R: 'r';
1009
- readonly X: 'x';
1010
- readonly XXX: 'xxx';
1011
- readonly NA: 'na';
946
+ export type OpenApiImageGenInput = ImageGenInput & {
947
+ engine: 'openai';
948
+ } & {
949
+ model: string;
950
+ prompt: string;
951
+ } & {
952
+ engine: 'openai';
1012
953
  };
1013
- /**
1014
- * Available options for priority.
1015
- */
1016
- export type Priority = 'high' | 'normal' | 'low';
1017
954
  /**
1018
955
  * Available options for priority.
1019
956
  */
@@ -1022,74 +959,24 @@ export declare const Priority: {
1022
959
  readonly NORMAL: 'normal';
1023
960
  readonly LOW: 'low';
1024
961
  };
962
+ /**
963
+ * Available options for priority.
964
+ */
965
+ export type Priority = (typeof Priority)[keyof typeof Priority];
1025
966
  export type ProblemDetails = {
1026
967
  type?: string | null;
1027
968
  title?: string | null;
1028
969
  status?: number | null;
1029
970
  detail?: string | null;
1030
971
  instance?: string | null;
1031
- '[key: string]': (unknown | string | number) | undefined;
1032
- };
1033
- /**
1034
- * Details of processing statistics.
1035
- */
1036
- export type ProcessingStatistics = {
1037
- /**
1038
- * The total number of jobs requested.
1039
- */
1040
- totalJobsRequested?: number;
1041
- /**
1042
- * The total cost of jobs requested.
1043
- */
1044
- totalCostRequested?: number;
1045
- /**
1046
- * The total number of successful jobs.
1047
- */
1048
- totalJobsSucceeded?: number;
1049
- /**
1050
- * The total cost of successful jobs.
1051
- */
1052
- totalCostSucceeded?: number;
1053
- /**
1054
- * The total number of rejected jobs.
1055
- */
1056
- totalJobsRejected?: number;
1057
- /**
1058
- * The total cost of rejected jobs.
1059
- */
1060
- totalCostRejected?: number;
1061
- /**
1062
- * The total number of late rejected jobs.
1063
- */
1064
- totalJobsLateRejected?: number;
1065
- /**
1066
- * The total cost of laterejected jobs.
1067
- */
1068
- totalCostLateRejected?: number;
1069
- /**
1070
- * The total number of expired jobs.
1071
- */
1072
- totalJobsExpired?: number;
1073
- /**
1074
- * The total cost of expired jobs.
1075
- */
1076
- totalCostExpired?: number;
1077
- /**
1078
- * The total number of failed jobs.
1079
- */
1080
- totalJobsFailed?: number;
1081
- /**
1082
- * The total cost of failed jobs.
1083
- */
1084
- totalCostFailed?: number;
1085
- /**
1086
- * The total number of completed jobs.
1087
- */
1088
- totalJobsCompleted?: number;
1089
- /**
1090
- * The total cost of completed jobs.
1091
- */
1092
- totalCostCompleted?: number;
972
+ [key: string]:
973
+ | unknown
974
+ | (string | null)
975
+ | (string | null)
976
+ | (number | null)
977
+ | (string | null)
978
+ | (string | null)
979
+ | undefined;
1093
980
  };
1094
981
  /**
1095
982
  * Details for a specific resource.
@@ -1146,36 +1033,29 @@ export type ResourceInfo = {
1146
1033
  */
1147
1034
  requiresAuthorization?: boolean | null;
1148
1035
  fileFormat?: FileFormat;
1036
+ /**
1037
+ * A boolean indicating whether this resource restricts mature content generation.
1038
+ * If resources with this restriction are used in generation, then generations will automatically be enforced to not generate mature content
1039
+ */
1040
+ hasMatureContentRestriction?: boolean;
1041
+ /**
1042
+ * Get a rank between 0-1 on the popularity of the resource.
1043
+ */
1044
+ popularityRank?: number | null;
1045
+ /**
1046
+ * Get wether this resource is featured
1047
+ */
1048
+ isFeatured?: boolean | null;
1049
+ /**
1050
+ * The date at which this model got published
1051
+ */
1052
+ publishedAt?: string | null;
1053
+ /**
1054
+ * A boolean indicating whether this resource restricts to SFW content generation.
1055
+ * NSFWContent covers X and AA whereas MatureContent includes R rated content.
1056
+ */
1057
+ hasNSFWContentRestriction?: boolean;
1149
1058
  };
1150
- /**
1151
- * The available options for schedulers used in image generation.
1152
- */
1153
- export type Scheduler =
1154
- | 'eulerA'
1155
- | 'euler'
1156
- | 'lms'
1157
- | 'heun'
1158
- | 'dpM2'
1159
- | 'dpM2A'
1160
- | 'dpM2SA'
1161
- | 'dpM2M'
1162
- | 'dpmsde'
1163
- | 'dpmFast'
1164
- | 'dpmAdaptive'
1165
- | 'lmsKarras'
1166
- | 'dpM2Karras'
1167
- | 'dpM2AKarras'
1168
- | 'dpM2SAKarras'
1169
- | 'dpM2MKarras'
1170
- | 'dpmsdeKarras'
1171
- | 'ddim'
1172
- | 'plms'
1173
- | 'uniPC'
1174
- | 'undefined'
1175
- | 'lcm'
1176
- | 'ddpm'
1177
- | 'deis'
1178
- | 'dpM3MSDE';
1179
1059
  /**
1180
1060
  * The available options for schedulers used in image generation.
1181
1061
  */
@@ -1192,10 +1072,10 @@ export declare const Scheduler: {
1192
1072
  readonly DPM_FAST: 'dpmFast';
1193
1073
  readonly DPM_ADAPTIVE: 'dpmAdaptive';
1194
1074
  readonly LMS_KARRAS: 'lmsKarras';
1195
- readonly DP_M2KARRAS: 'dpM2Karras';
1196
- readonly DP_M2AKARRAS: 'dpM2AKarras';
1197
- readonly DP_M2SAKARRAS: 'dpM2SAKarras';
1198
- readonly DP_M2MKARRAS: 'dpM2MKarras';
1075
+ readonly DP_M2_KARRAS: 'dpM2Karras';
1076
+ readonly DP_M2A_KARRAS: 'dpM2AKarras';
1077
+ readonly DP_M2SA_KARRAS: 'dpM2SAKarras';
1078
+ readonly DP_M2M_KARRAS: 'dpM2MKarras';
1199
1079
  readonly DPMSDE_KARRAS: 'dpmsdeKarras';
1200
1080
  readonly DDIM: 'ddim';
1201
1081
  readonly PLMS: 'plms';
@@ -1207,47 +1087,9 @@ export declare const Scheduler: {
1207
1087
  readonly DP_M3MSDE: 'dpM3MSDE';
1208
1088
  };
1209
1089
  /**
1210
- * Details for a similarity search job.
1211
- */
1212
- export type SimilaritySearchJob = Job & {
1213
- /**
1214
- * An AIR ID representing the primary model.
1215
- */
1216
- model: string;
1217
- /**
1218
- * A value for the NSFW filter.
1219
- */
1220
- nsfwFilter: string;
1221
- /**
1222
- * The prompt provided.
1223
- */
1224
- prompt: string;
1225
- /**
1226
- * A collection of parameters.
1227
- */
1228
- params: {
1229
- [key: string]: unknown;
1230
- };
1231
- /**
1232
- * The job type.
1233
- */
1234
- readonly type?: string;
1235
- } & {
1236
- $type: 'similaritySearch';
1237
- };
1238
- export type $type16 = 'similaritySearch';
1239
- export declare const $type16: {
1240
- readonly SIMILARITY_SEARCH: 'similaritySearch';
1241
- };
1242
- /**
1243
- * A subscription for pushed based notifications.
1090
+ * The available options for schedulers used in image generation.
1244
1091
  */
1245
- export type Subscription = {
1246
- /**
1247
- * The webhook url.
1248
- */
1249
- webhook: string;
1250
- };
1092
+ export type Scheduler = (typeof Scheduler)[keyof typeof Scheduler];
1251
1093
  /**
1252
1094
  * Input for an text to image step.
1253
1095
  */
@@ -1257,13 +1099,13 @@ export type TextToImageInput = {
1257
1099
  */
1258
1100
  quantity?: number;
1259
1101
  /**
1260
- * The size of each batch.D
1102
+ * The size of each batch
1261
1103
  */
1262
1104
  batchSize?: number;
1263
1105
  /**
1264
1106
  * The AIR of the checkpoint model to use for generation.
1265
1107
  */
1266
- model: string;
1108
+ model?: string;
1267
1109
  /**
1268
1110
  * Get or set a associative list of additional networks. Use the AIR of the network as the key.
1269
1111
  */
@@ -1317,70 +1159,31 @@ export type TextToImageInput = {
1317
1159
  engine?: string | null;
1318
1160
  };
1319
1161
  /**
1320
- * A text to image generation job.
1162
+ * Represents the output of a TextToImage workflow step.
1321
1163
  */
1322
- export type TextToImageJob = Job & {
1164
+ export type TextToImageOutput = {
1323
1165
  /**
1324
- * An AIR representing the model to use.
1166
+ * A collection of output images.
1325
1167
  */
1326
- model: string;
1327
- params: ImageJobParams;
1328
- /**
1329
- * The hash for the output image.
1330
- */
1331
- imageHash: string;
1332
- /**
1333
- * Get or set a associative list of additional networks. Each network is identified by a hash code.
1334
- */
1335
- additionalNetworks?: {
1336
- [key: string]: ImageJobNetworkParams;
1337
- };
1338
- /**
1339
- * Get or set the URL where the image will be uploaded to.
1340
- */
1341
- destinationUrl?: string | null;
1342
- /**
1343
- * A value indicating whether to store the image as a blob or as a legacy image.
1344
- */
1345
- storeAsBlob?: boolean;
1346
- /**
1347
- * Get or set a list of control nets that should be applied with this textToImage job.
1348
- */
1349
- controlNets?: Array<ImageJobControlNet>;
1350
- /**
1351
- * The duration for which this job can be claimed for.
1352
- */
1353
- readonly claimDuration?: string;
1354
- /**
1355
- * The job type.
1356
- */
1357
- readonly type?: string;
1358
- } & {
1359
- $type: 'textToImage';
1360
- };
1361
- export type $type17 = 'textToImage';
1362
- export declare const $type17: {
1363
- readonly TEXT_TO_IMAGE: 'textToImage';
1364
- };
1365
- /**
1366
- * Represents the output of a TextToImage workflow step.
1367
- */
1368
- export type TextToImageOutput = {
1369
- /**
1370
- * A collection of output images.
1371
- */
1372
- images: Array<Blob>;
1168
+ images: Array<ImageBlob>;
1373
1169
  };
1374
1170
  /**
1375
- * A workflow step for text to image generations.
1171
+ * TextToImage
1376
1172
  */
1377
1173
  export type TextToImageStep = WorkflowStep & {
1174
+ $type: 'textToImage';
1175
+ } & {
1378
1176
  input: TextToImageInput;
1379
1177
  output?: TextToImageOutput;
1380
1178
  } & {
1381
1179
  $type: 'textToImage';
1382
1180
  };
1181
+ /**
1182
+ * TextToImage
1183
+ */
1383
1184
  export type TextToImageStepTemplate = WorkflowStepTemplate & {
1185
+ $type: 'textToImage';
1186
+ } & {
1384
1187
  input: TextToImageInput;
1385
1188
  } & {
1386
1189
  $type: 'textToImage';
@@ -1405,12 +1208,16 @@ export type TransactionSummary = {
1405
1208
  * Get a list of individual transactions.
1406
1209
  */
1407
1210
  list?: Array<TransactionInfo>;
1211
+ /**
1212
+ * A boolean returned with whatif requests to indicate whether the user has nsufficient buzz to run a workflow.
1213
+ */
1214
+ insufficientBuzz?: boolean | null;
1408
1215
  };
1409
- export type TransactionType = 'debit' | 'credit';
1410
1216
  export declare const TransactionType: {
1411
1217
  readonly DEBIT: 'debit';
1412
1218
  readonly CREDIT: 'credit';
1413
1219
  };
1220
+ export type TransactionType = (typeof TransactionType)[keyof typeof TransactionType];
1414
1221
  export type TranscodeInput = {
1415
1222
  sourceUrl: string;
1416
1223
  containerFormat?: ContainerFormat;
@@ -1439,18 +1246,14 @@ export type TranscodeOutput = {
1439
1246
  */
1440
1247
  jobId: string;
1441
1248
  };
1249
+ /**
1250
+ * Transcoding
1251
+ */
1442
1252
  export type TranscodeStep = WorkflowStep & {
1443
- input: TranscodeInput;
1444
- output?: TranscodeOutput;
1445
- } & {
1446
1253
  $type: 'transcode';
1447
- };
1448
- export type $type18 = 'transcode';
1449
- export declare const $type18: {
1450
- readonly TRANSCODE: 'transcode';
1451
- };
1452
- export type TranscodeStepTemplate = WorkflowStepTemplate & {
1254
+ } & {
1453
1255
  input: TranscodeInput;
1256
+ output?: TranscodeOutput;
1454
1257
  } & {
1455
1258
  $type: 'transcode';
1456
1259
  };
@@ -1465,39 +1268,9 @@ export type TryOnUInput = {
1465
1268
  steps?: number;
1466
1269
  seed?: number;
1467
1270
  };
1468
- export type TryOnUJob = Job & {
1469
- subjectUrl: string;
1470
- garmentUrl: string;
1471
- subjectMaskUrl: string;
1472
- garmentDescription?: string | null;
1473
- maskSubject?: boolean;
1474
- cropSubject?: boolean;
1475
- steps?: number;
1476
- seed?: number;
1477
- destinationBlobKey: string;
1478
- readonly type?: string;
1479
- readonly claimDuration?: string;
1480
- } & {
1481
- $type: 'tryOnU';
1482
- };
1483
- export type $type19 = 'tryOnU';
1484
- export declare const $type19: {
1485
- readonly TRY_ON_U: 'tryOnU';
1486
- };
1487
1271
  export type TryOnUOutput = {
1488
1272
  blob: Blob;
1489
1273
  };
1490
- export type TryOnUStep = WorkflowStep & {
1491
- input: TryOnUInput;
1492
- output?: TryOnUOutput;
1493
- } & {
1494
- $type: 'tryOnU';
1495
- };
1496
- export type TryOnUStepTemplate = WorkflowStepTemplate & {
1497
- input: TryOnUInput;
1498
- } & {
1499
- $type: 'tryOnU';
1500
- };
1501
1274
  /**
1502
1275
  * An request for updating a workflow.
1503
1276
  */
@@ -1513,17 +1286,21 @@ export type UpdateWorkflowRequest = {
1513
1286
  * An optional set of new tags to set on the workflow.
1514
1287
  */
1515
1288
  tags?: Array<string> | null;
1289
+ /**
1290
+ * Set to true to remove the mature content restriction on the workflow.
1291
+ */
1292
+ allowMatureContent?: boolean | null;
1516
1293
  };
1517
- /**
1518
- * Available statuses for updating workflows.
1519
- */
1520
- export type UpdateWorkflowStatus = 'canceled';
1521
1294
  /**
1522
1295
  * Available statuses for updating workflows.
1523
1296
  */
1524
1297
  export declare const UpdateWorkflowStatus: {
1525
1298
  readonly CANCELED: 'canceled';
1526
1299
  };
1300
+ /**
1301
+ * Available statuses for updating workflows.
1302
+ */
1303
+ export type UpdateWorkflowStatus = (typeof UpdateWorkflowStatus)[keyof typeof UpdateWorkflowStatus];
1527
1304
  export type UpdateWorkflowStepRequest = {
1528
1305
  /**
1529
1306
  * An set of new properties to set on the workflow step.
@@ -1541,518 +1318,403 @@ export type ValidationProblemDetails = {
1541
1318
  errors?: {
1542
1319
  [key: string]: Array<string>;
1543
1320
  };
1544
- '[key: string]': (unknown | string | number) | undefined;
1321
+ [key: string]:
1322
+ | unknown
1323
+ | (string | null)
1324
+ | (string | null)
1325
+ | (number | null)
1326
+ | (string | null)
1327
+ | (string | null)
1328
+ | {
1329
+ [key: string]: Array<string>;
1330
+ }
1331
+ | undefined;
1545
1332
  };
1546
1333
  export type ValueTupleOfStringAndInt32 = {
1547
- [key: string]: unknown;
1334
+ [key: string]: never;
1335
+ };
1336
+ export declare const Veo3AspectRatio: {
1337
+ readonly '16:9': '16:9';
1338
+ readonly '9:16': '9:16';
1339
+ readonly '1:1': '1:1';
1340
+ };
1341
+ export type Veo3AspectRatio = (typeof Veo3AspectRatio)[keyof typeof Veo3AspectRatio];
1342
+ export type Veo3VideoGenInput = VideoGenInput & {
1343
+ engine: 'veo3';
1344
+ } & {
1345
+ negativePrompt?: string | null;
1346
+ enablePromptEnhancer?: boolean;
1347
+ aspectRatio?: Veo3AspectRatio;
1348
+ duration?: number;
1349
+ generateAudio?: boolean;
1350
+ seed?: number | null;
1351
+ fastMode?: boolean;
1352
+ images?: Array<string>;
1353
+ } & {
1354
+ engine: 'veo3';
1355
+ };
1356
+ export type VideoBlob = Blob & {
1357
+ type: 'video';
1358
+ } & {
1359
+ width?: number | null;
1360
+ height?: number | null;
1361
+ } & {
1362
+ type: 'video';
1363
+ };
1364
+ export type VideoEnhancementInput = {
1365
+ sourceUrl: string;
1366
+ upscaler?: VideoEnhancementInputUpscalerOptions;
1367
+ interpolation?: VideoEnhancementInputInterpolationOptions;
1368
+ };
1369
+ export type VideoEnhancementInputInterpolationOptions = {
1370
+ multiplier: number;
1371
+ };
1372
+ export type VideoEnhancementInputUpscalerOptions = {
1373
+ model?: string | null;
1374
+ width: number;
1375
+ height: number;
1376
+ };
1377
+ export type VideoEnhancementOutput = {
1378
+ video: VideoBlob;
1379
+ };
1380
+ /**
1381
+ * Upscale videos and/or interpolate frames
1382
+ */
1383
+ export type VideoEnhancementStep = WorkflowStep & {
1384
+ $type: 'videoEnhancement';
1385
+ } & {
1386
+ input: VideoEnhancementInput;
1387
+ output?: VideoEnhancementOutput;
1388
+ } & {
1389
+ $type: 'videoEnhancement';
1390
+ };
1391
+ /**
1392
+ * Upscale videos and/or interpolate frames
1393
+ */
1394
+ export type VideoEnhancementStepTemplate = WorkflowStepTemplate & {
1395
+ $type: 'videoEnhancement';
1396
+ } & {
1397
+ input: VideoEnhancementInput;
1398
+ } & {
1399
+ $type: 'videoEnhancement';
1548
1400
  };
1549
1401
  export type VideoGenInput = {
1550
1402
  engine: string;
1551
1403
  prompt: string;
1552
1404
  };
1405
+ export type VideoGenInputLora = {
1406
+ air: string;
1407
+ strength: number;
1408
+ };
1553
1409
  export type VideoGenOutput = {
1554
- video?: Blob;
1410
+ video?: VideoBlob;
1555
1411
  };
1412
+ /**
1413
+ * Video generation
1414
+ */
1556
1415
  export type VideoGenStep = WorkflowStep & {
1416
+ $type: 'videoGen';
1417
+ } & {
1557
1418
  input: VideoGenInput;
1558
1419
  output?: VideoGenOutput;
1559
1420
  } & {
1560
1421
  $type: 'videoGen';
1561
1422
  };
1562
- export type $type20 = 'videoGen';
1563
- export declare const $type20: {
1564
- readonly VIDEO_GEN: 'videoGen';
1565
- };
1423
+ /**
1424
+ * Video generation
1425
+ */
1566
1426
  export type VideoGenStepTemplate = WorkflowStepTemplate & {
1427
+ $type: 'videoGen';
1428
+ } & {
1567
1429
  input: VideoGenInput;
1568
1430
  } & {
1569
1431
  $type: 'videoGen';
1570
1432
  };
1571
- export type WDTaggingJob = Job & {
1572
- model?: string;
1573
- mediaUrl?: string;
1574
- threshold?: number | null;
1575
- movieRatingModel?: string | null;
1576
- prompt?: string | null;
1577
- readonly claimDuration?: string;
1578
- readonly type?: string;
1433
+ export type ViduVideoGenInput = VideoGenInput & {
1434
+ engine: 'vidu';
1435
+ } & {
1436
+ enablePromptEnhancer?: boolean;
1437
+ seed?: number | null;
1438
+ /**
1439
+ * Either A URL, A DataURL or a Base64 string
1440
+ */
1441
+ sourceImage?: string | null;
1442
+ style?: ViduVideoGenStyle;
1443
+ duration?: 4 | 8;
1444
+ /**
1445
+ * Either A URL, A DataURL or a Base64 string
1446
+ */
1447
+ endSourceImage?: string | null;
1448
+ model?: ViduVideoGenModel;
1449
+ aspectRatio?: '16:9' | '9:16' | '1:1';
1450
+ movementAmplitude?: 'auto' | 'small' | 'medium' | 'large';
1451
+ images?: Array<string>;
1452
+ enableBackgroundMusic?: boolean;
1579
1453
  } & {
1580
- $type: 'wdTagging';
1454
+ engine: 'vidu';
1581
1455
  };
1582
- export type $type21 = 'wdTagging';
1583
- export declare const $type21: {
1584
- readonly WD_TAGGING: 'wdTagging';
1456
+ export declare const ViduVideoGenModel: {
1457
+ readonly DEFAULT: 'default';
1458
+ readonly Q1: 'q1';
1585
1459
  };
1586
- /**
1587
- * Details of a worker's capabilities.
1588
- */
1589
- export type WorkerCapabilities = {
1590
- image?: WorkerImageCapabilities;
1591
- media?: WorkerMediaCapabilities;
1592
- modelManagement?: WorkerModelPreparationCapabilities;
1593
- configurationManagement?: WorkerConfigurationCapabilities;
1594
- similaritySearch?: WorkerSimilaritySearchCapabilities;
1595
- llmPromptAugmentation?: LLMPromptAugmentationCapabilities;
1596
- humanoidImageMask?: WorkerHumanoidImageMaskCapabilities;
1597
- tryOnU?: WorkerTryOnUCapabilities;
1598
- haiper?: WorkerHaiperCapabilities;
1460
+ export type ViduVideoGenModel = (typeof ViduVideoGenModel)[keyof typeof ViduVideoGenModel];
1461
+ export declare const ViduVideoGenStyle: {
1462
+ readonly GENERAL: 'general';
1463
+ readonly ANIME: 'anime';
1599
1464
  };
1600
- /**
1601
- * Details of a worker's configuration capabilities.
1602
- */
1603
- export type WorkerConfigurationCapabilities = {
1604
- [key: string]: unknown;
1465
+ export type ViduVideoGenStyle = (typeof ViduVideoGenStyle)[keyof typeof ViduVideoGenStyle];
1466
+ export type Wan21CivitaiVideoGenInput = Wan21VideoGenInput & {
1467
+ width?: number;
1468
+ height?: number;
1469
+ model?: string | null;
1470
+ images?: Array<string>;
1471
+ } & {
1472
+ provider: 'civitai';
1605
1473
  };
1606
- /**
1607
- * Details for a particular worker.
1608
- */
1609
- export type WorkerDetails = {
1474
+ export type Wan21FalVideoGenInput = Wan21VideoGenInput & {
1475
+ aspectRatio?: '1:1' | '16:9' | '9:16';
1476
+ enablePromptExpansion?: boolean;
1477
+ } & {
1478
+ provider: 'fal';
1479
+ };
1480
+ export type Wan21VideoGenInput = WanVideoGenInput & {
1481
+ provider: string | null;
1482
+ } & {
1483
+ version: 'v2.1';
1484
+ };
1485
+ export type Wan225bFalImageGenInput = Wan225bImageGenInput & {} & {
1486
+ provider: 'fal';
1487
+ };
1488
+ export type Wan225bFalImageToVideoInput = Wan225bFalVideoGenInput & {
1489
+ images?: Array<string>;
1490
+ } & {
1491
+ operation: 'image-to-video';
1492
+ };
1493
+ export type Wan225bFalTextToVideoInput = Wan225bFalVideoGenInput & {} & {
1494
+ operation: 'text-to-video';
1495
+ };
1496
+ export type Wan225bFalVideoGenInput = Wan225bVideoGenInput & {
1497
+ operation: string | null;
1498
+ resolution?: '480p' | '580p' | '720p';
1499
+ aspectRatio?: '1:1' | '16:9' | '9:16' | 'auto';
1500
+ enablePromptExpansion?: boolean;
1501
+ useDistill?: boolean;
1502
+ interpolatorModel?: 'none' | 'film' | 'rife';
1503
+ negativePrompt?: string | null;
1504
+ enableSafetyChecker?: boolean;
1505
+ numInferenceSteps?: number;
1506
+ } & {
1507
+ provider: 'fal';
1508
+ };
1509
+ export type Wan225bImageGenInput = WanImageGenInput & {
1510
+ provider: string | null;
1511
+ steps?: number;
1512
+ shift?: number;
1513
+ } & {
1514
+ version: 'v2.2-5b';
1515
+ };
1516
+ export type Wan225bVideoGenInput = WanVideoGenInput & {
1517
+ provider: string | null;
1518
+ } & {
1519
+ version: 'v2.2-5b';
1520
+ };
1521
+ export type Wan22FalImageGenInput = Wan22ImageGenInput & {
1522
+ acceleration?: 'none' | 'fast' | 'faster';
1523
+ } & {
1524
+ provider: 'fal';
1525
+ };
1526
+ export type Wan22FalImageToVideoInput = Wan22FalVideoGenInput & {
1527
+ images?: Array<string>;
1528
+ } & {
1529
+ operation: 'image-to-video';
1530
+ };
1531
+ export type Wan22FalTextToVideoInput = Wan22FalVideoGenInput & {} & {
1532
+ operation: 'text-to-video';
1533
+ };
1534
+ export type Wan22FalVideoGenInput = Wan22VideoGenInput & {
1535
+ operation: string | null;
1536
+ resolution?: '480p' | '720p';
1537
+ aspectRatio?: '1:1' | '16:9' | '9:16' | '4:3' | '3:4' | '4:5' | '5:4';
1538
+ enablePromptExpansion?: boolean;
1539
+ shift?: number;
1540
+ interpolatorModel?: 'film' | 'rife';
1541
+ useTurbo?: boolean;
1542
+ negativePrompt?: string | null;
1543
+ enableSafetyChecker?: boolean;
1544
+ } & {
1545
+ provider: 'fal';
1546
+ };
1547
+ export type Wan22ImageGenInput = WanImageGenInput & {
1548
+ provider: string | null;
1549
+ steps?: number;
1550
+ } & {
1551
+ version: 'v2.2';
1552
+ };
1553
+ export type Wan22VideoGenInput = WanVideoGenInput & {
1554
+ provider: string | null;
1555
+ } & {
1556
+ version: 'v2.2';
1557
+ };
1558
+ export type WanImageGenInput = ImageGenInput & {
1559
+ engine: 'wan';
1560
+ } & {
1561
+ version: string | null;
1562
+ prompt: string;
1563
+ negativePrompt?: string | null;
1564
+ guidanceScale?: number;
1565
+ seed?: number | null;
1566
+ quantity?: number;
1567
+ imageSize?: string;
1568
+ enablePromptExpansion?: boolean;
1569
+ enableSafetyChecker?: boolean;
1570
+ loras?: Array<ImageGenInputLora>;
1571
+ } & {
1572
+ engine: 'wan';
1573
+ };
1574
+ export type WanVideoGenInput = VideoGenInput & {
1575
+ engine: 'wan';
1576
+ } & {
1577
+ version: string | null;
1610
1578
  /**
1611
- * The worker's ID.
1579
+ * Either A URL, A DataURL or a Base64 string
1612
1580
  */
1613
- id: string;
1581
+ sourceImage?: string | null;
1582
+ cfgScale?: number;
1583
+ frameRate?: number;
1584
+ duration?: number;
1585
+ seed?: number | null;
1586
+ steps?: number;
1587
+ loras?: Array<VideoGenInputLora>;
1588
+ } & {
1589
+ engine: 'wan';
1590
+ };
1591
+ /**
1592
+ * Details of a workflow.
1593
+ */
1594
+ export type Workflow = {
1614
1595
  /**
1615
- * The worker's name.
1596
+ * The ID for the workflow.
1616
1597
  */
1617
- name: string;
1598
+ id?: string | null;
1618
1599
  /**
1619
- * The worker's active job count.
1600
+ * The date / time the workflow was created.
1620
1601
  */
1621
- activeJobs?: number;
1602
+ createdAt?: string;
1603
+ transactions?: TransactionSummary;
1622
1604
  /**
1623
- * The number of jobs in the worker's queue.
1605
+ * A collection of user defined metadata for the workflow.
1624
1606
  */
1625
- queueSize?: number;
1607
+ metadata?: {
1608
+ [key: string]: unknown;
1609
+ };
1610
+ status?: WorkflowStatus;
1626
1611
  /**
1627
- * The total cost of job's in the worker's queue.
1612
+ * The date / time the workflow was started. Null if not yet started.
1628
1613
  */
1629
- queueDepth?: number;
1614
+ startedAt?: string | null;
1630
1615
  /**
1631
- * The worker's start date / time.
1616
+ * The date / time the workflow was completed. Null if not yet complete.
1632
1617
  */
1633
- startDate?: string;
1618
+ completedAt?: string | null;
1634
1619
  /**
1635
- * The worker's last request date / time.
1620
+ * An optional list of tags for the workflow.
1636
1621
  */
1637
- lastRequestDate?: string | null;
1622
+ tags?: Array<string>;
1638
1623
  /**
1639
- * The worker's expiration date / time.
1624
+ * Get an associated collection of arguments
1640
1625
  */
1641
- expirationDate?: string | null;
1642
- statistics?: ProcessingStatistics;
1626
+ arguments?: {
1627
+ [key: string]: unknown;
1628
+ };
1643
1629
  /**
1644
- * The worker's succeeded job throughput rate.
1630
+ * The steps for the workflow.
1645
1631
  */
1646
- succeededThroughputRate?: number;
1632
+ steps?: Array<WorkflowStep>;
1647
1633
  /**
1648
- * The worker's failed job throughput rate.
1634
+ * An array of callback details for the workflow.
1649
1635
  */
1650
- failedThroughputRate?: number;
1636
+ callbacks?: Array<WorkflowCallback>;
1637
+ tips?: WorkflowTips;
1638
+ cost?: WorkflowCost;
1639
+ nsfwLevel?: NsfwLevel;
1651
1640
  /**
1652
- * The worker's idle rate.
1641
+ * Get or set whether this workflow is experimental
1653
1642
  */
1654
- idleRate?: number;
1643
+ experimental?: boolean | null;
1655
1644
  /**
1656
- * The date / time of the worker's last successfully completed job.
1645
+ * Gets or sets a value indicating whether mature content is allowed in this workflow.
1657
1646
  */
1658
- lastSuccesfullyCompletedJobDate?: string | null;
1647
+ allowMatureContent?: boolean | null;
1648
+ upgradeMode?: WorkflowUpgradeMode;
1649
+ };
1650
+ /**
1651
+ * Details of a callback setup for a workflow.
1652
+ */
1653
+ export type WorkflowCallback = {
1659
1654
  /**
1660
- * The date / time of the worker's last job update.
1655
+ * The url for the callback.
1661
1656
  */
1662
- lastJobUpdateDate?: string | null;
1657
+ url: string;
1663
1658
  /**
1664
- * The date / time that the worker's subscription was set.
1659
+ * An array of event types to send to the callback.
1665
1660
  */
1666
- subscriptionSetDate?: string | null;
1661
+ type: Array<
1662
+ | 'workflow:*'
1663
+ | 'workflow:unassigned'
1664
+ | 'workflow:processing'
1665
+ | 'workflow:succeeded'
1666
+ | 'workflow:failed'
1667
+ | 'workflow:expired'
1668
+ | 'workflow:canceled'
1669
+ | 'step:*'
1670
+ | 'step:unassigned'
1671
+ | 'step:processing'
1672
+ | 'step:succeeded'
1673
+ | 'step:failed'
1674
+ | 'step:expired'
1675
+ | 'step:canceled'
1676
+ | 'job:*'
1677
+ | 'job:unassigned'
1678
+ | 'job:processing'
1679
+ | 'job:succeeded'
1680
+ | 'job:failed'
1681
+ | 'job:expired'
1682
+ | 'job:canceled'
1683
+ >;
1684
+ };
1685
+ export type WorkflowCost = {
1667
1686
  /**
1668
- * The date / time that the worker was quarantined.
1687
+ * The base cost of this request, excludsing any tips
1669
1688
  */
1670
- quarantineDate?: string | null;
1689
+ base?: number;
1671
1690
  /**
1672
- * The rate at which this worker has been downloading
1691
+ * A breakdown of the cost factors for this request
1673
1692
  */
1674
- resourceDownloadRate?: number;
1693
+ factors?: {
1694
+ [key: string]: number;
1695
+ } | null;
1675
1696
  /**
1676
- * The rate at which this worker has been evicting resources
1697
+ * A fixed set of cost additions for this request
1677
1698
  */
1678
- resourceEvictionRate?: number;
1699
+ fixed?: {
1700
+ [key: string]: number;
1701
+ } | null;
1702
+ tips?: WorkflowCostTips;
1679
1703
  /**
1680
- * The size in bytes of resources that are queued up for this worker to download
1704
+ * The total cost of this request, including tips
1681
1705
  */
1682
- upcomingResourcesSize?: number | null;
1683
- };
1684
- export type WorkerHaiperCapabilities = {
1685
- [key: string]: unknown;
1686
- };
1687
- export type WorkerHumanoidImageMaskCapabilities = {
1688
- [key: string]: unknown;
1689
- };
1690
- /**
1691
- * Details of a worker's image capabilities.
1692
- */
1693
- export type WorkerImageCapabilities = {
1694
- textToImage?: WorkerImageTextToImageCapabilities;
1695
- imageToImage?: WorkerImageImageToImageCapabilities;
1696
- transform?: WorkerImageTransformCapabilities;
1697
- resourceTraining?: WorkerImageResourceTrainingCapabilities;
1698
- embedding?: WorkerImageEmbeddingCapabilities;
1699
- };
1700
- /**
1701
- * Details of a worker's image embedding capabilities.
1702
- */
1703
- export type WorkerImageEmbeddingCapabilities = {
1704
- [key: string]: unknown;
1706
+ total?: number;
1705
1707
  };
1706
1708
  /**
1707
- * Details of a worker's image to image capabilities.
1709
+ * Get the cost of tips
1708
1710
  */
1709
- export type WorkerImageImageToImageCapabilities = {
1710
- /**
1711
- * The worker's maximum supported image size for image to image (squared).
1712
- */
1713
- size?: number;
1711
+ export type WorkflowCostTips = {
1714
1712
  /**
1715
- * A list of schedulers the worker supports for image to image.
1713
+ * The buzz tipped to Civitai
1716
1714
  */
1717
- schedulers?: Array<Scheduler>;
1715
+ civitai: number;
1718
1716
  /**
1719
- * The number of ControlNets the worker supports for image to image (at once).
1720
- */
1721
- controlNet?: number;
1722
- /**
1723
- * Indicates whether the worker supports inpaiting.
1724
- */
1725
- inpainting?: boolean;
1726
- };
1727
- /**
1728
- * Details of a worker's image resource training capabilities.
1729
- */
1730
- export type WorkerImageResourceTrainingCapabilities = {
1731
- engine?: string;
1732
- };
1733
- /**
1734
- * Details of a worker's text to image capabilities.
1735
- */
1736
- export type WorkerImageTextToImageCapabilities = {
1737
- /**
1738
- * The worker's maximum supported image size for text to image (squared).
1739
- */
1740
- size?: number;
1741
- /**
1742
- * A list of schedulers the worker supports for text to image.
1743
- */
1744
- schedulers?: Array<Scheduler>;
1745
- /**
1746
- * The number of ControlNets the worker supports for text to image (at once).
1747
- */
1748
- controlNet?: number;
1749
- /**
1750
- * A list of engines that this worker supports for text to image.
1751
- */
1752
- engines?: Array<string> | null;
1753
- };
1754
- /**
1755
- * Details of a worker's image transform capabilities.
1756
- */
1757
- export type WorkerImageTransformCapabilities = {
1758
- /**
1759
- * A list of supported image transformers.
1760
- */
1761
- transformers?: Array<ImageTransformer>;
1762
- };
1763
- export type WorkerMediaAgeClassificationCapabilities = {
1764
- [key: string]: unknown;
1765
- };
1766
- /**
1767
- * Details of a worker's media capabilities.
1768
- */
1769
- export type WorkerMediaCapabilities = {
1770
- wdTagging?: WorkerMediaWDTaggingCapabilities;
1771
- comfy?: WorkerMediaComfyCapabilities;
1772
- tagging?: WorkerMediaTaggingCapabilities;
1773
- movieRating?: WorkerMediaMovieRatingCapabilities;
1774
- transcode?: WorkerMediaTranscodeCapabilities;
1775
- captioning?: WorkerMediaCaptioningCapabilities;
1776
- ageClassification?: WorkerMediaAgeClassificationCapabilities;
1777
- ocrSafetyClassification?: WorkerMediaOCRSafetyClassificationCapabilities;
1778
- };
1779
- export type WorkerMediaCaptioningCapabilities = {
1780
- [key: string]: unknown;
1781
- };
1782
- /**
1783
- * Details of a worker's media comfy capabilities.
1784
- */
1785
- export type WorkerMediaComfyCapabilities = {
1786
- [key: string]: unknown;
1787
- };
1788
- /**
1789
- * Details of a worker's media movie rating capabilities.
1790
- */
1791
- export type WorkerMediaMovieRatingCapabilities = {
1792
- [key: string]: unknown;
1793
- };
1794
- export type WorkerMediaOCRSafetyClassificationCapabilities = {
1795
- [key: string]: unknown;
1796
- };
1797
- /**
1798
- * Details of a worker's media tagging capabilities.
1799
- */
1800
- export type WorkerMediaTaggingCapabilities = {
1801
- [key: string]: unknown;
1802
- };
1803
- export type WorkerMediaTranscodeCapabilities = {
1804
- [key: string]: unknown;
1805
- };
1806
- /**
1807
- * Details of a worker's media WD tagging capabilities.
1808
- */
1809
- export type WorkerMediaWDTaggingCapabilities = {
1810
- [key: string]: unknown;
1811
- };
1812
- /**
1813
- * Details of a worker's model preparation capabilities.
1814
- */
1815
- export type WorkerModelPreparationCapabilities = {
1816
- [key: string]: unknown;
1817
- };
1818
- /**
1819
- * Details of a worker's registration.
1820
- */
1821
- export type WorkerRegistration = {
1822
- /**
1823
- * The worker's name.
1824
- */
1825
- name: string;
1826
- /**
1827
- * A hash set of resource types the worker can retrieve on demand.
1828
- */
1829
- onDemandResourceTypes?: Array<string>;
1830
- capabilities?: WorkerCapabilities;
1831
- subscription?: Subscription;
1832
- type?: WorkerType;
1833
- /**
1834
- * The number of requests the worker can handle at once.
1835
- */
1836
- concurrentLimit?: number;
1837
- /**
1838
- * A collection of ecosystems the worker supports.
1839
- */
1840
- ecosystems?: {
1841
- [key: string]: EcosystemElement;
1842
- };
1843
- /**
1844
- * A collection of information about the availability of particular resources on this worker.
1845
- */
1846
- resources?: {
1847
- [key: string]: WorkerResourceStatus;
1848
- };
1849
- /**
1850
- * The name of the closest cache level that this worker can interact with.
1851
- */
1852
- cacheLevel?: string | null;
1853
- /**
1854
- * The max queue size before the worker stops accepting requests that require cold swapping.
1855
- */
1856
- maxColdSwapQueueSize?: number | null;
1857
- /**
1858
- * The max size in Mb of downloads that can be pending.
1859
- */
1860
- maxPendingResourceSize?: number | null;
1861
- /**
1862
- * A value indicating if worker should consume jobs that are not yet available.
1863
- */
1864
- consumeUnavailableJobs?: boolean;
1865
- /**
1866
- * An optional identifier unique to this worker.
1867
- */
1868
- nodeIdentifier?: string | null;
1869
- /**
1870
- * An optional boost to the scoring of this worker. This can be used to make a worker more or less likely to be selected for work
1871
- */
1872
- scoreBoost?: number | null;
1873
- /**
1874
- * A list of file formats that the worker supports. If none are specified then all formats are considered supported
1875
- */
1876
- supportedFileFormats?: Array<FileFormat> | null;
1877
- preferredDownloadSource?: DownloadSource;
1878
- /**
1879
- * A collection of labels that will be applied to metrics produced by these workers
1880
- */
1881
- labels?: {
1882
- [key: string]: string;
1883
- } | null;
1884
- };
1885
- /**
1886
- * Options for representing the status for a resource on a worker.
1887
- */
1888
- export type WorkerResourceAvailability =
1889
- | 'unknown'
1890
- | 'unsupported'
1891
- | 'unavailable'
1892
- | 'available'
1893
- | 'providerUnsupported';
1894
- /**
1895
- * Options for representing the status for a resource on a worker.
1896
- */
1897
- export declare const WorkerResourceAvailability: {
1898
- readonly UNKNOWN: 'unknown';
1899
- readonly UNSUPPORTED: 'unsupported';
1900
- readonly UNAVAILABLE: 'unavailable';
1901
- readonly AVAILABLE: 'available';
1902
- readonly PROVIDER_UNSUPPORTED: 'providerUnsupported';
1903
- };
1904
- /**
1905
- * Details for the status of a resource on a particular worker.
1906
- */
1907
- export type WorkerResourceStatus = {
1908
- availability: WorkerResourceAvailability;
1909
- /**
1910
- * The cost associated with this resource.
1911
- */
1912
- cost?: number;
1913
- };
1914
- /**
1915
- * Details of a worker's similarity search capabilities.
1916
- */
1917
- export type WorkerSimilaritySearchCapabilities = {
1918
- [key: string]: unknown;
1919
- };
1920
- export type WorkerTryOnUCapabilities = {
1921
- [key: string]: unknown;
1922
- };
1923
- /**
1924
- * Available values for worker type.
1925
- */
1926
- export type WorkerType = 'normal' | 'deferred';
1927
- /**
1928
- * Available values for worker type.
1929
- */
1930
- export declare const WorkerType: {
1931
- readonly NORMAL: 'normal';
1932
- readonly DEFERRED: 'deferred';
1933
- };
1934
- /**
1935
- * Details of a workflow.
1936
- */
1937
- export type Workflow = {
1938
- /**
1939
- * The ID for the workflow.
1940
- */
1941
- id?: string | null;
1942
- /**
1943
- * The date / time the workflow was created.
1944
- */
1945
- createdAt?: string;
1946
- transactions?: TransactionSummary;
1947
- /**
1948
- * A collection of user defined metadata for the workflow.
1949
- */
1950
- metadata?: {
1951
- [key: string]: unknown;
1952
- };
1953
- status?: WorkflowStatus;
1954
- /**
1955
- * The date / time the workflow was started. Null if not yet started.
1956
- */
1957
- startedAt?: string | null;
1958
- /**
1959
- * The date / time the workflow was completed. Null if not yet complete.
1960
- */
1961
- completedAt?: string | null;
1962
- /**
1963
- * An optional list of tags for the workflow.
1964
- */
1965
- tags?: Array<string>;
1966
- /**
1967
- * Get an associated collection of arguments
1968
- */
1969
- arguments?: {
1970
- [key: string]: unknown;
1971
- };
1972
- /**
1973
- * The steps for the workflow.
1974
- */
1975
- steps?: Array<WorkflowStep>;
1976
- /**
1977
- * An array of callback details for the workflow.
1978
- */
1979
- callbacks?: Array<WorkflowCallback>;
1980
- tips?: WorkflowTips;
1981
- cost?: WorkflowCost;
1982
- nsfwLevel?: NSFWLevel;
1983
- /**
1984
- * Get or set whether this workflow is experimental
1985
- */
1986
- experimental?: boolean | null;
1987
- };
1988
- /**
1989
- * Details of a callback setup for a workflow.
1990
- */
1991
- export type WorkflowCallback = {
1992
- /**
1993
- * The url for the callback.
1994
- */
1995
- url: string;
1996
- /**
1997
- * An array of event types to send to the callback.
1998
- */
1999
- type: Array<
2000
- | 'workflow:*'
2001
- | 'workflow:unassigned'
2002
- | 'workflow:processing'
2003
- | 'workflow:succeeded'
2004
- | 'workflow:failed'
2005
- | 'workflow:expired'
2006
- | 'workflow:canceled'
2007
- | 'step:*'
2008
- | 'step:unassigned'
2009
- | 'step:processing'
2010
- | 'step:succeeded'
2011
- | 'step:failed'
2012
- | 'step:expired'
2013
- | 'step:canceled'
2014
- | 'job:*'
2015
- | 'job:unassigned'
2016
- | 'job:processing'
2017
- | 'job:succeeded'
2018
- | 'job:failed'
2019
- | 'job:expired'
2020
- | 'job:canceled'
2021
- >;
2022
- };
2023
- export type WorkflowCost = {
2024
- /**
2025
- * The base cost of this request, excludsing any tips
2026
- */
2027
- base?: number;
2028
- /**
2029
- * A breakdown of the cost factors for this request
2030
- */
2031
- factors?: {
2032
- [key: string]: number;
2033
- } | null;
2034
- /**
2035
- * A fixed set of cost additions for this request
2036
- */
2037
- fixed?: {
2038
- [key: string]: number;
2039
- } | null;
2040
- tips?: WorkflowCostTips;
2041
- /**
2042
- * The total cost of this request, including tips
2043
- */
2044
- total?: number;
2045
- };
2046
- /**
2047
- * Get the cost of tips
2048
- */
2049
- export type WorkflowCostTips = {
2050
- /**
2051
- * The buzz tipped to Civitai
2052
- */
2053
- civitai: number;
2054
- /**
2055
- * The buzz tipped to the Creators who's resources were used
1717
+ * The buzz tipped to the Creators who's resources were used
2056
1718
  */
2057
1719
  creators: number;
2058
1720
  };
@@ -2071,18 +1733,6 @@ export type WorkflowEvent = {
2071
1733
  timestamp?: string;
2072
1734
  $type?: string;
2073
1735
  };
2074
- /**
2075
- * Values available to represent workflow status.
2076
- */
2077
- export type WorkflowStatus =
2078
- | 'unassigned'
2079
- | 'preparing'
2080
- | 'scheduled'
2081
- | 'processing'
2082
- | 'succeeded'
2083
- | 'failed'
2084
- | 'expired'
2085
- | 'canceled';
2086
1736
  /**
2087
1737
  * Values available to represent workflow status.
2088
1738
  */
@@ -2096,6 +1746,10 @@ export declare const WorkflowStatus: {
2096
1746
  readonly EXPIRED: 'expired';
2097
1747
  readonly CANCELED: 'canceled';
2098
1748
  };
1749
+ /**
1750
+ * Values available to represent workflow status.
1751
+ */
1752
+ export type WorkflowStatus = (typeof WorkflowStatus)[keyof typeof WorkflowStatus];
2099
1753
  /**
2100
1754
  * Details of a workflow step.
2101
1755
  */
@@ -2133,6 +1787,10 @@ export type WorkflowStep = {
2133
1787
  metadata?: {
2134
1788
  [key: string]: unknown;
2135
1789
  };
1790
+ /**
1791
+ * An estimation on the current progression of this step, or null if there is no estimation
1792
+ */
1793
+ estimatedProgressRate?: number | null;
2136
1794
  };
2137
1795
  /**
2138
1796
  * Details of a workflow step event.
@@ -2171,6 +1829,10 @@ export type WorkflowStepJob = {
2171
1829
  * The job's cost.
2172
1830
  */
2173
1831
  cost?: number;
1832
+ /**
1833
+ * An estimation on the current progression of this job, or null if there is no estimation
1834
+ */
1835
+ estimatedProgressRate?: number | null;
2174
1836
  };
2175
1837
  /**
2176
1838
  * Details of a workflow step job event.
@@ -2191,6 +1853,9 @@ export type WorkflowStepJobEvent = {
2191
1853
  status: WorkflowStatus;
2192
1854
  $type?: string;
2193
1855
  progress?: number | null;
1856
+ reason?: string | null;
1857
+ blockedReason?: string | null;
1858
+ matureContent?: boolean | null;
2194
1859
  };
2195
1860
  /**
2196
1861
  * Details of the workflow step job's queue position.
@@ -2266,11 +1931,18 @@ export type WorkflowTemplate = {
2266
1931
  arguments?: {
2267
1932
  [key: string]: unknown;
2268
1933
  } | null;
2269
- nsfwLevel?: NSFWLevel;
1934
+ nsfwLevel?: NsfwLevel;
2270
1935
  /**
2271
1936
  * Get or set whether this workflow is experimental
2272
1937
  */
2273
1938
  experimental?: boolean | null;
1939
+ /**
1940
+ * Get or set whether this workflow should allow mature content.
1941
+ * When set to false, the workflow will not return any content that is marked as mature.
1942
+ * Additional payment options are available for workflows that do not allow mature content.
1943
+ */
1944
+ allowMatureContent?: boolean | null;
1945
+ upgradeMode?: WorkflowUpgradeMode;
2274
1946
  };
2275
1947
  export type WorkflowTips = {
2276
1948
  /**
@@ -2282,14 +1954,19 @@ export type WorkflowTips = {
2282
1954
  */
2283
1955
  creators: number;
2284
1956
  };
2285
- export type PutV2ProvidersBlobsByBlobKeyData = {
2286
- path: {
2287
- blobKey: string;
2288
- };
1957
+ /**
1958
+ * Specifies how a workflow should be upgraded when mature content is detected and green or blue buzz was used for payment.
1959
+ */
1960
+ export declare const WorkflowUpgradeMode: {
1961
+ readonly MANUAL: 'manual';
1962
+ readonly AUTOMATIC: 'automatic';
2289
1963
  };
2290
- export type PutV2ProvidersBlobsByBlobKeyResponse = unknown;
2291
- export type PutV2ProvidersBlobsByBlobKeyError = ProblemDetails;
1964
+ /**
1965
+ * Specifies how a workflow should be upgraded when mature content is detected and green or blue buzz was used for payment.
1966
+ */
1967
+ export type WorkflowUpgradeMode = (typeof WorkflowUpgradeMode)[keyof typeof WorkflowUpgradeMode];
2292
1968
  export type GetBlobData = {
1969
+ body?: never;
2293
1970
  path: {
2294
1971
  /**
2295
1972
  * The blob ID to retrieve.
@@ -2297,53 +1974,289 @@ export type GetBlobData = {
2297
1974
  blobId: string;
2298
1975
  };
2299
1976
  query?: {
1977
+ /**
1978
+ * The id of the workflow to obtain
1979
+ */
1980
+ workflowId?: string;
2300
1981
  /**
2301
1982
  * A maximum nsfw level. If this is specified and the blob does not have a NSFW level specified or the NSFW level exceeds our max then we'll return an error
2302
1983
  */
2303
- nsfwLevel?: NSFWLevel;
1984
+ nsfwLevel?: NsfwLevel;
2304
1985
  };
1986
+ url: '/v2/consumer/blobs/{blobId}';
2305
1987
  };
2306
- export type CreateConfigurationData = {
1988
+ export type GetBlobErrors = {
2307
1989
  /**
2308
- * The details of the configuration being created.
1990
+ * Unauthorized
2309
1991
  */
2310
- body?: ConfigurationOptions;
1992
+ 401: ProblemDetails;
2311
1993
  };
2312
- export type CreateConfigurationResponse = CreateConfigurationResult;
2313
- export type CreateConfigurationError = ProblemDetails;
2314
- export type QueryConfigurationsResponse = ConfigurationStatus;
2315
- export type QueryConfigurationsError = ProblemDetails;
2316
- export type GetConfigurationData = {
1994
+ export type GetBlobError = GetBlobErrors[keyof GetBlobErrors];
1995
+ export type HeadBlobData = {
1996
+ body?: never;
2317
1997
  path: {
2318
1998
  /**
2319
- * The ID of the configuration whose options are being requested.
1999
+ * Identifies the specific blob to check for existence and NSFW level.
2320
2000
  */
2321
- configurationId: string;
2001
+ blobId: string;
2322
2002
  };
2003
+ query?: never;
2004
+ url: '/v2/consumer/blobs/{blobId}';
2323
2005
  };
2324
- export type GetConfigurationResponse = ConfigurationOptions;
2325
- export type GetConfigurationError = ProblemDetails;
2326
- export type DeleteConfigurationData = {
2327
- path: {
2328
- /**
2329
- * The ID of the configuration to delete.
2330
- */
2331
- configurationId: string;
2332
- };
2006
+ export type HeadBlobErrors = {
2007
+ /**
2008
+ * Unauthorized
2009
+ */
2010
+ 401: ProblemDetails;
2011
+ /**
2012
+ * Not Found
2013
+ */
2014
+ 404: ProblemDetails;
2333
2015
  };
2334
- export type DeleteConfigurationResponse = unknown;
2335
- export type DeleteConfigurationError = ProblemDetails;
2336
- export type GetResourceData = {
2337
- path: {
2338
- /**
2339
- * A unique ID for the resource being requested. See https://developer.civitai.com/docs/getting-started/ai-resource-identifier for more info on AIRs.
2340
- */
2341
- air: string;
2342
- };
2016
+ export type HeadBlobError = HeadBlobErrors[keyof HeadBlobErrors];
2017
+ export type HeadBlobResponses = {
2018
+ /**
2019
+ * No Content
2020
+ */
2021
+ 204: void;
2022
+ };
2023
+ export type HeadBlobResponse = HeadBlobResponses[keyof HeadBlobResponses];
2024
+ export type InvokeAgeClassificationStepTemplateData = {
2025
+ body?: AgeClassificationInput;
2026
+ path?: never;
2027
+ query?: never;
2028
+ url: '/v2/consumer/recipes/ageClassification';
2029
+ };
2030
+ export type InvokeAgeClassificationStepTemplateErrors = {
2031
+ /**
2032
+ * Bad Request
2033
+ */
2034
+ 400: ProblemDetails;
2035
+ /**
2036
+ * Unauthorized
2037
+ */
2038
+ 401: ProblemDetails;
2039
+ };
2040
+ export type InvokeAgeClassificationStepTemplateError =
2041
+ InvokeAgeClassificationStepTemplateErrors[keyof InvokeAgeClassificationStepTemplateErrors];
2042
+ export type InvokeAgeClassificationStepTemplateResponses = {
2043
+ /**
2044
+ * OK
2045
+ */
2046
+ 200: AgeClassificationOutput;
2047
+ };
2048
+ export type InvokeAgeClassificationStepTemplateResponse =
2049
+ InvokeAgeClassificationStepTemplateResponses[keyof InvokeAgeClassificationStepTemplateResponses];
2050
+ export type InvokeComfyStepTemplateData = {
2051
+ body?: ComfyInput;
2052
+ path?: never;
2053
+ query?: never;
2054
+ url: '/v2/consumer/recipes/comfy';
2055
+ };
2056
+ export type InvokeComfyStepTemplateErrors = {
2057
+ /**
2058
+ * Bad Request
2059
+ */
2060
+ 400: ProblemDetails;
2061
+ /**
2062
+ * Unauthorized
2063
+ */
2064
+ 401: ProblemDetails;
2065
+ };
2066
+ export type InvokeComfyStepTemplateError =
2067
+ InvokeComfyStepTemplateErrors[keyof InvokeComfyStepTemplateErrors];
2068
+ export type InvokeComfyStepTemplateResponses = {
2069
+ /**
2070
+ * OK
2071
+ */
2072
+ 200: ComfyOutput;
2073
+ };
2074
+ export type InvokeComfyStepTemplateResponse =
2075
+ InvokeComfyStepTemplateResponses[keyof InvokeComfyStepTemplateResponses];
2076
+ export type InvokeEchoStepTemplateData = {
2077
+ body?: EchoInput;
2078
+ path?: never;
2079
+ query?: never;
2080
+ url: '/v2/consumer/recipes/echo';
2081
+ };
2082
+ export type InvokeEchoStepTemplateErrors = {
2083
+ /**
2084
+ * Bad Request
2085
+ */
2086
+ 400: ProblemDetails;
2087
+ /**
2088
+ * Unauthorized
2089
+ */
2090
+ 401: ProblemDetails;
2091
+ };
2092
+ export type InvokeEchoStepTemplateError =
2093
+ InvokeEchoStepTemplateErrors[keyof InvokeEchoStepTemplateErrors];
2094
+ export type InvokeEchoStepTemplateResponses = {
2095
+ /**
2096
+ * OK
2097
+ */
2098
+ 200: EchoOutput;
2099
+ };
2100
+ export type InvokeEchoStepTemplateResponse =
2101
+ InvokeEchoStepTemplateResponses[keyof InvokeEchoStepTemplateResponses];
2102
+ export type InvokeImageGenStepTemplateData = {
2103
+ body?: ImageGenInput;
2104
+ path?: never;
2105
+ query?: never;
2106
+ url: '/v2/consumer/recipes/imageGen';
2107
+ };
2108
+ export type InvokeImageGenStepTemplateErrors = {
2109
+ /**
2110
+ * Bad Request
2111
+ */
2112
+ 400: ProblemDetails;
2113
+ /**
2114
+ * Unauthorized
2115
+ */
2116
+ 401: ProblemDetails;
2117
+ };
2118
+ export type InvokeImageGenStepTemplateError =
2119
+ InvokeImageGenStepTemplateErrors[keyof InvokeImageGenStepTemplateErrors];
2120
+ export type InvokeImageGenStepTemplateResponses = {
2121
+ /**
2122
+ * OK
2123
+ */
2124
+ 200: ImageGenOutput;
2125
+ };
2126
+ export type InvokeImageGenStepTemplateResponse =
2127
+ InvokeImageGenStepTemplateResponses[keyof InvokeImageGenStepTemplateResponses];
2128
+ export type InvokeImageResourceTrainingStepTemplateData = {
2129
+ body?: ImageResourceTrainingInput;
2130
+ path?: never;
2131
+ query?: never;
2132
+ url: '/v2/consumer/recipes/imageResourceTraining';
2133
+ };
2134
+ export type InvokeImageResourceTrainingStepTemplateErrors = {
2135
+ /**
2136
+ * Bad Request
2137
+ */
2138
+ 400: ProblemDetails;
2139
+ /**
2140
+ * Unauthorized
2141
+ */
2142
+ 401: ProblemDetails;
2143
+ };
2144
+ export type InvokeImageResourceTrainingStepTemplateError =
2145
+ InvokeImageResourceTrainingStepTemplateErrors[keyof InvokeImageResourceTrainingStepTemplateErrors];
2146
+ export type InvokeImageResourceTrainingStepTemplateResponses = {
2147
+ /**
2148
+ * OK
2149
+ */
2150
+ 200: ImageResourceTrainingOutput;
2151
+ };
2152
+ export type InvokeImageResourceTrainingStepTemplateResponse =
2153
+ InvokeImageResourceTrainingStepTemplateResponses[keyof InvokeImageResourceTrainingStepTemplateResponses];
2154
+ export type InvokeImageUploadStepTemplateData = {
2155
+ body?: string;
2156
+ path?: never;
2157
+ query?: never;
2158
+ url: '/v2/consumer/recipes/imageUpload';
2159
+ };
2160
+ export type InvokeImageUploadStepTemplateErrors = {
2161
+ /**
2162
+ * Bad Request
2163
+ */
2164
+ 400: ProblemDetails;
2165
+ /**
2166
+ * Unauthorized
2167
+ */
2168
+ 401: ProblemDetails;
2169
+ };
2170
+ export type InvokeImageUploadStepTemplateError =
2171
+ InvokeImageUploadStepTemplateErrors[keyof InvokeImageUploadStepTemplateErrors];
2172
+ export type InvokeImageUploadStepTemplateResponses = {
2173
+ /**
2174
+ * OK
2175
+ */
2176
+ 200: ImageUploadOutput;
2177
+ };
2178
+ export type InvokeImageUploadStepTemplateResponse =
2179
+ InvokeImageUploadStepTemplateResponses[keyof InvokeImageUploadStepTemplateResponses];
2180
+ export type InvokeTextToImageStepTemplateData = {
2181
+ body?: TextToImageInput;
2182
+ path?: never;
2183
+ query?: never;
2184
+ url: '/v2/consumer/recipes/textToImage';
2185
+ };
2186
+ export type InvokeTextToImageStepTemplateErrors = {
2187
+ /**
2188
+ * Bad Request
2189
+ */
2190
+ 400: ProblemDetails;
2191
+ /**
2192
+ * Unauthorized
2193
+ */
2194
+ 401: ProblemDetails;
2195
+ };
2196
+ export type InvokeTextToImageStepTemplateError =
2197
+ InvokeTextToImageStepTemplateErrors[keyof InvokeTextToImageStepTemplateErrors];
2198
+ export type InvokeTextToImageStepTemplateResponses = {
2199
+ /**
2200
+ * OK
2201
+ */
2202
+ 200: TextToImageOutput;
2203
+ };
2204
+ export type InvokeTextToImageStepTemplateResponse =
2205
+ InvokeTextToImageStepTemplateResponses[keyof InvokeTextToImageStepTemplateResponses];
2206
+ export type InvokeVideoEnhancementStepTemplateData = {
2207
+ body?: VideoEnhancementInput;
2208
+ path?: never;
2209
+ query?: never;
2210
+ url: '/v2/consumer/recipes/videoEnhancement';
2211
+ };
2212
+ export type InvokeVideoEnhancementStepTemplateErrors = {
2213
+ /**
2214
+ * Bad Request
2215
+ */
2216
+ 400: ProblemDetails;
2217
+ /**
2218
+ * Unauthorized
2219
+ */
2220
+ 401: ProblemDetails;
2221
+ };
2222
+ export type InvokeVideoEnhancementStepTemplateError =
2223
+ InvokeVideoEnhancementStepTemplateErrors[keyof InvokeVideoEnhancementStepTemplateErrors];
2224
+ export type InvokeVideoEnhancementStepTemplateResponses = {
2225
+ /**
2226
+ * OK
2227
+ */
2228
+ 200: VideoEnhancementOutput;
2229
+ };
2230
+ export type InvokeVideoEnhancementStepTemplateResponse =
2231
+ InvokeVideoEnhancementStepTemplateResponses[keyof InvokeVideoEnhancementStepTemplateResponses];
2232
+ export type InvokeVideoGenStepTemplateData = {
2233
+ body?: VideoGenInput;
2234
+ path?: never;
2235
+ query?: never;
2236
+ url: '/v2/consumer/recipes/videoGen';
2237
+ };
2238
+ export type InvokeVideoGenStepTemplateErrors = {
2239
+ /**
2240
+ * Bad Request
2241
+ */
2242
+ 400: ProblemDetails;
2243
+ /**
2244
+ * Unauthorized
2245
+ */
2246
+ 401: ProblemDetails;
2247
+ };
2248
+ export type InvokeVideoGenStepTemplateError =
2249
+ InvokeVideoGenStepTemplateErrors[keyof InvokeVideoGenStepTemplateErrors];
2250
+ export type InvokeVideoGenStepTemplateResponses = {
2251
+ /**
2252
+ * OK
2253
+ */
2254
+ 200: VideoGenOutput;
2343
2255
  };
2344
- export type GetResourceResponse = ResourceInfo;
2345
- export type GetResourceError = ProblemDetails;
2256
+ export type InvokeVideoGenStepTemplateResponse =
2257
+ InvokeVideoGenStepTemplateResponses[keyof InvokeVideoGenStepTemplateResponses];
2346
2258
  export type InvalidateResourceData = {
2259
+ body?: never;
2347
2260
  path: {
2348
2261
  /**
2349
2262
  * A unique ID for the resource being requested. See https://developer.civitai.com/docs/getting-started/ai-resource-identifier for more info on AIRs.
@@ -2355,102 +2268,108 @@ export type InvalidateResourceData = {
2355
2268
  * One or more userIds to invalidate early access for
2356
2269
  */
2357
2270
  userId?: Array<number>;
2271
+ etag?: string;
2358
2272
  };
2273
+ url: '/v2/resources/{air}';
2359
2274
  };
2360
- export type InvalidateResourceResponse = void;
2361
- export type InvalidateResourceError = ProblemDetails;
2362
- export type GetJobsData = {
2363
- path: {
2364
- workerId: string;
2365
- };
2366
- query?: {
2367
- claim?: boolean;
2368
- take?: number;
2369
- wait?: number;
2370
- };
2275
+ export type InvalidateResourceErrors = {
2276
+ /**
2277
+ * Bad Request
2278
+ */
2279
+ 400: ProblemDetails;
2280
+ };
2281
+ export type InvalidateResourceError = InvalidateResourceErrors[keyof InvalidateResourceErrors];
2282
+ export type InvalidateResourceResponses = {
2283
+ /**
2284
+ * No Content
2285
+ */
2286
+ 204: void;
2371
2287
  };
2372
- export type GetJobsResponse = Array<Job>;
2373
- export type GetJobsError = ProblemDetails;
2374
- export type DownloadResourceData = {
2288
+ export type InvalidateResourceResponse =
2289
+ InvalidateResourceResponses[keyof InvalidateResourceResponses];
2290
+ export type GetResourceData = {
2291
+ body?: never;
2375
2292
  path: {
2293
+ /**
2294
+ * A unique ID for the resource being requested. See https://developer.civitai.com/docs/getting-started/ai-resource-identifier for more info on AIRs.
2295
+ */
2376
2296
  air: string;
2377
- workerId: string;
2378
2297
  };
2298
+ query?: never;
2299
+ url: '/v2/resources/{air}';
2379
2300
  };
2380
- export type DownloadResourceResponse = ProblemDetails;
2381
- export type DownloadResourceError = unknown & ProblemDetails;
2382
- export type CreateWorkerData = {
2301
+ export type GetResourceErrors = {
2383
2302
  /**
2384
- * The registration specifying the details of the worker to be created.
2303
+ * Bad Request
2385
2304
  */
2386
- body?: WorkerRegistration;
2305
+ 400: ProblemDetails;
2306
+ /**
2307
+ * Not Found
2308
+ */
2309
+ 404: ProblemDetails;
2387
2310
  };
2388
- export type CreateWorkerResponse = CreateWorkerResult;
2389
- export type CreateWorkerError = ProblemDetails;
2390
- export type QueryWorkersResponse = Array<WorkerDetails>;
2391
- export type QueryWorkersError = ProblemDetails;
2392
- export type GetWorkerData = {
2393
- path: {
2311
+ export type GetResourceError = GetResourceErrors[keyof GetResourceErrors];
2312
+ export type GetResourceResponses = {
2313
+ /**
2314
+ * OK
2315
+ */
2316
+ 200: ResourceInfo;
2317
+ };
2318
+ export type GetResourceResponse = GetResourceResponses[keyof GetResourceResponses];
2319
+ export type QueryWorkflowsData = {
2320
+ body?: never;
2321
+ headers?: {
2394
2322
  /**
2395
- * The ID for the requested worker.
2323
+ * Specify 'application/zip' to get the response as a zip file
2396
2324
  */
2397
- workerId: string;
2325
+ Accept?: string;
2398
2326
  };
2399
- };
2400
- export type GetWorkerResponse = WorkerDetails;
2401
- export type GetWorkerError = ProblemDetails;
2402
- export type DeleteWorkerData = {
2403
- path: {
2327
+ path?: never;
2328
+ query?: {
2404
2329
  /**
2405
- * The ID for the worker to be deleted.
2330
+ * An optional cursor to continue querying workflows from a previous query.
2406
2331
  */
2407
- workerId: string;
2408
- };
2409
- };
2410
- export type DeleteWorkerResponse = void;
2411
- export type DeleteWorkerError = ProblemDetails;
2412
- export type GetRegistrationData = {
2413
- path: {
2332
+ cursor?: string;
2333
+ /**
2334
+ * How many workflows to return
2335
+ */
2336
+ take?: number;
2337
+ /**
2338
+ * An optional list of tags to query by
2339
+ */
2340
+ tags?: Array<string>;
2414
2341
  /**
2415
- * The ID of the worker whose registration is being requested.
2342
+ * An optional additional query that is used to match workflows through metadata
2416
2343
  */
2417
- workerId: string;
2344
+ query?: string;
2345
+ /**
2346
+ * Whether to return data from oldest to newest
2347
+ */
2348
+ ascending?: boolean;
2349
+ /**
2350
+ * When set to true, any blob that has mature won't be available and won't have a URL
2351
+ */
2352
+ hideMatureContent?: boolean;
2418
2353
  };
2354
+ url: '/v2/consumer/workflows';
2419
2355
  };
2420
- export type GetRegistrationResponse = WorkerRegistration;
2421
- export type GetRegistrationError = ProblemDetails;
2422
- export type UpdateWorkerRegistrationData = {
2356
+ export type QueryWorkflowsErrors = {
2423
2357
  /**
2424
- * The registration details to update on the worker's registration.
2358
+ * Unauthorized
2425
2359
  */
2426
- body?: WorkerRegistration;
2427
- path: {
2428
- /**
2429
- * The ID for the worker whose registration is being updated.
2430
- */
2431
- workerId: string;
2432
- };
2360
+ 401: ProblemDetails;
2433
2361
  };
2434
- export type UpdateWorkerRegistrationResponse = void;
2435
- export type UpdateWorkerRegistrationError = ProblemDetails;
2436
- export type PatchWorkerResourcesData = {
2362
+ export type QueryWorkflowsError = QueryWorkflowsErrors[keyof QueryWorkflowsErrors];
2363
+ export type QueryWorkflowsResponses = {
2437
2364
  /**
2438
- * A dictionary of resource AIRs and their corresponding status for on that worker.
2365
+ * OK
2439
2366
  */
2440
- body?: {
2441
- [key: string]: WorkerResourceStatus;
2442
- };
2443
- path: {
2444
- /**
2445
- * The ID for the worker whose registration resources are being patched.
2446
- */
2447
- workerId: string;
2448
- };
2367
+ 200: CursedArrayOfTelemetryCursorAndWorkflow;
2449
2368
  };
2450
- export type PatchWorkerResourcesResponse = void;
2451
- export type PatchWorkerResourcesError = ProblemDetails;
2369
+ export type QueryWorkflowsResponse = QueryWorkflowsResponses[keyof QueryWorkflowsResponses];
2452
2370
  export type SubmitWorkflowData = {
2453
2371
  body?: WorkflowTemplate;
2372
+ path?: never;
2454
2373
  query?: {
2455
2374
  /**
2456
2375
  * Whether to wait for the workflow to complete before returning or to return immediately
@@ -2462,35 +2381,74 @@ export type SubmitWorkflowData = {
2462
2381
  * Whether to actually submit the workflow or return an estimate on what would happen upon submission
2463
2382
  */
2464
2383
  whatif?: boolean;
2465
- };
2466
- };
2467
- export type SubmitWorkflowResponse = Workflow;
2468
- export type SubmitWorkflowError = ProblemDetails;
2469
- export type QueryWorkflowsData = {
2470
- headers?: {
2471
2384
  /**
2472
- * Specify 'application/zip' to get the response as a zip file
2385
+ * When set to true, any blob that has mature won't be available and won't have a URL
2473
2386
  */
2474
- Accept?: string;
2387
+ hideMatureContent?: boolean;
2475
2388
  };
2476
- query?: {
2477
- /**
2478
- * An optional cursor to continue querying workflows from a previous query.
2479
- */
2480
- cursor?: string;
2481
- /**
2482
- * An optional list of tags to query by
2483
- */
2484
- tags?: Array<string>;
2389
+ url: '/v2/consumer/workflows';
2390
+ };
2391
+ export type SubmitWorkflowErrors = {
2392
+ /**
2393
+ * Bad Request
2394
+ */
2395
+ 400: ProblemDetails;
2396
+ /**
2397
+ * Unauthorized
2398
+ */
2399
+ 401: ProblemDetails;
2400
+ /**
2401
+ * Forbidden
2402
+ */
2403
+ 403: string;
2404
+ /**
2405
+ * Too Many Requests
2406
+ */
2407
+ 429: ProblemDetails;
2408
+ };
2409
+ export type SubmitWorkflowError = SubmitWorkflowErrors[keyof SubmitWorkflowErrors];
2410
+ export type SubmitWorkflowResponses = {
2411
+ /**
2412
+ * OK
2413
+ */
2414
+ 200: Workflow;
2415
+ /**
2416
+ * Accepted
2417
+ */
2418
+ 202: Workflow;
2419
+ };
2420
+ export type SubmitWorkflowResponse = SubmitWorkflowResponses[keyof SubmitWorkflowResponses];
2421
+ export type DeleteWorkflowData = {
2422
+ body?: never;
2423
+ path: {
2485
2424
  /**
2486
- * How many workflows to return
2425
+ * The ID of the workflow to delete.
2487
2426
  */
2488
- take?: number;
2427
+ workflowId: string;
2489
2428
  };
2429
+ query?: never;
2430
+ url: '/v2/consumer/workflows/{workflowId}';
2431
+ };
2432
+ export type DeleteWorkflowErrors = {
2433
+ /**
2434
+ * Unauthorized
2435
+ */
2436
+ 401: ProblemDetails;
2437
+ /**
2438
+ * Not Found
2439
+ */
2440
+ 404: ProblemDetails;
2490
2441
  };
2491
- export type QueryWorkflowsResponse = CursedArrayOfTelemetryCursorAndWorkflow;
2492
- export type QueryWorkflowsError = ProblemDetails;
2442
+ export type DeleteWorkflowError = DeleteWorkflowErrors[keyof DeleteWorkflowErrors];
2443
+ export type DeleteWorkflowResponses = {
2444
+ /**
2445
+ * No Content
2446
+ */
2447
+ 204: void;
2448
+ };
2449
+ export type DeleteWorkflowResponse = DeleteWorkflowResponses[keyof DeleteWorkflowResponses];
2493
2450
  export type GetWorkflowData = {
2451
+ body?: never;
2494
2452
  path: {
2495
2453
  /**
2496
2454
  * The ID of the workflow to get status for
@@ -2504,10 +2462,67 @@ export type GetWorkflowData = {
2504
2462
  * In which case the client should use the token to query the status of the workflow.
2505
2463
  */
2506
2464
  wait?: boolean;
2465
+ /**
2466
+ * When set to true, any blob that has mature won't be available and won't have a URL
2467
+ */
2468
+ hideMatureContent?: boolean;
2507
2469
  };
2470
+ url: '/v2/consumer/workflows/{workflowId}';
2471
+ };
2472
+ export type GetWorkflowErrors = {
2473
+ /**
2474
+ * Unauthorized
2475
+ */
2476
+ 401: ProblemDetails;
2477
+ /**
2478
+ * Not Found
2479
+ */
2480
+ 404: ProblemDetails;
2481
+ };
2482
+ export type GetWorkflowError = GetWorkflowErrors[keyof GetWorkflowErrors];
2483
+ export type GetWorkflowResponses = {
2484
+ /**
2485
+ * OK
2486
+ */
2487
+ 200: Workflow;
2488
+ };
2489
+ export type GetWorkflowResponse = GetWorkflowResponses[keyof GetWorkflowResponses];
2490
+ export type PatchWorkflowData = {
2491
+ /**
2492
+ * A valid PATCH document
2493
+ */
2494
+ body?: JsonPatchDocument;
2495
+ path: {
2496
+ /**
2497
+ * The ID of the workflow to patch
2498
+ */
2499
+ workflowId: string;
2500
+ };
2501
+ query?: never;
2502
+ url: '/v2/consumer/workflows/{workflowId}';
2503
+ };
2504
+ export type PatchWorkflowErrors = {
2505
+ /**
2506
+ * Bad Request
2507
+ */
2508
+ 400: ProblemDetails;
2509
+ /**
2510
+ * Unauthorized
2511
+ */
2512
+ 401: ProblemDetails;
2513
+ /**
2514
+ * Not Found
2515
+ */
2516
+ 404: ProblemDetails;
2517
+ };
2518
+ export type PatchWorkflowError = PatchWorkflowErrors[keyof PatchWorkflowErrors];
2519
+ export type PatchWorkflowResponses = {
2520
+ /**
2521
+ * No Content
2522
+ */
2523
+ 204: void;
2508
2524
  };
2509
- export type GetWorkflowResponse = Workflow;
2510
- export type GetWorkflowError = ProblemDetails;
2525
+ export type PatchWorkflowResponse = PatchWorkflowResponses[keyof PatchWorkflowResponses];
2511
2526
  export type UpdateWorkflowData = {
2512
2527
  /**
2513
2528
  * The details to update on the workflow.
@@ -2519,27 +2534,66 @@ export type UpdateWorkflowData = {
2519
2534
  */
2520
2535
  workflowId: string;
2521
2536
  };
2537
+ query?: never;
2538
+ url: '/v2/consumer/workflows/{workflowId}';
2522
2539
  };
2523
- export type UpdateWorkflowResponse = void;
2524
- export type UpdateWorkflowError = ProblemDetails;
2525
- export type PatchWorkflowData = {
2526
- body?: JsonPatchDocument;
2527
- path: {
2528
- workflowId: string;
2529
- };
2540
+ export type UpdateWorkflowErrors = {
2541
+ /**
2542
+ * Bad Request
2543
+ */
2544
+ 400: ProblemDetails;
2545
+ /**
2546
+ * Unauthorized
2547
+ */
2548
+ 401: ProblemDetails;
2549
+ /**
2550
+ * Not Found
2551
+ */
2552
+ 404: ProblemDetails;
2530
2553
  };
2531
- export type PatchWorkflowResponse = void;
2532
- export type PatchWorkflowError = ProblemDetails;
2533
- export type DeleteWorkflowData = {
2554
+ export type UpdateWorkflowError = UpdateWorkflowErrors[keyof UpdateWorkflowErrors];
2555
+ export type UpdateWorkflowResponses = {
2556
+ /**
2557
+ * No Content
2558
+ */
2559
+ 204: void;
2560
+ };
2561
+ export type UpdateWorkflowResponse = UpdateWorkflowResponses[keyof UpdateWorkflowResponses];
2562
+ export type RemoveAllWorkflowTagsData = {
2563
+ body?: never;
2534
2564
  path: {
2535
2565
  /**
2536
- * The ID of the workflow to delete.
2566
+ * The ID of the worfklow to update.
2537
2567
  */
2538
2568
  workflowId: string;
2539
2569
  };
2570
+ query?: never;
2571
+ url: '/v2/consumer/workflows/{workflowId}/tags';
2540
2572
  };
2541
- export type DeleteWorkflowResponse = void;
2542
- export type DeleteWorkflowError = ProblemDetails;
2573
+ export type RemoveAllWorkflowTagsErrors = {
2574
+ /**
2575
+ * Bad Request
2576
+ */
2577
+ 400: ValidationProblemDetails;
2578
+ /**
2579
+ * Unauthorized
2580
+ */
2581
+ 401: ProblemDetails;
2582
+ /**
2583
+ * Not Found
2584
+ */
2585
+ 404: ProblemDetails;
2586
+ };
2587
+ export type RemoveAllWorkflowTagsError =
2588
+ RemoveAllWorkflowTagsErrors[keyof RemoveAllWorkflowTagsErrors];
2589
+ export type RemoveAllWorkflowTagsResponses = {
2590
+ /**
2591
+ * No Content
2592
+ */
2593
+ 204: void;
2594
+ };
2595
+ export type RemoveAllWorkflowTagsResponse =
2596
+ RemoveAllWorkflowTagsResponses[keyof RemoveAllWorkflowTagsResponses];
2543
2597
  export type AddWorkflowTagData = {
2544
2598
  /**
2545
2599
  * The the tag to add to the workflow.
@@ -2551,662 +2605,171 @@ export type AddWorkflowTagData = {
2551
2605
  */
2552
2606
  workflowId: string;
2553
2607
  };
2608
+ query?: never;
2609
+ url: '/v2/consumer/workflows/{workflowId}/tags';
2554
2610
  };
2555
- export type AddWorkflowTagResponse = void;
2556
- export type AddWorkflowTagError = ValidationProblemDetails & ProblemDetails;
2557
- export type RemoveAllWorkflowTagsData = {
2611
+ export type AddWorkflowTagErrors = {
2612
+ /**
2613
+ * Bad Request
2614
+ */
2615
+ 400: ValidationProblemDetails;
2616
+ /**
2617
+ * Unauthorized
2618
+ */
2619
+ 401: ProblemDetails;
2620
+ /**
2621
+ * Not Found
2622
+ */
2623
+ 404: ProblemDetails;
2624
+ };
2625
+ export type AddWorkflowTagError = AddWorkflowTagErrors[keyof AddWorkflowTagErrors];
2626
+ export type AddWorkflowTagResponses = {
2627
+ /**
2628
+ * No Content
2629
+ */
2630
+ 204: void;
2631
+ };
2632
+ export type AddWorkflowTagResponse = AddWorkflowTagResponses[keyof AddWorkflowTagResponses];
2633
+ export type RemoveWorkflowTagData = {
2634
+ body?: never;
2558
2635
  path: {
2559
2636
  /**
2560
2637
  * The ID of the worfklow to update.
2561
2638
  */
2562
2639
  workflowId: string;
2563
- };
2564
- };
2565
- export type RemoveAllWorkflowTagsResponse = void;
2566
- export type RemoveAllWorkflowTagsError = ValidationProblemDetails & ProblemDetails;
2567
- export type RemoveWorkflowTagData = {
2568
- path: {
2569
2640
  /**
2570
2641
  * The the tag to remove from the workflow.
2571
2642
  */
2572
2643
  tag: string;
2573
- /**
2574
- * The ID of the worfklow to update.
2575
- */
2576
- workflowId: string;
2577
2644
  };
2645
+ query?: never;
2646
+ url: '/v2/consumer/workflows/{workflowId}/tags/{tag}';
2647
+ };
2648
+ export type RemoveWorkflowTagErrors = {
2649
+ /**
2650
+ * Bad Request
2651
+ */
2652
+ 400: ValidationProblemDetails;
2653
+ /**
2654
+ * Unauthorized
2655
+ */
2656
+ 401: ProblemDetails;
2657
+ /**
2658
+ * Not Found
2659
+ */
2660
+ 404: ProblemDetails;
2661
+ };
2662
+ export type RemoveWorkflowTagError = RemoveWorkflowTagErrors[keyof RemoveWorkflowTagErrors];
2663
+ export type RemoveWorkflowTagResponses = {
2664
+ /**
2665
+ * No Content
2666
+ */
2667
+ 204: void;
2578
2668
  };
2579
- export type RemoveWorkflowTagResponse = void;
2580
- export type RemoveWorkflowTagError = ValidationProblemDetails & ProblemDetails;
2669
+ export type RemoveWorkflowTagResponse =
2670
+ RemoveWorkflowTagResponses[keyof RemoveWorkflowTagResponses];
2581
2671
  export type GetWorkflowStepData = {
2672
+ body?: never;
2582
2673
  path: {
2583
2674
  /**
2584
- * The name of the step within the workflow to get status for
2675
+ * The id of the workflow to get status for
2585
2676
  */
2586
- stepName: string;
2677
+ workflowId: string;
2587
2678
  /**
2588
- * The id of the workflow to get status for
2679
+ * The name of the step within the workflow to get status for
2589
2680
  */
2681
+ stepName: string;
2682
+ };
2683
+ query?: never;
2684
+ url: '/v2/consumer/workflows/{workflowId}/steps/{stepName}';
2685
+ };
2686
+ export type GetWorkflowStepErrors = {
2687
+ /**
2688
+ * Unauthorized
2689
+ */
2690
+ 401: ProblemDetails;
2691
+ /**
2692
+ * Not Found
2693
+ */
2694
+ 404: ProblemDetails;
2695
+ };
2696
+ export type GetWorkflowStepError = GetWorkflowStepErrors[keyof GetWorkflowStepErrors];
2697
+ export type GetWorkflowStepResponses = {
2698
+ /**
2699
+ * OK
2700
+ */
2701
+ 200: WorkflowStep;
2702
+ };
2703
+ export type GetWorkflowStepResponse = GetWorkflowStepResponses[keyof GetWorkflowStepResponses];
2704
+ export type PatchWorkflowStepData = {
2705
+ body?: JsonPatchDocument;
2706
+ path: {
2590
2707
  workflowId: string;
2708
+ stepName: string;
2591
2709
  };
2710
+ query?: never;
2711
+ url: '/v2/consumer/workflows/{workflowId}/steps/{stepName}';
2712
+ };
2713
+ export type PatchWorkflowStepErrors = {
2714
+ /**
2715
+ * Unauthorized
2716
+ */
2717
+ 401: ProblemDetails;
2718
+ /**
2719
+ * Not Found
2720
+ */
2721
+ 404: ProblemDetails;
2592
2722
  };
2593
- export type GetWorkflowStepResponse = WorkflowStep;
2594
- export type GetWorkflowStepError = ProblemDetails;
2723
+ export type PatchWorkflowStepError = PatchWorkflowStepErrors[keyof PatchWorkflowStepErrors];
2724
+ export type PatchWorkflowStepResponses = {
2725
+ /**
2726
+ * No Content
2727
+ */
2728
+ 204: void;
2729
+ };
2730
+ export type PatchWorkflowStepResponse =
2731
+ PatchWorkflowStepResponses[keyof PatchWorkflowStepResponses];
2595
2732
  export type UpdateWorkflowStepData = {
2596
2733
  /**
2597
2734
  * The details to update on the workflow step.
2598
2735
  */
2599
2736
  body?: UpdateWorkflowStepRequest;
2600
2737
  path: {
2601
- /**
2602
- * The name of the step to update.
2603
- */
2604
- stepName: string;
2605
2738
  /**
2606
2739
  * The id of the workflow to update.
2607
2740
  */
2608
2741
  workflowId: string;
2609
- };
2610
- };
2611
- export type UpdateWorkflowStepResponse = void;
2612
- export type UpdateWorkflowStepError = ProblemDetails;
2613
- export type PatchWorkflowStepData = {
2614
- body?: JsonPatchDocument;
2615
- path: {
2742
+ /**
2743
+ * The name of the step to update.
2744
+ */
2616
2745
  stepName: string;
2617
- workflowId: string;
2618
2746
  };
2747
+ query?: never;
2748
+ url: '/v2/consumer/workflows/{workflowId}/steps/{stepName}';
2619
2749
  };
2620
- export type PatchWorkflowStepResponse = void;
2621
- export type PatchWorkflowStepError = ProblemDetails;
2622
- export type $OpenApiTs = {
2623
- '/v2/providers/blobs/{blobKey}': {
2624
- put: {
2625
- req: PutV2ProvidersBlobsByBlobKeyData;
2626
- res: {
2627
- /**
2628
- * Accepted
2629
- */
2630
- '202': unknown;
2631
- /**
2632
- * Unauthorized
2633
- */
2634
- '401': ProblemDetails;
2635
- /**
2636
- * Forbidden
2637
- */
2638
- '403': ProblemDetails;
2639
- };
2640
- };
2641
- };
2642
- '/v2/consumer/blobs/{blobId}': {
2643
- get: {
2644
- req: GetBlobData;
2645
- res: {
2646
- /**
2647
- * Unauthorized
2648
- */
2649
- '401': ProblemDetails;
2650
- };
2651
- };
2652
- };
2653
- '/v2/providers/configurations': {
2654
- post: {
2655
- req: CreateConfigurationData;
2656
- res: {
2657
- /**
2658
- * OK
2659
- */
2660
- '200': CreateConfigurationResult;
2661
- /**
2662
- * Unauthorized
2663
- */
2664
- '401': ProblemDetails;
2665
- /**
2666
- * Forbidden
2667
- */
2668
- '403': ProblemDetails;
2669
- };
2670
- };
2671
- get: {
2672
- res: {
2673
- /**
2674
- * OK
2675
- */
2676
- '200': ConfigurationStatus;
2677
- /**
2678
- * Unauthorized
2679
- */
2680
- '401': ProblemDetails;
2681
- /**
2682
- * Forbidden
2683
- */
2684
- '403': ProblemDetails;
2685
- };
2686
- };
2687
- };
2688
- '/v2/providers/configurations/{configurationId}/options': {
2689
- get: {
2690
- req: GetConfigurationData;
2691
- res: {
2692
- /**
2693
- * OK
2694
- */
2695
- '200': ConfigurationOptions;
2696
- /**
2697
- * Unauthorized
2698
- */
2699
- '401': ProblemDetails;
2700
- /**
2701
- * Forbidden
2702
- */
2703
- '403': ProblemDetails;
2704
- /**
2705
- * Not Found
2706
- */
2707
- '404': ProblemDetails;
2708
- };
2709
- };
2710
- };
2711
- '/v2/providers/configurations/{configurationId}': {
2712
- delete: {
2713
- req: DeleteConfigurationData;
2714
- res: {
2715
- /**
2716
- * OK
2717
- */
2718
- '200': unknown;
2719
- /**
2720
- * Unauthorized
2721
- */
2722
- '401': ProblemDetails;
2723
- /**
2724
- * Forbidden
2725
- */
2726
- '403': ProblemDetails;
2727
- /**
2728
- * Not Found
2729
- */
2730
- '404': ProblemDetails;
2731
- };
2732
- };
2733
- };
2734
- '/v2/resources/{air}': {
2735
- get: {
2736
- req: GetResourceData;
2737
- res: {
2738
- /**
2739
- * OK
2740
- */
2741
- '200': ResourceInfo;
2742
- /**
2743
- * Bad Request
2744
- */
2745
- '400': ProblemDetails;
2746
- /**
2747
- * Not Found
2748
- */
2749
- '404': ProblemDetails;
2750
- };
2751
- };
2752
- delete: {
2753
- req: InvalidateResourceData;
2754
- res: {
2755
- /**
2756
- * No Content
2757
- */
2758
- '204': void;
2759
- /**
2760
- * Bad Request
2761
- */
2762
- '400': ProblemDetails;
2763
- };
2764
- };
2765
- };
2766
- '/v2/providers/workers/{workerId}/jobs': {
2767
- get: {
2768
- req: GetJobsData;
2769
- res: {
2770
- /**
2771
- * OK
2772
- */
2773
- '200': Array<Job>;
2774
- /**
2775
- * Unauthorized
2776
- */
2777
- '401': ProblemDetails;
2778
- /**
2779
- * Forbidden
2780
- */
2781
- '403': ProblemDetails;
2782
- /**
2783
- * Not Found
2784
- */
2785
- '404': ProblemDetails;
2786
- };
2787
- };
2788
- };
2789
- '/v2/providers/workers/{workerId}/resources/{air}': {
2790
- get: {
2791
- req: DownloadResourceData;
2792
- res: {
2793
- /**
2794
- * Temporary Redirect
2795
- */
2796
- '307': unknown;
2797
- /**
2798
- * Bad Request
2799
- */
2800
- '400': ProblemDetails;
2801
- /**
2802
- * Unauthorized
2803
- */
2804
- '401': ProblemDetails;
2805
- /**
2806
- * Forbidden
2807
- */
2808
- '403': ProblemDetails;
2809
- /**
2810
- * Not Found
2811
- */
2812
- '404': ProblemDetails;
2813
- /**
2814
- * Error
2815
- */
2816
- default: ProblemDetails;
2817
- };
2818
- };
2819
- };
2820
- '/v2/providers/workers': {
2821
- post: {
2822
- req: CreateWorkerData;
2823
- res: {
2824
- /**
2825
- * Created
2826
- */
2827
- '201': CreateWorkerResult;
2828
- /**
2829
- * Bad Request
2830
- */
2831
- '400': ProblemDetails;
2832
- /**
2833
- * Unauthorized
2834
- */
2835
- '401': ProblemDetails;
2836
- /**
2837
- * Forbidden
2838
- */
2839
- '403': ProblemDetails;
2840
- };
2841
- };
2842
- get: {
2843
- res: {
2844
- /**
2845
- * OK
2846
- */
2847
- '200': Array<WorkerDetails>;
2848
- /**
2849
- * Unauthorized
2850
- */
2851
- '401': ProblemDetails;
2852
- /**
2853
- * Forbidden
2854
- */
2855
- '403': ProblemDetails;
2856
- };
2857
- };
2858
- };
2859
- '/v2/providers/workers/{workerId}': {
2860
- get: {
2861
- req: GetWorkerData;
2862
- res: {
2863
- /**
2864
- * OK
2865
- */
2866
- '200': WorkerDetails;
2867
- /**
2868
- * Unauthorized
2869
- */
2870
- '401': ProblemDetails;
2871
- /**
2872
- * Forbidden
2873
- */
2874
- '403': ProblemDetails;
2875
- /**
2876
- * Not Found
2877
- */
2878
- '404': ProblemDetails;
2879
- };
2880
- };
2881
- delete: {
2882
- req: DeleteWorkerData;
2883
- res: {
2884
- /**
2885
- * No Content
2886
- */
2887
- '204': void;
2888
- /**
2889
- * Unauthorized
2890
- */
2891
- '401': ProblemDetails;
2892
- /**
2893
- * Forbidden
2894
- */
2895
- '403': ProblemDetails;
2896
- /**
2897
- * Not Found
2898
- */
2899
- '404': ProblemDetails;
2900
- };
2901
- };
2902
- };
2903
- '/v2/providers/workers/{workerId}/registration': {
2904
- get: {
2905
- req: GetRegistrationData;
2906
- res: {
2907
- /**
2908
- * OK
2909
- */
2910
- '200': WorkerRegistration;
2911
- /**
2912
- * Unauthorized
2913
- */
2914
- '401': ProblemDetails;
2915
- /**
2916
- * Forbidden
2917
- */
2918
- '403': ProblemDetails;
2919
- /**
2920
- * Not Found
2921
- */
2922
- '404': ProblemDetails;
2923
- };
2924
- };
2925
- put: {
2926
- req: UpdateWorkerRegistrationData;
2927
- res: {
2928
- /**
2929
- * No Content
2930
- */
2931
- '204': void;
2932
- /**
2933
- * Bad Request
2934
- */
2935
- '400': ProblemDetails;
2936
- /**
2937
- * Unauthorized
2938
- */
2939
- '401': ProblemDetails;
2940
- /**
2941
- * Forbidden
2942
- */
2943
- '403': ProblemDetails;
2944
- /**
2945
- * Not Found
2946
- */
2947
- '404': ProblemDetails;
2948
- };
2949
- };
2950
- };
2951
- '/v2/providers/workers/{workerId}/registration/resources': {
2952
- patch: {
2953
- req: PatchWorkerResourcesData;
2954
- res: {
2955
- /**
2956
- * No Content
2957
- */
2958
- '204': void;
2959
- /**
2960
- * Bad Request
2961
- */
2962
- '400': ProblemDetails;
2963
- /**
2964
- * Unauthorized
2965
- */
2966
- '401': ProblemDetails;
2967
- /**
2968
- * Forbidden
2969
- */
2970
- '403': ProblemDetails;
2971
- /**
2972
- * Not Found
2973
- */
2974
- '404': ProblemDetails;
2975
- };
2976
- };
2977
- };
2978
- '/v2/consumer/workflows': {
2979
- post: {
2980
- req: SubmitWorkflowData;
2981
- res: {
2982
- /**
2983
- * OK
2984
- */
2985
- '200': Workflow;
2986
- /**
2987
- * Bad Request
2988
- */
2989
- '400': ProblemDetails;
2990
- /**
2991
- * Unauthorized
2992
- */
2993
- '401': ProblemDetails;
2994
- /**
2995
- * Too Many Requests
2996
- */
2997
- '429': ProblemDetails;
2998
- };
2999
- };
3000
- get: {
3001
- req: QueryWorkflowsData;
3002
- res: {
3003
- /**
3004
- * OK
3005
- */
3006
- '200': CursedArrayOfTelemetryCursorAndWorkflow;
3007
- /**
3008
- * Unauthorized
3009
- */
3010
- '401': ProblemDetails;
3011
- };
3012
- };
3013
- };
3014
- '/v2/consumer/workflows/{workflowId}': {
3015
- get: {
3016
- req: GetWorkflowData;
3017
- res: {
3018
- /**
3019
- * OK
3020
- */
3021
- '200': Workflow;
3022
- /**
3023
- * Unauthorized
3024
- */
3025
- '401': ProblemDetails;
3026
- /**
3027
- * Not Found
3028
- */
3029
- '404': ProblemDetails;
3030
- };
3031
- };
3032
- put: {
3033
- req: UpdateWorkflowData;
3034
- res: {
3035
- /**
3036
- * No Content
3037
- */
3038
- '204': void;
3039
- /**
3040
- * Bad Request
3041
- */
3042
- '400': ProblemDetails;
3043
- /**
3044
- * Unauthorized
3045
- */
3046
- '401': ProblemDetails;
3047
- /**
3048
- * Not Found
3049
- */
3050
- '404': ProblemDetails;
3051
- };
3052
- };
3053
- patch: {
3054
- req: PatchWorkflowData;
3055
- res: {
3056
- /**
3057
- * No Content
3058
- */
3059
- '204': void;
3060
- /**
3061
- * Unauthorized
3062
- */
3063
- '401': ProblemDetails;
3064
- /**
3065
- * Not Found
3066
- */
3067
- '404': ProblemDetails;
3068
- };
3069
- };
3070
- delete: {
3071
- req: DeleteWorkflowData;
3072
- res: {
3073
- /**
3074
- * No Content
3075
- */
3076
- '204': void;
3077
- /**
3078
- * Unauthorized
3079
- */
3080
- '401': ProblemDetails;
3081
- /**
3082
- * Not Found
3083
- */
3084
- '404': ProblemDetails;
3085
- };
3086
- };
3087
- };
3088
- '/v2/consumer/workflows/{workflowId}/tags': {
3089
- post: {
3090
- req: AddWorkflowTagData;
3091
- res: {
3092
- /**
3093
- * No Content
3094
- */
3095
- '204': void;
3096
- /**
3097
- * Bad Request
3098
- */
3099
- '400': ValidationProblemDetails;
3100
- /**
3101
- * Unauthorized
3102
- */
3103
- '401': ProblemDetails;
3104
- /**
3105
- * Not Found
3106
- */
3107
- '404': ProblemDetails;
3108
- };
3109
- };
3110
- delete: {
3111
- req: RemoveAllWorkflowTagsData;
3112
- res: {
3113
- /**
3114
- * No Content
3115
- */
3116
- '204': void;
3117
- /**
3118
- * Bad Request
3119
- */
3120
- '400': ValidationProblemDetails;
3121
- /**
3122
- * Unauthorized
3123
- */
3124
- '401': ProblemDetails;
3125
- /**
3126
- * Not Found
3127
- */
3128
- '404': ProblemDetails;
3129
- };
3130
- };
3131
- };
3132
- '/v2/consumer/workflows/{workflowId}/tags/{tag}': {
3133
- delete: {
3134
- req: RemoveWorkflowTagData;
3135
- res: {
3136
- /**
3137
- * No Content
3138
- */
3139
- '204': void;
3140
- /**
3141
- * Bad Request
3142
- */
3143
- '400': ValidationProblemDetails;
3144
- /**
3145
- * Unauthorized
3146
- */
3147
- '401': ProblemDetails;
3148
- /**
3149
- * Not Found
3150
- */
3151
- '404': ProblemDetails;
3152
- };
3153
- };
3154
- };
3155
- '/v2/consumer/workflows/{workflowId}/steps/{stepName}': {
3156
- get: {
3157
- req: GetWorkflowStepData;
3158
- res: {
3159
- /**
3160
- * OK
3161
- */
3162
- '200': WorkflowStep;
3163
- /**
3164
- * Unauthorized
3165
- */
3166
- '401': ProblemDetails;
3167
- /**
3168
- * Not Found
3169
- */
3170
- '404': ProblemDetails;
3171
- };
3172
- };
3173
- put: {
3174
- req: UpdateWorkflowStepData;
3175
- res: {
3176
- /**
3177
- * No Content
3178
- */
3179
- '204': void;
3180
- /**
3181
- * Bad Request
3182
- */
3183
- '400': ProblemDetails;
3184
- /**
3185
- * Unauthorized
3186
- */
3187
- '401': ProblemDetails;
3188
- /**
3189
- * Not Found
3190
- */
3191
- '404': ProblemDetails;
3192
- };
3193
- };
3194
- patch: {
3195
- req: PatchWorkflowStepData;
3196
- res: {
3197
- /**
3198
- * No Content
3199
- */
3200
- '204': void;
3201
- /**
3202
- * Unauthorized
3203
- */
3204
- '401': ProblemDetails;
3205
- /**
3206
- * Not Found
3207
- */
3208
- '404': ProblemDetails;
3209
- };
3210
- };
3211
- };
2750
+ export type UpdateWorkflowStepErrors = {
2751
+ /**
2752
+ * Bad Request
2753
+ */
2754
+ 400: ProblemDetails;
2755
+ /**
2756
+ * Unauthorized
2757
+ */
2758
+ 401: ProblemDetails;
2759
+ /**
2760
+ * Not Found
2761
+ */
2762
+ 404: ProblemDetails;
2763
+ };
2764
+ export type UpdateWorkflowStepError = UpdateWorkflowStepErrors[keyof UpdateWorkflowStepErrors];
2765
+ export type UpdateWorkflowStepResponses = {
2766
+ /**
2767
+ * No Content
2768
+ */
2769
+ 204: void;
2770
+ };
2771
+ export type UpdateWorkflowStepResponse =
2772
+ UpdateWorkflowStepResponses[keyof UpdateWorkflowStepResponses];
2773
+ export type ClientOptions = {
2774
+ baseUrl: `${string}://swagger.json` | (string & {});
3212
2775
  };