@scenario-labs/sdk 0.3.0 → 1.0.0
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 +22 -0
- package/README.md +40 -6
- package/client.d.mts +34 -14
- package/client.d.mts.map +1 -1
- package/client.d.ts +34 -14
- package/client.d.ts.map +1 -1
- package/client.js +10 -0
- package/client.js.map +1 -1
- package/client.mjs +10 -0
- package/client.mjs.map +1 -1
- package/core/pagination.d.mts +153 -0
- package/core/pagination.d.mts.map +1 -0
- package/core/pagination.d.ts +153 -0
- package/core/pagination.d.ts.map +1 -0
- package/core/pagination.js +276 -0
- package/core/pagination.js.map +1 -0
- package/core/pagination.mjs +263 -0
- package/core/pagination.mjs.map +1 -0
- package/index.d.mts +2 -0
- package/index.d.mts.map +1 -1
- package/index.d.ts +2 -0
- package/index.d.ts.map +1 -1
- package/index.js +7 -1
- package/index.js.map +1 -1
- package/index.mjs +2 -0
- package/index.mjs.map +1 -1
- package/lib/models.d.mts +34 -2
- package/lib/models.d.mts.map +1 -1
- package/lib/models.d.ts +34 -2
- package/lib/models.d.ts.map +1 -1
- package/lib/models.js +39 -2
- package/lib/models.js.map +1 -1
- package/lib/models.mjs +37 -1
- package/lib/models.mjs.map +1 -1
- package/lib/scenario.d.mts +2 -0
- package/lib/scenario.d.mts.map +1 -1
- package/lib/scenario.d.ts +2 -0
- package/lib/scenario.d.ts.map +1 -1
- package/lib/scenario.js +2 -0
- package/lib/scenario.js.map +1 -1
- package/lib/scenario.mjs +2 -0
- package/lib/scenario.mjs.map +1 -1
- package/lib/upload.d.mts +89 -0
- package/lib/upload.d.mts.map +1 -0
- package/lib/upload.d.ts +89 -0
- package/lib/upload.d.ts.map +1 -0
- package/lib/upload.js +193 -0
- package/lib/upload.js.map +1 -0
- package/lib/upload.mjs +156 -0
- package/lib/upload.mjs.map +1 -0
- package/lib/workflow.d.mts +13 -2
- package/lib/workflow.d.mts.map +1 -1
- package/lib/workflow.d.ts +13 -2
- package/lib/workflow.d.ts.map +1 -1
- package/lib/workflow.js +17 -4
- package/lib/workflow.js.map +1 -1
- package/lib/workflow.mjs +17 -4
- package/lib/workflow.mjs.map +1 -1
- package/lib/workflow_import_validator.d.mts +40 -0
- package/lib/workflow_import_validator.d.mts.map +1 -0
- package/lib/workflow_import_validator.d.ts +40 -0
- package/lib/workflow_import_validator.d.ts.map +1 -0
- package/lib/workflow_import_validator.js +69 -0
- package/lib/workflow_import_validator.js.map +1 -0
- package/lib/workflow_import_validator.mjs +64 -0
- package/lib/workflow_import_validator.mjs.map +1 -0
- package/package.json +11 -1
- package/pagination.d.mts +2 -0
- package/pagination.d.mts.map +1 -0
- package/pagination.d.ts +2 -0
- package/pagination.d.ts.map +1 -0
- package/pagination.js +6 -0
- package/pagination.js.map +1 -0
- package/pagination.mjs +2 -0
- package/pagination.mjs.map +1 -0
- package/resources/assets/assets.d.mts +623 -646
- package/resources/assets/assets.d.mts.map +1 -1
- package/resources/assets/assets.d.ts +623 -646
- package/resources/assets/assets.d.ts.map +1 -1
- package/resources/assets/assets.js +3 -2
- package/resources/assets/assets.js.map +1 -1
- package/resources/assets/assets.mjs +3 -2
- package/resources/assets/assets.mjs.map +1 -1
- package/resources/assets/index.d.mts +1 -1
- package/resources/assets/index.d.mts.map +1 -1
- package/resources/assets/index.d.ts +1 -1
- package/resources/assets/index.d.ts.map +1 -1
- package/resources/assets/index.js.map +1 -1
- package/resources/assets/index.mjs.map +1 -1
- package/resources/collections/collections.d.mts +38 -49
- package/resources/collections/collections.d.mts.map +1 -1
- package/resources/collections/collections.d.ts +38 -49
- package/resources/collections/collections.d.ts.map +1 -1
- package/resources/collections/collections.js +5 -1
- package/resources/collections/collections.js.map +1 -1
- package/resources/collections/collections.mjs +5 -1
- package/resources/collections/collections.mjs.map +1 -1
- package/resources/collections/index.d.mts +1 -1
- package/resources/collections/index.d.mts.map +1 -1
- package/resources/collections/index.d.ts +1 -1
- package/resources/collections/index.d.ts.map +1 -1
- package/resources/collections/index.js.map +1 -1
- package/resources/collections/index.mjs.map +1 -1
- package/resources/index.d.mts +7 -7
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +7 -7
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/jobs.d.mts +369 -380
- package/resources/jobs.d.mts.map +1 -1
- package/resources/jobs.d.ts +369 -380
- package/resources/jobs.d.ts.map +1 -1
- package/resources/jobs.js +2 -1
- package/resources/jobs.js.map +1 -1
- package/resources/jobs.mjs +2 -1
- package/resources/jobs.mjs.map +1 -1
- package/resources/models/index.d.mts +1 -1
- package/resources/models/index.d.mts.map +1 -1
- package/resources/models/index.d.ts +1 -1
- package/resources/models/index.d.ts.map +1 -1
- package/resources/models/index.js.map +1 -1
- package/resources/models/index.mjs.map +1 -1
- package/resources/models/models.d.mts +839 -850
- package/resources/models/models.d.mts.map +1 -1
- package/resources/models/models.d.ts +839 -850
- package/resources/models/models.d.ts.map +1 -1
- package/resources/models/models.js +2 -1
- package/resources/models/models.js.map +1 -1
- package/resources/models/models.mjs +2 -1
- package/resources/models/models.mjs.map +1 -1
- package/resources/search.d.mts +215 -295
- package/resources/search.d.mts.map +1 -1
- package/resources/search.d.ts +215 -295
- package/resources/search.d.ts.map +1 -1
- package/resources/search.js +9 -2
- package/resources/search.js.map +1 -1
- package/resources/search.mjs +9 -2
- package/resources/search.mjs.map +1 -1
- package/resources/tags.d.mts +23 -35
- package/resources/tags.d.mts.map +1 -1
- package/resources/tags.d.ts +23 -35
- package/resources/tags.d.ts.map +1 -1
- package/resources/tags.js +2 -1
- package/resources/tags.js.map +1 -1
- package/resources/tags.mjs +2 -1
- package/resources/tags.mjs.map +1 -1
- package/resources/workflows.d.mts +688 -704
- package/resources/workflows.d.mts.map +1 -1
- package/resources/workflows.d.ts +688 -704
- package/resources/workflows.d.ts.map +1 -1
- package/resources/workflows.js +5 -1
- package/resources/workflows.js.map +1 -1
- package/resources/workflows.mjs +5 -1
- package/resources/workflows.mjs.map +1 -1
- package/src/client.ts +103 -2
- package/src/core/pagination.ts +497 -0
- package/src/index.ts +8 -0
- package/src/lib/models.ts +62 -2
- package/src/lib/scenario.ts +2 -0
- package/src/lib/upload.ts +250 -0
- package/src/lib/workflow.ts +29 -4
- package/src/lib/workflow_import_validator.ts +104 -0
- package/src/pagination.ts +2 -0
- package/src/resources/assets/assets.ts +887 -902
- package/src/resources/assets/index.ts +2 -0
- package/src/resources/collections/collections.ts +45 -54
- package/src/resources/collections/index.ts +1 -0
- package/src/resources/index.ts +9 -1
- package/src/resources/jobs.ts +613 -622
- package/src/resources/models/index.ts +1 -0
- package/src/resources/models/models.ts +1052 -1064
- package/src/resources/search.ts +239 -327
- package/src/resources/tags.ts +32 -39
- package/src/resources/workflows.ts +850 -864
- 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
|
@@ -4,6 +4,7 @@ import { Download, DownloadGetStatusResponse, DownloadRequestBatchParams, Downlo
|
|
|
4
4
|
import * as PublicAPI from "./public.js";
|
|
5
5
|
import { Public, PublicListParams, PublicListResponse, PublicRetrieveResponse } from "./public.js";
|
|
6
6
|
import { APIPromise } from "../../core/api-promise.js";
|
|
7
|
+
import { AssetsCursor, type AssetsCursorParams, PagePromise, SnapshotsCursor, type SnapshotsCursorParams } from "../../core/pagination.js";
|
|
7
8
|
import { RequestOptions } from "../../internal/request-options.js";
|
|
8
9
|
export declare class Assets extends APIResource {
|
|
9
10
|
download: DownloadAPI.Download;
|
|
@@ -23,7 +24,7 @@ export declare class Assets extends APIResource {
|
|
|
23
24
|
* `Authorization` header set to `public-auth-token`) and authenticated user access
|
|
24
25
|
* (including API keys).
|
|
25
26
|
*/
|
|
26
|
-
list(query?: AssetListParams | null | undefined, options?: RequestOptions):
|
|
27
|
+
list(query?: AssetListParams | null | undefined, options?: RequestOptions): PagePromise<AssetListResponsesAssetsCursor, AssetListResponse>;
|
|
27
28
|
/**
|
|
28
29
|
* Delete multiple assets
|
|
29
30
|
*/
|
|
@@ -39,7 +40,7 @@ export declare class Assets extends APIResource {
|
|
|
39
40
|
/**
|
|
40
41
|
* List snapshots of a canvas type asset
|
|
41
42
|
*/
|
|
42
|
-
listSnapshots(assetID: string, query?: AssetListSnapshotsParams | null | undefined, options?: RequestOptions):
|
|
43
|
+
listSnapshots(assetID: string, query?: AssetListSnapshotsParams | null | undefined, options?: RequestOptions): PagePromise<AssetListSnapshotsResponsesSnapshotsCursor, AssetListSnapshotsResponse>;
|
|
43
44
|
/**
|
|
44
45
|
* Lock a canvas
|
|
45
46
|
*/
|
|
@@ -57,6 +58,8 @@ export declare class Assets extends APIResource {
|
|
|
57
58
|
*/
|
|
58
59
|
upload(params: AssetUploadParams, options?: RequestOptions): APIPromise<AssetUploadResponse>;
|
|
59
60
|
}
|
|
61
|
+
export type AssetListResponsesAssetsCursor = AssetsCursor<AssetListResponse>;
|
|
62
|
+
export type AssetListSnapshotsResponsesSnapshotsCursor = SnapshotsCursor<AssetListSnapshotsResponse>;
|
|
60
63
|
export interface AssetRetrieveResponse {
|
|
61
64
|
asset: AssetRetrieveResponse.Asset;
|
|
62
65
|
}
|
|
@@ -1472,715 +1475,706 @@ export declare namespace AssetUpdateResponse {
|
|
|
1472
1475
|
}
|
|
1473
1476
|
}
|
|
1474
1477
|
export interface AssetListResponse {
|
|
1475
|
-
assets: Array<AssetListResponse.Asset>;
|
|
1476
1478
|
/**
|
|
1477
|
-
*
|
|
1479
|
+
* The asset ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")
|
|
1478
1480
|
*/
|
|
1479
|
-
|
|
1481
|
+
id: string;
|
|
1482
|
+
/**
|
|
1483
|
+
* The author user ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")
|
|
1484
|
+
*/
|
|
1485
|
+
authorId: string;
|
|
1486
|
+
/**
|
|
1487
|
+
* A list of CollectionId this asset belongs to
|
|
1488
|
+
*/
|
|
1489
|
+
collectionIds: Array<string>;
|
|
1490
|
+
/**
|
|
1491
|
+
* The asset creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
|
|
1492
|
+
*/
|
|
1493
|
+
createdAt: string;
|
|
1494
|
+
/**
|
|
1495
|
+
* List of edit capabilities
|
|
1496
|
+
*/
|
|
1497
|
+
editCapabilities: Array<'DETECTION' | 'GENERATIVE_FILL' | 'PIXELATE' | 'PROMPT_EDITING' | 'REFINE' | 'REFRAME' | 'REMOVE_BACKGROUND' | 'SEGMENTATION' | 'UPSCALE' | 'UPSCALE_360' | 'VECTORIZATION'>;
|
|
1498
|
+
/**
|
|
1499
|
+
* The kind of asset
|
|
1500
|
+
*/
|
|
1501
|
+
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
1502
|
+
/**
|
|
1503
|
+
* Metadata of the asset with some additional information
|
|
1504
|
+
*/
|
|
1505
|
+
metadata: AssetListResponse.Metadata;
|
|
1506
|
+
/**
|
|
1507
|
+
* The mime type of the asset (example: "image/png")
|
|
1508
|
+
*/
|
|
1509
|
+
mimeType: string;
|
|
1510
|
+
/**
|
|
1511
|
+
* The owner (project) ID (example: "proj_23tlk332lkht3kl2" or
|
|
1512
|
+
* "team_dlkhgs23tlk3hlkth32lkht3kl2" for old teams)
|
|
1513
|
+
*/
|
|
1514
|
+
ownerId: string;
|
|
1515
|
+
/**
|
|
1516
|
+
* The privacy of the asset
|
|
1517
|
+
*/
|
|
1518
|
+
privacy: 'private' | 'public' | 'unlisted';
|
|
1519
|
+
/**
|
|
1520
|
+
* The properties of the asset, content may depend on the kind of asset returned
|
|
1521
|
+
*/
|
|
1522
|
+
properties: AssetListResponse.Properties;
|
|
1523
|
+
/**
|
|
1524
|
+
* source of the asset
|
|
1525
|
+
*/
|
|
1526
|
+
source: '3d23d' | '3d23d:texture' | '3d:texture' | '3d:texture:albedo' | '3d:texture:metallic' | '3d:texture:mtl' | '3d:texture:normal' | '3d:texture:roughness' | 'audio2audio' | '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' | 'video2img' | 'video2video' | 'voice-clone';
|
|
1527
|
+
/**
|
|
1528
|
+
* The actual status
|
|
1529
|
+
*/
|
|
1530
|
+
status: 'error' | 'pending' | 'success';
|
|
1531
|
+
/**
|
|
1532
|
+
* The associated tags (example: ["sci-fi", "landscape"])
|
|
1533
|
+
*/
|
|
1534
|
+
tags: Array<string>;
|
|
1535
|
+
/**
|
|
1536
|
+
* The asset last update date as an ISO string (example:
|
|
1537
|
+
* "2023-02-03T11:19:41.579Z")
|
|
1538
|
+
*/
|
|
1539
|
+
updatedAt: string;
|
|
1540
|
+
/**
|
|
1541
|
+
* Signed URL to get the asset content
|
|
1542
|
+
*/
|
|
1543
|
+
url: string;
|
|
1544
|
+
/**
|
|
1545
|
+
* Automatic captioning of the asset
|
|
1546
|
+
*/
|
|
1547
|
+
automaticCaptioning?: string;
|
|
1548
|
+
/**
|
|
1549
|
+
* The description, it will contain in priority:
|
|
1550
|
+
*
|
|
1551
|
+
* - the manual description
|
|
1552
|
+
* - the advanced captioning when the asset is used in training flow
|
|
1553
|
+
* - the automatic captioning
|
|
1554
|
+
*/
|
|
1555
|
+
description?: string;
|
|
1556
|
+
/**
|
|
1557
|
+
* The embedding of the asset when requested.
|
|
1558
|
+
*
|
|
1559
|
+
* Only available when an asset can be embedded (ie: not Detection maps)
|
|
1560
|
+
*/
|
|
1561
|
+
embedding?: Array<number>;
|
|
1562
|
+
/**
|
|
1563
|
+
* The video asset's first frame.
|
|
1564
|
+
*
|
|
1565
|
+
* Contains the assetId and the url of the first frame.
|
|
1566
|
+
*/
|
|
1567
|
+
firstFrame?: AssetListResponse.FirstFrame;
|
|
1568
|
+
/**
|
|
1569
|
+
* Whether the asset is hidden.
|
|
1570
|
+
*/
|
|
1571
|
+
isHidden?: boolean;
|
|
1572
|
+
/**
|
|
1573
|
+
* The video asset's last frame.
|
|
1574
|
+
*
|
|
1575
|
+
* Contains the assetId and the url of the last frame.
|
|
1576
|
+
*/
|
|
1577
|
+
lastFrame?: AssetListResponse.LastFrame;
|
|
1578
|
+
/**
|
|
1579
|
+
* The NSFW labels
|
|
1580
|
+
*/
|
|
1581
|
+
nsfw?: Array<string>;
|
|
1582
|
+
/**
|
|
1583
|
+
* The original file url.
|
|
1584
|
+
*
|
|
1585
|
+
* Contains the url of the original file. without any conversion. Only available
|
|
1586
|
+
* for some specific video, audio and threeD assets. Is only specified if the given
|
|
1587
|
+
* asset data has been replaced with a new file during the creation of the asset.
|
|
1588
|
+
*/
|
|
1589
|
+
originalFileUrl?: string;
|
|
1590
|
+
/**
|
|
1591
|
+
* The output index of the asset within a job This index is an positive integer
|
|
1592
|
+
* that starts at 0 It is used to differentiate between multiple outputs of the
|
|
1593
|
+
* same job If the job has only one output, this index is 0
|
|
1594
|
+
*/
|
|
1595
|
+
outputIndex?: number;
|
|
1596
|
+
/**
|
|
1597
|
+
* The asset's preview.
|
|
1598
|
+
*
|
|
1599
|
+
* Contains the assetId and the url of the preview.
|
|
1600
|
+
*/
|
|
1601
|
+
preview?: AssetListResponse.Preview;
|
|
1602
|
+
/**
|
|
1603
|
+
* The asset's thumbnail.
|
|
1604
|
+
*
|
|
1605
|
+
* Contains the assetId and the url of the thumbnail.
|
|
1606
|
+
*/
|
|
1607
|
+
thumbnail?: AssetListResponse.Thumbnail;
|
|
1480
1608
|
}
|
|
1481
1609
|
export declare namespace AssetListResponse {
|
|
1482
|
-
|
|
1610
|
+
/**
|
|
1611
|
+
* Metadata of the asset with some additional information
|
|
1612
|
+
*/
|
|
1613
|
+
interface Metadata {
|
|
1614
|
+
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
1483
1615
|
/**
|
|
1484
|
-
* The asset
|
|
1616
|
+
* The type of the asset. Ex: 'inference-txt2img' will represent an asset generated
|
|
1617
|
+
* from a text to image model
|
|
1485
1618
|
*/
|
|
1486
|
-
|
|
1619
|
+
type: '3d-texture' | '3d-texture-albedo' | '3d-texture-metallic' | '3d-texture-mtl' | '3d-texture-normal' | '3d-texture-roughness' | '3d23d' | '3d23d-texture' | 'audio2audio' | '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' | 'video2img' | 'video2video' | 'voice-clone';
|
|
1487
1620
|
/**
|
|
1488
|
-
*
|
|
1621
|
+
* How angular is the surface? 0 is like a sphere, 1 is like a mechanical object
|
|
1489
1622
|
*/
|
|
1490
|
-
|
|
1623
|
+
angular?: number;
|
|
1491
1624
|
/**
|
|
1492
|
-
*
|
|
1625
|
+
* The optional aspect ratio given for the generation, only applicable for some
|
|
1626
|
+
* models
|
|
1493
1627
|
*/
|
|
1494
|
-
|
|
1628
|
+
aspectRatio?: string;
|
|
1495
1629
|
/**
|
|
1496
|
-
*
|
|
1630
|
+
* Int to set between 0 and 255 for the opacity of the background in the result
|
|
1631
|
+
* images.
|
|
1497
1632
|
*/
|
|
1498
|
-
|
|
1633
|
+
backgroundOpacity?: number;
|
|
1499
1634
|
/**
|
|
1500
|
-
*
|
|
1635
|
+
* The baseModelId that maybe changed at inference time
|
|
1501
1636
|
*/
|
|
1502
|
-
|
|
1637
|
+
baseModelId?: string;
|
|
1503
1638
|
/**
|
|
1504
|
-
*
|
|
1639
|
+
* A bounding box around the object of interest, in the format [x1, y1, x2, y2].
|
|
1505
1640
|
*/
|
|
1506
|
-
|
|
1641
|
+
bbox?: Array<number>;
|
|
1507
1642
|
/**
|
|
1508
|
-
*
|
|
1643
|
+
* Remove small dark spots (i.e. “pepper”) and connect small bright cracks.
|
|
1509
1644
|
*/
|
|
1510
|
-
|
|
1645
|
+
betterQuality?: boolean;
|
|
1511
1646
|
/**
|
|
1512
|
-
* The
|
|
1647
|
+
* The control image already processed by canny detector. Must reference an
|
|
1648
|
+
* existing AssetId.
|
|
1513
1649
|
*/
|
|
1514
|
-
|
|
1650
|
+
cannyStructureImage?: string;
|
|
1515
1651
|
/**
|
|
1516
|
-
*
|
|
1517
|
-
* "team_dlkhgs23tlk3hlkth32lkht3kl2" for old teams)
|
|
1652
|
+
* Activate clustering.
|
|
1518
1653
|
*/
|
|
1519
|
-
|
|
1654
|
+
clustering?: boolean;
|
|
1520
1655
|
/**
|
|
1521
|
-
*
|
|
1656
|
+
* Ensure upscaled tile have the same color histogram as original tile.
|
|
1522
1657
|
*/
|
|
1523
|
-
|
|
1658
|
+
colorCorrection?: boolean;
|
|
1659
|
+
colorMode?: string;
|
|
1660
|
+
colorPrecision?: number;
|
|
1524
1661
|
/**
|
|
1525
|
-
*
|
|
1662
|
+
* Flux Kontext LoRA to style the image. For Flux Kontext Prompt Editing.
|
|
1526
1663
|
*/
|
|
1527
|
-
|
|
1664
|
+
concepts?: Array<Metadata.Concept>;
|
|
1665
|
+
contours?: Array<Array<Array<Array<number>>>>;
|
|
1528
1666
|
/**
|
|
1529
|
-
*
|
|
1667
|
+
* End step for control.
|
|
1530
1668
|
*/
|
|
1531
|
-
|
|
1669
|
+
controlEnd?: number;
|
|
1532
1670
|
/**
|
|
1533
|
-
* The
|
|
1671
|
+
* The date when the asset was copied to a project
|
|
1534
1672
|
*/
|
|
1535
|
-
|
|
1673
|
+
copiedAt?: string;
|
|
1674
|
+
cornerThreshold?: number;
|
|
1536
1675
|
/**
|
|
1537
|
-
*
|
|
1676
|
+
* Allow the generation of "hallucinations" during the upscale process, which adds
|
|
1677
|
+
* additional details and deviates from the original image. Default: optimized for
|
|
1678
|
+
* your preset and style.
|
|
1538
1679
|
*/
|
|
1539
|
-
|
|
1680
|
+
creativity?: number;
|
|
1540
1681
|
/**
|
|
1541
|
-
*
|
|
1542
|
-
*
|
|
1682
|
+
* Amount of decay in creativity over the upscale process. The lowest the value,
|
|
1683
|
+
* the less the creativity will be preserved over the upscale process.
|
|
1543
1684
|
*/
|
|
1544
|
-
|
|
1685
|
+
creativityDecay?: number;
|
|
1545
1686
|
/**
|
|
1546
|
-
*
|
|
1687
|
+
* If true, use the default parameters
|
|
1547
1688
|
*/
|
|
1548
|
-
|
|
1689
|
+
defaultParameters?: boolean;
|
|
1549
1690
|
/**
|
|
1550
|
-
*
|
|
1691
|
+
* The depth fidelity if a depth image provided
|
|
1551
1692
|
*/
|
|
1552
|
-
|
|
1693
|
+
depthFidelity?: number;
|
|
1553
1694
|
/**
|
|
1554
|
-
* The
|
|
1555
|
-
*
|
|
1556
|
-
* - the manual description
|
|
1557
|
-
* - the advanced captioning when the asset is used in training flow
|
|
1558
|
-
* - the automatic captioning
|
|
1695
|
+
* The control image processed by depth estimator. Must reference an existing
|
|
1696
|
+
* AssetId.
|
|
1559
1697
|
*/
|
|
1560
|
-
|
|
1698
|
+
depthImage?: string;
|
|
1561
1699
|
/**
|
|
1562
|
-
*
|
|
1700
|
+
* Amount of details to remove or add
|
|
1701
|
+
*/
|
|
1702
|
+
detailsLevel?: number;
|
|
1703
|
+
/**
|
|
1704
|
+
* The number of pixels to dilate the result masks.
|
|
1705
|
+
*/
|
|
1706
|
+
dilate?: number;
|
|
1707
|
+
/**
|
|
1708
|
+
* Contrast factor for Grayscale detector
|
|
1709
|
+
*/
|
|
1710
|
+
factor?: number;
|
|
1711
|
+
filterSpeckle?: number;
|
|
1712
|
+
/**
|
|
1713
|
+
* Determine the scale at which the upscale process works.
|
|
1563
1714
|
*
|
|
1564
|
-
*
|
|
1715
|
+
* - With a small value, the upscale works at the largest scale, resulting in fewer
|
|
1716
|
+
* added details and more coherent images. Ideal for portraits, for example.
|
|
1717
|
+
* - With a large value, the upscale works at the smallest scale, resulting in more
|
|
1718
|
+
* added details and more hallucinations. Ideal for landscapes, for example.
|
|
1719
|
+
*
|
|
1720
|
+
* (info): A small value is slower and more expensive to run.
|
|
1565
1721
|
*/
|
|
1566
|
-
|
|
1722
|
+
fractality?: number;
|
|
1567
1723
|
/**
|
|
1568
|
-
* The
|
|
1724
|
+
* Apply extra control to the Skybox 360 geometry. The higher the value, the more
|
|
1725
|
+
* the 360 geometry will influence the generated skybox image.
|
|
1569
1726
|
*
|
|
1570
|
-
*
|
|
1727
|
+
* Use with caution. Default is adapted to the other parameters.
|
|
1571
1728
|
*/
|
|
1572
|
-
|
|
1729
|
+
geometryEnforcement?: number;
|
|
1573
1730
|
/**
|
|
1574
|
-
*
|
|
1731
|
+
* The guidance used to generate this asset
|
|
1575
1732
|
*/
|
|
1576
|
-
|
|
1733
|
+
guidance?: number;
|
|
1734
|
+
halfMode?: boolean;
|
|
1735
|
+
hdr?: number;
|
|
1736
|
+
height?: number;
|
|
1577
1737
|
/**
|
|
1578
|
-
*
|
|
1579
|
-
*
|
|
1580
|
-
* Contains the assetId and the url of the last frame.
|
|
1738
|
+
* High threshold for Canny detector
|
|
1581
1739
|
*/
|
|
1582
|
-
|
|
1740
|
+
highThreshold?: number;
|
|
1583
1741
|
/**
|
|
1584
|
-
*
|
|
1742
|
+
* (deprecated) Horizontal expansion ratio.
|
|
1585
1743
|
*/
|
|
1586
|
-
|
|
1744
|
+
horizontalExpansionRatio?: number;
|
|
1587
1745
|
/**
|
|
1588
|
-
* The
|
|
1746
|
+
* The input image to process. Must reference an existing AssetId or be a data URL.
|
|
1747
|
+
*/
|
|
1748
|
+
image?: string;
|
|
1749
|
+
/**
|
|
1750
|
+
* Strengthen the similarity to the original image during the upscale. Default:
|
|
1751
|
+
* optimized for your preset and style.
|
|
1752
|
+
*/
|
|
1753
|
+
imageFidelity?: number;
|
|
1754
|
+
/**
|
|
1755
|
+
* Preserve the seamless properties of skybox or texture images. Input has to be of
|
|
1756
|
+
* same type (seamless).
|
|
1757
|
+
*/
|
|
1758
|
+
imageType?: 'seamfull' | 'skybox' | 'texture';
|
|
1759
|
+
/**
|
|
1760
|
+
* The id of the Inference describing how this image was generated
|
|
1761
|
+
*/
|
|
1762
|
+
inferenceId?: string;
|
|
1763
|
+
/**
|
|
1764
|
+
* When set to `high`, allows to better preserve details from the input images in
|
|
1765
|
+
* the output. This is especially useful when using images that contain elements
|
|
1766
|
+
* like faces or logos that require accurate preservation in the generated image.
|
|
1589
1767
|
*
|
|
1590
|
-
*
|
|
1591
|
-
*
|
|
1592
|
-
*
|
|
1768
|
+
* You can provide multiple input images that will all be preserved with high
|
|
1769
|
+
* fidelity, but keep in mind that the first image will be preserved with richer
|
|
1770
|
+
* textures and finer details, so if you include elements such as faces, consider
|
|
1771
|
+
* placing them in the first image.
|
|
1772
|
+
*
|
|
1773
|
+
* Only available for the `gpt-image-1` model.
|
|
1593
1774
|
*/
|
|
1594
|
-
|
|
1775
|
+
inputFidelity?: 'high' | 'low';
|
|
1595
1776
|
/**
|
|
1596
|
-
*
|
|
1597
|
-
|
|
1598
|
-
|
|
1777
|
+
* Location of the input image in the output.
|
|
1778
|
+
*/
|
|
1779
|
+
inputLocation?: 'bottom' | 'left' | 'middle' | 'right' | 'top';
|
|
1780
|
+
/**
|
|
1781
|
+
* To invert the relief
|
|
1782
|
+
*/
|
|
1783
|
+
invert?: boolean;
|
|
1784
|
+
/**
|
|
1785
|
+
* How polished is the surface? 0 is like a rough surface, 1 is like a mirror
|
|
1786
|
+
*/
|
|
1787
|
+
keypointThreshold?: number;
|
|
1788
|
+
layerDifference?: number;
|
|
1789
|
+
lengthThreshold?: number;
|
|
1790
|
+
/**
|
|
1791
|
+
* The ISO timestamp when the lock on the canvas will expire
|
|
1792
|
+
*/
|
|
1793
|
+
lockExpiresAt?: string;
|
|
1794
|
+
/**
|
|
1795
|
+
* Low threshold for Canny detector
|
|
1796
|
+
*/
|
|
1797
|
+
lowThreshold?: number;
|
|
1798
|
+
/**
|
|
1799
|
+
* The mask used for the asset generation or editing
|
|
1800
|
+
*/
|
|
1801
|
+
mask?: string;
|
|
1802
|
+
maxIterations?: number;
|
|
1803
|
+
/**
|
|
1804
|
+
* Maximum threshold for Grayscale conversion
|
|
1805
|
+
*/
|
|
1806
|
+
maxThreshold?: number;
|
|
1807
|
+
/**
|
|
1808
|
+
* Minimum threshold for Grayscale conversion
|
|
1809
|
+
*/
|
|
1810
|
+
minThreshold?: number;
|
|
1811
|
+
/**
|
|
1812
|
+
* Modality to detect
|
|
1599
1813
|
*/
|
|
1814
|
+
modality?: 'canny' | 'depth' | 'grayscale' | 'lineart_anime' | 'mlsd' | 'normal' | 'pose' | 'scribble' | 'segmentation' | 'sketch';
|
|
1815
|
+
mode?: string;
|
|
1816
|
+
/**
|
|
1817
|
+
* The modelId used to generate this asset
|
|
1818
|
+
*/
|
|
1819
|
+
modelId?: string;
|
|
1820
|
+
/**
|
|
1821
|
+
* The type of the generator used
|
|
1822
|
+
*/
|
|
1823
|
+
modelType?: 'custom' | 'elevenlabs-voice' | 'flux.1' | 'flux.1-composition' | 'flux.1-kontext-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-dev' | 'flux.1-krea-lora' | 'flux.1-lora' | 'flux.1-pro' | 'flux.1.1-pro-ultra' | 'flux.2-dev-edit-lora' | 'flux.2-dev-lora' | 'flux.2-klein-4b-edit-lora' | 'flux.2-klein-4b-lora' | 'flux.2-klein-9b-edit-lora' | 'flux.2-klein-9b-lora' | 'flux.2-klein-base-4b-edit-lora' | 'flux.2-klein-base-4b-lora' | 'flux.2-klein-base-9b-edit-lora' | 'flux.2-klein-base-9b-lora' | 'flux1.1-pro' | 'gpt-image-1' | 'qwen-image-2512-lora' | 'qwen-image-edit-2509-lora' | 'qwen-image-edit-2511-lora' | 'qwen-image-edit-lora' | 'qwen-image-lora' | 'sd-1_5' | 'sd-1_5-composition' | 'sd-1_5-lora' | 'sd-xl' | 'sd-xl-composition' | 'sd-xl-lora' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora';
|
|
1824
|
+
name?: string;
|
|
1825
|
+
nbMasks?: number;
|
|
1826
|
+
/**
|
|
1827
|
+
* The negative prompt used to generate this asset
|
|
1828
|
+
*/
|
|
1829
|
+
negativePrompt?: string;
|
|
1830
|
+
/**
|
|
1831
|
+
* Controls the influence of the negative prompt. Default 0 means the negative
|
|
1832
|
+
* prompt has no effect. Higher values increase negative prompt influence. Must
|
|
1833
|
+
* be > 0 if negativePrompt is provided.
|
|
1834
|
+
*/
|
|
1835
|
+
negativePromptStrength?: number;
|
|
1836
|
+
/**
|
|
1837
|
+
* The number of denoising steps for each image generation.
|
|
1838
|
+
*/
|
|
1839
|
+
numInferenceSteps?: number;
|
|
1840
|
+
/**
|
|
1841
|
+
* The number of outputs to generate.
|
|
1842
|
+
*/
|
|
1843
|
+
numOutputs?: number;
|
|
1844
|
+
originalAssetId?: string;
|
|
1600
1845
|
outputIndex?: number;
|
|
1601
1846
|
/**
|
|
1602
|
-
*
|
|
1603
|
-
*
|
|
1604
|
-
* Contains the assetId and the url of the preview.
|
|
1847
|
+
* Overlap percentage for the output image.
|
|
1605
1848
|
*/
|
|
1606
|
-
|
|
1849
|
+
overlapPercentage?: number;
|
|
1607
1850
|
/**
|
|
1608
|
-
*
|
|
1851
|
+
* Override the embeddings of the model. Only your prompt and negativePrompt will
|
|
1852
|
+
* be used. Use with caution.
|
|
1853
|
+
*/
|
|
1854
|
+
overrideEmbeddings?: boolean;
|
|
1855
|
+
parentId?: string;
|
|
1856
|
+
parentJobId?: string;
|
|
1857
|
+
pathPrecision?: number;
|
|
1858
|
+
/**
|
|
1859
|
+
* List of points (label, x, y) in the image where label = 0 for background and 1
|
|
1860
|
+
* for object.
|
|
1861
|
+
*/
|
|
1862
|
+
points?: Array<Array<number>>;
|
|
1863
|
+
/**
|
|
1864
|
+
* How polished is the surface? 0 is like a rough surface, 1 is like a mirror
|
|
1865
|
+
*/
|
|
1866
|
+
polished?: number;
|
|
1867
|
+
preset?: string;
|
|
1868
|
+
progressPercent?: number;
|
|
1869
|
+
/**
|
|
1870
|
+
* The prompt that guided the asset generation or editing
|
|
1871
|
+
*/
|
|
1872
|
+
prompt?: string;
|
|
1873
|
+
/**
|
|
1874
|
+
* Increase the fidelity to the prompt during upscale. Default: optimized for your
|
|
1875
|
+
* preset and style.
|
|
1876
|
+
*/
|
|
1877
|
+
promptFidelity?: number;
|
|
1878
|
+
/**
|
|
1879
|
+
* How raised is the surface? 0 is flat like water, 1 is like a very rough rock
|
|
1880
|
+
*/
|
|
1881
|
+
raised?: number;
|
|
1882
|
+
/**
|
|
1883
|
+
* The reference images used for the asset generation or editing
|
|
1884
|
+
*/
|
|
1885
|
+
referenceImages?: Array<string>;
|
|
1886
|
+
/**
|
|
1887
|
+
* Additional refinement steps before scaling.
|
|
1609
1888
|
*
|
|
1610
|
-
*
|
|
1889
|
+
* If scalingFactor == 1, the refinement process will be applied (1 +
|
|
1890
|
+
* refinementSteps) times. If scalingFactor > 1, the refinement process will be
|
|
1891
|
+
* applied refinementSteps times.
|
|
1611
1892
|
*/
|
|
1612
|
-
|
|
1613
|
-
}
|
|
1614
|
-
namespace Asset {
|
|
1893
|
+
refinementSteps?: number;
|
|
1615
1894
|
/**
|
|
1616
|
-
*
|
|
1895
|
+
* Remove background for Grayscale detector
|
|
1617
1896
|
*/
|
|
1618
|
-
|
|
1619
|
-
|
|
1620
|
-
|
|
1621
|
-
|
|
1622
|
-
|
|
1623
|
-
|
|
1624
|
-
|
|
1625
|
-
|
|
1626
|
-
|
|
1627
|
-
|
|
1628
|
-
|
|
1629
|
-
|
|
1630
|
-
|
|
1631
|
-
|
|
1632
|
-
|
|
1633
|
-
|
|
1634
|
-
|
|
1635
|
-
|
|
1636
|
-
|
|
1637
|
-
|
|
1638
|
-
|
|
1639
|
-
|
|
1640
|
-
|
|
1641
|
-
|
|
1642
|
-
|
|
1643
|
-
|
|
1644
|
-
|
|
1645
|
-
|
|
1646
|
-
|
|
1647
|
-
|
|
1648
|
-
|
|
1649
|
-
|
|
1650
|
-
|
|
1651
|
-
|
|
1652
|
-
|
|
1653
|
-
|
|
1654
|
-
|
|
1655
|
-
|
|
1656
|
-
|
|
1657
|
-
|
|
1658
|
-
|
|
1659
|
-
|
|
1660
|
-
|
|
1661
|
-
|
|
1662
|
-
|
|
1663
|
-
|
|
1664
|
-
|
|
1665
|
-
|
|
1666
|
-
|
|
1667
|
-
|
|
1668
|
-
|
|
1669
|
-
|
|
1670
|
-
|
|
1671
|
-
|
|
1672
|
-
|
|
1673
|
-
|
|
1674
|
-
|
|
1675
|
-
|
|
1676
|
-
|
|
1677
|
-
|
|
1678
|
-
|
|
1679
|
-
|
|
1680
|
-
|
|
1681
|
-
|
|
1682
|
-
|
|
1683
|
-
|
|
1684
|
-
|
|
1685
|
-
|
|
1686
|
-
|
|
1687
|
-
|
|
1688
|
-
|
|
1689
|
-
|
|
1690
|
-
|
|
1691
|
-
|
|
1692
|
-
|
|
1693
|
-
|
|
1694
|
-
|
|
1695
|
-
|
|
1696
|
-
|
|
1697
|
-
|
|
1698
|
-
|
|
1699
|
-
|
|
1700
|
-
|
|
1701
|
-
|
|
1702
|
-
|
|
1703
|
-
|
|
1704
|
-
|
|
1705
|
-
|
|
1706
|
-
|
|
1707
|
-
|
|
1708
|
-
|
|
1709
|
-
|
|
1710
|
-
|
|
1711
|
-
|
|
1712
|
-
|
|
1713
|
-
|
|
1714
|
-
|
|
1715
|
-
|
|
1716
|
-
|
|
1717
|
-
|
|
1718
|
-
|
|
1719
|
-
|
|
1720
|
-
|
|
1721
|
-
|
|
1722
|
-
|
|
1723
|
-
|
|
1724
|
-
|
|
1725
|
-
|
|
1726
|
-
|
|
1727
|
-
|
|
1728
|
-
|
|
1729
|
-
|
|
1730
|
-
|
|
1731
|
-
|
|
1732
|
-
|
|
1733
|
-
|
|
1734
|
-
|
|
1735
|
-
|
|
1736
|
-
|
|
1737
|
-
*/
|
|
1738
|
-
guidance?: number;
|
|
1739
|
-
halfMode?: boolean;
|
|
1740
|
-
hdr?: number;
|
|
1741
|
-
height?: number;
|
|
1742
|
-
/**
|
|
1743
|
-
* High threshold for Canny detector
|
|
1744
|
-
*/
|
|
1745
|
-
highThreshold?: number;
|
|
1746
|
-
/**
|
|
1747
|
-
* (deprecated) Horizontal expansion ratio.
|
|
1748
|
-
*/
|
|
1749
|
-
horizontalExpansionRatio?: number;
|
|
1750
|
-
/**
|
|
1751
|
-
* The input image to process. Must reference an existing AssetId or be a data URL.
|
|
1752
|
-
*/
|
|
1753
|
-
image?: string;
|
|
1754
|
-
/**
|
|
1755
|
-
* Strengthen the similarity to the original image during the upscale. Default:
|
|
1756
|
-
* optimized for your preset and style.
|
|
1757
|
-
*/
|
|
1758
|
-
imageFidelity?: number;
|
|
1759
|
-
/**
|
|
1760
|
-
* Preserve the seamless properties of skybox or texture images. Input has to be of
|
|
1761
|
-
* same type (seamless).
|
|
1762
|
-
*/
|
|
1763
|
-
imageType?: 'seamfull' | 'skybox' | 'texture';
|
|
1764
|
-
/**
|
|
1765
|
-
* The id of the Inference describing how this image was generated
|
|
1766
|
-
*/
|
|
1767
|
-
inferenceId?: string;
|
|
1768
|
-
/**
|
|
1769
|
-
* When set to `high`, allows to better preserve details from the input images in
|
|
1770
|
-
* the output. This is especially useful when using images that contain elements
|
|
1771
|
-
* like faces or logos that require accurate preservation in the generated image.
|
|
1772
|
-
*
|
|
1773
|
-
* You can provide multiple input images that will all be preserved with high
|
|
1774
|
-
* fidelity, but keep in mind that the first image will be preserved with richer
|
|
1775
|
-
* textures and finer details, so if you include elements such as faces, consider
|
|
1776
|
-
* placing them in the first image.
|
|
1777
|
-
*
|
|
1778
|
-
* Only available for the `gpt-image-1` model.
|
|
1779
|
-
*/
|
|
1780
|
-
inputFidelity?: 'high' | 'low';
|
|
1781
|
-
/**
|
|
1782
|
-
* Location of the input image in the output.
|
|
1783
|
-
*/
|
|
1784
|
-
inputLocation?: 'bottom' | 'left' | 'middle' | 'right' | 'top';
|
|
1785
|
-
/**
|
|
1786
|
-
* To invert the relief
|
|
1787
|
-
*/
|
|
1788
|
-
invert?: boolean;
|
|
1789
|
-
/**
|
|
1790
|
-
* How polished is the surface? 0 is like a rough surface, 1 is like a mirror
|
|
1791
|
-
*/
|
|
1792
|
-
keypointThreshold?: number;
|
|
1793
|
-
layerDifference?: number;
|
|
1794
|
-
lengthThreshold?: number;
|
|
1795
|
-
/**
|
|
1796
|
-
* The ISO timestamp when the lock on the canvas will expire
|
|
1797
|
-
*/
|
|
1798
|
-
lockExpiresAt?: string;
|
|
1799
|
-
/**
|
|
1800
|
-
* Low threshold for Canny detector
|
|
1801
|
-
*/
|
|
1802
|
-
lowThreshold?: number;
|
|
1803
|
-
/**
|
|
1804
|
-
* The mask used for the asset generation or editing
|
|
1805
|
-
*/
|
|
1806
|
-
mask?: string;
|
|
1807
|
-
maxIterations?: number;
|
|
1808
|
-
/**
|
|
1809
|
-
* Maximum threshold for Grayscale conversion
|
|
1810
|
-
*/
|
|
1811
|
-
maxThreshold?: number;
|
|
1812
|
-
/**
|
|
1813
|
-
* Minimum threshold for Grayscale conversion
|
|
1814
|
-
*/
|
|
1815
|
-
minThreshold?: number;
|
|
1816
|
-
/**
|
|
1817
|
-
* Modality to detect
|
|
1818
|
-
*/
|
|
1819
|
-
modality?: 'canny' | 'depth' | 'grayscale' | 'lineart_anime' | 'mlsd' | 'normal' | 'pose' | 'scribble' | 'segmentation' | 'sketch';
|
|
1820
|
-
mode?: string;
|
|
1821
|
-
/**
|
|
1822
|
-
* The modelId used to generate this asset
|
|
1823
|
-
*/
|
|
1824
|
-
modelId?: string;
|
|
1825
|
-
/**
|
|
1826
|
-
* The type of the generator used
|
|
1827
|
-
*/
|
|
1828
|
-
modelType?: 'custom' | 'elevenlabs-voice' | 'flux.1' | 'flux.1-composition' | 'flux.1-kontext-dev' | 'flux.1-kontext-lora' | 'flux.1-krea-dev' | 'flux.1-krea-lora' | 'flux.1-lora' | 'flux.1-pro' | 'flux.1.1-pro-ultra' | 'flux.2-dev-edit-lora' | 'flux.2-dev-lora' | 'flux.2-klein-4b-edit-lora' | 'flux.2-klein-4b-lora' | 'flux.2-klein-9b-edit-lora' | 'flux.2-klein-9b-lora' | 'flux.2-klein-base-4b-edit-lora' | 'flux.2-klein-base-4b-lora' | 'flux.2-klein-base-9b-edit-lora' | 'flux.2-klein-base-9b-lora' | 'flux1.1-pro' | 'gpt-image-1' | 'qwen-image-2512-lora' | 'qwen-image-edit-2509-lora' | 'qwen-image-edit-2511-lora' | 'qwen-image-edit-lora' | 'qwen-image-lora' | 'sd-1_5' | 'sd-1_5-composition' | 'sd-1_5-lora' | 'sd-xl' | 'sd-xl-composition' | 'sd-xl-lora' | 'zimage-de-turbo-lora' | 'zimage-lora' | 'zimage-turbo-lora';
|
|
1829
|
-
name?: string;
|
|
1830
|
-
nbMasks?: number;
|
|
1831
|
-
/**
|
|
1832
|
-
* The negative prompt used to generate this asset
|
|
1833
|
-
*/
|
|
1834
|
-
negativePrompt?: string;
|
|
1835
|
-
/**
|
|
1836
|
-
* Controls the influence of the negative prompt. Default 0 means the negative
|
|
1837
|
-
* prompt has no effect. Higher values increase negative prompt influence. Must
|
|
1838
|
-
* be > 0 if negativePrompt is provided.
|
|
1839
|
-
*/
|
|
1840
|
-
negativePromptStrength?: number;
|
|
1841
|
-
/**
|
|
1842
|
-
* The number of denoising steps for each image generation.
|
|
1843
|
-
*/
|
|
1844
|
-
numInferenceSteps?: number;
|
|
1845
|
-
/**
|
|
1846
|
-
* The number of outputs to generate.
|
|
1847
|
-
*/
|
|
1848
|
-
numOutputs?: number;
|
|
1849
|
-
originalAssetId?: string;
|
|
1850
|
-
outputIndex?: number;
|
|
1851
|
-
/**
|
|
1852
|
-
* Overlap percentage for the output image.
|
|
1853
|
-
*/
|
|
1854
|
-
overlapPercentage?: number;
|
|
1855
|
-
/**
|
|
1856
|
-
* Override the embeddings of the model. Only your prompt and negativePrompt will
|
|
1857
|
-
* be used. Use with caution.
|
|
1858
|
-
*/
|
|
1859
|
-
overrideEmbeddings?: boolean;
|
|
1860
|
-
parentId?: string;
|
|
1861
|
-
parentJobId?: string;
|
|
1862
|
-
pathPrecision?: number;
|
|
1863
|
-
/**
|
|
1864
|
-
* List of points (label, x, y) in the image where label = 0 for background and 1
|
|
1865
|
-
* for object.
|
|
1866
|
-
*/
|
|
1867
|
-
points?: Array<Array<number>>;
|
|
1868
|
-
/**
|
|
1869
|
-
* How polished is the surface? 0 is like a rough surface, 1 is like a mirror
|
|
1870
|
-
*/
|
|
1871
|
-
polished?: number;
|
|
1872
|
-
preset?: string;
|
|
1873
|
-
progressPercent?: number;
|
|
1874
|
-
/**
|
|
1875
|
-
* The prompt that guided the asset generation or editing
|
|
1876
|
-
*/
|
|
1877
|
-
prompt?: string;
|
|
1878
|
-
/**
|
|
1879
|
-
* Increase the fidelity to the prompt during upscale. Default: optimized for your
|
|
1880
|
-
* preset and style.
|
|
1881
|
-
*/
|
|
1882
|
-
promptFidelity?: number;
|
|
1883
|
-
/**
|
|
1884
|
-
* How raised is the surface? 0 is flat like water, 1 is like a very rough rock
|
|
1885
|
-
*/
|
|
1886
|
-
raised?: number;
|
|
1887
|
-
/**
|
|
1888
|
-
* The reference images used for the asset generation or editing
|
|
1889
|
-
*/
|
|
1890
|
-
referenceImages?: Array<string>;
|
|
1891
|
-
/**
|
|
1892
|
-
* Additional refinement steps before scaling.
|
|
1893
|
-
*
|
|
1894
|
-
* If scalingFactor == 1, the refinement process will be applied (1 +
|
|
1895
|
-
* refinementSteps) times. If scalingFactor > 1, the refinement process will be
|
|
1896
|
-
* applied refinementSteps times.
|
|
1897
|
-
*/
|
|
1898
|
-
refinementSteps?: number;
|
|
1899
|
-
/**
|
|
1900
|
-
* Remove background for Grayscale detector
|
|
1901
|
-
*/
|
|
1902
|
-
removeBackground?: boolean;
|
|
1903
|
-
/**
|
|
1904
|
-
* Size proportion of the input image in the output.
|
|
1905
|
-
*/
|
|
1906
|
-
resizeOption?: number;
|
|
1907
|
-
/**
|
|
1908
|
-
* Boolean to output the contours.
|
|
1909
|
-
*/
|
|
1910
|
-
resultContours?: boolean;
|
|
1911
|
-
/**
|
|
1912
|
-
* Boolean to able output the cut out object.
|
|
1913
|
-
*/
|
|
1914
|
-
resultImage?: boolean;
|
|
1915
|
-
/**
|
|
1916
|
-
* Boolean to able return the masks (binary image) in the response.
|
|
1917
|
-
*/
|
|
1918
|
-
resultMask?: boolean;
|
|
1919
|
-
rootParentId?: string;
|
|
1920
|
-
/**
|
|
1921
|
-
* Save a flipbook of the texture. Deactivated when the input texture is larger
|
|
1922
|
-
* than 2048x2048px
|
|
1923
|
-
*/
|
|
1924
|
-
saveFlipbook?: boolean;
|
|
1925
|
-
/**
|
|
1926
|
-
* Scaling factor (when `targetWidth` not specified)
|
|
1927
|
-
*/
|
|
1928
|
-
scalingFactor?: number;
|
|
1929
|
-
/**
|
|
1930
|
-
* The scheduler used to generate this asset
|
|
1931
|
-
*/
|
|
1932
|
-
scheduler?: string;
|
|
1933
|
-
/**
|
|
1934
|
-
* The seed used to generate this asset. <!> Can be a string or a number in some
|
|
1935
|
-
* cases <!>.
|
|
1936
|
-
*/
|
|
1937
|
-
seed?: string;
|
|
1938
|
-
/**
|
|
1939
|
-
* Sharpen tiles.
|
|
1940
|
-
*/
|
|
1941
|
-
sharpen?: boolean;
|
|
1942
|
-
/**
|
|
1943
|
-
* How shiny is the surface? 0 is like a matte surface, 1 is like a diamond
|
|
1944
|
-
*/
|
|
1945
|
-
shiny?: number;
|
|
1946
|
-
size?: number;
|
|
1947
|
-
/**
|
|
1948
|
-
* Activate sketch detection instead of canny.
|
|
1949
|
-
*/
|
|
1950
|
-
sketch?: boolean;
|
|
1951
|
-
sourceProjectId?: string;
|
|
1952
|
-
spliceThreshold?: number;
|
|
1953
|
-
/**
|
|
1954
|
-
* The strength
|
|
1955
|
-
*
|
|
1956
|
-
* Only available for the `flux-kontext` LoRA model.
|
|
1957
|
-
*/
|
|
1958
|
-
strength?: number;
|
|
1959
|
-
/**
|
|
1960
|
-
* Strength for the input image structure preservation
|
|
1961
|
-
*/
|
|
1962
|
-
structureFidelity?: number;
|
|
1963
|
-
/**
|
|
1964
|
-
* The control image for structure. A canny detector will be applied to this image.
|
|
1965
|
-
* Must reference an existing AssetId.
|
|
1966
|
-
*/
|
|
1967
|
-
structureImage?: string;
|
|
1968
|
-
style?: '3d-cartoon' | '3d-rendered' | 'anime' | 'cartoon' | 'cinematic' | 'claymation' | 'cloud-skydome' | 'comic' | 'cyberpunk' | 'enchanted' | 'fantasy' | 'ink' | 'manga' | 'manga-color' | 'minimalist' | 'neon-tron' | 'oil-painting' | 'pastel' | 'photo' | 'photography' | 'psychedelic' | 'retro-fantasy' | 'scifi-concept-art' | 'space' | 'standard' | 'whimsical';
|
|
1969
|
-
/**
|
|
1970
|
-
* The higher the value the more it will look like the style image(s)
|
|
1971
|
-
*/
|
|
1972
|
-
styleFidelity?: number;
|
|
1973
|
-
/**
|
|
1974
|
-
* List of style images. Most of the time, only one image is enough. It must be
|
|
1975
|
-
* existing AssetIds.
|
|
1976
|
-
*/
|
|
1977
|
-
styleImages?: Array<string>;
|
|
1978
|
-
/**
|
|
1979
|
-
* Condition the influence of the style image(s). The higher the value, the more
|
|
1980
|
-
* the style images will influence the upscaled image.
|
|
1981
|
-
*/
|
|
1982
|
-
styleImagesFidelity?: number;
|
|
1983
|
-
/**
|
|
1984
|
-
* The target height of the output image.
|
|
1985
|
-
*/
|
|
1986
|
-
targetHeight?: number;
|
|
1987
|
-
/**
|
|
1988
|
-
* Target width for the upscaled image, take priority over scaling factor
|
|
1989
|
-
*/
|
|
1990
|
-
targetWidth?: number;
|
|
1991
|
-
/**
|
|
1992
|
-
* A textual description / keywords describing the object of interest.
|
|
1993
|
-
*/
|
|
1994
|
-
text?: string;
|
|
1995
|
-
/**
|
|
1996
|
-
* The asset to convert in texture maps. Must reference an existing AssetId.
|
|
1997
|
-
*/
|
|
1998
|
-
texture?: string;
|
|
1999
|
-
/**
|
|
2000
|
-
* The thumbnail of the canvas
|
|
2001
|
-
*/
|
|
2002
|
-
thumbnail?: Metadata.Thumbnail;
|
|
2003
|
-
/**
|
|
2004
|
-
* If set to true, during the upscaling process, the model will match tiles of the
|
|
2005
|
-
* source image with tiles of the style image(s). This will result in a more
|
|
2006
|
-
* coherent restyle. Works best with style images that have a similar composition.
|
|
2007
|
-
*/
|
|
2008
|
-
tileStyle?: boolean;
|
|
2009
|
-
trainingImage?: boolean;
|
|
1897
|
+
removeBackground?: boolean;
|
|
1898
|
+
/**
|
|
1899
|
+
* Size proportion of the input image in the output.
|
|
1900
|
+
*/
|
|
1901
|
+
resizeOption?: number;
|
|
1902
|
+
/**
|
|
1903
|
+
* Boolean to output the contours.
|
|
1904
|
+
*/
|
|
1905
|
+
resultContours?: boolean;
|
|
1906
|
+
/**
|
|
1907
|
+
* Boolean to able output the cut out object.
|
|
1908
|
+
*/
|
|
1909
|
+
resultImage?: boolean;
|
|
1910
|
+
/**
|
|
1911
|
+
* Boolean to able return the masks (binary image) in the response.
|
|
1912
|
+
*/
|
|
1913
|
+
resultMask?: boolean;
|
|
1914
|
+
rootParentId?: string;
|
|
1915
|
+
/**
|
|
1916
|
+
* Save a flipbook of the texture. Deactivated when the input texture is larger
|
|
1917
|
+
* than 2048x2048px
|
|
1918
|
+
*/
|
|
1919
|
+
saveFlipbook?: boolean;
|
|
1920
|
+
/**
|
|
1921
|
+
* Scaling factor (when `targetWidth` not specified)
|
|
1922
|
+
*/
|
|
1923
|
+
scalingFactor?: number;
|
|
1924
|
+
/**
|
|
1925
|
+
* The scheduler used to generate this asset
|
|
1926
|
+
*/
|
|
1927
|
+
scheduler?: string;
|
|
1928
|
+
/**
|
|
1929
|
+
* The seed used to generate this asset. <!> Can be a string or a number in some
|
|
1930
|
+
* cases <!>.
|
|
1931
|
+
*/
|
|
1932
|
+
seed?: string;
|
|
1933
|
+
/**
|
|
1934
|
+
* Sharpen tiles.
|
|
1935
|
+
*/
|
|
1936
|
+
sharpen?: boolean;
|
|
1937
|
+
/**
|
|
1938
|
+
* How shiny is the surface? 0 is like a matte surface, 1 is like a diamond
|
|
1939
|
+
*/
|
|
1940
|
+
shiny?: number;
|
|
1941
|
+
size?: number;
|
|
1942
|
+
/**
|
|
1943
|
+
* Activate sketch detection instead of canny.
|
|
1944
|
+
*/
|
|
1945
|
+
sketch?: boolean;
|
|
1946
|
+
sourceProjectId?: string;
|
|
1947
|
+
spliceThreshold?: number;
|
|
1948
|
+
/**
|
|
1949
|
+
* The strength
|
|
1950
|
+
*
|
|
1951
|
+
* Only available for the `flux-kontext` LoRA model.
|
|
1952
|
+
*/
|
|
1953
|
+
strength?: number;
|
|
1954
|
+
/**
|
|
1955
|
+
* Strength for the input image structure preservation
|
|
1956
|
+
*/
|
|
1957
|
+
structureFidelity?: number;
|
|
1958
|
+
/**
|
|
1959
|
+
* The control image for structure. A canny detector will be applied to this image.
|
|
1960
|
+
* Must reference an existing AssetId.
|
|
1961
|
+
*/
|
|
1962
|
+
structureImage?: string;
|
|
1963
|
+
style?: '3d-cartoon' | '3d-rendered' | 'anime' | 'cartoon' | 'cinematic' | 'claymation' | 'cloud-skydome' | 'comic' | 'cyberpunk' | 'enchanted' | 'fantasy' | 'ink' | 'manga' | 'manga-color' | 'minimalist' | 'neon-tron' | 'oil-painting' | 'pastel' | 'photo' | 'photography' | 'psychedelic' | 'retro-fantasy' | 'scifi-concept-art' | 'space' | 'standard' | 'whimsical';
|
|
1964
|
+
/**
|
|
1965
|
+
* The higher the value the more it will look like the style image(s)
|
|
1966
|
+
*/
|
|
1967
|
+
styleFidelity?: number;
|
|
1968
|
+
/**
|
|
1969
|
+
* List of style images. Most of the time, only one image is enough. It must be
|
|
1970
|
+
* existing AssetIds.
|
|
1971
|
+
*/
|
|
1972
|
+
styleImages?: Array<string>;
|
|
1973
|
+
/**
|
|
1974
|
+
* Condition the influence of the style image(s). The higher the value, the more
|
|
1975
|
+
* the style images will influence the upscaled image.
|
|
1976
|
+
*/
|
|
1977
|
+
styleImagesFidelity?: number;
|
|
1978
|
+
/**
|
|
1979
|
+
* The target height of the output image.
|
|
1980
|
+
*/
|
|
1981
|
+
targetHeight?: number;
|
|
1982
|
+
/**
|
|
1983
|
+
* Target width for the upscaled image, take priority over scaling factor
|
|
1984
|
+
*/
|
|
1985
|
+
targetWidth?: number;
|
|
1986
|
+
/**
|
|
1987
|
+
* A textual description / keywords describing the object of interest.
|
|
1988
|
+
*/
|
|
1989
|
+
text?: string;
|
|
1990
|
+
/**
|
|
1991
|
+
* The asset to convert in texture maps. Must reference an existing AssetId.
|
|
1992
|
+
*/
|
|
1993
|
+
texture?: string;
|
|
1994
|
+
/**
|
|
1995
|
+
* The thumbnail of the canvas
|
|
1996
|
+
*/
|
|
1997
|
+
thumbnail?: Metadata.Thumbnail;
|
|
1998
|
+
/**
|
|
1999
|
+
* If set to true, during the upscaling process, the model will match tiles of the
|
|
2000
|
+
* source image with tiles of the style image(s). This will result in a more
|
|
2001
|
+
* coherent restyle. Works best with style images that have a similar composition.
|
|
2002
|
+
*/
|
|
2003
|
+
tileStyle?: boolean;
|
|
2004
|
+
trainingImage?: boolean;
|
|
2005
|
+
/**
|
|
2006
|
+
* (deprecated) Vertical expansion ratio.
|
|
2007
|
+
*/
|
|
2008
|
+
verticalExpansionRatio?: number;
|
|
2009
|
+
/**
|
|
2010
|
+
* The width of the rendered image.
|
|
2011
|
+
*/
|
|
2012
|
+
width?: number;
|
|
2013
|
+
}
|
|
2014
|
+
namespace Metadata {
|
|
2015
|
+
interface Concept {
|
|
2010
2016
|
/**
|
|
2011
|
-
*
|
|
2017
|
+
* The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
|
|
2012
2018
|
*/
|
|
2013
|
-
|
|
2019
|
+
modelId: string;
|
|
2014
2020
|
/**
|
|
2015
|
-
* The
|
|
2021
|
+
* The scale of the model (example: 1.0) For Flux Kontext Prompt Editing, the scale
|
|
2022
|
+
* is between 0 and 2.
|
|
2016
2023
|
*/
|
|
2017
|
-
|
|
2018
|
-
}
|
|
2019
|
-
namespace Metadata {
|
|
2020
|
-
interface Concept {
|
|
2021
|
-
/**
|
|
2022
|
-
* The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
|
|
2023
|
-
*/
|
|
2024
|
-
modelId: string;
|
|
2025
|
-
/**
|
|
2026
|
-
* The scale of the model (example: 1.0) For Flux Kontext Prompt Editing, the scale
|
|
2027
|
-
* is between 0 and 2.
|
|
2028
|
-
*/
|
|
2029
|
-
scale: number;
|
|
2030
|
-
/**
|
|
2031
|
-
* The epoch of the model (example: "000001") Only available for Flux Lora Trained
|
|
2032
|
-
* models
|
|
2033
|
-
*/
|
|
2034
|
-
modelEpoch?: string;
|
|
2035
|
-
}
|
|
2024
|
+
scale: number;
|
|
2036
2025
|
/**
|
|
2037
|
-
* The
|
|
2026
|
+
* The epoch of the model (example: "000001") Only available for Flux Lora Trained
|
|
2027
|
+
* models
|
|
2038
2028
|
*/
|
|
2039
|
-
|
|
2040
|
-
/**
|
|
2041
|
-
* The AssetId of the image used as a thumbnail for the canvas (example:
|
|
2042
|
-
* "asset_GTrL3mq4SXWyMxkOHRxlpw")
|
|
2043
|
-
*/
|
|
2044
|
-
assetId: string;
|
|
2045
|
-
/**
|
|
2046
|
-
* The url of the image used as a thumbnail for the canvas
|
|
2047
|
-
*/
|
|
2048
|
-
url: string;
|
|
2049
|
-
}
|
|
2029
|
+
modelEpoch?: string;
|
|
2050
2030
|
}
|
|
2051
2031
|
/**
|
|
2052
|
-
* The
|
|
2032
|
+
* The thumbnail of the canvas
|
|
2053
2033
|
*/
|
|
2054
|
-
interface
|
|
2055
|
-
size: number;
|
|
2056
|
-
/**
|
|
2057
|
-
* Number of animation frames if animations exist
|
|
2058
|
-
*/
|
|
2059
|
-
animationFrameCount?: number;
|
|
2060
|
-
/**
|
|
2061
|
-
* Bitrate of the media in bits per second
|
|
2062
|
-
*/
|
|
2063
|
-
bitrate?: number;
|
|
2064
|
-
/**
|
|
2065
|
-
* Number of bones if skeleton exists
|
|
2066
|
-
*/
|
|
2067
|
-
boneCount?: number;
|
|
2068
|
-
/**
|
|
2069
|
-
* Number of channels of the audio
|
|
2070
|
-
*/
|
|
2071
|
-
channels?: number;
|
|
2072
|
-
/**
|
|
2073
|
-
* Classification of the audio
|
|
2074
|
-
*/
|
|
2075
|
-
classification?: 'effect' | 'interview' | 'music' | 'other' | 'sound' | 'speech' | 'text' | 'unknown';
|
|
2076
|
-
/**
|
|
2077
|
-
* Codec name of the media
|
|
2078
|
-
*/
|
|
2079
|
-
codecName?: string;
|
|
2080
|
-
/**
|
|
2081
|
-
* Description of the audio
|
|
2082
|
-
*/
|
|
2083
|
-
description?: string;
|
|
2084
|
-
/**
|
|
2085
|
-
* Bounding box dimensions [width, height, depth]
|
|
2086
|
-
*/
|
|
2087
|
-
dimensions?: Array<number>;
|
|
2088
|
-
/**
|
|
2089
|
-
* Duration of the media in seconds
|
|
2090
|
-
*/
|
|
2091
|
-
duration?: number;
|
|
2092
|
-
/**
|
|
2093
|
-
* Number of faces/triangles in the mesh
|
|
2094
|
-
*/
|
|
2095
|
-
faceCount?: number;
|
|
2096
|
-
/**
|
|
2097
|
-
* Format of the mesh file (e.g. 'glb', etc.)
|
|
2098
|
-
*/
|
|
2099
|
-
format?: string;
|
|
2100
|
-
/**
|
|
2101
|
-
* Frame rate of the video in frames per second
|
|
2102
|
-
*/
|
|
2103
|
-
frameRate?: number;
|
|
2104
|
-
/**
|
|
2105
|
-
* Whether the mesh has animations
|
|
2106
|
-
*/
|
|
2107
|
-
hasAnimations?: boolean;
|
|
2108
|
-
/**
|
|
2109
|
-
* Whether the mesh has normal vectors
|
|
2110
|
-
*/
|
|
2111
|
-
hasNormals?: boolean;
|
|
2112
|
-
/**
|
|
2113
|
-
* Whether the mesh has bones/skeleton
|
|
2114
|
-
*/
|
|
2115
|
-
hasSkeleton?: boolean;
|
|
2116
|
-
/**
|
|
2117
|
-
* Whether the mesh has UV coordinates
|
|
2118
|
-
*/
|
|
2119
|
-
hasUVs?: boolean;
|
|
2120
|
-
height?: number;
|
|
2121
|
-
/**
|
|
2122
|
-
* Number of frames in the video
|
|
2123
|
-
*/
|
|
2124
|
-
nbFrames?: number;
|
|
2125
|
-
/**
|
|
2126
|
-
* Sample rate of the media in Hz
|
|
2127
|
-
*/
|
|
2128
|
-
sampleRate?: number;
|
|
2129
|
-
/**
|
|
2130
|
-
* Transcription of the audio
|
|
2131
|
-
*/
|
|
2132
|
-
transcription?: Properties.Transcription;
|
|
2034
|
+
interface Thumbnail {
|
|
2133
2035
|
/**
|
|
2134
|
-
*
|
|
2036
|
+
* The AssetId of the image used as a thumbnail for the canvas (example:
|
|
2037
|
+
* "asset_GTrL3mq4SXWyMxkOHRxlpw")
|
|
2135
2038
|
*/
|
|
2136
|
-
|
|
2137
|
-
width?: number;
|
|
2138
|
-
}
|
|
2139
|
-
namespace Properties {
|
|
2039
|
+
assetId: string;
|
|
2140
2040
|
/**
|
|
2141
|
-
*
|
|
2041
|
+
* The url of the image used as a thumbnail for the canvas
|
|
2142
2042
|
*/
|
|
2143
|
-
|
|
2144
|
-
text: string;
|
|
2145
|
-
}
|
|
2043
|
+
url: string;
|
|
2146
2044
|
}
|
|
2045
|
+
}
|
|
2046
|
+
/**
|
|
2047
|
+
* The properties of the asset, content may depend on the kind of asset returned
|
|
2048
|
+
*/
|
|
2049
|
+
interface Properties {
|
|
2050
|
+
size: number;
|
|
2147
2051
|
/**
|
|
2148
|
-
*
|
|
2149
|
-
*
|
|
2150
|
-
* Contains the assetId and the url of the first frame.
|
|
2052
|
+
* Number of animation frames if animations exist
|
|
2151
2053
|
*/
|
|
2152
|
-
|
|
2153
|
-
assetId: string;
|
|
2154
|
-
url: string;
|
|
2155
|
-
}
|
|
2054
|
+
animationFrameCount?: number;
|
|
2156
2055
|
/**
|
|
2157
|
-
*
|
|
2158
|
-
*
|
|
2159
|
-
* Contains the assetId and the url of the last frame.
|
|
2056
|
+
* Bitrate of the media in bits per second
|
|
2160
2057
|
*/
|
|
2161
|
-
|
|
2162
|
-
assetId: string;
|
|
2163
|
-
url: string;
|
|
2164
|
-
}
|
|
2058
|
+
bitrate?: number;
|
|
2165
2059
|
/**
|
|
2166
|
-
*
|
|
2167
|
-
*
|
|
2168
|
-
* Contains the assetId and the url of the preview.
|
|
2060
|
+
* Number of bones if skeleton exists
|
|
2169
2061
|
*/
|
|
2170
|
-
|
|
2171
|
-
assetId: string;
|
|
2172
|
-
url: string;
|
|
2173
|
-
}
|
|
2062
|
+
boneCount?: number;
|
|
2174
2063
|
/**
|
|
2175
|
-
*
|
|
2176
|
-
*
|
|
2177
|
-
* Contains the assetId and the url of the thumbnail.
|
|
2064
|
+
* Number of channels of the audio
|
|
2178
2065
|
*/
|
|
2179
|
-
|
|
2180
|
-
|
|
2181
|
-
|
|
2066
|
+
channels?: number;
|
|
2067
|
+
/**
|
|
2068
|
+
* Classification of the audio
|
|
2069
|
+
*/
|
|
2070
|
+
classification?: 'effect' | 'interview' | 'music' | 'other' | 'sound' | 'speech' | 'text' | 'unknown';
|
|
2071
|
+
/**
|
|
2072
|
+
* Codec name of the media
|
|
2073
|
+
*/
|
|
2074
|
+
codecName?: string;
|
|
2075
|
+
/**
|
|
2076
|
+
* Description of the audio
|
|
2077
|
+
*/
|
|
2078
|
+
description?: string;
|
|
2079
|
+
/**
|
|
2080
|
+
* Bounding box dimensions [width, height, depth]
|
|
2081
|
+
*/
|
|
2082
|
+
dimensions?: Array<number>;
|
|
2083
|
+
/**
|
|
2084
|
+
* Duration of the media in seconds
|
|
2085
|
+
*/
|
|
2086
|
+
duration?: number;
|
|
2087
|
+
/**
|
|
2088
|
+
* Number of faces/triangles in the mesh
|
|
2089
|
+
*/
|
|
2090
|
+
faceCount?: number;
|
|
2091
|
+
/**
|
|
2092
|
+
* Format of the mesh file (e.g. 'glb', etc.)
|
|
2093
|
+
*/
|
|
2094
|
+
format?: string;
|
|
2095
|
+
/**
|
|
2096
|
+
* Frame rate of the video in frames per second
|
|
2097
|
+
*/
|
|
2098
|
+
frameRate?: number;
|
|
2099
|
+
/**
|
|
2100
|
+
* Whether the mesh has animations
|
|
2101
|
+
*/
|
|
2102
|
+
hasAnimations?: boolean;
|
|
2103
|
+
/**
|
|
2104
|
+
* Whether the mesh has normal vectors
|
|
2105
|
+
*/
|
|
2106
|
+
hasNormals?: boolean;
|
|
2107
|
+
/**
|
|
2108
|
+
* Whether the mesh has bones/skeleton
|
|
2109
|
+
*/
|
|
2110
|
+
hasSkeleton?: boolean;
|
|
2111
|
+
/**
|
|
2112
|
+
* Whether the mesh has UV coordinates
|
|
2113
|
+
*/
|
|
2114
|
+
hasUVs?: boolean;
|
|
2115
|
+
height?: number;
|
|
2116
|
+
/**
|
|
2117
|
+
* Number of frames in the video
|
|
2118
|
+
*/
|
|
2119
|
+
nbFrames?: number;
|
|
2120
|
+
/**
|
|
2121
|
+
* Sample rate of the media in Hz
|
|
2122
|
+
*/
|
|
2123
|
+
sampleRate?: number;
|
|
2124
|
+
/**
|
|
2125
|
+
* Transcription of the audio
|
|
2126
|
+
*/
|
|
2127
|
+
transcription?: Properties.Transcription;
|
|
2128
|
+
/**
|
|
2129
|
+
* Number of vertices in the mesh
|
|
2130
|
+
*/
|
|
2131
|
+
vertexCount?: number;
|
|
2132
|
+
width?: number;
|
|
2133
|
+
}
|
|
2134
|
+
namespace Properties {
|
|
2135
|
+
/**
|
|
2136
|
+
* Transcription of the audio
|
|
2137
|
+
*/
|
|
2138
|
+
interface Transcription {
|
|
2139
|
+
text: string;
|
|
2182
2140
|
}
|
|
2183
2141
|
}
|
|
2142
|
+
/**
|
|
2143
|
+
* The video asset's first frame.
|
|
2144
|
+
*
|
|
2145
|
+
* Contains the assetId and the url of the first frame.
|
|
2146
|
+
*/
|
|
2147
|
+
interface FirstFrame {
|
|
2148
|
+
assetId: string;
|
|
2149
|
+
url: string;
|
|
2150
|
+
}
|
|
2151
|
+
/**
|
|
2152
|
+
* The video asset's last frame.
|
|
2153
|
+
*
|
|
2154
|
+
* Contains the assetId and the url of the last frame.
|
|
2155
|
+
*/
|
|
2156
|
+
interface LastFrame {
|
|
2157
|
+
assetId: string;
|
|
2158
|
+
url: string;
|
|
2159
|
+
}
|
|
2160
|
+
/**
|
|
2161
|
+
* The asset's preview.
|
|
2162
|
+
*
|
|
2163
|
+
* Contains the assetId and the url of the preview.
|
|
2164
|
+
*/
|
|
2165
|
+
interface Preview {
|
|
2166
|
+
assetId: string;
|
|
2167
|
+
url: string;
|
|
2168
|
+
}
|
|
2169
|
+
/**
|
|
2170
|
+
* The asset's thumbnail.
|
|
2171
|
+
*
|
|
2172
|
+
* Contains the assetId and the url of the thumbnail.
|
|
2173
|
+
*/
|
|
2174
|
+
interface Thumbnail {
|
|
2175
|
+
assetId: string;
|
|
2176
|
+
url: string;
|
|
2177
|
+
}
|
|
2184
2178
|
}
|
|
2185
2179
|
export type AssetDeleteMultipleResponse = unknown;
|
|
2186
2180
|
export interface AssetDuplicateResponse {
|
|
@@ -3598,19 +3592,10 @@ export declare namespace AssetGetBulkResponse {
|
|
|
3598
3592
|
}
|
|
3599
3593
|
}
|
|
3600
3594
|
export interface AssetListSnapshotsResponse {
|
|
3601
|
-
|
|
3602
|
-
|
|
3603
|
-
|
|
3604
|
-
|
|
3605
|
-
nextPaginationToken?: string;
|
|
3606
|
-
}
|
|
3607
|
-
export declare namespace AssetListSnapshotsResponse {
|
|
3608
|
-
interface Snapshot {
|
|
3609
|
-
authorId: string;
|
|
3610
|
-
hash: string;
|
|
3611
|
-
rawData: string;
|
|
3612
|
-
takenAt: number;
|
|
3613
|
-
}
|
|
3595
|
+
authorId: string;
|
|
3596
|
+
hash: string;
|
|
3597
|
+
rawData: string;
|
|
3598
|
+
takenAt: number;
|
|
3614
3599
|
}
|
|
3615
3600
|
export interface AssetLockResponse {
|
|
3616
3601
|
asset: AssetLockResponse.Asset;
|
|
@@ -6463,7 +6448,7 @@ export interface AssetUpdateParams {
|
|
|
6463
6448
|
*/
|
|
6464
6449
|
thumbnail?: string;
|
|
6465
6450
|
}
|
|
6466
|
-
export interface AssetListParams {
|
|
6451
|
+
export interface AssetListParams extends AssetsCursorParams {
|
|
6467
6452
|
/**
|
|
6468
6453
|
* List assets generated by a specific author (the user that created the asset)
|
|
6469
6454
|
*/
|
|
@@ -6497,10 +6482,6 @@ export interface AssetListParams {
|
|
|
6497
6482
|
* value is 100, minimum value is 1
|
|
6498
6483
|
*/
|
|
6499
6484
|
pageSize?: number;
|
|
6500
|
-
/**
|
|
6501
|
-
* A token you received in a previous request to query the next page of items
|
|
6502
|
-
*/
|
|
6503
|
-
paginationToken?: string;
|
|
6504
6485
|
/**
|
|
6505
6486
|
* List all the children assets that were generated from a specific parent asset
|
|
6506
6487
|
*/
|
|
@@ -6610,16 +6591,12 @@ export interface AssetGetBulkParams {
|
|
|
6610
6591
|
*/
|
|
6611
6592
|
assetIds?: Array<string>;
|
|
6612
6593
|
}
|
|
6613
|
-
export interface AssetListSnapshotsParams {
|
|
6594
|
+
export interface AssetListSnapshotsParams extends SnapshotsCursorParams {
|
|
6614
6595
|
/**
|
|
6615
6596
|
* The number of items to return in the response. The default value is 10, maximum
|
|
6616
6597
|
* value is 100, minimum value is 10
|
|
6617
6598
|
*/
|
|
6618
6599
|
pageSize?: number;
|
|
6619
|
-
/**
|
|
6620
|
-
* A token you received in a previous request to query the next page of items
|
|
6621
|
-
*/
|
|
6622
|
-
paginationToken?: string;
|
|
6623
6600
|
}
|
|
6624
6601
|
export interface AssetLockParams {
|
|
6625
6602
|
/**
|
|
@@ -6701,7 +6678,7 @@ export interface AssetUploadParams {
|
|
|
6701
6678
|
thumbnail?: string;
|
|
6702
6679
|
}
|
|
6703
6680
|
export declare namespace Assets {
|
|
6704
|
-
export { type AssetRetrieveResponse as AssetRetrieveResponse, type AssetUpdateResponse as AssetUpdateResponse, type AssetListResponse as AssetListResponse, type AssetDeleteMultipleResponse as AssetDeleteMultipleResponse, type AssetDuplicateResponse as AssetDuplicateResponse, type AssetGetBulkResponse as AssetGetBulkResponse, type AssetListSnapshotsResponse as AssetListSnapshotsResponse, type AssetLockResponse as AssetLockResponse, type AssetUnlockResponse as AssetUnlockResponse, type AssetUpdateTagsResponse as AssetUpdateTagsResponse, type AssetUploadResponse as AssetUploadResponse, type AssetRetrieveParams as AssetRetrieveParams, type AssetUpdateParams as AssetUpdateParams, type AssetListParams as AssetListParams, type AssetDeleteMultipleParams as AssetDeleteMultipleParams, type AssetDuplicateParams as AssetDuplicateParams, type AssetGetBulkParams as AssetGetBulkParams, type AssetListSnapshotsParams as AssetListSnapshotsParams, type AssetLockParams as AssetLockParams, type AssetUnlockParams as AssetUnlockParams, type AssetUpdateTagsParams as AssetUpdateTagsParams, type AssetUploadParams as AssetUploadParams, };
|
|
6681
|
+
export { type AssetRetrieveResponse as AssetRetrieveResponse, type AssetUpdateResponse as AssetUpdateResponse, type AssetListResponse as AssetListResponse, type AssetDeleteMultipleResponse as AssetDeleteMultipleResponse, type AssetDuplicateResponse as AssetDuplicateResponse, type AssetGetBulkResponse as AssetGetBulkResponse, type AssetListSnapshotsResponse as AssetListSnapshotsResponse, type AssetLockResponse as AssetLockResponse, type AssetUnlockResponse as AssetUnlockResponse, type AssetUpdateTagsResponse as AssetUpdateTagsResponse, type AssetUploadResponse as AssetUploadResponse, type AssetListResponsesAssetsCursor as AssetListResponsesAssetsCursor, type AssetListSnapshotsResponsesSnapshotsCursor as AssetListSnapshotsResponsesSnapshotsCursor, type AssetRetrieveParams as AssetRetrieveParams, type AssetUpdateParams as AssetUpdateParams, type AssetListParams as AssetListParams, type AssetDeleteMultipleParams as AssetDeleteMultipleParams, type AssetDuplicateParams as AssetDuplicateParams, type AssetGetBulkParams as AssetGetBulkParams, type AssetListSnapshotsParams as AssetListSnapshotsParams, type AssetLockParams as AssetLockParams, type AssetUnlockParams as AssetUnlockParams, type AssetUpdateTagsParams as AssetUpdateTagsParams, type AssetUploadParams as AssetUploadParams, };
|
|
6705
6682
|
export { Download as Download, type DownloadGetStatusResponse as DownloadGetStatusResponse, type DownloadRequestResponse as DownloadRequestResponse, type DownloadRequestBatchResponse as DownloadRequestBatchResponse, type DownloadRequestParams as DownloadRequestParams, type DownloadRequestBatchParams as DownloadRequestBatchParams, };
|
|
6706
6683
|
export { Public as Public, type PublicRetrieveResponse as PublicRetrieveResponse, type PublicListResponse as PublicListResponse, type PublicListParams as PublicListParams, };
|
|
6707
6684
|
}
|