generated from mintlify/starter
-
Notifications
You must be signed in to change notification settings - Fork 163
Expand file tree
/
Copy pathopenapi-cloud.yaml
More file actions
3709 lines (3622 loc) · 115 KB
/
openapi-cloud.yaml
File metadata and controls
3709 lines (3622 loc) · 115 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
openapi: 3.0.3
info:
title: Comfy Cloud API
description: |
<Warning>
**Experimental API:** This API is experimental and subject to change.
Endpoints, request/response formats, and behavior may be modified without notice.
</Warning>
API for Comfy Cloud - Run ComfyUI workflows on cloud infrastructure.
This API allows you to interact with Comfy Cloud programmatically, including:
- Submitting and managing workflows
- Uploading and downloading files
- Monitoring job status and progress
## Cloud vs OSS ComfyUI Compatibility
Comfy Cloud implements the same API interfaces as OSS ComfyUI for maximum compatibility,
but some fields are accepted for compatibility while being handled differently or ignored:
| Field | Endpoints | Cloud Behavior |
|-------|-----------|----------------|
| `subfolder` | `/api/view`, `/api/upload/*` | **Ignored** - Cloud uses content-addressed storage (hash-based). Returned in responses for client-side organization. |
| `type` (input/output/temp) | `/api/view`, `/api/upload/*` | Partially used - All files stored with tag-based organization rather than directory structure. |
| `overwrite` | `/api/upload/*` | **Ignored** - Content-addressed storage means identical content always has the same hash. |
| `number`, `front` | `/api/prompt` | **Ignored** - Cloud uses its own fair queue scheduling per user. |
| `split`, `full_info` | `/api/userdata` | **Ignored** - Cloud always returns full file metadata. |
These fields are retained in the API schema for drop-in compatibility with existing ComfyUI clients and workflows.
version: 1.0.0
license:
name: GNU General Public License v3.0
url: https://github.com/comfyanonymous/ComfyUI/blob/master/LICENSE
servers:
- url: https://cloud.comfy.org
description: Comfy Cloud API
# All endpoints require API key authentication unless marked with security: []
security:
- ApiKeyAuth: []
tags:
- name: workflow
description: |
Submit workflows for execution and manage the execution queue.
This is the primary way to run ComfyUI workflows on the cloud.
- name: job
description: |
Monitor job status, view execution history, and manage running jobs.
Jobs are created when you submit a workflow via POST /api/prompt.
- name: asset
description: |
Upload, download, and manage persistent assets (images, models, outputs).
Assets provide durable storage with tagging and metadata support.
- name: file
description: |
Legacy file upload and download endpoints compatible with local ComfyUI.
For new integrations, consider using the Assets API instead.
- name: model
description: |
Browse available AI models. Models are pre-loaded on cloud infrastructure.
- name: node
description: |
Get information about available ComfyUI nodes and their inputs/outputs.
Useful for building dynamic workflow interfaces.
- name: user
description: |
User account information and personal data storage.
- name: system
description: |
Server status, health checks, and system information.
x-tagGroups:
- name: Core
tags:
- workflow
- job
- name: Storage
tags:
- asset
- file
- name: Reference
tags:
- model
- node
- name: Account
tags:
- user
- system
paths:
/api/prompt:
post:
tags:
- workflow
summary: Submit a workflow for execution
description: |
Submit a workflow to be executed by the backend.
The workflow is a JSON object describing the nodes and their connections.
operationId: executePrompt
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/PromptRequest'
responses:
'200':
description: Success - Prompt accepted
content:
application/json:
schema:
$ref: '#/components/schemas/PromptResponse'
'400':
description: Invalid prompt
content:
application/json:
schema:
$ref: '#/components/schemas/PromptErrorResponse'
'402':
description: Payment required - Insufficient credits
content:
application/json:
schema:
$ref: '#/components/schemas/PromptErrorResponse'
'429':
description: Payment required - User has not paid
content:
application/json:
schema:
$ref: '#/components/schemas/PromptErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/PromptErrorResponse'
'503':
description: Service unavailable
content:
application/json:
schema:
$ref: '#/components/schemas/PromptErrorResponse'
get:
tags:
- workflow
summary: Get information about current prompt execution
description: Returns information about the current prompt in the execution queue
operationId: getPromptInfo
responses:
'200':
description: Success
content:
application/json:
schema:
$ref: '#/components/schemas/PromptInfo'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/object_info:
get:
tags:
- node
summary: Get all node information
description: Returns information about all available nodes
operationId: getNodeInfo
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/NodeInfo'
/api/features:
get:
tags:
- node
summary: Get server feature flags
description: Returns the server's feature capabilities
operationId: getFeatures
security:
- ApiKeyAuth: []
- {} # Also allows unauthenticated access (optional auth)
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
properties:
supports_preview_metadata:
type: boolean
description: Whether the server supports preview metadata
max_upload_size:
type: integer
description: Maximum upload size in bytes
additionalProperties: true
/api/workflow_templates:
get:
tags:
- workflow
summary: Get available workflow templates
description: Returns available workflow templates
operationId: getWorkflowTemplates
security: [] # Public endpoint
responses:
'200':
description: Success
content:
application/json:
schema:
type: object
description: Empty object for workflow templates
/api/global_subgraphs:
get:
tags:
- workflow
summary: Get available subgraph blueprints
description: |
Returns a list of globally available subgraph blueprints.
These are pre-built workflow components that can be used as nodes.
The data field contains a promise that resolves to the full subgraph JSON.
operationId: getGlobalSubgraphs
security: [] # Public endpoint
responses:
'200':
description: Success - Map of subgraph IDs to their metadata
content:
application/json:
schema:
type: object
additionalProperties:
$ref: '#/components/schemas/GlobalSubgraphInfo'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/global_subgraphs/{id}:
get:
tags:
- workflow
summary: Get a specific subgraph blueprint
description: Returns the full data for a specific subgraph blueprint by ID
operationId: getGlobalSubgraph
security: [] # Public endpoint
parameters:
- name: id
in: path
required: true
description: The unique identifier of the subgraph blueprint
schema:
type: string
responses:
'200':
description: Success - Full subgraph data
content:
application/json:
schema:
$ref: '#/components/schemas/GlobalSubgraphData'
'404':
description: Subgraph not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/experiment/models:
get:
tags:
- model
summary: Get available model folders
description: |
Returns a list of model folders available in the system.
This is an experimental endpoint that replaces the legacy /models endpoint.
operationId: getModelFolders
security: [] # Public endpoint
responses:
'200':
description: Success - List of model folders
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ModelFolder'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/experiment/models/{folder}:
get:
tags:
- model
summary: Get models in a specific folder
description: |
Returns a list of models available in the specified folder.
This is an experimental endpoint that provides enhanced model information.
operationId: getModelsInFolder
security: [] # Public endpoint
parameters:
- name: folder
in: path
required: true
description: The folder name to list models from
schema:
type: string
example: "checkpoints"
responses:
'200':
description: Success - List of models in the folder
content:
application/json:
schema:
type: array
items:
$ref: '#/components/schemas/ModelFile'
'404':
description: Folder not found or no models in folder
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/experiment/models/preview/{folder}/{path_index}/{filename}:
get:
tags:
- model
summary: Get model preview image
description: |
Returns a preview image for the specified model.
The image is returned in WebP format for optimal performance.
operationId: getModelPreview
security: [] # Public endpoint
parameters:
- name: folder
in: path
required: true
description: The folder name containing the model
schema:
type: string
example: "checkpoints"
- name: path_index
in: path
required: true
description: The path index (usually 0 for cloud service)
schema:
type: integer
example: 0
- name: filename
in: path
required: true
description: The model filename (with or without .webp extension)
schema:
type: string
example: "model.safetensors"
responses:
'200':
description: Success - Model preview image
content:
image/webp:
schema:
type: string
format: binary
'404':
description: Model not found or preview not available
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/history:
post:
tags:
- job
summary: Manage execution history
description: |
Clear all history for the authenticated user or delete specific job IDs.
Supports clearing all history or deleting specific job IDs.
operationId: manageHistory
requestBody:
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/HistoryManageRequest'
responses:
'200':
description: Success - History management operation completed
'400':
description: Invalid request parameters
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Unauthorized - Authentication required
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/history_v2:
get:
tags:
- job
summary: Get execution history (v2)
description: |
Retrieve execution history for the authenticated user with pagination support.
Returns a lightweight history format with filtered prompt data (workflow removed from extra_pnginfo).
operationId: getHistory
parameters:
- name: max_items
in: query
required: false
description: Maximum number of items to return
schema:
type: integer
- name: offset
in: query
required: false
description: Starting position (default 0)
schema:
type: integer
default: 0
responses:
'200':
description: Success - Execution history retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/HistoryResponse'
'401':
description: Unauthorized - Authentication required
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/history_v2/{prompt_id}:
get:
tags:
- job
summary: Get history for specific prompt
description: |
Retrieve detailed execution history for a specific prompt ID.
Returns full history data including complete prompt information.
operationId: getHistoryForPrompt
parameters:
- name: prompt_id
in: path
required: true
description: The prompt ID to retrieve history for
schema:
type: string
responses:
'200':
description: Success - History for prompt retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/HistoryDetailResponse'
'401':
description: Unauthorized - Authentication required
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Prompt not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/jobs:
get:
tags:
- job
summary: List jobs with pagination and filtering
description: |
Retrieve a paginated list of jobs for the authenticated user.
Returns lightweight job data optimized for list views.
Workflow and full outputs are excluded to reduce payload size.
operationId: listJobs
parameters:
- name: status
in: query
required: false
description: Filter by one or more statuses (comma-separated). If not provided, returns all jobs.
schema:
type: string
example: pending,in_progress
- name: workflow_id
in: query
required: false
description: Filter by workflow ID (exact match)
schema:
type: string
example: 550e8400-e29b-41d4-a716-446655440000
- name: output_type
in: query
required: false
description: Filter by output media type (only applies to completed jobs with outputs)
schema:
type: string
enum: [image, video, audio]
example: image
- name: sort_by
in: query
required: false
description: Field to sort by (create_time = when job was submitted, execution_time = how long workflow took to run)
schema:
type: string
enum: [create_time, execution_time]
default: create_time
example: execution_time
- name: sort_order
in: query
required: false
description: Sort direction (asc = ascending, desc = descending)
schema:
type: string
enum: [asc, desc]
default: desc
- name: offset
in: query
required: false
description: Pagination offset (0-based)
schema:
type: integer
minimum: 0
default: 0
- name: limit
in: query
required: false
description: Maximum items per page (1-1000)
schema:
type: integer
minimum: 1
maximum: 1000
default: 100
responses:
'200':
description: Success - Jobs retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/JobsListResponse'
'401':
description: Unauthorized - Authentication required
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/jobs/{job_id}:
get:
tags:
- job
summary: Get full job details
description: |
Retrieve complete details for a specific job including workflow and outputs.
Used for detail views, workflow re-execution, and debugging.
operationId: getJobDetail
parameters:
- name: job_id
in: path
required: true
description: Job identifier (UUID)
schema:
type: string
format: uuid
responses:
'200':
description: Success - Job details retrieved
content:
application/json:
schema:
$ref: '#/components/schemas/JobDetailResponse'
'401':
description: Unauthorized - Authentication required
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'403':
description: Forbidden - Job does not belong to user
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'404':
description: Job not found
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/view:
get:
tags:
- file
summary: View a file
description: |
Retrieve and view a file from the ComfyUI file system.
This endpoint is typically used to view generated images or other output files.
operationId: viewFile
parameters:
- name: filename
in: query
required: true
description: Name of the file to view
schema:
type: string
example: "ComfyUI_00004_.png"
- name: subfolder
in: query
required: false
description: |
Subfolder path where the file is located.
**Note:** Accepted for ComfyUI API compatibility but **ignored** in cloud.
Cloud uses content-addressed storage where assets are stored by hash only.
The subfolder is client-side UI metadata and not used for storage lookup.
schema:
type: string
example: "tests/foo/bar"
- name: type
in: query
required: false
description: |
Type of file (e.g., output, input, temp).
**Note:** In cloud, both `output` and `temp` files are stored in the same bucket.
The type parameter is used for compatibility but storage location is determined by hash.
schema:
type: string
example: "output"
- name: fullpath
in: query
required: false
description: Full path to the file (used for temp files)
schema:
type: string
- name: format
in: query
required: false
description: Format of the file
schema:
type: string
- name: frame_rate
in: query
required: false
description: Frame rate for video files
schema:
type: integer
- name: workflow
in: query
required: false
description: Workflow identifier
schema:
type: string
- name: timestamp
in: query
required: false
description: Timestamp parameter
schema:
type: integer
example: "1234567890"
- name: channel
in: query
required: false
description: |
Image channel to extract from PNG images.
- 'rgb': Return only RGB channels (alpha set to fully opaque)
- 'a' or 'alpha': Return alpha channel as grayscale image
- If not specified, return original image unchanged via redirect
schema:
type: string
example: "rgb"
responses:
'302':
description: Redirect to GCS signed URL
headers:
Location:
description: Signed URL to access the file in GCS
schema:
type: string
'200':
description: Success - File content returned (used when channel parameter is present)
content:
image/png:
schema:
type: string
format: binary
description: Processed PNG image with extracted channel
'404':
description: File not found or unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'400':
description: Invalid request parameters
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/files/mask-layers:
get:
tags:
- file
summary: Get related mask layer files
description: |
Given a mask file (any of the 4 layers), returns all related mask layer files.
This is used by the mask editor to load the paint, mask, and painted layers
when reopening a previously edited mask.
operationId: getMaskLayers
parameters:
- name: filename
in: query
required: true
description: Hash filename of any mask layer file
schema:
type: string
example: "abc123def456.png"
responses:
'200':
description: Success - Related mask layers returned
content:
application/json:
schema:
type: object
properties:
mask:
type: string
description: Filename of the mask layer
nullable: true
paint:
type: string
description: Filename of the paint strokes layer
nullable: true
painted:
type: string
description: Filename of the painted image layer
nullable: true
painted_masked:
type: string
description: Filename of the final composite layer
nullable: true
'404':
description: File not found or not a mask file
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
/api/assets:
get:
tags:
- asset
summary: List user assets
description: |
Retrieves a paginated list of assets belonging to the authenticated user.
Supports filtering by tags, name, metadata, and sorting options.
operationId: listAssets
parameters:
- name: include_tags
in: query
description: Filter assets that have ALL of these tags
schema:
type: array
items:
type: string
style: form
explode: false
- name: exclude_tags
in: query
description: Exclude assets that have ANY of these tags
schema:
type: array
items:
type: string
style: form
explode: false
- name: name_contains
in: query
description: Filter assets where name contains this substring (case-insensitive)
schema:
type: string
- name: metadata_filter
in: query
description: JSON object for filtering by metadata fields
schema:
type: string
- name: limit
in: query
description: Maximum number of assets to return (1-500)
schema:
type: integer
minimum: 1
maximum: 500
default: 20
- name: offset
in: query
description: Number of assets to skip for pagination
schema:
type: integer
minimum: 0
default: 0
- name: sort
in: query
description: Field to sort by
schema:
type: string
enum: [name, created_at, updated_at, size, last_access_time]
default: created_at
- name: order
in: query
description: Sort order
schema:
type: string
enum: [asc, desc]
default: desc
- name: include_public
in: query
description: Whether to include public/shared assets in results
schema:
type: boolean
default: true
responses:
'200':
description: Success - Assets returned
content:
application/json:
schema:
$ref: '#/components/schemas/ListAssetsResponse'
'400':
description: Invalid request parameters
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'401':
description: Unauthorized
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
'500':
description: Internal server error
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorResponse'
post:
tags:
- asset
summary: Upload a new asset
description: |
Uploads a new asset to the system with associated metadata.
Supports two upload methods:
1. Direct file upload (multipart/form-data)
2. URL-based upload (application/json with source: "url")
If an asset with the same hash already exists, returns the existing asset.
operationId: uploadAsset
requestBody:
required: true
content:
multipart/form-data:
schema:
type: object
required:
- file
properties:
file:
type: string
format: binary
description: The asset file to upload
tags:
type: array
items:
type: string
description: Freeform tags for the asset. Common types include "models", "input", "output", and "temp", but any tag can be used in any order.
id:
type: string
format: uuid
description: Optional asset ID for idempotent creation. If provided and asset exists, returns existing asset.
preview_id:
type: string
format: uuid
description: Optional preview asset ID. If not provided, images will use their own ID as preview.
name:
type: string
description: Display name for the asset
mime_type:
type: string
description: MIME type of the asset (e.g., "image/png", "video/mp4")
user_metadata:
type: string
description: Custom JSON metadata as a string
application/json:
schema:
type: object
required:
- url
- name
properties:
url:
type: string
format: uri
description: HTTP/HTTPS URL to download the asset from
name:
type: string
description: Display name for the asset (used to determine file extension)
tags:
type: array
items:
type: string
description: Freeform tags for the asset. Common types include "models", "input", "output", and "temp", but any tag can be used in any order.
user_metadata:
type: object
additionalProperties: true
description: Custom metadata to store with the asset
preview_id: