@scenario-labs/sdk 2.1.0 → 2.2.1
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/CHANGELOG.md +38 -0
- package/index.d.mts +1 -1
- package/index.d.mts.map +1 -1
- package/index.d.ts +1 -1
- package/index.d.ts.map +1 -1
- package/index.js +6 -1
- package/index.js.map +1 -1
- package/index.mjs +1 -1
- package/index.mjs.map +1 -1
- package/lib/workflow_converter.d.mts +47 -2
- package/lib/workflow_converter.d.mts.map +1 -1
- package/lib/workflow_converter.d.ts +47 -2
- package/lib/workflow_converter.d.ts.map +1 -1
- package/lib/workflow_converter.js +253 -28
- package/lib/workflow_converter.js.map +1 -1
- package/lib/workflow_converter.mjs +248 -28
- package/lib/workflow_converter.mjs.map +1 -1
- package/lib/workflow_import_validator.d.mts +1 -1
- package/lib/workflow_import_validator.d.mts.map +1 -1
- package/lib/workflow_import_validator.d.ts +1 -1
- package/lib/workflow_import_validator.d.ts.map +1 -1
- package/lib/workflow_import_validator.js +2 -0
- package/lib/workflow_import_validator.js.map +1 -1
- package/lib/workflow_import_validator.mjs +2 -0
- package/lib/workflow_import_validator.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/assets/assets.d.mts +289 -135
- package/resources/assets/assets.d.mts.map +1 -1
- package/resources/assets/assets.d.ts +289 -135
- package/resources/assets/assets.d.ts.map +1 -1
- package/resources/assets/assets.js.map +1 -1
- package/resources/assets/assets.mjs.map +1 -1
- package/resources/generate.d.mts +86 -48
- package/resources/generate.d.mts.map +1 -1
- package/resources/generate.d.ts +86 -48
- package/resources/generate.d.ts.map +1 -1
- package/resources/jobs.d.mts +6 -6
- package/resources/jobs.d.mts.map +1 -1
- package/resources/jobs.d.ts +6 -6
- package/resources/jobs.d.ts.map +1 -1
- package/resources/models/description.d.mts +54 -4
- package/resources/models/description.d.mts.map +1 -1
- package/resources/models/description.d.ts +54 -4
- package/resources/models/description.d.ts.map +1 -1
- package/resources/models/examples.d.mts +74 -36
- package/resources/models/examples.d.mts.map +1 -1
- package/resources/models/examples.d.ts +74 -36
- package/resources/models/examples.d.ts.map +1 -1
- package/resources/models/models.d.mts +21 -21
- package/resources/models/models.d.mts.map +1 -1
- package/resources/models/models.d.ts +21 -21
- package/resources/models/models.d.ts.map +1 -1
- package/resources/models/models.js.map +1 -1
- package/resources/models/models.mjs.map +1 -1
- package/resources/models/train.d.mts +8 -8
- package/resources/models/train.d.mts.map +1 -1
- package/resources/models/train.d.ts +8 -8
- package/resources/models/train.d.ts.map +1 -1
- package/resources/search.d.mts +6 -0
- package/resources/search.d.mts.map +1 -1
- package/resources/search.d.ts +6 -0
- package/resources/search.d.ts.map +1 -1
- package/resources/uploads.d.mts +4 -4
- package/resources/uploads.d.mts.map +1 -1
- package/resources/uploads.d.ts +4 -4
- package/resources/uploads.d.ts.map +1 -1
- package/resources/usages.d.mts +31 -6
- package/resources/usages.d.mts.map +1 -1
- package/resources/usages.d.ts +31 -6
- package/resources/usages.d.ts.map +1 -1
- package/resources/workflows.d.mts +36 -36
- package/resources/workflows.d.mts.map +1 -1
- package/resources/workflows.d.ts +36 -36
- package/resources/workflows.d.ts.map +1 -1
- package/src/index.ts +9 -0
- package/src/lib/workflow_converter.ts +347 -21
- package/src/lib/workflow_import_validator.ts +5 -1
- package/src/resources/assets/assets.ts +376 -118
- package/src/resources/generate.ts +106 -44
- package/src/resources/jobs.ts +6 -6
- package/src/resources/models/description.ts +68 -2
- package/src/resources/models/examples.ts +94 -32
- package/src/resources/models/models.ts +21 -14
- package/src/resources/models/train.ts +8 -6
- package/src/resources/search.ts +7 -0
- package/src/resources/uploads.ts +4 -4
- package/src/resources/usages.ts +41 -4
- package/src/resources/workflows.ts +36 -36
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -85,7 +85,7 @@ export declare namespace AssetRetrieveResponse {
|
|
|
85
85
|
/**
|
|
86
86
|
* The kind of asset
|
|
87
87
|
*/
|
|
88
|
-
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
88
|
+
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
89
89
|
/**
|
|
90
90
|
* Metadata of the asset with some additional information
|
|
91
91
|
*/
|
|
@@ -110,7 +110,7 @@ export declare namespace AssetRetrieveResponse {
|
|
|
110
110
|
/**
|
|
111
111
|
* source of the asset
|
|
112
112
|
*/
|
|
113
|
-
source: '3d23d' | '3d23d:texture' | '3d:texture' | '3d:texture:albedo' | '3d:texture:metallic' | '3d:texture:mtl' | '3d:texture:normal' | '3d:texture:roughness' | 'audio2audio' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-control-net' | 'inference-control-net-img' | 'inference-control-net-inpainting' | 'inference-control-net-inpainting-ip-adapter' | 'inference-control-net-ip-adapter' | 'inference-control-net-reference' | 'inference-control-net-texture' | 'inference-img' | 'inference-img-ip-adapter' | 'inference-img-texture' | 'inference-in-paint' | 'inference-in-paint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt' | 'inference-txt-ip-adapter' | 'inference-txt-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture:albedo' | 'texture:ao' | 'texture:edge' | 'texture:height' | 'texture:metallic' | 'texture:normal' | 'texture:smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
113
|
+
source: '3d23d' | '3d23d:texture' | '3d:texture' | '3d:texture:albedo' | '3d:texture:metallic' | '3d:texture:mtl' | '3d:texture:normal' | '3d:texture:roughness' | 'audio2audio' | 'audio2txt' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2txt' | 'img2video' | 'inference-control-net' | 'inference-control-net-img' | 'inference-control-net-inpainting' | 'inference-control-net-inpainting-ip-adapter' | 'inference-control-net-ip-adapter' | 'inference-control-net-reference' | 'inference-control-net-texture' | 'inference-img' | 'inference-img-ip-adapter' | 'inference-img-texture' | 'inference-in-paint' | 'inference-in-paint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt' | 'inference-txt-ip-adapter' | 'inference-txt-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture:albedo' | 'texture:ao' | 'texture:edge' | 'texture:height' | 'texture:metallic' | 'texture:normal' | 'texture:smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2txt' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-text' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
114
114
|
/**
|
|
115
115
|
* The actual status
|
|
116
116
|
*/
|
|
@@ -198,12 +198,12 @@ export declare namespace AssetRetrieveResponse {
|
|
|
198
198
|
* Metadata of the asset with some additional information
|
|
199
199
|
*/
|
|
200
200
|
interface Metadata {
|
|
201
|
-
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
201
|
+
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
202
202
|
/**
|
|
203
203
|
* The type of the asset. Ex: 'inference-txt2img' will represent an asset generated
|
|
204
204
|
* from a text to image model
|
|
205
205
|
*/
|
|
206
|
-
type: '3d-texture' | '3d-texture-albedo' | '3d-texture-metallic' | '3d-texture-mtl' | '3d-texture-normal' | '3d-texture-roughness' | '3d23d' | '3d23d-texture' | 'audio2audio' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-controlnet' | 'inference-controlnet-img2img' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-reference' | 'inference-controlnet-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture-albedo' | 'texture-ao' | 'texture-edge' | 'texture-height' | 'texture-metallic' | 'texture-normal' | 'texture-smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
206
|
+
type: '3d-texture' | '3d-texture-albedo' | '3d-texture-metallic' | '3d-texture-mtl' | '3d-texture-normal' | '3d-texture-roughness' | '3d23d' | '3d23d-texture' | 'audio2audio' | 'audio2txt' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2txt' | 'img2video' | 'inference-controlnet' | 'inference-controlnet-img2img' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-reference' | 'inference-controlnet-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture-albedo' | 'texture-ao' | 'texture-edge' | 'texture-height' | 'texture-metallic' | 'texture-normal' | 'texture-smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2txt' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-text' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
207
207
|
/**
|
|
208
208
|
* How angular is the surface? 0 is like a sphere, 1 is like a mechanical object
|
|
209
209
|
*/
|
|
@@ -213,10 +213,6 @@ export declare namespace AssetRetrieveResponse {
|
|
|
213
213
|
* models
|
|
214
214
|
*/
|
|
215
215
|
aspectRatio?: string;
|
|
216
|
-
/**
|
|
217
|
-
* Int to set between 0 and 255 for the opacity of the background in the result
|
|
218
|
-
* images.
|
|
219
|
-
*/
|
|
220
216
|
backgroundOpacity?: number;
|
|
221
217
|
/**
|
|
222
218
|
* The baseModelId that maybe changed at inference time
|
|
@@ -226,9 +222,6 @@ export declare namespace AssetRetrieveResponse {
|
|
|
226
222
|
* A bounding box around the object of interest, in the format [x1, y1, x2, y2].
|
|
227
223
|
*/
|
|
228
224
|
bbox?: Array<number>;
|
|
229
|
-
/**
|
|
230
|
-
* Remove small dark spots (i.e. “pepper”) and connect small bright cracks.
|
|
231
|
-
*/
|
|
232
225
|
betterQuality?: boolean;
|
|
233
226
|
/**
|
|
234
227
|
* The control image already processed by canny detector. Must reference an
|
|
@@ -287,9 +280,6 @@ export declare namespace AssetRetrieveResponse {
|
|
|
287
280
|
* Amount of details to remove or add
|
|
288
281
|
*/
|
|
289
282
|
detailsLevel?: number;
|
|
290
|
-
/**
|
|
291
|
-
* The number of pixels to dilate the result masks.
|
|
292
|
-
*/
|
|
293
283
|
dilate?: number;
|
|
294
284
|
/**
|
|
295
285
|
* Contrast factor for Grayscale detector
|
|
@@ -491,11 +481,15 @@ export declare namespace AssetRetrieveResponse {
|
|
|
491
481
|
*/
|
|
492
482
|
resultContours?: boolean;
|
|
493
483
|
/**
|
|
494
|
-
* Boolean to
|
|
484
|
+
* Boolean to return the source image with the mask applied as alpha channel (RGBA
|
|
485
|
+
* PNG, transparent background) instead of the binary mask. Mutually exclusive with
|
|
486
|
+
* `resultMask` — passing both as `true` returns a 400 error. Note:
|
|
487
|
+
* `backgroundOpacity` is no longer honored — alpha is binary (0/255) only.
|
|
495
488
|
*/
|
|
496
489
|
resultImage?: boolean;
|
|
497
490
|
/**
|
|
498
|
-
* Boolean to
|
|
491
|
+
* Boolean to return the binary masks in the response. Mutually exclusive with
|
|
492
|
+
* `resultImage` — passing both as `true` returns a 400 error.
|
|
499
493
|
*/
|
|
500
494
|
resultMask?: boolean;
|
|
501
495
|
rootParentId?: string;
|
|
@@ -651,6 +645,12 @@ export declare namespace AssetRetrieveResponse {
|
|
|
651
645
|
* Number of channels of the audio
|
|
652
646
|
*/
|
|
653
647
|
channels?: number;
|
|
648
|
+
/**
|
|
649
|
+
* Number of Unicode code points in the text. Code-point-aware (so a non-BMP emoji
|
|
650
|
+
* counts as 1) but not full grapheme-cluster aware (a ZWJ sequence still counts as
|
|
651
|
+
* several).
|
|
652
|
+
*/
|
|
653
|
+
charCount?: number;
|
|
654
654
|
/**
|
|
655
655
|
* Classification of the audio
|
|
656
656
|
*/
|
|
@@ -687,6 +687,13 @@ export declare namespace AssetRetrieveResponse {
|
|
|
687
687
|
* Whether the mesh has animations
|
|
688
688
|
*/
|
|
689
689
|
hasAnimations?: boolean;
|
|
690
|
+
/**
|
|
691
|
+
* True when `preview` holds the entire content unmodified — consumers can use it
|
|
692
|
+
* directly without fetching `asset.url`. False or undefined means the content
|
|
693
|
+
* exceeds the preview budget and consumers must fetch the full body from S3 to
|
|
694
|
+
* read past the preview.
|
|
695
|
+
*/
|
|
696
|
+
hasFullPreview?: boolean;
|
|
690
697
|
/**
|
|
691
698
|
* Whether the mesh has normal vectors
|
|
692
699
|
*/
|
|
@@ -704,6 +711,14 @@ export declare namespace AssetRetrieveResponse {
|
|
|
704
711
|
* Number of frames in the video
|
|
705
712
|
*/
|
|
706
713
|
nbFrames?: number;
|
|
714
|
+
/**
|
|
715
|
+
* Leading slice of the content used for inline UI display and as a search
|
|
716
|
+
* shortcut. Capped at TEXT_PREVIEW_MAX_BYTES (UTF-8) and always cut on a
|
|
717
|
+
* code-point boundary so no character is split. Number of characters in the
|
|
718
|
+
* preview varies by script (around 1024 for ASCII, ~340 for CJK, ~256 for
|
|
719
|
+
* emoji-heavy text at the default 1 KB budget).
|
|
720
|
+
*/
|
|
721
|
+
preview?: string;
|
|
707
722
|
/**
|
|
708
723
|
* Sample rate of the media in Hz
|
|
709
724
|
*/
|
|
@@ -717,6 +732,10 @@ export declare namespace AssetRetrieveResponse {
|
|
|
717
732
|
*/
|
|
718
733
|
vertexCount?: number;
|
|
719
734
|
width?: number;
|
|
735
|
+
/**
|
|
736
|
+
* Number of whitespace-separated words in the text
|
|
737
|
+
*/
|
|
738
|
+
wordCount?: number;
|
|
720
739
|
}
|
|
721
740
|
namespace Properties {
|
|
722
741
|
/**
|
|
@@ -792,7 +811,7 @@ export declare namespace AssetUpdateResponse {
|
|
|
792
811
|
/**
|
|
793
812
|
* The kind of asset
|
|
794
813
|
*/
|
|
795
|
-
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
814
|
+
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
796
815
|
/**
|
|
797
816
|
* Metadata of the asset with some additional information
|
|
798
817
|
*/
|
|
@@ -817,7 +836,7 @@ export declare namespace AssetUpdateResponse {
|
|
|
817
836
|
/**
|
|
818
837
|
* source of the asset
|
|
819
838
|
*/
|
|
820
|
-
source: '3d23d' | '3d23d:texture' | '3d:texture' | '3d:texture:albedo' | '3d:texture:metallic' | '3d:texture:mtl' | '3d:texture:normal' | '3d:texture:roughness' | 'audio2audio' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-control-net' | 'inference-control-net-img' | 'inference-control-net-inpainting' | 'inference-control-net-inpainting-ip-adapter' | 'inference-control-net-ip-adapter' | 'inference-control-net-reference' | 'inference-control-net-texture' | 'inference-img' | 'inference-img-ip-adapter' | 'inference-img-texture' | 'inference-in-paint' | 'inference-in-paint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt' | 'inference-txt-ip-adapter' | 'inference-txt-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture:albedo' | 'texture:ao' | 'texture:edge' | 'texture:height' | 'texture:metallic' | 'texture:normal' | 'texture:smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
839
|
+
source: '3d23d' | '3d23d:texture' | '3d:texture' | '3d:texture:albedo' | '3d:texture:metallic' | '3d:texture:mtl' | '3d:texture:normal' | '3d:texture:roughness' | 'audio2audio' | 'audio2txt' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2txt' | 'img2video' | 'inference-control-net' | 'inference-control-net-img' | 'inference-control-net-inpainting' | 'inference-control-net-inpainting-ip-adapter' | 'inference-control-net-ip-adapter' | 'inference-control-net-reference' | 'inference-control-net-texture' | 'inference-img' | 'inference-img-ip-adapter' | 'inference-img-texture' | 'inference-in-paint' | 'inference-in-paint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt' | 'inference-txt-ip-adapter' | 'inference-txt-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture:albedo' | 'texture:ao' | 'texture:edge' | 'texture:height' | 'texture:metallic' | 'texture:normal' | 'texture:smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2txt' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-text' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
821
840
|
/**
|
|
822
841
|
* The actual status
|
|
823
842
|
*/
|
|
@@ -905,12 +924,12 @@ export declare namespace AssetUpdateResponse {
|
|
|
905
924
|
* Metadata of the asset with some additional information
|
|
906
925
|
*/
|
|
907
926
|
interface Metadata {
|
|
908
|
-
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
927
|
+
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
909
928
|
/**
|
|
910
929
|
* The type of the asset. Ex: 'inference-txt2img' will represent an asset generated
|
|
911
930
|
* from a text to image model
|
|
912
931
|
*/
|
|
913
|
-
type: '3d-texture' | '3d-texture-albedo' | '3d-texture-metallic' | '3d-texture-mtl' | '3d-texture-normal' | '3d-texture-roughness' | '3d23d' | '3d23d-texture' | 'audio2audio' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-controlnet' | 'inference-controlnet-img2img' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-reference' | 'inference-controlnet-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture-albedo' | 'texture-ao' | 'texture-edge' | 'texture-height' | 'texture-metallic' | 'texture-normal' | 'texture-smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
932
|
+
type: '3d-texture' | '3d-texture-albedo' | '3d-texture-metallic' | '3d-texture-mtl' | '3d-texture-normal' | '3d-texture-roughness' | '3d23d' | '3d23d-texture' | 'audio2audio' | 'audio2txt' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2txt' | 'img2video' | 'inference-controlnet' | 'inference-controlnet-img2img' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-reference' | 'inference-controlnet-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture-albedo' | 'texture-ao' | 'texture-edge' | 'texture-height' | 'texture-metallic' | 'texture-normal' | 'texture-smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2txt' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-text' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
914
933
|
/**
|
|
915
934
|
* How angular is the surface? 0 is like a sphere, 1 is like a mechanical object
|
|
916
935
|
*/
|
|
@@ -920,10 +939,6 @@ export declare namespace AssetUpdateResponse {
|
|
|
920
939
|
* models
|
|
921
940
|
*/
|
|
922
941
|
aspectRatio?: string;
|
|
923
|
-
/**
|
|
924
|
-
* Int to set between 0 and 255 for the opacity of the background in the result
|
|
925
|
-
* images.
|
|
926
|
-
*/
|
|
927
942
|
backgroundOpacity?: number;
|
|
928
943
|
/**
|
|
929
944
|
* The baseModelId that maybe changed at inference time
|
|
@@ -933,9 +948,6 @@ export declare namespace AssetUpdateResponse {
|
|
|
933
948
|
* A bounding box around the object of interest, in the format [x1, y1, x2, y2].
|
|
934
949
|
*/
|
|
935
950
|
bbox?: Array<number>;
|
|
936
|
-
/**
|
|
937
|
-
* Remove small dark spots (i.e. “pepper”) and connect small bright cracks.
|
|
938
|
-
*/
|
|
939
951
|
betterQuality?: boolean;
|
|
940
952
|
/**
|
|
941
953
|
* The control image already processed by canny detector. Must reference an
|
|
@@ -994,9 +1006,6 @@ export declare namespace AssetUpdateResponse {
|
|
|
994
1006
|
* Amount of details to remove or add
|
|
995
1007
|
*/
|
|
996
1008
|
detailsLevel?: number;
|
|
997
|
-
/**
|
|
998
|
-
* The number of pixels to dilate the result masks.
|
|
999
|
-
*/
|
|
1000
1009
|
dilate?: number;
|
|
1001
1010
|
/**
|
|
1002
1011
|
* Contrast factor for Grayscale detector
|
|
@@ -1198,11 +1207,15 @@ export declare namespace AssetUpdateResponse {
|
|
|
1198
1207
|
*/
|
|
1199
1208
|
resultContours?: boolean;
|
|
1200
1209
|
/**
|
|
1201
|
-
* Boolean to
|
|
1210
|
+
* Boolean to return the source image with the mask applied as alpha channel (RGBA
|
|
1211
|
+
* PNG, transparent background) instead of the binary mask. Mutually exclusive with
|
|
1212
|
+
* `resultMask` — passing both as `true` returns a 400 error. Note:
|
|
1213
|
+
* `backgroundOpacity` is no longer honored — alpha is binary (0/255) only.
|
|
1202
1214
|
*/
|
|
1203
1215
|
resultImage?: boolean;
|
|
1204
1216
|
/**
|
|
1205
|
-
* Boolean to
|
|
1217
|
+
* Boolean to return the binary masks in the response. Mutually exclusive with
|
|
1218
|
+
* `resultImage` — passing both as `true` returns a 400 error.
|
|
1206
1219
|
*/
|
|
1207
1220
|
resultMask?: boolean;
|
|
1208
1221
|
rootParentId?: string;
|
|
@@ -1358,6 +1371,12 @@ export declare namespace AssetUpdateResponse {
|
|
|
1358
1371
|
* Number of channels of the audio
|
|
1359
1372
|
*/
|
|
1360
1373
|
channels?: number;
|
|
1374
|
+
/**
|
|
1375
|
+
* Number of Unicode code points in the text. Code-point-aware (so a non-BMP emoji
|
|
1376
|
+
* counts as 1) but not full grapheme-cluster aware (a ZWJ sequence still counts as
|
|
1377
|
+
* several).
|
|
1378
|
+
*/
|
|
1379
|
+
charCount?: number;
|
|
1361
1380
|
/**
|
|
1362
1381
|
* Classification of the audio
|
|
1363
1382
|
*/
|
|
@@ -1394,6 +1413,13 @@ export declare namespace AssetUpdateResponse {
|
|
|
1394
1413
|
* Whether the mesh has animations
|
|
1395
1414
|
*/
|
|
1396
1415
|
hasAnimations?: boolean;
|
|
1416
|
+
/**
|
|
1417
|
+
* True when `preview` holds the entire content unmodified — consumers can use it
|
|
1418
|
+
* directly without fetching `asset.url`. False or undefined means the content
|
|
1419
|
+
* exceeds the preview budget and consumers must fetch the full body from S3 to
|
|
1420
|
+
* read past the preview.
|
|
1421
|
+
*/
|
|
1422
|
+
hasFullPreview?: boolean;
|
|
1397
1423
|
/**
|
|
1398
1424
|
* Whether the mesh has normal vectors
|
|
1399
1425
|
*/
|
|
@@ -1411,6 +1437,14 @@ export declare namespace AssetUpdateResponse {
|
|
|
1411
1437
|
* Number of frames in the video
|
|
1412
1438
|
*/
|
|
1413
1439
|
nbFrames?: number;
|
|
1440
|
+
/**
|
|
1441
|
+
* Leading slice of the content used for inline UI display and as a search
|
|
1442
|
+
* shortcut. Capped at TEXT_PREVIEW_MAX_BYTES (UTF-8) and always cut on a
|
|
1443
|
+
* code-point boundary so no character is split. Number of characters in the
|
|
1444
|
+
* preview varies by script (around 1024 for ASCII, ~340 for CJK, ~256 for
|
|
1445
|
+
* emoji-heavy text at the default 1 KB budget).
|
|
1446
|
+
*/
|
|
1447
|
+
preview?: string;
|
|
1414
1448
|
/**
|
|
1415
1449
|
* Sample rate of the media in Hz
|
|
1416
1450
|
*/
|
|
@@ -1424,6 +1458,10 @@ export declare namespace AssetUpdateResponse {
|
|
|
1424
1458
|
*/
|
|
1425
1459
|
vertexCount?: number;
|
|
1426
1460
|
width?: number;
|
|
1461
|
+
/**
|
|
1462
|
+
* Number of whitespace-separated words in the text
|
|
1463
|
+
*/
|
|
1464
|
+
wordCount?: number;
|
|
1427
1465
|
}
|
|
1428
1466
|
namespace Properties {
|
|
1429
1467
|
/**
|
|
@@ -1495,7 +1533,7 @@ export interface AssetListResponse {
|
|
|
1495
1533
|
/**
|
|
1496
1534
|
* The kind of asset
|
|
1497
1535
|
*/
|
|
1498
|
-
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
1536
|
+
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
1499
1537
|
/**
|
|
1500
1538
|
* Metadata of the asset with some additional information
|
|
1501
1539
|
*/
|
|
@@ -1520,7 +1558,7 @@ export interface AssetListResponse {
|
|
|
1520
1558
|
/**
|
|
1521
1559
|
* source of the asset
|
|
1522
1560
|
*/
|
|
1523
|
-
source: '3d23d' | '3d23d:texture' | '3d:texture' | '3d:texture:albedo' | '3d:texture:metallic' | '3d:texture:mtl' | '3d:texture:normal' | '3d:texture:roughness' | 'audio2audio' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-control-net' | 'inference-control-net-img' | 'inference-control-net-inpainting' | 'inference-control-net-inpainting-ip-adapter' | 'inference-control-net-ip-adapter' | 'inference-control-net-reference' | 'inference-control-net-texture' | 'inference-img' | 'inference-img-ip-adapter' | 'inference-img-texture' | 'inference-in-paint' | 'inference-in-paint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt' | 'inference-txt-ip-adapter' | 'inference-txt-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture:albedo' | 'texture:ao' | 'texture:edge' | 'texture:height' | 'texture:metallic' | 'texture:normal' | 'texture:smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
1561
|
+
source: '3d23d' | '3d23d:texture' | '3d:texture' | '3d:texture:albedo' | '3d:texture:metallic' | '3d:texture:mtl' | '3d:texture:normal' | '3d:texture:roughness' | 'audio2audio' | 'audio2txt' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2txt' | 'img2video' | 'inference-control-net' | 'inference-control-net-img' | 'inference-control-net-inpainting' | 'inference-control-net-inpainting-ip-adapter' | 'inference-control-net-ip-adapter' | 'inference-control-net-reference' | 'inference-control-net-texture' | 'inference-img' | 'inference-img-ip-adapter' | 'inference-img-texture' | 'inference-in-paint' | 'inference-in-paint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt' | 'inference-txt-ip-adapter' | 'inference-txt-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture:albedo' | 'texture:ao' | 'texture:edge' | 'texture:height' | 'texture:metallic' | 'texture:normal' | 'texture:smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2txt' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-text' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
1524
1562
|
/**
|
|
1525
1563
|
* The actual status
|
|
1526
1564
|
*/
|
|
@@ -1608,12 +1646,12 @@ export declare namespace AssetListResponse {
|
|
|
1608
1646
|
* Metadata of the asset with some additional information
|
|
1609
1647
|
*/
|
|
1610
1648
|
interface Metadata {
|
|
1611
|
-
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
1649
|
+
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
1612
1650
|
/**
|
|
1613
1651
|
* The type of the asset. Ex: 'inference-txt2img' will represent an asset generated
|
|
1614
1652
|
* from a text to image model
|
|
1615
1653
|
*/
|
|
1616
|
-
type: '3d-texture' | '3d-texture-albedo' | '3d-texture-metallic' | '3d-texture-mtl' | '3d-texture-normal' | '3d-texture-roughness' | '3d23d' | '3d23d-texture' | 'audio2audio' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-controlnet' | 'inference-controlnet-img2img' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-reference' | 'inference-controlnet-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture-albedo' | 'texture-ao' | 'texture-edge' | 'texture-height' | 'texture-metallic' | 'texture-normal' | 'texture-smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
1654
|
+
type: '3d-texture' | '3d-texture-albedo' | '3d-texture-metallic' | '3d-texture-mtl' | '3d-texture-normal' | '3d-texture-roughness' | '3d23d' | '3d23d-texture' | 'audio2audio' | 'audio2txt' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2txt' | 'img2video' | 'inference-controlnet' | 'inference-controlnet-img2img' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-reference' | 'inference-controlnet-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture-albedo' | 'texture-ao' | 'texture-edge' | 'texture-height' | 'texture-metallic' | 'texture-normal' | 'texture-smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2txt' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-text' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
1617
1655
|
/**
|
|
1618
1656
|
* How angular is the surface? 0 is like a sphere, 1 is like a mechanical object
|
|
1619
1657
|
*/
|
|
@@ -1623,10 +1661,6 @@ export declare namespace AssetListResponse {
|
|
|
1623
1661
|
* models
|
|
1624
1662
|
*/
|
|
1625
1663
|
aspectRatio?: string;
|
|
1626
|
-
/**
|
|
1627
|
-
* Int to set between 0 and 255 for the opacity of the background in the result
|
|
1628
|
-
* images.
|
|
1629
|
-
*/
|
|
1630
1664
|
backgroundOpacity?: number;
|
|
1631
1665
|
/**
|
|
1632
1666
|
* The baseModelId that maybe changed at inference time
|
|
@@ -1636,9 +1670,6 @@ export declare namespace AssetListResponse {
|
|
|
1636
1670
|
* A bounding box around the object of interest, in the format [x1, y1, x2, y2].
|
|
1637
1671
|
*/
|
|
1638
1672
|
bbox?: Array<number>;
|
|
1639
|
-
/**
|
|
1640
|
-
* Remove small dark spots (i.e. “pepper”) and connect small bright cracks.
|
|
1641
|
-
*/
|
|
1642
1673
|
betterQuality?: boolean;
|
|
1643
1674
|
/**
|
|
1644
1675
|
* The control image already processed by canny detector. Must reference an
|
|
@@ -1697,9 +1728,6 @@ export declare namespace AssetListResponse {
|
|
|
1697
1728
|
* Amount of details to remove or add
|
|
1698
1729
|
*/
|
|
1699
1730
|
detailsLevel?: number;
|
|
1700
|
-
/**
|
|
1701
|
-
* The number of pixels to dilate the result masks.
|
|
1702
|
-
*/
|
|
1703
1731
|
dilate?: number;
|
|
1704
1732
|
/**
|
|
1705
1733
|
* Contrast factor for Grayscale detector
|
|
@@ -1901,11 +1929,15 @@ export declare namespace AssetListResponse {
|
|
|
1901
1929
|
*/
|
|
1902
1930
|
resultContours?: boolean;
|
|
1903
1931
|
/**
|
|
1904
|
-
* Boolean to
|
|
1932
|
+
* Boolean to return the source image with the mask applied as alpha channel (RGBA
|
|
1933
|
+
* PNG, transparent background) instead of the binary mask. Mutually exclusive with
|
|
1934
|
+
* `resultMask` — passing both as `true` returns a 400 error. Note:
|
|
1935
|
+
* `backgroundOpacity` is no longer honored — alpha is binary (0/255) only.
|
|
1905
1936
|
*/
|
|
1906
1937
|
resultImage?: boolean;
|
|
1907
1938
|
/**
|
|
1908
|
-
* Boolean to
|
|
1939
|
+
* Boolean to return the binary masks in the response. Mutually exclusive with
|
|
1940
|
+
* `resultImage` — passing both as `true` returns a 400 error.
|
|
1909
1941
|
*/
|
|
1910
1942
|
resultMask?: boolean;
|
|
1911
1943
|
rootParentId?: string;
|
|
@@ -2061,6 +2093,12 @@ export declare namespace AssetListResponse {
|
|
|
2061
2093
|
* Number of channels of the audio
|
|
2062
2094
|
*/
|
|
2063
2095
|
channels?: number;
|
|
2096
|
+
/**
|
|
2097
|
+
* Number of Unicode code points in the text. Code-point-aware (so a non-BMP emoji
|
|
2098
|
+
* counts as 1) but not full grapheme-cluster aware (a ZWJ sequence still counts as
|
|
2099
|
+
* several).
|
|
2100
|
+
*/
|
|
2101
|
+
charCount?: number;
|
|
2064
2102
|
/**
|
|
2065
2103
|
* Classification of the audio
|
|
2066
2104
|
*/
|
|
@@ -2097,6 +2135,13 @@ export declare namespace AssetListResponse {
|
|
|
2097
2135
|
* Whether the mesh has animations
|
|
2098
2136
|
*/
|
|
2099
2137
|
hasAnimations?: boolean;
|
|
2138
|
+
/**
|
|
2139
|
+
* True when `preview` holds the entire content unmodified — consumers can use it
|
|
2140
|
+
* directly without fetching `asset.url`. False or undefined means the content
|
|
2141
|
+
* exceeds the preview budget and consumers must fetch the full body from S3 to
|
|
2142
|
+
* read past the preview.
|
|
2143
|
+
*/
|
|
2144
|
+
hasFullPreview?: boolean;
|
|
2100
2145
|
/**
|
|
2101
2146
|
* Whether the mesh has normal vectors
|
|
2102
2147
|
*/
|
|
@@ -2114,6 +2159,14 @@ export declare namespace AssetListResponse {
|
|
|
2114
2159
|
* Number of frames in the video
|
|
2115
2160
|
*/
|
|
2116
2161
|
nbFrames?: number;
|
|
2162
|
+
/**
|
|
2163
|
+
* Leading slice of the content used for inline UI display and as a search
|
|
2164
|
+
* shortcut. Capped at TEXT_PREVIEW_MAX_BYTES (UTF-8) and always cut on a
|
|
2165
|
+
* code-point boundary so no character is split. Number of characters in the
|
|
2166
|
+
* preview varies by script (around 1024 for ASCII, ~340 for CJK, ~256 for
|
|
2167
|
+
* emoji-heavy text at the default 1 KB budget).
|
|
2168
|
+
*/
|
|
2169
|
+
preview?: string;
|
|
2117
2170
|
/**
|
|
2118
2171
|
* Sample rate of the media in Hz
|
|
2119
2172
|
*/
|
|
@@ -2127,6 +2180,10 @@ export declare namespace AssetListResponse {
|
|
|
2127
2180
|
*/
|
|
2128
2181
|
vertexCount?: number;
|
|
2129
2182
|
width?: number;
|
|
2183
|
+
/**
|
|
2184
|
+
* Number of whitespace-separated words in the text
|
|
2185
|
+
*/
|
|
2186
|
+
wordCount?: number;
|
|
2130
2187
|
}
|
|
2131
2188
|
namespace Properties {
|
|
2132
2189
|
/**
|
|
@@ -2202,7 +2259,7 @@ export declare namespace AssetDuplicateResponse {
|
|
|
2202
2259
|
/**
|
|
2203
2260
|
* The kind of asset
|
|
2204
2261
|
*/
|
|
2205
|
-
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
2262
|
+
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
2206
2263
|
/**
|
|
2207
2264
|
* Metadata of the asset with some additional information
|
|
2208
2265
|
*/
|
|
@@ -2227,7 +2284,7 @@ export declare namespace AssetDuplicateResponse {
|
|
|
2227
2284
|
/**
|
|
2228
2285
|
* source of the asset
|
|
2229
2286
|
*/
|
|
2230
|
-
source: '3d23d' | '3d23d:texture' | '3d:texture' | '3d:texture:albedo' | '3d:texture:metallic' | '3d:texture:mtl' | '3d:texture:normal' | '3d:texture:roughness' | 'audio2audio' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-control-net' | 'inference-control-net-img' | 'inference-control-net-inpainting' | 'inference-control-net-inpainting-ip-adapter' | 'inference-control-net-ip-adapter' | 'inference-control-net-reference' | 'inference-control-net-texture' | 'inference-img' | 'inference-img-ip-adapter' | 'inference-img-texture' | 'inference-in-paint' | 'inference-in-paint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt' | 'inference-txt-ip-adapter' | 'inference-txt-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture:albedo' | 'texture:ao' | 'texture:edge' | 'texture:height' | 'texture:metallic' | 'texture:normal' | 'texture:smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
2287
|
+
source: '3d23d' | '3d23d:texture' | '3d:texture' | '3d:texture:albedo' | '3d:texture:metallic' | '3d:texture:mtl' | '3d:texture:normal' | '3d:texture:roughness' | 'audio2audio' | 'audio2txt' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2txt' | 'img2video' | 'inference-control-net' | 'inference-control-net-img' | 'inference-control-net-inpainting' | 'inference-control-net-inpainting-ip-adapter' | 'inference-control-net-ip-adapter' | 'inference-control-net-reference' | 'inference-control-net-texture' | 'inference-img' | 'inference-img-ip-adapter' | 'inference-img-texture' | 'inference-in-paint' | 'inference-in-paint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt' | 'inference-txt-ip-adapter' | 'inference-txt-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture:albedo' | 'texture:ao' | 'texture:edge' | 'texture:height' | 'texture:metallic' | 'texture:normal' | 'texture:smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2txt' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-text' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
2231
2288
|
/**
|
|
2232
2289
|
* The actual status
|
|
2233
2290
|
*/
|
|
@@ -2315,12 +2372,12 @@ export declare namespace AssetDuplicateResponse {
|
|
|
2315
2372
|
* Metadata of the asset with some additional information
|
|
2316
2373
|
*/
|
|
2317
2374
|
interface Metadata {
|
|
2318
|
-
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
2375
|
+
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
2319
2376
|
/**
|
|
2320
2377
|
* The type of the asset. Ex: 'inference-txt2img' will represent an asset generated
|
|
2321
2378
|
* from a text to image model
|
|
2322
2379
|
*/
|
|
2323
|
-
type: '3d-texture' | '3d-texture-albedo' | '3d-texture-metallic' | '3d-texture-mtl' | '3d-texture-normal' | '3d-texture-roughness' | '3d23d' | '3d23d-texture' | 'audio2audio' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-controlnet' | 'inference-controlnet-img2img' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-reference' | 'inference-controlnet-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture-albedo' | 'texture-ao' | 'texture-edge' | 'texture-height' | 'texture-metallic' | 'texture-normal' | 'texture-smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
2380
|
+
type: '3d-texture' | '3d-texture-albedo' | '3d-texture-metallic' | '3d-texture-mtl' | '3d-texture-normal' | '3d-texture-roughness' | '3d23d' | '3d23d-texture' | 'audio2audio' | 'audio2txt' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2txt' | 'img2video' | 'inference-controlnet' | 'inference-controlnet-img2img' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-reference' | 'inference-controlnet-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture-albedo' | 'texture-ao' | 'texture-edge' | 'texture-height' | 'texture-metallic' | 'texture-normal' | 'texture-smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2txt' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-text' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
2324
2381
|
/**
|
|
2325
2382
|
* How angular is the surface? 0 is like a sphere, 1 is like a mechanical object
|
|
2326
2383
|
*/
|
|
@@ -2330,10 +2387,6 @@ export declare namespace AssetDuplicateResponse {
|
|
|
2330
2387
|
* models
|
|
2331
2388
|
*/
|
|
2332
2389
|
aspectRatio?: string;
|
|
2333
|
-
/**
|
|
2334
|
-
* Int to set between 0 and 255 for the opacity of the background in the result
|
|
2335
|
-
* images.
|
|
2336
|
-
*/
|
|
2337
2390
|
backgroundOpacity?: number;
|
|
2338
2391
|
/**
|
|
2339
2392
|
* The baseModelId that maybe changed at inference time
|
|
@@ -2343,9 +2396,6 @@ export declare namespace AssetDuplicateResponse {
|
|
|
2343
2396
|
* A bounding box around the object of interest, in the format [x1, y1, x2, y2].
|
|
2344
2397
|
*/
|
|
2345
2398
|
bbox?: Array<number>;
|
|
2346
|
-
/**
|
|
2347
|
-
* Remove small dark spots (i.e. “pepper”) and connect small bright cracks.
|
|
2348
|
-
*/
|
|
2349
2399
|
betterQuality?: boolean;
|
|
2350
2400
|
/**
|
|
2351
2401
|
* The control image already processed by canny detector. Must reference an
|
|
@@ -2404,9 +2454,6 @@ export declare namespace AssetDuplicateResponse {
|
|
|
2404
2454
|
* Amount of details to remove or add
|
|
2405
2455
|
*/
|
|
2406
2456
|
detailsLevel?: number;
|
|
2407
|
-
/**
|
|
2408
|
-
* The number of pixels to dilate the result masks.
|
|
2409
|
-
*/
|
|
2410
2457
|
dilate?: number;
|
|
2411
2458
|
/**
|
|
2412
2459
|
* Contrast factor for Grayscale detector
|
|
@@ -2608,11 +2655,15 @@ export declare namespace AssetDuplicateResponse {
|
|
|
2608
2655
|
*/
|
|
2609
2656
|
resultContours?: boolean;
|
|
2610
2657
|
/**
|
|
2611
|
-
* Boolean to
|
|
2658
|
+
* Boolean to return the source image with the mask applied as alpha channel (RGBA
|
|
2659
|
+
* PNG, transparent background) instead of the binary mask. Mutually exclusive with
|
|
2660
|
+
* `resultMask` — passing both as `true` returns a 400 error. Note:
|
|
2661
|
+
* `backgroundOpacity` is no longer honored — alpha is binary (0/255) only.
|
|
2612
2662
|
*/
|
|
2613
2663
|
resultImage?: boolean;
|
|
2614
2664
|
/**
|
|
2615
|
-
* Boolean to
|
|
2665
|
+
* Boolean to return the binary masks in the response. Mutually exclusive with
|
|
2666
|
+
* `resultImage` — passing both as `true` returns a 400 error.
|
|
2616
2667
|
*/
|
|
2617
2668
|
resultMask?: boolean;
|
|
2618
2669
|
rootParentId?: string;
|
|
@@ -2768,6 +2819,12 @@ export declare namespace AssetDuplicateResponse {
|
|
|
2768
2819
|
* Number of channels of the audio
|
|
2769
2820
|
*/
|
|
2770
2821
|
channels?: number;
|
|
2822
|
+
/**
|
|
2823
|
+
* Number of Unicode code points in the text. Code-point-aware (so a non-BMP emoji
|
|
2824
|
+
* counts as 1) but not full grapheme-cluster aware (a ZWJ sequence still counts as
|
|
2825
|
+
* several).
|
|
2826
|
+
*/
|
|
2827
|
+
charCount?: number;
|
|
2771
2828
|
/**
|
|
2772
2829
|
* Classification of the audio
|
|
2773
2830
|
*/
|
|
@@ -2804,6 +2861,13 @@ export declare namespace AssetDuplicateResponse {
|
|
|
2804
2861
|
* Whether the mesh has animations
|
|
2805
2862
|
*/
|
|
2806
2863
|
hasAnimations?: boolean;
|
|
2864
|
+
/**
|
|
2865
|
+
* True when `preview` holds the entire content unmodified — consumers can use it
|
|
2866
|
+
* directly without fetching `asset.url`. False or undefined means the content
|
|
2867
|
+
* exceeds the preview budget and consumers must fetch the full body from S3 to
|
|
2868
|
+
* read past the preview.
|
|
2869
|
+
*/
|
|
2870
|
+
hasFullPreview?: boolean;
|
|
2807
2871
|
/**
|
|
2808
2872
|
* Whether the mesh has normal vectors
|
|
2809
2873
|
*/
|
|
@@ -2821,6 +2885,14 @@ export declare namespace AssetDuplicateResponse {
|
|
|
2821
2885
|
* Number of frames in the video
|
|
2822
2886
|
*/
|
|
2823
2887
|
nbFrames?: number;
|
|
2888
|
+
/**
|
|
2889
|
+
* Leading slice of the content used for inline UI display and as a search
|
|
2890
|
+
* shortcut. Capped at TEXT_PREVIEW_MAX_BYTES (UTF-8) and always cut on a
|
|
2891
|
+
* code-point boundary so no character is split. Number of characters in the
|
|
2892
|
+
* preview varies by script (around 1024 for ASCII, ~340 for CJK, ~256 for
|
|
2893
|
+
* emoji-heavy text at the default 1 KB budget).
|
|
2894
|
+
*/
|
|
2895
|
+
preview?: string;
|
|
2824
2896
|
/**
|
|
2825
2897
|
* Sample rate of the media in Hz
|
|
2826
2898
|
*/
|
|
@@ -2834,6 +2906,10 @@ export declare namespace AssetDuplicateResponse {
|
|
|
2834
2906
|
*/
|
|
2835
2907
|
vertexCount?: number;
|
|
2836
2908
|
width?: number;
|
|
2909
|
+
/**
|
|
2910
|
+
* Number of whitespace-separated words in the text
|
|
2911
|
+
*/
|
|
2912
|
+
wordCount?: number;
|
|
2837
2913
|
}
|
|
2838
2914
|
namespace Properties {
|
|
2839
2915
|
/**
|
|
@@ -2909,7 +2985,7 @@ export declare namespace AssetGetBulkResponse {
|
|
|
2909
2985
|
/**
|
|
2910
2986
|
* The kind of asset
|
|
2911
2987
|
*/
|
|
2912
|
-
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
2988
|
+
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
2913
2989
|
/**
|
|
2914
2990
|
* Metadata of the asset with some additional information
|
|
2915
2991
|
*/
|
|
@@ -2934,7 +3010,7 @@ export declare namespace AssetGetBulkResponse {
|
|
|
2934
3010
|
/**
|
|
2935
3011
|
* source of the asset
|
|
2936
3012
|
*/
|
|
2937
|
-
source: '3d23d' | '3d23d:texture' | '3d:texture' | '3d:texture:albedo' | '3d:texture:metallic' | '3d:texture:mtl' | '3d:texture:normal' | '3d:texture:roughness' | 'audio2audio' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-control-net' | 'inference-control-net-img' | 'inference-control-net-inpainting' | 'inference-control-net-inpainting-ip-adapter' | 'inference-control-net-ip-adapter' | 'inference-control-net-reference' | 'inference-control-net-texture' | 'inference-img' | 'inference-img-ip-adapter' | 'inference-img-texture' | 'inference-in-paint' | 'inference-in-paint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt' | 'inference-txt-ip-adapter' | 'inference-txt-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture:albedo' | 'texture:ao' | 'texture:edge' | 'texture:height' | 'texture:metallic' | 'texture:normal' | 'texture:smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
3013
|
+
source: '3d23d' | '3d23d:texture' | '3d:texture' | '3d:texture:albedo' | '3d:texture:metallic' | '3d:texture:mtl' | '3d:texture:normal' | '3d:texture:roughness' | 'audio2audio' | 'audio2txt' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2txt' | 'img2video' | 'inference-control-net' | 'inference-control-net-img' | 'inference-control-net-inpainting' | 'inference-control-net-inpainting-ip-adapter' | 'inference-control-net-ip-adapter' | 'inference-control-net-reference' | 'inference-control-net-texture' | 'inference-img' | 'inference-img-ip-adapter' | 'inference-img-texture' | 'inference-in-paint' | 'inference-in-paint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt' | 'inference-txt-ip-adapter' | 'inference-txt-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture:albedo' | 'texture:ao' | 'texture:edge' | 'texture:height' | 'texture:metallic' | 'texture:normal' | 'texture:smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2txt' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-text' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
2938
3014
|
/**
|
|
2939
3015
|
* The actual status
|
|
2940
3016
|
*/
|
|
@@ -3022,12 +3098,12 @@ export declare namespace AssetGetBulkResponse {
|
|
|
3022
3098
|
* Metadata of the asset with some additional information
|
|
3023
3099
|
*/
|
|
3024
3100
|
interface Metadata {
|
|
3025
|
-
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
3101
|
+
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
3026
3102
|
/**
|
|
3027
3103
|
* The type of the asset. Ex: 'inference-txt2img' will represent an asset generated
|
|
3028
3104
|
* from a text to image model
|
|
3029
3105
|
*/
|
|
3030
|
-
type: '3d-texture' | '3d-texture-albedo' | '3d-texture-metallic' | '3d-texture-mtl' | '3d-texture-normal' | '3d-texture-roughness' | '3d23d' | '3d23d-texture' | 'audio2audio' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-controlnet' | 'inference-controlnet-img2img' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-reference' | 'inference-controlnet-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture-albedo' | 'texture-ao' | 'texture-edge' | 'texture-height' | 'texture-metallic' | 'texture-normal' | 'texture-smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
3106
|
+
type: '3d-texture' | '3d-texture-albedo' | '3d-texture-metallic' | '3d-texture-mtl' | '3d-texture-normal' | '3d-texture-roughness' | '3d23d' | '3d23d-texture' | 'audio2audio' | 'audio2txt' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2txt' | 'img2video' | 'inference-controlnet' | 'inference-controlnet-img2img' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-reference' | 'inference-controlnet-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture-albedo' | 'texture-ao' | 'texture-edge' | 'texture-height' | 'texture-metallic' | 'texture-normal' | 'texture-smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2txt' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-text' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
3031
3107
|
/**
|
|
3032
3108
|
* How angular is the surface? 0 is like a sphere, 1 is like a mechanical object
|
|
3033
3109
|
*/
|
|
@@ -3037,10 +3113,6 @@ export declare namespace AssetGetBulkResponse {
|
|
|
3037
3113
|
* models
|
|
3038
3114
|
*/
|
|
3039
3115
|
aspectRatio?: string;
|
|
3040
|
-
/**
|
|
3041
|
-
* Int to set between 0 and 255 for the opacity of the background in the result
|
|
3042
|
-
* images.
|
|
3043
|
-
*/
|
|
3044
3116
|
backgroundOpacity?: number;
|
|
3045
3117
|
/**
|
|
3046
3118
|
* The baseModelId that maybe changed at inference time
|
|
@@ -3050,9 +3122,6 @@ export declare namespace AssetGetBulkResponse {
|
|
|
3050
3122
|
* A bounding box around the object of interest, in the format [x1, y1, x2, y2].
|
|
3051
3123
|
*/
|
|
3052
3124
|
bbox?: Array<number>;
|
|
3053
|
-
/**
|
|
3054
|
-
* Remove small dark spots (i.e. “pepper”) and connect small bright cracks.
|
|
3055
|
-
*/
|
|
3056
3125
|
betterQuality?: boolean;
|
|
3057
3126
|
/**
|
|
3058
3127
|
* The control image already processed by canny detector. Must reference an
|
|
@@ -3111,9 +3180,6 @@ export declare namespace AssetGetBulkResponse {
|
|
|
3111
3180
|
* Amount of details to remove or add
|
|
3112
3181
|
*/
|
|
3113
3182
|
detailsLevel?: number;
|
|
3114
|
-
/**
|
|
3115
|
-
* The number of pixels to dilate the result masks.
|
|
3116
|
-
*/
|
|
3117
3183
|
dilate?: number;
|
|
3118
3184
|
/**
|
|
3119
3185
|
* Contrast factor for Grayscale detector
|
|
@@ -3315,11 +3381,15 @@ export declare namespace AssetGetBulkResponse {
|
|
|
3315
3381
|
*/
|
|
3316
3382
|
resultContours?: boolean;
|
|
3317
3383
|
/**
|
|
3318
|
-
* Boolean to
|
|
3384
|
+
* Boolean to return the source image with the mask applied as alpha channel (RGBA
|
|
3385
|
+
* PNG, transparent background) instead of the binary mask. Mutually exclusive with
|
|
3386
|
+
* `resultMask` — passing both as `true` returns a 400 error. Note:
|
|
3387
|
+
* `backgroundOpacity` is no longer honored — alpha is binary (0/255) only.
|
|
3319
3388
|
*/
|
|
3320
3389
|
resultImage?: boolean;
|
|
3321
3390
|
/**
|
|
3322
|
-
* Boolean to
|
|
3391
|
+
* Boolean to return the binary masks in the response. Mutually exclusive with
|
|
3392
|
+
* `resultImage` — passing both as `true` returns a 400 error.
|
|
3323
3393
|
*/
|
|
3324
3394
|
resultMask?: boolean;
|
|
3325
3395
|
rootParentId?: string;
|
|
@@ -3475,6 +3545,12 @@ export declare namespace AssetGetBulkResponse {
|
|
|
3475
3545
|
* Number of channels of the audio
|
|
3476
3546
|
*/
|
|
3477
3547
|
channels?: number;
|
|
3548
|
+
/**
|
|
3549
|
+
* Number of Unicode code points in the text. Code-point-aware (so a non-BMP emoji
|
|
3550
|
+
* counts as 1) but not full grapheme-cluster aware (a ZWJ sequence still counts as
|
|
3551
|
+
* several).
|
|
3552
|
+
*/
|
|
3553
|
+
charCount?: number;
|
|
3478
3554
|
/**
|
|
3479
3555
|
* Classification of the audio
|
|
3480
3556
|
*/
|
|
@@ -3511,6 +3587,13 @@ export declare namespace AssetGetBulkResponse {
|
|
|
3511
3587
|
* Whether the mesh has animations
|
|
3512
3588
|
*/
|
|
3513
3589
|
hasAnimations?: boolean;
|
|
3590
|
+
/**
|
|
3591
|
+
* True when `preview` holds the entire content unmodified — consumers can use it
|
|
3592
|
+
* directly without fetching `asset.url`. False or undefined means the content
|
|
3593
|
+
* exceeds the preview budget and consumers must fetch the full body from S3 to
|
|
3594
|
+
* read past the preview.
|
|
3595
|
+
*/
|
|
3596
|
+
hasFullPreview?: boolean;
|
|
3514
3597
|
/**
|
|
3515
3598
|
* Whether the mesh has normal vectors
|
|
3516
3599
|
*/
|
|
@@ -3528,6 +3611,14 @@ export declare namespace AssetGetBulkResponse {
|
|
|
3528
3611
|
* Number of frames in the video
|
|
3529
3612
|
*/
|
|
3530
3613
|
nbFrames?: number;
|
|
3614
|
+
/**
|
|
3615
|
+
* Leading slice of the content used for inline UI display and as a search
|
|
3616
|
+
* shortcut. Capped at TEXT_PREVIEW_MAX_BYTES (UTF-8) and always cut on a
|
|
3617
|
+
* code-point boundary so no character is split. Number of characters in the
|
|
3618
|
+
* preview varies by script (around 1024 for ASCII, ~340 for CJK, ~256 for
|
|
3619
|
+
* emoji-heavy text at the default 1 KB budget).
|
|
3620
|
+
*/
|
|
3621
|
+
preview?: string;
|
|
3531
3622
|
/**
|
|
3532
3623
|
* Sample rate of the media in Hz
|
|
3533
3624
|
*/
|
|
@@ -3541,6 +3632,10 @@ export declare namespace AssetGetBulkResponse {
|
|
|
3541
3632
|
*/
|
|
3542
3633
|
vertexCount?: number;
|
|
3543
3634
|
width?: number;
|
|
3635
|
+
/**
|
|
3636
|
+
* Number of whitespace-separated words in the text
|
|
3637
|
+
*/
|
|
3638
|
+
wordCount?: number;
|
|
3544
3639
|
}
|
|
3545
3640
|
namespace Properties {
|
|
3546
3641
|
/**
|
|
@@ -3626,7 +3721,7 @@ export declare namespace AssetLockResponse {
|
|
|
3626
3721
|
/**
|
|
3627
3722
|
* The kind of asset
|
|
3628
3723
|
*/
|
|
3629
|
-
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
3724
|
+
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
3630
3725
|
/**
|
|
3631
3726
|
* Metadata of the asset with some additional information
|
|
3632
3727
|
*/
|
|
@@ -3651,7 +3746,7 @@ export declare namespace AssetLockResponse {
|
|
|
3651
3746
|
/**
|
|
3652
3747
|
* source of the asset
|
|
3653
3748
|
*/
|
|
3654
|
-
source: '3d23d' | '3d23d:texture' | '3d:texture' | '3d:texture:albedo' | '3d:texture:metallic' | '3d:texture:mtl' | '3d:texture:normal' | '3d:texture:roughness' | 'audio2audio' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-control-net' | 'inference-control-net-img' | 'inference-control-net-inpainting' | 'inference-control-net-inpainting-ip-adapter' | 'inference-control-net-ip-adapter' | 'inference-control-net-reference' | 'inference-control-net-texture' | 'inference-img' | 'inference-img-ip-adapter' | 'inference-img-texture' | 'inference-in-paint' | 'inference-in-paint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt' | 'inference-txt-ip-adapter' | 'inference-txt-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture:albedo' | 'texture:ao' | 'texture:edge' | 'texture:height' | 'texture:metallic' | 'texture:normal' | 'texture:smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
3749
|
+
source: '3d23d' | '3d23d:texture' | '3d:texture' | '3d:texture:albedo' | '3d:texture:metallic' | '3d:texture:mtl' | '3d:texture:normal' | '3d:texture:roughness' | 'audio2audio' | 'audio2txt' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2txt' | 'img2video' | 'inference-control-net' | 'inference-control-net-img' | 'inference-control-net-inpainting' | 'inference-control-net-inpainting-ip-adapter' | 'inference-control-net-ip-adapter' | 'inference-control-net-reference' | 'inference-control-net-texture' | 'inference-img' | 'inference-img-ip-adapter' | 'inference-img-texture' | 'inference-in-paint' | 'inference-in-paint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt' | 'inference-txt-ip-adapter' | 'inference-txt-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture:albedo' | 'texture:ao' | 'texture:edge' | 'texture:height' | 'texture:metallic' | 'texture:normal' | 'texture:smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2txt' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-text' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
3655
3750
|
/**
|
|
3656
3751
|
* The actual status
|
|
3657
3752
|
*/
|
|
@@ -3739,12 +3834,12 @@ export declare namespace AssetLockResponse {
|
|
|
3739
3834
|
* Metadata of the asset with some additional information
|
|
3740
3835
|
*/
|
|
3741
3836
|
interface Metadata {
|
|
3742
|
-
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
3837
|
+
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
3743
3838
|
/**
|
|
3744
3839
|
* The type of the asset. Ex: 'inference-txt2img' will represent an asset generated
|
|
3745
3840
|
* from a text to image model
|
|
3746
3841
|
*/
|
|
3747
|
-
type: '3d-texture' | '3d-texture-albedo' | '3d-texture-metallic' | '3d-texture-mtl' | '3d-texture-normal' | '3d-texture-roughness' | '3d23d' | '3d23d-texture' | 'audio2audio' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-controlnet' | 'inference-controlnet-img2img' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-reference' | 'inference-controlnet-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture-albedo' | 'texture-ao' | 'texture-edge' | 'texture-height' | 'texture-metallic' | 'texture-normal' | 'texture-smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
3842
|
+
type: '3d-texture' | '3d-texture-albedo' | '3d-texture-metallic' | '3d-texture-mtl' | '3d-texture-normal' | '3d-texture-roughness' | '3d23d' | '3d23d-texture' | 'audio2audio' | 'audio2txt' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2txt' | 'img2video' | 'inference-controlnet' | 'inference-controlnet-img2img' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-reference' | 'inference-controlnet-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture-albedo' | 'texture-ao' | 'texture-edge' | 'texture-height' | 'texture-metallic' | 'texture-normal' | 'texture-smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2txt' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-text' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
3748
3843
|
/**
|
|
3749
3844
|
* How angular is the surface? 0 is like a sphere, 1 is like a mechanical object
|
|
3750
3845
|
*/
|
|
@@ -3754,10 +3849,6 @@ export declare namespace AssetLockResponse {
|
|
|
3754
3849
|
* models
|
|
3755
3850
|
*/
|
|
3756
3851
|
aspectRatio?: string;
|
|
3757
|
-
/**
|
|
3758
|
-
* Int to set between 0 and 255 for the opacity of the background in the result
|
|
3759
|
-
* images.
|
|
3760
|
-
*/
|
|
3761
3852
|
backgroundOpacity?: number;
|
|
3762
3853
|
/**
|
|
3763
3854
|
* The baseModelId that maybe changed at inference time
|
|
@@ -3767,9 +3858,6 @@ export declare namespace AssetLockResponse {
|
|
|
3767
3858
|
* A bounding box around the object of interest, in the format [x1, y1, x2, y2].
|
|
3768
3859
|
*/
|
|
3769
3860
|
bbox?: Array<number>;
|
|
3770
|
-
/**
|
|
3771
|
-
* Remove small dark spots (i.e. “pepper”) and connect small bright cracks.
|
|
3772
|
-
*/
|
|
3773
3861
|
betterQuality?: boolean;
|
|
3774
3862
|
/**
|
|
3775
3863
|
* The control image already processed by canny detector. Must reference an
|
|
@@ -3828,9 +3916,6 @@ export declare namespace AssetLockResponse {
|
|
|
3828
3916
|
* Amount of details to remove or add
|
|
3829
3917
|
*/
|
|
3830
3918
|
detailsLevel?: number;
|
|
3831
|
-
/**
|
|
3832
|
-
* The number of pixels to dilate the result masks.
|
|
3833
|
-
*/
|
|
3834
3919
|
dilate?: number;
|
|
3835
3920
|
/**
|
|
3836
3921
|
* Contrast factor for Grayscale detector
|
|
@@ -4032,11 +4117,15 @@ export declare namespace AssetLockResponse {
|
|
|
4032
4117
|
*/
|
|
4033
4118
|
resultContours?: boolean;
|
|
4034
4119
|
/**
|
|
4035
|
-
* Boolean to
|
|
4120
|
+
* Boolean to return the source image with the mask applied as alpha channel (RGBA
|
|
4121
|
+
* PNG, transparent background) instead of the binary mask. Mutually exclusive with
|
|
4122
|
+
* `resultMask` — passing both as `true` returns a 400 error. Note:
|
|
4123
|
+
* `backgroundOpacity` is no longer honored — alpha is binary (0/255) only.
|
|
4036
4124
|
*/
|
|
4037
4125
|
resultImage?: boolean;
|
|
4038
4126
|
/**
|
|
4039
|
-
* Boolean to
|
|
4127
|
+
* Boolean to return the binary masks in the response. Mutually exclusive with
|
|
4128
|
+
* `resultImage` — passing both as `true` returns a 400 error.
|
|
4040
4129
|
*/
|
|
4041
4130
|
resultMask?: boolean;
|
|
4042
4131
|
rootParentId?: string;
|
|
@@ -4192,6 +4281,12 @@ export declare namespace AssetLockResponse {
|
|
|
4192
4281
|
* Number of channels of the audio
|
|
4193
4282
|
*/
|
|
4194
4283
|
channels?: number;
|
|
4284
|
+
/**
|
|
4285
|
+
* Number of Unicode code points in the text. Code-point-aware (so a non-BMP emoji
|
|
4286
|
+
* counts as 1) but not full grapheme-cluster aware (a ZWJ sequence still counts as
|
|
4287
|
+
* several).
|
|
4288
|
+
*/
|
|
4289
|
+
charCount?: number;
|
|
4195
4290
|
/**
|
|
4196
4291
|
* Classification of the audio
|
|
4197
4292
|
*/
|
|
@@ -4228,6 +4323,13 @@ export declare namespace AssetLockResponse {
|
|
|
4228
4323
|
* Whether the mesh has animations
|
|
4229
4324
|
*/
|
|
4230
4325
|
hasAnimations?: boolean;
|
|
4326
|
+
/**
|
|
4327
|
+
* True when `preview` holds the entire content unmodified — consumers can use it
|
|
4328
|
+
* directly without fetching `asset.url`. False or undefined means the content
|
|
4329
|
+
* exceeds the preview budget and consumers must fetch the full body from S3 to
|
|
4330
|
+
* read past the preview.
|
|
4331
|
+
*/
|
|
4332
|
+
hasFullPreview?: boolean;
|
|
4231
4333
|
/**
|
|
4232
4334
|
* Whether the mesh has normal vectors
|
|
4233
4335
|
*/
|
|
@@ -4245,6 +4347,14 @@ export declare namespace AssetLockResponse {
|
|
|
4245
4347
|
* Number of frames in the video
|
|
4246
4348
|
*/
|
|
4247
4349
|
nbFrames?: number;
|
|
4350
|
+
/**
|
|
4351
|
+
* Leading slice of the content used for inline UI display and as a search
|
|
4352
|
+
* shortcut. Capped at TEXT_PREVIEW_MAX_BYTES (UTF-8) and always cut on a
|
|
4353
|
+
* code-point boundary so no character is split. Number of characters in the
|
|
4354
|
+
* preview varies by script (around 1024 for ASCII, ~340 for CJK, ~256 for
|
|
4355
|
+
* emoji-heavy text at the default 1 KB budget).
|
|
4356
|
+
*/
|
|
4357
|
+
preview?: string;
|
|
4248
4358
|
/**
|
|
4249
4359
|
* Sample rate of the media in Hz
|
|
4250
4360
|
*/
|
|
@@ -4258,6 +4368,10 @@ export declare namespace AssetLockResponse {
|
|
|
4258
4368
|
*/
|
|
4259
4369
|
vertexCount?: number;
|
|
4260
4370
|
width?: number;
|
|
4371
|
+
/**
|
|
4372
|
+
* Number of whitespace-separated words in the text
|
|
4373
|
+
*/
|
|
4374
|
+
wordCount?: number;
|
|
4261
4375
|
}
|
|
4262
4376
|
namespace Properties {
|
|
4263
4377
|
/**
|
|
@@ -4333,7 +4447,7 @@ export declare namespace AssetUnlockResponse {
|
|
|
4333
4447
|
/**
|
|
4334
4448
|
* The kind of asset
|
|
4335
4449
|
*/
|
|
4336
|
-
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
4450
|
+
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
4337
4451
|
/**
|
|
4338
4452
|
* Metadata of the asset with some additional information
|
|
4339
4453
|
*/
|
|
@@ -4358,7 +4472,7 @@ export declare namespace AssetUnlockResponse {
|
|
|
4358
4472
|
/**
|
|
4359
4473
|
* source of the asset
|
|
4360
4474
|
*/
|
|
4361
|
-
source: '3d23d' | '3d23d:texture' | '3d:texture' | '3d:texture:albedo' | '3d:texture:metallic' | '3d:texture:mtl' | '3d:texture:normal' | '3d:texture:roughness' | 'audio2audio' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-control-net' | 'inference-control-net-img' | 'inference-control-net-inpainting' | 'inference-control-net-inpainting-ip-adapter' | 'inference-control-net-ip-adapter' | 'inference-control-net-reference' | 'inference-control-net-texture' | 'inference-img' | 'inference-img-ip-adapter' | 'inference-img-texture' | 'inference-in-paint' | 'inference-in-paint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt' | 'inference-txt-ip-adapter' | 'inference-txt-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture:albedo' | 'texture:ao' | 'texture:edge' | 'texture:height' | 'texture:metallic' | 'texture:normal' | 'texture:smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
4475
|
+
source: '3d23d' | '3d23d:texture' | '3d:texture' | '3d:texture:albedo' | '3d:texture:metallic' | '3d:texture:mtl' | '3d:texture:normal' | '3d:texture:roughness' | 'audio2audio' | 'audio2txt' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2txt' | 'img2video' | 'inference-control-net' | 'inference-control-net-img' | 'inference-control-net-inpainting' | 'inference-control-net-inpainting-ip-adapter' | 'inference-control-net-ip-adapter' | 'inference-control-net-reference' | 'inference-control-net-texture' | 'inference-img' | 'inference-img-ip-adapter' | 'inference-img-texture' | 'inference-in-paint' | 'inference-in-paint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt' | 'inference-txt-ip-adapter' | 'inference-txt-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture:albedo' | 'texture:ao' | 'texture:edge' | 'texture:height' | 'texture:metallic' | 'texture:normal' | 'texture:smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2txt' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-text' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
4362
4476
|
/**
|
|
4363
4477
|
* The actual status
|
|
4364
4478
|
*/
|
|
@@ -4446,12 +4560,12 @@ export declare namespace AssetUnlockResponse {
|
|
|
4446
4560
|
* Metadata of the asset with some additional information
|
|
4447
4561
|
*/
|
|
4448
4562
|
interface Metadata {
|
|
4449
|
-
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
4563
|
+
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
4450
4564
|
/**
|
|
4451
4565
|
* The type of the asset. Ex: 'inference-txt2img' will represent an asset generated
|
|
4452
4566
|
* from a text to image model
|
|
4453
4567
|
*/
|
|
4454
|
-
type: '3d-texture' | '3d-texture-albedo' | '3d-texture-metallic' | '3d-texture-mtl' | '3d-texture-normal' | '3d-texture-roughness' | '3d23d' | '3d23d-texture' | 'audio2audio' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-controlnet' | 'inference-controlnet-img2img' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-reference' | 'inference-controlnet-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture-albedo' | 'texture-ao' | 'texture-edge' | 'texture-height' | 'texture-metallic' | 'texture-normal' | 'texture-smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
4568
|
+
type: '3d-texture' | '3d-texture-albedo' | '3d-texture-metallic' | '3d-texture-mtl' | '3d-texture-normal' | '3d-texture-roughness' | '3d23d' | '3d23d-texture' | 'audio2audio' | 'audio2txt' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2txt' | 'img2video' | 'inference-controlnet' | 'inference-controlnet-img2img' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-reference' | 'inference-controlnet-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture-albedo' | 'texture-ao' | 'texture-edge' | 'texture-height' | 'texture-metallic' | 'texture-normal' | 'texture-smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2txt' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-text' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
4455
4569
|
/**
|
|
4456
4570
|
* How angular is the surface? 0 is like a sphere, 1 is like a mechanical object
|
|
4457
4571
|
*/
|
|
@@ -4461,10 +4575,6 @@ export declare namespace AssetUnlockResponse {
|
|
|
4461
4575
|
* models
|
|
4462
4576
|
*/
|
|
4463
4577
|
aspectRatio?: string;
|
|
4464
|
-
/**
|
|
4465
|
-
* Int to set between 0 and 255 for the opacity of the background in the result
|
|
4466
|
-
* images.
|
|
4467
|
-
*/
|
|
4468
4578
|
backgroundOpacity?: number;
|
|
4469
4579
|
/**
|
|
4470
4580
|
* The baseModelId that maybe changed at inference time
|
|
@@ -4474,9 +4584,6 @@ export declare namespace AssetUnlockResponse {
|
|
|
4474
4584
|
* A bounding box around the object of interest, in the format [x1, y1, x2, y2].
|
|
4475
4585
|
*/
|
|
4476
4586
|
bbox?: Array<number>;
|
|
4477
|
-
/**
|
|
4478
|
-
* Remove small dark spots (i.e. “pepper”) and connect small bright cracks.
|
|
4479
|
-
*/
|
|
4480
4587
|
betterQuality?: boolean;
|
|
4481
4588
|
/**
|
|
4482
4589
|
* The control image already processed by canny detector. Must reference an
|
|
@@ -4535,9 +4642,6 @@ export declare namespace AssetUnlockResponse {
|
|
|
4535
4642
|
* Amount of details to remove or add
|
|
4536
4643
|
*/
|
|
4537
4644
|
detailsLevel?: number;
|
|
4538
|
-
/**
|
|
4539
|
-
* The number of pixels to dilate the result masks.
|
|
4540
|
-
*/
|
|
4541
4645
|
dilate?: number;
|
|
4542
4646
|
/**
|
|
4543
4647
|
* Contrast factor for Grayscale detector
|
|
@@ -4739,11 +4843,15 @@ export declare namespace AssetUnlockResponse {
|
|
|
4739
4843
|
*/
|
|
4740
4844
|
resultContours?: boolean;
|
|
4741
4845
|
/**
|
|
4742
|
-
* Boolean to
|
|
4846
|
+
* Boolean to return the source image with the mask applied as alpha channel (RGBA
|
|
4847
|
+
* PNG, transparent background) instead of the binary mask. Mutually exclusive with
|
|
4848
|
+
* `resultMask` — passing both as `true` returns a 400 error. Note:
|
|
4849
|
+
* `backgroundOpacity` is no longer honored — alpha is binary (0/255) only.
|
|
4743
4850
|
*/
|
|
4744
4851
|
resultImage?: boolean;
|
|
4745
4852
|
/**
|
|
4746
|
-
* Boolean to
|
|
4853
|
+
* Boolean to return the binary masks in the response. Mutually exclusive with
|
|
4854
|
+
* `resultImage` — passing both as `true` returns a 400 error.
|
|
4747
4855
|
*/
|
|
4748
4856
|
resultMask?: boolean;
|
|
4749
4857
|
rootParentId?: string;
|
|
@@ -4899,6 +5007,12 @@ export declare namespace AssetUnlockResponse {
|
|
|
4899
5007
|
* Number of channels of the audio
|
|
4900
5008
|
*/
|
|
4901
5009
|
channels?: number;
|
|
5010
|
+
/**
|
|
5011
|
+
* Number of Unicode code points in the text. Code-point-aware (so a non-BMP emoji
|
|
5012
|
+
* counts as 1) but not full grapheme-cluster aware (a ZWJ sequence still counts as
|
|
5013
|
+
* several).
|
|
5014
|
+
*/
|
|
5015
|
+
charCount?: number;
|
|
4902
5016
|
/**
|
|
4903
5017
|
* Classification of the audio
|
|
4904
5018
|
*/
|
|
@@ -4935,6 +5049,13 @@ export declare namespace AssetUnlockResponse {
|
|
|
4935
5049
|
* Whether the mesh has animations
|
|
4936
5050
|
*/
|
|
4937
5051
|
hasAnimations?: boolean;
|
|
5052
|
+
/**
|
|
5053
|
+
* True when `preview` holds the entire content unmodified — consumers can use it
|
|
5054
|
+
* directly without fetching `asset.url`. False or undefined means the content
|
|
5055
|
+
* exceeds the preview budget and consumers must fetch the full body from S3 to
|
|
5056
|
+
* read past the preview.
|
|
5057
|
+
*/
|
|
5058
|
+
hasFullPreview?: boolean;
|
|
4938
5059
|
/**
|
|
4939
5060
|
* Whether the mesh has normal vectors
|
|
4940
5061
|
*/
|
|
@@ -4952,6 +5073,14 @@ export declare namespace AssetUnlockResponse {
|
|
|
4952
5073
|
* Number of frames in the video
|
|
4953
5074
|
*/
|
|
4954
5075
|
nbFrames?: number;
|
|
5076
|
+
/**
|
|
5077
|
+
* Leading slice of the content used for inline UI display and as a search
|
|
5078
|
+
* shortcut. Capped at TEXT_PREVIEW_MAX_BYTES (UTF-8) and always cut on a
|
|
5079
|
+
* code-point boundary so no character is split. Number of characters in the
|
|
5080
|
+
* preview varies by script (around 1024 for ASCII, ~340 for CJK, ~256 for
|
|
5081
|
+
* emoji-heavy text at the default 1 KB budget).
|
|
5082
|
+
*/
|
|
5083
|
+
preview?: string;
|
|
4955
5084
|
/**
|
|
4956
5085
|
* Sample rate of the media in Hz
|
|
4957
5086
|
*/
|
|
@@ -4965,6 +5094,10 @@ export declare namespace AssetUnlockResponse {
|
|
|
4965
5094
|
*/
|
|
4966
5095
|
vertexCount?: number;
|
|
4967
5096
|
width?: number;
|
|
5097
|
+
/**
|
|
5098
|
+
* Number of whitespace-separated words in the text
|
|
5099
|
+
*/
|
|
5100
|
+
wordCount?: number;
|
|
4968
5101
|
}
|
|
4969
5102
|
namespace Properties {
|
|
4970
5103
|
/**
|
|
@@ -5051,7 +5184,7 @@ export declare namespace AssetUploadResponse {
|
|
|
5051
5184
|
/**
|
|
5052
5185
|
* The kind of asset
|
|
5053
5186
|
*/
|
|
5054
|
-
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
5187
|
+
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
5055
5188
|
/**
|
|
5056
5189
|
* Metadata of the asset with some additional information
|
|
5057
5190
|
*/
|
|
@@ -5076,7 +5209,7 @@ export declare namespace AssetUploadResponse {
|
|
|
5076
5209
|
/**
|
|
5077
5210
|
* source of the asset
|
|
5078
5211
|
*/
|
|
5079
|
-
source: '3d23d' | '3d23d:texture' | '3d:texture' | '3d:texture:albedo' | '3d:texture:metallic' | '3d:texture:mtl' | '3d:texture:normal' | '3d:texture:roughness' | 'audio2audio' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-control-net' | 'inference-control-net-img' | 'inference-control-net-inpainting' | 'inference-control-net-inpainting-ip-adapter' | 'inference-control-net-ip-adapter' | 'inference-control-net-reference' | 'inference-control-net-texture' | 'inference-img' | 'inference-img-ip-adapter' | 'inference-img-texture' | 'inference-in-paint' | 'inference-in-paint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt' | 'inference-txt-ip-adapter' | 'inference-txt-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture:albedo' | 'texture:ao' | 'texture:edge' | 'texture:height' | 'texture:metallic' | 'texture:normal' | 'texture:smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
5212
|
+
source: '3d23d' | '3d23d:texture' | '3d:texture' | '3d:texture:albedo' | '3d:texture:metallic' | '3d:texture:mtl' | '3d:texture:normal' | '3d:texture:roughness' | 'audio2audio' | 'audio2txt' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2txt' | 'img2video' | 'inference-control-net' | 'inference-control-net-img' | 'inference-control-net-inpainting' | 'inference-control-net-inpainting-ip-adapter' | 'inference-control-net-ip-adapter' | 'inference-control-net-reference' | 'inference-control-net-texture' | 'inference-img' | 'inference-img-ip-adapter' | 'inference-img-texture' | 'inference-in-paint' | 'inference-in-paint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt' | 'inference-txt-ip-adapter' | 'inference-txt-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture:albedo' | 'texture:ao' | 'texture:edge' | 'texture:height' | 'texture:metallic' | 'texture:normal' | 'texture:smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2txt' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-text' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
5080
5213
|
/**
|
|
5081
5214
|
* The actual status
|
|
5082
5215
|
*/
|
|
@@ -5164,12 +5297,12 @@ export declare namespace AssetUploadResponse {
|
|
|
5164
5297
|
* Metadata of the asset with some additional information
|
|
5165
5298
|
*/
|
|
5166
5299
|
interface Metadata {
|
|
5167
|
-
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
5300
|
+
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
5168
5301
|
/**
|
|
5169
5302
|
* The type of the asset. Ex: 'inference-txt2img' will represent an asset generated
|
|
5170
5303
|
* from a text to image model
|
|
5171
5304
|
*/
|
|
5172
|
-
type: '3d-texture' | '3d-texture-albedo' | '3d-texture-metallic' | '3d-texture-mtl' | '3d-texture-normal' | '3d-texture-roughness' | '3d23d' | '3d23d-texture' | 'audio2audio' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2video' | 'inference-controlnet' | 'inference-controlnet-img2img' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-reference' | 'inference-controlnet-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture-albedo' | 'texture-ao' | 'texture-edge' | 'texture-height' | 'texture-metallic' | 'texture-normal' | 'texture-smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
5305
|
+
type: '3d-texture' | '3d-texture-albedo' | '3d-texture-metallic' | '3d-texture-mtl' | '3d-texture-normal' | '3d-texture-roughness' | '3d23d' | '3d23d-texture' | 'audio2audio' | 'audio2txt' | 'audio2video' | 'background-removal' | 'canvas' | 'canvas-drawing' | 'canvas-export' | 'detection' | 'generative-fill' | 'image-prompt-editing' | 'img23d' | 'img2img' | 'img2txt' | 'img2video' | 'inference-controlnet' | 'inference-controlnet-img2img' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-reference' | 'inference-controlnet-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'patch' | 'pixelization' | 'reframe' | 'restyle' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-3d' | 'skybox-base-360' | 'skybox-hdri' | 'texture' | 'texture-albedo' | 'texture-ao' | 'texture-edge' | 'texture-height' | 'texture-metallic' | 'texture-normal' | 'texture-smoothness' | 'txt23d' | 'txt2audio' | 'txt2img' | 'txt2txt' | 'txt2video' | 'unknown' | 'uploaded' | 'uploaded-3d' | 'uploaded-audio' | 'uploaded-avatar' | 'uploaded-text' | 'uploaded-video' | 'upscale' | 'upscale-skybox' | 'upscale-texture' | 'upscale-video' | 'vectorization' | 'video23d' | 'video2audio' | 'video2img' | 'video2video' | 'voice-clone';
|
|
5173
5306
|
/**
|
|
5174
5307
|
* How angular is the surface? 0 is like a sphere, 1 is like a mechanical object
|
|
5175
5308
|
*/
|
|
@@ -5179,10 +5312,6 @@ export declare namespace AssetUploadResponse {
|
|
|
5179
5312
|
* models
|
|
5180
5313
|
*/
|
|
5181
5314
|
aspectRatio?: string;
|
|
5182
|
-
/**
|
|
5183
|
-
* Int to set between 0 and 255 for the opacity of the background in the result
|
|
5184
|
-
* images.
|
|
5185
|
-
*/
|
|
5186
5315
|
backgroundOpacity?: number;
|
|
5187
5316
|
/**
|
|
5188
5317
|
* The baseModelId that maybe changed at inference time
|
|
@@ -5192,9 +5321,6 @@ export declare namespace AssetUploadResponse {
|
|
|
5192
5321
|
* A bounding box around the object of interest, in the format [x1, y1, x2, y2].
|
|
5193
5322
|
*/
|
|
5194
5323
|
bbox?: Array<number>;
|
|
5195
|
-
/**
|
|
5196
|
-
* Remove small dark spots (i.e. “pepper”) and connect small bright cracks.
|
|
5197
|
-
*/
|
|
5198
5324
|
betterQuality?: boolean;
|
|
5199
5325
|
/**
|
|
5200
5326
|
* The control image already processed by canny detector. Must reference an
|
|
@@ -5253,9 +5379,6 @@ export declare namespace AssetUploadResponse {
|
|
|
5253
5379
|
* Amount of details to remove or add
|
|
5254
5380
|
*/
|
|
5255
5381
|
detailsLevel?: number;
|
|
5256
|
-
/**
|
|
5257
|
-
* The number of pixels to dilate the result masks.
|
|
5258
|
-
*/
|
|
5259
5382
|
dilate?: number;
|
|
5260
5383
|
/**
|
|
5261
5384
|
* Contrast factor for Grayscale detector
|
|
@@ -5457,11 +5580,15 @@ export declare namespace AssetUploadResponse {
|
|
|
5457
5580
|
*/
|
|
5458
5581
|
resultContours?: boolean;
|
|
5459
5582
|
/**
|
|
5460
|
-
* Boolean to
|
|
5583
|
+
* Boolean to return the source image with the mask applied as alpha channel (RGBA
|
|
5584
|
+
* PNG, transparent background) instead of the binary mask. Mutually exclusive with
|
|
5585
|
+
* `resultMask` — passing both as `true` returns a 400 error. Note:
|
|
5586
|
+
* `backgroundOpacity` is no longer honored — alpha is binary (0/255) only.
|
|
5461
5587
|
*/
|
|
5462
5588
|
resultImage?: boolean;
|
|
5463
5589
|
/**
|
|
5464
|
-
* Boolean to
|
|
5590
|
+
* Boolean to return the binary masks in the response. Mutually exclusive with
|
|
5591
|
+
* `resultImage` — passing both as `true` returns a 400 error.
|
|
5465
5592
|
*/
|
|
5466
5593
|
resultMask?: boolean;
|
|
5467
5594
|
rootParentId?: string;
|
|
@@ -5617,6 +5744,12 @@ export declare namespace AssetUploadResponse {
|
|
|
5617
5744
|
* Number of channels of the audio
|
|
5618
5745
|
*/
|
|
5619
5746
|
channels?: number;
|
|
5747
|
+
/**
|
|
5748
|
+
* Number of Unicode code points in the text. Code-point-aware (so a non-BMP emoji
|
|
5749
|
+
* counts as 1) but not full grapheme-cluster aware (a ZWJ sequence still counts as
|
|
5750
|
+
* several).
|
|
5751
|
+
*/
|
|
5752
|
+
charCount?: number;
|
|
5620
5753
|
/**
|
|
5621
5754
|
* Classification of the audio
|
|
5622
5755
|
*/
|
|
@@ -5653,6 +5786,13 @@ export declare namespace AssetUploadResponse {
|
|
|
5653
5786
|
* Whether the mesh has animations
|
|
5654
5787
|
*/
|
|
5655
5788
|
hasAnimations?: boolean;
|
|
5789
|
+
/**
|
|
5790
|
+
* True when `preview` holds the entire content unmodified — consumers can use it
|
|
5791
|
+
* directly without fetching `asset.url`. False or undefined means the content
|
|
5792
|
+
* exceeds the preview budget and consumers must fetch the full body from S3 to
|
|
5793
|
+
* read past the preview.
|
|
5794
|
+
*/
|
|
5795
|
+
hasFullPreview?: boolean;
|
|
5656
5796
|
/**
|
|
5657
5797
|
* Whether the mesh has normal vectors
|
|
5658
5798
|
*/
|
|
@@ -5670,6 +5810,14 @@ export declare namespace AssetUploadResponse {
|
|
|
5670
5810
|
* Number of frames in the video
|
|
5671
5811
|
*/
|
|
5672
5812
|
nbFrames?: number;
|
|
5813
|
+
/**
|
|
5814
|
+
* Leading slice of the content used for inline UI display and as a search
|
|
5815
|
+
* shortcut. Capped at TEXT_PREVIEW_MAX_BYTES (UTF-8) and always cut on a
|
|
5816
|
+
* code-point boundary so no character is split. Number of characters in the
|
|
5817
|
+
* preview varies by script (around 1024 for ASCII, ~340 for CJK, ~256 for
|
|
5818
|
+
* emoji-heavy text at the default 1 KB budget).
|
|
5819
|
+
*/
|
|
5820
|
+
preview?: string;
|
|
5673
5821
|
/**
|
|
5674
5822
|
* Sample rate of the media in Hz
|
|
5675
5823
|
*/
|
|
@@ -5683,6 +5831,10 @@ export declare namespace AssetUploadResponse {
|
|
|
5683
5831
|
*/
|
|
5684
5832
|
vertexCount?: number;
|
|
5685
5833
|
width?: number;
|
|
5834
|
+
/**
|
|
5835
|
+
* Number of whitespace-separated words in the text
|
|
5836
|
+
*/
|
|
5837
|
+
wordCount?: number;
|
|
5686
5838
|
}
|
|
5687
5839
|
namespace Properties {
|
|
5688
5840
|
/**
|
|
@@ -5987,7 +6139,7 @@ export declare namespace AssetUploadResponse {
|
|
|
5987
6139
|
* not able to create the asset on the flight on API side with dataurl without
|
|
5988
6140
|
* data:kind, prefix
|
|
5989
6141
|
*/
|
|
5990
|
-
kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
6142
|
+
kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
5991
6143
|
/**
|
|
5992
6144
|
* The label displayed in the UI for this input
|
|
5993
6145
|
*/
|
|
@@ -6145,7 +6297,7 @@ export declare namespace AssetUploadResponse {
|
|
|
6145
6297
|
* not able to create the asset on the flight on API side with dataurl without
|
|
6146
6298
|
* data:kind, prefix
|
|
6147
6299
|
*/
|
|
6148
|
-
kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
6300
|
+
kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
|
|
6149
6301
|
/**
|
|
6150
6302
|
* The label displayed in the UI for this input
|
|
6151
6303
|
*/
|
|
@@ -6535,10 +6687,11 @@ export interface AssetListParams extends AssetsCursorParams {
|
|
|
6535
6687
|
* 3d-texture-albedo, 3d-texture-normal, 3d-texture-roughness, 3d-texture-metallic,
|
|
6536
6688
|
* img2video, txt2audio, audio2audio, audio2video, video2audio, voice-clone,
|
|
6537
6689
|
* video2video, video2img, txt2img, img2img, txt2video, uploaded, uploaded-video,
|
|
6538
|
-
* uploaded-audio, uploaded-3d, uploaded-avatar, upscale-video,
|
|
6539
|
-
* starting with "inference-" will
|
|
6690
|
+
* uploaded-audio, uploaded-3d, uploaded-avatar, upscale-video, uploaded-text,
|
|
6691
|
+
* audio2txt, txt2txt, img2txt, assets with a type starting with "inference-" will
|
|
6692
|
+
* be returned
|
|
6540
6693
|
*/
|
|
6541
|
-
type?: 'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-controlnet' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-img2img' | 'inference-controlnet-reference' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-texture' | 'background-removal' | 'canvas' | 'canvas-export' | 'canvas-drawing' | 'detection' | 'patch' | 'pixelization' | 'upscale' | 'upscale-texture' | 'upscale-skybox' | 'vectorization' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-base-360' | 'skybox-hdri' | 'skybox-3d' | 'restyle' | 'reframe' | 'generative-fill' | 'texture' | 'texture-height' | 'texture-normal' | 'texture-smoothness' | 'texture-metallic' | 'texture-edge' | 'texture-ao' | 'texture-albedo' | 'image-prompt-editing' | 'unknown' | 'img23d' | 'txt23d' | 'video23d' | '3d23d' | '3d23d-texture' | '3d-texture' | '3d-texture-mtl' | '3d-texture-albedo' | '3d-texture-normal' | '3d-texture-roughness' | '3d-texture-metallic' | 'img2video' | 'txt2audio' | 'audio2audio' | 'audio2video' | 'video2audio' | 'voice-clone' | 'video2video' | 'video2img' | 'txt2img' | 'img2img' | 'txt2video' | 'uploaded' | 'uploaded-video' | 'uploaded-audio' | 'uploaded-3d' | 'uploaded-avatar' | 'upscale-video';
|
|
6694
|
+
type?: 'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-controlnet' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-img2img' | 'inference-controlnet-reference' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-texture' | 'background-removal' | 'canvas' | 'canvas-export' | 'canvas-drawing' | 'detection' | 'patch' | 'pixelization' | 'upscale' | 'upscale-texture' | 'upscale-skybox' | 'vectorization' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-base-360' | 'skybox-hdri' | 'skybox-3d' | 'restyle' | 'reframe' | 'generative-fill' | 'texture' | 'texture-height' | 'texture-normal' | 'texture-smoothness' | 'texture-metallic' | 'texture-edge' | 'texture-ao' | 'texture-albedo' | 'image-prompt-editing' | 'unknown' | 'img23d' | 'txt23d' | 'video23d' | '3d23d' | '3d23d-texture' | '3d-texture' | '3d-texture-mtl' | '3d-texture-albedo' | '3d-texture-normal' | '3d-texture-roughness' | '3d-texture-metallic' | 'img2video' | 'txt2audio' | 'audio2audio' | 'audio2video' | 'video2audio' | 'voice-clone' | 'video2video' | 'video2img' | 'txt2img' | 'img2img' | 'txt2video' | 'uploaded' | 'uploaded-video' | 'uploaded-audio' | 'uploaded-3d' | 'uploaded-avatar' | 'upscale-video' | 'uploaded-text' | 'audio2txt' | 'txt2txt' | 'img2txt';
|
|
6542
6695
|
/**
|
|
6543
6696
|
* List of the asset types to request. The parameter "type" and "types" cannot be
|
|
6544
6697
|
* used together. Can be any of the following values: inference-txt2img,
|
|
@@ -6558,9 +6711,10 @@ export interface AssetListParams extends AssetsCursorParams {
|
|
|
6558
6711
|
* 3d-texture-albedo, 3d-texture-normal, 3d-texture-roughness, 3d-texture-metallic,
|
|
6559
6712
|
* img2video, txt2audio, audio2audio, audio2video, video2audio, voice-clone,
|
|
6560
6713
|
* video2video, video2img, txt2img, img2img, txt2video, uploaded, uploaded-video,
|
|
6561
|
-
* uploaded-audio, uploaded-3d, uploaded-avatar, upscale-video
|
|
6714
|
+
* uploaded-audio, uploaded-3d, uploaded-avatar, upscale-video, uploaded-text,
|
|
6715
|
+
* audio2txt, txt2txt, img2txt
|
|
6562
6716
|
*/
|
|
6563
|
-
types?: Array<'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-controlnet' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-img2img' | 'inference-controlnet-reference' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-texture' | 'background-removal' | 'canvas' | 'canvas-export' | 'canvas-drawing' | 'detection' | 'patch' | 'pixelization' | 'upscale' | 'upscale-texture' | 'upscale-skybox' | 'vectorization' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-base-360' | 'skybox-hdri' | 'skybox-3d' | 'restyle' | 'reframe' | 'generative-fill' | 'texture' | 'texture-height' | 'texture-normal' | 'texture-smoothness' | 'texture-metallic' | 'texture-edge' | 'texture-ao' | 'texture-albedo' | 'image-prompt-editing' | 'unknown' | 'img23d' | 'txt23d' | 'video23d' | '3d23d' | '3d23d-texture' | '3d-texture' | '3d-texture-mtl' | '3d-texture-albedo' | '3d-texture-normal' | '3d-texture-roughness' | '3d-texture-metallic' | 'img2video' | 'txt2audio' | 'audio2audio' | 'audio2video' | 'video2audio' | 'voice-clone' | 'video2video' | 'video2img' | 'txt2img' | 'img2img' | 'txt2video' | 'uploaded' | 'uploaded-video' | 'uploaded-audio' | 'uploaded-3d' | 'uploaded-avatar' | 'upscale-video'>;
|
|
6717
|
+
types?: Array<'inference-txt2img' | 'inference-txt2img-ip-adapter' | 'inference-txt2img-texture' | 'inference-img2img' | 'inference-img2img-ip-adapter' | 'inference-img2img-texture' | 'inference-inpaint' | 'inference-inpaint-ip-adapter' | 'inference-reference' | 'inference-reference-texture' | 'inference-controlnet' | 'inference-controlnet-ip-adapter' | 'inference-controlnet-img2img' | 'inference-controlnet-reference' | 'inference-controlnet-inpaint' | 'inference-controlnet-inpaint-ip-adapter' | 'inference-controlnet-texture' | 'background-removal' | 'canvas' | 'canvas-export' | 'canvas-drawing' | 'detection' | 'patch' | 'pixelization' | 'upscale' | 'upscale-texture' | 'upscale-skybox' | 'vectorization' | 'segment' | 'segmentation-image' | 'segmentation-mask' | 'skybox-base-360' | 'skybox-hdri' | 'skybox-3d' | 'restyle' | 'reframe' | 'generative-fill' | 'texture' | 'texture-height' | 'texture-normal' | 'texture-smoothness' | 'texture-metallic' | 'texture-edge' | 'texture-ao' | 'texture-albedo' | 'image-prompt-editing' | 'unknown' | 'img23d' | 'txt23d' | 'video23d' | '3d23d' | '3d23d-texture' | '3d-texture' | '3d-texture-mtl' | '3d-texture-albedo' | '3d-texture-normal' | '3d-texture-roughness' | '3d-texture-metallic' | 'img2video' | 'txt2audio' | 'audio2audio' | 'audio2video' | 'video2audio' | 'voice-clone' | 'video2video' | 'video2img' | 'txt2img' | 'img2img' | 'txt2video' | 'uploaded' | 'uploaded-video' | 'uploaded-audio' | 'uploaded-3d' | 'uploaded-avatar' | 'upscale-video' | 'uploaded-text' | 'audio2txt' | 'txt2txt' | 'img2txt'>;
|
|
6564
6718
|
/**
|
|
6565
6719
|
* Filter results to only return assets updated after the specified ISO string date
|
|
6566
6720
|
* (exclusive). Requires the sortBy parameter to be "updatedAt"
|