-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathopenapi.yml
More file actions
1057 lines (1057 loc) · 36.9 KB
/
Copy pathopenapi.yml
File metadata and controls
1057 lines (1057 loc) · 36.9 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
components:
schemas:
AbortedEvent:
properties:
event_type:
enum:
- aborted
title: Event Type
type: string
reason:
title: Reason
type: string
task_id:
title: Task Id
type: string
required:
- event_type
- task_id
- reason
title: AbortedEvent
type: object
AuthToken:
properties:
access_token:
title: Access Token
type: string
token_type:
title: Token Type
type: string
required:
- access_token
- token_type
title: AuthToken
type: object
Body_login_access_token_token_post:
properties:
client_id:
title: Client Id
type: string
client_secret:
title: Client Secret
type: string
grant_type:
pattern: password
title: Grant Type
type: string
password:
title: Password
type: string
scope:
default: ''
title: Scope
type: string
username:
title: Username
type: string
required:
- username
- password
title: Body_login_access_token_token_post
type: object
Body_post_blob_blob_post:
properties:
blob_data:
format: binary
title: Blob Data
type: string
required:
- blob_data
title: Body_post_blob_blob_post
type: object
FinishedEvent:
properties:
event_type:
enum:
- finished
title: Event Type
type: string
result:
$ref: '#/components/schemas/GeneratedBlob'
task_id:
title: Task Id
type: string
required:
- event_type
- task_id
- result
title: FinishedEvent
type: object
GeneratedBlob:
properties:
blob_url:
title: Blob Url
type: string
parameters_used:
anyOf:
- $ref: '#/components/schemas/Txt2ImgParams'
- $ref: '#/components/schemas/Img2ImgParams'
- $ref: '#/components/schemas/InpaintParams'
title: Parameters Used
required:
- blob_url
- parameters_used
title: GeneratedBlob
type: object
HTTPValidationError:
properties:
detail:
items:
$ref: '#/components/schemas/ValidationError'
title: Detail
type: array
title: HTTPValidationError
type: object
Img2ImgParams:
additionalProperties: false
properties:
guidance:
default: 7.5
description: 'Higher guidance encourages generation closely linked to `prompt`,
usually at the expense of lower image quality. Try using more steps to
improve image quality when using high guidance. Guidance is disabled by
setting `guidance` to `1`. `guidance` is defined as `w` of equation 2.
of [ImagenPaper](https://arxiv.org/pdf/2205.11487.pdf). See also: [Classifier-Free
Diffusion Guidance](https://arxiv.org/abs/2207.12598).'
minimum: 1.0
title: Guidance
type: number
initial_image:
description: 'The image to use as input for image generation. The image
must have a width and height divisible by 8. '
title: Initial Image
type: string
model:
default: CompVis/stable-diffusion-v1-4
description: 'The model to use for image generation. One of: the *repo id*
of a pretrained pipeline hosted on huggingface (e.g. ''CompVis/stable-diffusion-v1-4''),
*a path* to a *directory* containing pipeline weights, (e.g., ''./my_model_directory/''). '
title: Model
type: string
negative_prompt:
description: The prompt to dissuade image generation. Ignored when not using
guidance (i.e., if `guidance` is `1`).
title: Negative Prompt
type: string
params_type:
default: img2img
enum:
- img2img
title: Params Type
type: string
prompt:
description: The prompt to guide image generation.
title: Prompt
type: string
safety_filter:
default: true
description: Ensure that you abide by the conditions of the Stable Diffusion
license and do not expose unfiltered results in services or applications
open to the public. For more information, please see https://github.com/huggingface/diffusers/pull/254
title: Safety Filter
type: boolean
scheduler:
default: plms
description: The scheduler to use for image generation. Currently only 'plms',
'ddim', and 'k-lms', are supported.
enum:
- plms
- ddim
- k-lms
title: Scheduler
type: string
seed:
description: The randomness seed to use for image generation. If not set,
a random seed is used.
title: Seed
type: integer
steps:
default: 20
description: The number of denoising steps. More denoising steps usually
lead to a higher quality image at the expense of slower inference.
title: Steps
type: integer
strength:
default: 0.8
description: Conceptually, indicates how much to transform the image. The
image will be used as a starting point, adding more noise to it the larger
the `strength`. The number of denoising steps depends on the amount of
noise initially added. When `strength` is 1, it becomes pure noise, and
the denoising process will run for the full number of iterations specified
in `steps`. A value of 1, therefore, works like Txt2Img, essentially ignoring
the reference image.
maximum: 1.0
minimum: 0.0
title: Strength
type: number
required:
- prompt
- initial_image
title: Img2ImgParams
type: object
InpaintParams:
additionalProperties: false
properties:
guidance:
default: 7.5
description: 'Higher guidance encourages generation closely linked to `prompt`,
usually at the expense of lower image quality. Try using more steps to
improve image quality when using high guidance. Guidance is disabled by
setting `guidance` to `1`. `guidance` is defined as `w` of equation 2.
of [ImagenPaper](https://arxiv.org/pdf/2205.11487.pdf). See also: [Classifier-Free
Diffusion Guidance](https://arxiv.org/abs/2207.12598).'
minimum: 1.0
title: Guidance
type: number
initial_image:
description: 'The image to use as input for image generation. It must have
a width and height divisible by 8. '
title: Initial Image
type: string
mask:
description: The mask to use for image generation. It must have the same
width and height as the initial image. It will be converted to a black-and-white
image, wherein white indicates the area to be inpainted.
title: Mask
type: string
model:
default: runwayml/stable-diffusion-inpainting
description: The model to use for image generation, e.g. 'runwayml/stable-diffusion-inpainting'.
title: Model
type: string
negative_prompt:
description: The prompt to dissuade image generation. Ignored when not using
guidance (i.e., if `guidance` is `1`).
title: Negative Prompt
type: string
params_type:
default: inpaint
enum:
- inpaint
title: Params Type
type: string
prompt:
description: The prompt to guide image generation.
title: Prompt
type: string
safety_filter:
default: true
description: Ensure that you abide by the conditions of the Stable Diffusion
license and do not expose unfiltered results in services or applications
open to the public. For more information, please see https://github.com/huggingface/diffusers/pull/254
title: Safety Filter
type: boolean
scheduler:
default: plms
description: The scheduler to use for image generation. Currently only 'plms',
'ddim', and 'k-lms', are supported.
enum:
- plms
- ddim
- k-lms
title: Scheduler
type: string
seed:
description: The randomness seed to use for image generation. If not set,
a random seed is used.
title: Seed
type: integer
steps:
default: 20
description: The number of denoising steps. More denoising steps usually
lead to a higher quality image at the expense of slower inference.
title: Steps
type: integer
required:
- prompt
- initial_image
- mask
title: InpaintParams
type: object
PendingEvent:
properties:
event_type:
enum:
- pending
title: Event Type
type: string
task_id:
title: Task Id
type: string
required:
- event_type
- task_id
title: PendingEvent
type: object
StartedEvent:
properties:
event_type:
enum:
- started
title: Event Type
type: string
task_id:
title: Task Id
type: string
required:
- event_type
- task_id
title: StartedEvent
type: object
Txt2ImgParams:
additionalProperties: false
properties:
guidance:
default: 7.5
description: 'Higher guidance encourages generation closely linked to `prompt`,
usually at the expense of lower image quality. Try using more steps to
improve image quality when using high guidance. Guidance is disabled by
setting `guidance` to `1`. `guidance` is defined as `w` of equation 2.
of [ImagenPaper](https://arxiv.org/pdf/2205.11487.pdf). See also: [Classifier-Free
Diffusion Guidance](https://arxiv.org/abs/2207.12598).'
minimum: 1.0
title: Guidance
type: number
height:
default: 512
description: The pixel height of the generated image.
title: Height
type: integer
model:
default: CompVis/stable-diffusion-v1-4
description: 'The model to use for image generation. One of: the *repo id*
of a pretrained pipeline hosted on huggingface (e.g. ''CompVis/stable-diffusion-v1-4''),
*a path* to a *directory* containing pipeline weights, (e.g., ''./my_model_directory/''). '
title: Model
type: string
negative_prompt:
description: The prompt to dissuade image generation. Ignored when not using
guidance (i.e., if `guidance` is `1`).
title: Negative Prompt
type: string
params_type:
default: txt2img
enum:
- txt2img
title: Params Type
type: string
prompt:
description: The prompt to guide image generation.
title: Prompt
type: string
safety_filter:
default: true
description: Ensure that you abide by the conditions of the Stable Diffusion
license and do not expose unfiltered results in services or applications
open to the public. For more information, please see https://github.com/huggingface/diffusers/pull/254
title: Safety Filter
type: boolean
scheduler:
default: plms
description: The scheduler to use for image generation. Currently only 'plms',
'ddim', and 'k-lms', are supported.
enum:
- plms
- ddim
- k-lms
title: Scheduler
type: string
seed:
description: The randomness seed to use for image generation. If not set,
a random seed is used.
title: Seed
type: integer
steps:
default: 20
description: The number of denoising steps. More denoising steps usually
lead to a higher quality image at the expense of slower inference.
title: Steps
type: integer
width:
default: 512
description: The pixel width of the generated image.
title: Width
type: integer
required:
- prompt
title: Txt2ImgParams
type: object
UserBase:
properties:
username:
title: Username
type: string
required:
- username
title: UserBase
type: object
ValidationError:
properties:
loc:
items:
anyOf:
- type: string
- type: integer
title: Location
type: array
msg:
title: Message
type: string
type:
title: Error Type
type: string
required:
- loc
- msg
- type
title: ValidationError
type: object
securitySchemes:
OAuth2PasswordBearer:
flows:
password:
scopes: {}
tokenUrl: token
type: oauth2
info:
title: Stable Diffusion Server
version: 0.1.0
openapi: 3.0.2
paths:
/blob:
post:
operationId: post_blob_blob_post
requestBody:
content:
multipart/form-data:
schema:
$ref: '#/components/schemas/Body_post_blob_blob_post'
required: true
responses:
'200':
content:
application/json:
schema:
title: Response Post Blob Blob Post
type: string
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Post Blob
/img2img:
get:
operationId: get_endpoint_img2img_get
parameters:
- in: query
name: params_type
required: false
schema:
default: img2img
enum:
- img2img
title: Params Type
type: string
- description: 'The model to use for image generation. One of: the *repo id*
of a pretrained pipeline hosted on huggingface (e.g. ''CompVis/stable-diffusion-v1-4''),
*a path* to a *directory* containing pipeline weights, (e.g., ''./my_model_directory/''). '
in: query
name: model
required: false
schema:
default: CompVis/stable-diffusion-v1-4
description: 'The model to use for image generation. One of: the *repo id*
of a pretrained pipeline hosted on huggingface (e.g. ''CompVis/stable-diffusion-v1-4''),
*a path* to a *directory* containing pipeline weights, (e.g., ''./my_model_directory/''). '
title: Model
type: string
- description: The prompt to guide image generation.
in: query
name: prompt
required: true
schema:
description: The prompt to guide image generation.
title: Prompt
type: string
- description: The prompt to dissuade image generation. Ignored when not using
guidance (i.e., if `guidance` is `1`).
in: query
name: negative_prompt
required: false
schema:
description: The prompt to dissuade image generation. Ignored when not using
guidance (i.e., if `guidance` is `1`).
title: Negative Prompt
type: string
- description: The number of denoising steps. More denoising steps usually lead
to a higher quality image at the expense of slower inference.
in: query
name: steps
required: false
schema:
default: 20
description: The number of denoising steps. More denoising steps usually
lead to a higher quality image at the expense of slower inference.
title: Steps
type: integer
- description: 'Higher guidance encourages generation closely linked to `prompt`,
usually at the expense of lower image quality. Try using more steps to improve
image quality when using high guidance. Guidance is disabled by setting
`guidance` to `1`. `guidance` is defined as `w` of equation 2. of [ImagenPaper](https://arxiv.org/pdf/2205.11487.pdf).
See also: [Classifier-Free Diffusion Guidance](https://arxiv.org/abs/2207.12598).'
in: query
name: guidance
required: false
schema:
default: 7.5
description: 'Higher guidance encourages generation closely linked to `prompt`,
usually at the expense of lower image quality. Try using more steps to
improve image quality when using high guidance. Guidance is disabled by
setting `guidance` to `1`. `guidance` is defined as `w` of equation 2.
of [ImagenPaper](https://arxiv.org/pdf/2205.11487.pdf). See also: [Classifier-Free
Diffusion Guidance](https://arxiv.org/abs/2207.12598).'
minimum: 1.0
title: Guidance
type: number
- description: The scheduler to use for image generation. Currently only 'plms',
'ddim', and 'k-lms', are supported.
in: query
name: scheduler
required: false
schema:
default: plms
description: The scheduler to use for image generation. Currently only 'plms',
'ddim', and 'k-lms', are supported.
enum:
- plms
- ddim
- k-lms
title: Scheduler
type: string
- description: Ensure that you abide by the conditions of the Stable Diffusion
license and do not expose unfiltered results in services or applications
open to the public. For more information, please see https://github.com/huggingface/diffusers/pull/254
in: query
name: safety_filter
required: false
schema:
default: true
description: Ensure that you abide by the conditions of the Stable Diffusion
license and do not expose unfiltered results in services or applications
open to the public. For more information, please see https://github.com/huggingface/diffusers/pull/254
title: Safety Filter
type: boolean
- description: The randomness seed to use for image generation. If not set,
a random seed is used.
in: query
name: seed
required: false
schema:
description: The randomness seed to use for image generation. If not set,
a random seed is used.
title: Seed
type: integer
- description: 'The image to use as input for image generation. The image must
have a width and height divisible by 8. '
in: query
name: initial_image
required: true
schema:
description: 'The image to use as input for image generation. The image
must have a width and height divisible by 8. '
title: Initial Image
type: string
- description: Conceptually, indicates how much to transform the image. The
image will be used as a starting point, adding more noise to it the larger
the `strength`. The number of denoising steps depends on the amount of noise
initially added. When `strength` is 1, it becomes pure noise, and the denoising
process will run for the full number of iterations specified in `steps`.
A value of 1, therefore, works like Txt2Img, essentially ignoring the reference
image.
in: query
name: strength
required: false
schema:
default: 0.8
description: Conceptually, indicates how much to transform the image. The
image will be used as a starting point, adding more noise to it the larger
the `strength`. The number of denoising steps depends on the amount of
noise initially added. When `strength` is 1, it becomes pure noise, and
the denoising process will run for the full number of iterations specified
in `steps`. A value of 1, therefore, works like Txt2Img, essentially ignoring
the reference image.
maximum: 1.0
minimum: 0.0
title: Strength
type: number
responses:
'200':
content:
application/json:
schema: {}
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
summary: img2img
/inpaint:
get:
operationId: get_endpoint_inpaint_get
parameters:
- in: query
name: params_type
required: false
schema:
default: inpaint
enum:
- inpaint
title: Params Type
type: string
- description: The model to use for image generation, e.g. 'runwayml/stable-diffusion-inpainting'.
in: query
name: model
required: false
schema:
default: runwayml/stable-diffusion-inpainting
description: The model to use for image generation, e.g. 'runwayml/stable-diffusion-inpainting'.
title: Model
type: string
- description: The prompt to guide image generation.
in: query
name: prompt
required: true
schema:
description: The prompt to guide image generation.
title: Prompt
type: string
- description: The prompt to dissuade image generation. Ignored when not using
guidance (i.e., if `guidance` is `1`).
in: query
name: negative_prompt
required: false
schema:
description: The prompt to dissuade image generation. Ignored when not using
guidance (i.e., if `guidance` is `1`).
title: Negative Prompt
type: string
- description: The number of denoising steps. More denoising steps usually lead
to a higher quality image at the expense of slower inference.
in: query
name: steps
required: false
schema:
default: 20
description: The number of denoising steps. More denoising steps usually
lead to a higher quality image at the expense of slower inference.
title: Steps
type: integer
- description: 'Higher guidance encourages generation closely linked to `prompt`,
usually at the expense of lower image quality. Try using more steps to improve
image quality when using high guidance. Guidance is disabled by setting
`guidance` to `1`. `guidance` is defined as `w` of equation 2. of [ImagenPaper](https://arxiv.org/pdf/2205.11487.pdf).
See also: [Classifier-Free Diffusion Guidance](https://arxiv.org/abs/2207.12598).'
in: query
name: guidance
required: false
schema:
default: 7.5
description: 'Higher guidance encourages generation closely linked to `prompt`,
usually at the expense of lower image quality. Try using more steps to
improve image quality when using high guidance. Guidance is disabled by
setting `guidance` to `1`. `guidance` is defined as `w` of equation 2.
of [ImagenPaper](https://arxiv.org/pdf/2205.11487.pdf). See also: [Classifier-Free
Diffusion Guidance](https://arxiv.org/abs/2207.12598).'
minimum: 1.0
title: Guidance
type: number
- description: The scheduler to use for image generation. Currently only 'plms',
'ddim', and 'k-lms', are supported.
in: query
name: scheduler
required: false
schema:
default: plms
description: The scheduler to use for image generation. Currently only 'plms',
'ddim', and 'k-lms', are supported.
enum:
- plms
- ddim
- k-lms
title: Scheduler
type: string
- description: Ensure that you abide by the conditions of the Stable Diffusion
license and do not expose unfiltered results in services or applications
open to the public. For more information, please see https://github.com/huggingface/diffusers/pull/254
in: query
name: safety_filter
required: false
schema:
default: true
description: Ensure that you abide by the conditions of the Stable Diffusion
license and do not expose unfiltered results in services or applications
open to the public. For more information, please see https://github.com/huggingface/diffusers/pull/254
title: Safety Filter
type: boolean
- description: The randomness seed to use for image generation. If not set,
a random seed is used.
in: query
name: seed
required: false
schema:
description: The randomness seed to use for image generation. If not set,
a random seed is used.
title: Seed
type: integer
- description: 'The image to use as input for image generation. It must have
a width and height divisible by 8. '
in: query
name: initial_image
required: true
schema:
description: 'The image to use as input for image generation. It must have
a width and height divisible by 8. '
title: Initial Image
type: string
- description: The mask to use for image generation. It must have the same width
and height as the initial image. It will be converted to a black-and-white
image, wherein white indicates the area to be inpainted.
in: query
name: mask
required: true
schema:
description: The mask to use for image generation. It must have the same
width and height as the initial image. It will be converted to a black-and-white
image, wherein white indicates the area to be inpainted.
title: Mask
type: string
responses:
'200':
content:
application/json:
schema: {}
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
summary: inpaint
/task:
post:
operationId: create_task_task_post
requestBody:
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/Txt2ImgParams'
- $ref: '#/components/schemas/Img2ImgParams'
- $ref: '#/components/schemas/InpaintParams'
title: Parameters
required: true
responses:
'200':
content:
application/json:
schema:
title: Response Create Task Task Post
type: string
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
summary: Create Task
/task/{task_id}:
delete:
operationId: delete_task_task__task_id__delete
parameters:
- in: path
name: task_id
required: true
schema:
title: Task Id
type: string
responses:
'200':
content:
application/json:
schema: {}
description: Successful Response
'204':
description: Task cancelled
'404':
description: Task not found
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
summary: Delete Task
get:
operationId: poll_task_status_task__task_id__get
parameters:
- in: path
name: task_id
required: true
schema:
title: Task Id
type: string
responses:
'200':
content:
application/json:
schema:
anyOf:
- $ref: '#/components/schemas/PendingEvent'
- $ref: '#/components/schemas/StartedEvent'
- $ref: '#/components/schemas/AbortedEvent'
- $ref: '#/components/schemas/FinishedEvent'
title: Response Poll Task Status Task Task Id Get
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
security:
- OAuth2PasswordBearer: []
summary: Poll Task Status
/token:
post:
operationId: login_access_token_token_post
requestBody:
content:
application/x-www-form-urlencoded:
schema:
$ref: '#/components/schemas/Body_login_access_token_token_post'
required: true
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AuthToken'
description: Successful Response
'422':
content:
application/json:
schema:
$ref: '#/components/schemas/HTTPValidationError'
description: Validation Error
summary: Login Access Token
/token/all:
post:
operationId: public_access_token_token_all_post
responses:
'200':
content:
application/json:
schema:
$ref: '#/components/schemas/AuthToken'
description: Successful Response
summary: Public Access Token
/txt2img:
get:
operationId: get_endpoint_txt2img_get
parameters:
- in: query
name: params_type
required: false
schema:
default: txt2img
enum:
- txt2img
title: Params Type
type: string
- description: 'The model to use for image generation. One of: the *repo id*
of a pretrained pipeline hosted on huggingface (e.g. ''CompVis/stable-diffusion-v1-4''),
*a path* to a *directory* containing pipeline weights, (e.g., ''./my_model_directory/''). '
in: query
name: model
required: false
schema:
default: CompVis/stable-diffusion-v1-4
description: 'The model to use for image generation. One of: the *repo id*
of a pretrained pipeline hosted on huggingface (e.g. ''CompVis/stable-diffusion-v1-4''),
*a path* to a *directory* containing pipeline weights, (e.g., ''./my_model_directory/''). '
title: Model
type: string
- description: The prompt to guide image generation.
in: query
name: prompt
required: true
schema:
description: The prompt to guide image generation.
title: Prompt
type: string
- description: The prompt to dissuade image generation. Ignored when not using
guidance (i.e., if `guidance` is `1`).
in: query
name: negative_prompt
required: false
schema:
description: The prompt to dissuade image generation. Ignored when not using
guidance (i.e., if `guidance` is `1`).
title: Negative Prompt
type: string
- description: The number of denoising steps. More denoising steps usually lead
to a higher quality image at the expense of slower inference.
in: query
name: steps
required: false
schema:
default: 20
description: The number of denoising steps. More denoising steps usually
lead to a higher quality image at the expense of slower inference.
title: Steps
type: integer
- description: 'Higher guidance encourages generation closely linked to `prompt`,
usually at the expense of lower image quality. Try using more steps to improve
image quality when using high guidance. Guidance is disabled by setting
`guidance` to `1`. `guidance` is defined as `w` of equation 2. of [ImagenPaper](https://arxiv.org/pdf/2205.11487.pdf).
See also: [Classifier-Free Diffusion Guidance](https://arxiv.org/abs/2207.12598).'
in: query
name: guidance
required: false
schema:
default: 7.5
description: 'Higher guidance encourages generation closely linked to `prompt`,
usually at the expense of lower image quality. Try using more steps to
improve image quality when using high guidance. Guidance is disabled by
setting `guidance` to `1`. `guidance` is defined as `w` of equation 2.
of [ImagenPaper](https://arxiv.org/pdf/2205.11487.pdf). See also: [Classifier-Free
Diffusion Guidance](https://arxiv.org/abs/2207.12598).'
minimum: 1.0
title: Guidance
type: number
- description: The scheduler to use for image generation. Currently only 'plms',
'ddim', and 'k-lms', are supported.
in: query
name: scheduler
required: false
schema:
default: plms
description: The scheduler to use for image generation. Currently only 'plms',
'ddim', and 'k-lms', are supported.
enum:
- plms
- ddim
- k-lms
title: Scheduler
type: string
- description: Ensure that you abide by the conditions of the Stable Diffusion
license and do not expose unfiltered results in services or applications
open to the public. For more information, please see https://github.com/huggingface/diffusers/pull/254
in: query
name: safety_filter
required: false
schema:
default: true
description: Ensure that you abide by the conditions of the Stable Diffusion
license and do not expose unfiltered results in services or applications
open to the public. For more information, please see https://github.com/huggingface/diffusers/pull/254
title: Safety Filter
type: boolean
- description: The randomness seed to use for image generation. If not set,
a random seed is used.
in: query
name: seed
required: false
schema:
description: The randomness seed to use for image generation. If not set,
a random seed is used.
title: Seed
type: integer
- description: The pixel width of the generated image.
in: query
name: width
required: false
schema:
default: 512