@scenario-labs/sdk 0.2.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 +48 -0
- package/README.md +44 -8
- package/client.d.mts +36 -16
- package/client.d.mts.map +1 -1
- package/client.d.ts +36 -16
- package/client.d.ts.map +1 -1
- package/client.js +21 -11
- package/client.js.map +1 -1
- package/client.mjs +21 -11
- 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 +3 -0
- package/index.d.mts.map +1 -1
- package/index.d.ts +3 -0
- package/index.d.ts.map +1 -1
- package/index.js +9 -1
- package/index.js.map +1 -1
- package/index.mjs +3 -0
- package/index.mjs.map +1 -1
- package/internal/request-options.d.mts +1 -1
- package/internal/request-options.d.mts.map +1 -1
- package/internal/request-options.d.ts +1 -1
- package/internal/request-options.d.ts.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 +19 -3
- package/lib/workflow.d.mts.map +1 -1
- package/lib/workflow.d.ts +19 -3
- package/lib/workflow.d.ts.map +1 -1
- package/lib/workflow.js +26 -5
- package/lib/workflow.js.map +1 -1
- package/lib/workflow.mjs +26 -5
- 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/lib/workflow_validator.d.mts +22 -0
- package/lib/workflow_validator.d.mts.map +1 -0
- package/lib/workflow_validator.d.ts +22 -0
- package/lib/workflow_validator.d.ts.map +1 -0
- package/lib/workflow_validator.js +124 -0
- package/lib/workflow_validator.js.map +1 -0
- package/lib/workflow_validator.mjs +121 -0
- package/lib/workflow_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 +631 -648
- package/resources/assets/assets.d.mts.map +1 -1
- package/resources/assets/assets.d.ts +631 -648
- package/resources/assets/assets.d.ts.map +1 -1
- package/resources/assets/assets.js +5 -4
- package/resources/assets/assets.js.map +1 -1
- package/resources/assets/assets.mjs +5 -4
- 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/assets.d.mts +8 -2
- package/resources/collections/assets.d.mts.map +1 -1
- package/resources/collections/assets.d.ts +8 -2
- package/resources/collections/assets.d.ts.map +1 -1
- package/resources/collections/assets.js +2 -2
- package/resources/collections/assets.js.map +1 -1
- package/resources/collections/assets.mjs +2 -2
- package/resources/collections/assets.mjs.map +1 -1
- package/resources/collections/collections.d.mts +42 -53
- package/resources/collections/collections.d.mts.map +1 -1
- package/resources/collections/collections.d.ts +42 -53
- 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 +3 -3
- package/resources/collections/index.d.mts.map +1 -1
- package/resources/collections/index.d.ts +3 -3
- package/resources/collections/index.d.ts.map +1 -1
- package/resources/collections/index.js.map +1 -1
- package/resources/collections/index.mjs +2 -2
- package/resources/collections/index.mjs.map +1 -1
- package/resources/collections/models.d.mts +8 -2
- package/resources/collections/models.d.mts.map +1 -1
- package/resources/collections/models.d.ts +8 -2
- package/resources/collections/models.d.ts.map +1 -1
- package/resources/collections/models.js +2 -2
- package/resources/collections/models.js.map +1 -1
- package/resources/collections/models.mjs +2 -2
- package/resources/collections/models.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 +956 -967
- package/resources/models/models.d.mts.map +1 -1
- package/resources/models/models.d.ts +956 -967
- 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/models/train.d.mts +38 -38
- package/resources/models/train.d.mts.map +1 -1
- package/resources/models/train.d.ts +38 -38
- package/resources/models/train.d.ts.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 +118 -15
- package/src/core/pagination.ts +497 -0
- package/src/index.ts +9 -0
- package/src/internal/request-options.ts +1 -1
- 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 +39 -5
- package/src/lib/workflow_import_validator.ts +104 -0
- package/src/lib/workflow_validator.ts +167 -0
- package/src/pagination.ts +2 -0
- package/src/resources/assets/assets.ts +971 -905
- package/src/resources/assets/index.ts +3 -0
- package/src/resources/collections/assets.ts +14 -2
- package/src/resources/collections/collections.ts +49 -56
- package/src/resources/collections/index.ts +15 -2
- package/src/resources/collections/models.ts +14 -2
- package/src/resources/index.ts +10 -1
- package/src/resources/jobs.ts +613 -622
- package/src/resources/models/index.ts +1 -0
- package/src/resources/models/models.ts +1118 -1130
- package/src/resources/models/train.ts +40 -40
- 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
|
@@ -13,6 +13,13 @@ import {
|
|
|
13
13
|
import * as PublicAPI from './public';
|
|
14
14
|
import { Public, PublicListParams, PublicListResponse, PublicRetrieveResponse } from './public';
|
|
15
15
|
import { APIPromise } from '../../core/api-promise';
|
|
16
|
+
import {
|
|
17
|
+
AssetsCursor,
|
|
18
|
+
type AssetsCursorParams,
|
|
19
|
+
PagePromise,
|
|
20
|
+
SnapshotsCursor,
|
|
21
|
+
type SnapshotsCursorParams,
|
|
22
|
+
} from '../../core/pagination';
|
|
16
23
|
import { RequestOptions } from '../../internal/request-options';
|
|
17
24
|
import { path } from '../../internal/utils/path';
|
|
18
25
|
|
|
@@ -53,15 +60,15 @@ export class Assets extends APIResource {
|
|
|
53
60
|
list(
|
|
54
61
|
query: AssetListParams | null | undefined = {},
|
|
55
62
|
options?: RequestOptions,
|
|
56
|
-
):
|
|
57
|
-
return this._client.
|
|
63
|
+
): PagePromise<AssetListResponsesAssetsCursor, AssetListResponse> {
|
|
64
|
+
return this._client.getAPIList('/assets', AssetsCursor<AssetListResponse>, { query, ...options });
|
|
58
65
|
}
|
|
59
66
|
|
|
60
67
|
/**
|
|
61
68
|
* Delete multiple assets
|
|
62
69
|
*/
|
|
63
|
-
deleteMultiple(options?: RequestOptions): APIPromise<unknown> {
|
|
64
|
-
return this._client.delete('/assets', options);
|
|
70
|
+
deleteMultiple(body: AssetDeleteMultipleParams, options?: RequestOptions): APIPromise<unknown> {
|
|
71
|
+
return this._client.delete('/assets', { body, ...options });
|
|
65
72
|
}
|
|
66
73
|
|
|
67
74
|
/**
|
|
@@ -91,8 +98,12 @@ export class Assets extends APIResource {
|
|
|
91
98
|
assetID: string,
|
|
92
99
|
query: AssetListSnapshotsParams | null | undefined = {},
|
|
93
100
|
options?: RequestOptions,
|
|
94
|
-
):
|
|
95
|
-
return this._client.
|
|
101
|
+
): PagePromise<AssetListSnapshotsResponsesSnapshotsCursor, AssetListSnapshotsResponse> {
|
|
102
|
+
return this._client.getAPIList(
|
|
103
|
+
path`/assets/${assetID}/snapshots`,
|
|
104
|
+
SnapshotsCursor<AssetListSnapshotsResponse>,
|
|
105
|
+
{ query, ...options },
|
|
106
|
+
);
|
|
96
107
|
}
|
|
97
108
|
|
|
98
109
|
/**
|
|
@@ -135,6 +146,10 @@ export class Assets extends APIResource {
|
|
|
135
146
|
}
|
|
136
147
|
}
|
|
137
148
|
|
|
149
|
+
export type AssetListResponsesAssetsCursor = AssetsCursor<AssetListResponse>;
|
|
150
|
+
|
|
151
|
+
export type AssetListSnapshotsResponsesSnapshotsCursor = SnapshotsCursor<AssetListSnapshotsResponse>;
|
|
152
|
+
|
|
138
153
|
export interface AssetRetrieveResponse {
|
|
139
154
|
asset: AssetRetrieveResponse.Asset;
|
|
140
155
|
}
|
|
@@ -2360,96 +2375,269 @@ export namespace AssetUpdateResponse {
|
|
|
2360
2375
|
}
|
|
2361
2376
|
|
|
2362
2377
|
export interface AssetListResponse {
|
|
2363
|
-
|
|
2378
|
+
/**
|
|
2379
|
+
* The asset ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")
|
|
2380
|
+
*/
|
|
2381
|
+
id: string;
|
|
2364
2382
|
|
|
2365
2383
|
/**
|
|
2366
|
-
*
|
|
2384
|
+
* The author user ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")
|
|
2367
2385
|
*/
|
|
2368
|
-
|
|
2369
|
-
}
|
|
2386
|
+
authorId: string;
|
|
2370
2387
|
|
|
2371
|
-
|
|
2372
|
-
|
|
2373
|
-
|
|
2374
|
-
|
|
2375
|
-
*/
|
|
2376
|
-
id: string;
|
|
2388
|
+
/**
|
|
2389
|
+
* A list of CollectionId this asset belongs to
|
|
2390
|
+
*/
|
|
2391
|
+
collectionIds: Array<string>;
|
|
2377
2392
|
|
|
2378
|
-
|
|
2379
|
-
|
|
2380
|
-
|
|
2381
|
-
|
|
2393
|
+
/**
|
|
2394
|
+
* The asset creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
|
|
2395
|
+
*/
|
|
2396
|
+
createdAt: string;
|
|
2382
2397
|
|
|
2383
|
-
|
|
2384
|
-
|
|
2385
|
-
|
|
2386
|
-
|
|
2398
|
+
/**
|
|
2399
|
+
* List of edit capabilities
|
|
2400
|
+
*/
|
|
2401
|
+
editCapabilities: Array<
|
|
2402
|
+
| 'DETECTION'
|
|
2403
|
+
| 'GENERATIVE_FILL'
|
|
2404
|
+
| 'PIXELATE'
|
|
2405
|
+
| 'PROMPT_EDITING'
|
|
2406
|
+
| 'REFINE'
|
|
2407
|
+
| 'REFRAME'
|
|
2408
|
+
| 'REMOVE_BACKGROUND'
|
|
2409
|
+
| 'SEGMENTATION'
|
|
2410
|
+
| 'UPSCALE'
|
|
2411
|
+
| 'UPSCALE_360'
|
|
2412
|
+
| 'VECTORIZATION'
|
|
2413
|
+
>;
|
|
2387
2414
|
|
|
2388
|
-
|
|
2389
|
-
|
|
2390
|
-
|
|
2391
|
-
|
|
2415
|
+
/**
|
|
2416
|
+
* The kind of asset
|
|
2417
|
+
*/
|
|
2418
|
+
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
2392
2419
|
|
|
2393
|
-
|
|
2394
|
-
|
|
2395
|
-
|
|
2396
|
-
|
|
2397
|
-
| 'DETECTION'
|
|
2398
|
-
| 'GENERATIVE_FILL'
|
|
2399
|
-
| 'PIXELATE'
|
|
2400
|
-
| 'PROMPT_EDITING'
|
|
2401
|
-
| 'REFINE'
|
|
2402
|
-
| 'REFRAME'
|
|
2403
|
-
| 'REMOVE_BACKGROUND'
|
|
2404
|
-
| 'SEGMENTATION'
|
|
2405
|
-
| 'UPSCALE'
|
|
2406
|
-
| 'UPSCALE_360'
|
|
2407
|
-
| 'VECTORIZATION'
|
|
2408
|
-
>;
|
|
2420
|
+
/**
|
|
2421
|
+
* Metadata of the asset with some additional information
|
|
2422
|
+
*/
|
|
2423
|
+
metadata: AssetListResponse.Metadata;
|
|
2409
2424
|
|
|
2410
|
-
|
|
2411
|
-
|
|
2412
|
-
|
|
2413
|
-
|
|
2425
|
+
/**
|
|
2426
|
+
* The mime type of the asset (example: "image/png")
|
|
2427
|
+
*/
|
|
2428
|
+
mimeType: string;
|
|
2414
2429
|
|
|
2415
|
-
|
|
2416
|
-
|
|
2417
|
-
|
|
2418
|
-
|
|
2430
|
+
/**
|
|
2431
|
+
* The owner (project) ID (example: "proj_23tlk332lkht3kl2" or
|
|
2432
|
+
* "team_dlkhgs23tlk3hlkth32lkht3kl2" for old teams)
|
|
2433
|
+
*/
|
|
2434
|
+
ownerId: string;
|
|
2419
2435
|
|
|
2420
|
-
|
|
2421
|
-
|
|
2422
|
-
|
|
2423
|
-
|
|
2436
|
+
/**
|
|
2437
|
+
* The privacy of the asset
|
|
2438
|
+
*/
|
|
2439
|
+
privacy: 'private' | 'public' | 'unlisted';
|
|
2424
2440
|
|
|
2425
|
-
|
|
2426
|
-
|
|
2427
|
-
|
|
2428
|
-
|
|
2429
|
-
ownerId: string;
|
|
2441
|
+
/**
|
|
2442
|
+
* The properties of the asset, content may depend on the kind of asset returned
|
|
2443
|
+
*/
|
|
2444
|
+
properties: AssetListResponse.Properties;
|
|
2430
2445
|
|
|
2431
|
-
|
|
2432
|
-
|
|
2433
|
-
|
|
2434
|
-
|
|
2446
|
+
/**
|
|
2447
|
+
* source of the asset
|
|
2448
|
+
*/
|
|
2449
|
+
source:
|
|
2450
|
+
| '3d23d'
|
|
2451
|
+
| '3d23d:texture'
|
|
2452
|
+
| '3d:texture'
|
|
2453
|
+
| '3d:texture:albedo'
|
|
2454
|
+
| '3d:texture:metallic'
|
|
2455
|
+
| '3d:texture:mtl'
|
|
2456
|
+
| '3d:texture:normal'
|
|
2457
|
+
| '3d:texture:roughness'
|
|
2458
|
+
| 'audio2audio'
|
|
2459
|
+
| 'background-removal'
|
|
2460
|
+
| 'canvas'
|
|
2461
|
+
| 'canvas-drawing'
|
|
2462
|
+
| 'canvas-export'
|
|
2463
|
+
| 'detection'
|
|
2464
|
+
| 'generative-fill'
|
|
2465
|
+
| 'image-prompt-editing'
|
|
2466
|
+
| 'img23d'
|
|
2467
|
+
| 'img2img'
|
|
2468
|
+
| 'img2video'
|
|
2469
|
+
| 'inference-control-net'
|
|
2470
|
+
| 'inference-control-net-img'
|
|
2471
|
+
| 'inference-control-net-inpainting'
|
|
2472
|
+
| 'inference-control-net-inpainting-ip-adapter'
|
|
2473
|
+
| 'inference-control-net-ip-adapter'
|
|
2474
|
+
| 'inference-control-net-reference'
|
|
2475
|
+
| 'inference-control-net-texture'
|
|
2476
|
+
| 'inference-img'
|
|
2477
|
+
| 'inference-img-ip-adapter'
|
|
2478
|
+
| 'inference-img-texture'
|
|
2479
|
+
| 'inference-in-paint'
|
|
2480
|
+
| 'inference-in-paint-ip-adapter'
|
|
2481
|
+
| 'inference-reference'
|
|
2482
|
+
| 'inference-reference-texture'
|
|
2483
|
+
| 'inference-txt'
|
|
2484
|
+
| 'inference-txt-ip-adapter'
|
|
2485
|
+
| 'inference-txt-texture'
|
|
2486
|
+
| 'patch'
|
|
2487
|
+
| 'pixelization'
|
|
2488
|
+
| 'reframe'
|
|
2489
|
+
| 'restyle'
|
|
2490
|
+
| 'segment'
|
|
2491
|
+
| 'segmentation-image'
|
|
2492
|
+
| 'segmentation-mask'
|
|
2493
|
+
| 'skybox-3d'
|
|
2494
|
+
| 'skybox-base-360'
|
|
2495
|
+
| 'skybox-hdri'
|
|
2496
|
+
| 'texture'
|
|
2497
|
+
| 'texture:albedo'
|
|
2498
|
+
| 'texture:ao'
|
|
2499
|
+
| 'texture:edge'
|
|
2500
|
+
| 'texture:height'
|
|
2501
|
+
| 'texture:metallic'
|
|
2502
|
+
| 'texture:normal'
|
|
2503
|
+
| 'texture:smoothness'
|
|
2504
|
+
| 'txt23d'
|
|
2505
|
+
| 'txt2audio'
|
|
2506
|
+
| 'txt2img'
|
|
2507
|
+
| 'txt2video'
|
|
2508
|
+
| 'unknown'
|
|
2509
|
+
| 'uploaded'
|
|
2510
|
+
| 'uploaded-3d'
|
|
2511
|
+
| 'uploaded-audio'
|
|
2512
|
+
| 'uploaded-avatar'
|
|
2513
|
+
| 'uploaded-video'
|
|
2514
|
+
| 'upscale'
|
|
2515
|
+
| 'upscale-skybox'
|
|
2516
|
+
| 'upscale-texture'
|
|
2517
|
+
| 'upscale-video'
|
|
2518
|
+
| 'vectorization'
|
|
2519
|
+
| 'video23d'
|
|
2520
|
+
| 'video2img'
|
|
2521
|
+
| 'video2video'
|
|
2522
|
+
| 'voice-clone';
|
|
2435
2523
|
|
|
2436
|
-
|
|
2437
|
-
|
|
2438
|
-
|
|
2439
|
-
|
|
2524
|
+
/**
|
|
2525
|
+
* The actual status
|
|
2526
|
+
*/
|
|
2527
|
+
status: 'error' | 'pending' | 'success';
|
|
2528
|
+
|
|
2529
|
+
/**
|
|
2530
|
+
* The associated tags (example: ["sci-fi", "landscape"])
|
|
2531
|
+
*/
|
|
2532
|
+
tags: Array<string>;
|
|
2533
|
+
|
|
2534
|
+
/**
|
|
2535
|
+
* The asset last update date as an ISO string (example:
|
|
2536
|
+
* "2023-02-03T11:19:41.579Z")
|
|
2537
|
+
*/
|
|
2538
|
+
updatedAt: string;
|
|
2539
|
+
|
|
2540
|
+
/**
|
|
2541
|
+
* Signed URL to get the asset content
|
|
2542
|
+
*/
|
|
2543
|
+
url: string;
|
|
2544
|
+
|
|
2545
|
+
/**
|
|
2546
|
+
* Automatic captioning of the asset
|
|
2547
|
+
*/
|
|
2548
|
+
automaticCaptioning?: string;
|
|
2549
|
+
|
|
2550
|
+
/**
|
|
2551
|
+
* The description, it will contain in priority:
|
|
2552
|
+
*
|
|
2553
|
+
* - the manual description
|
|
2554
|
+
* - the advanced captioning when the asset is used in training flow
|
|
2555
|
+
* - the automatic captioning
|
|
2556
|
+
*/
|
|
2557
|
+
description?: string;
|
|
2558
|
+
|
|
2559
|
+
/**
|
|
2560
|
+
* The embedding of the asset when requested.
|
|
2561
|
+
*
|
|
2562
|
+
* Only available when an asset can be embedded (ie: not Detection maps)
|
|
2563
|
+
*/
|
|
2564
|
+
embedding?: Array<number>;
|
|
2565
|
+
|
|
2566
|
+
/**
|
|
2567
|
+
* The video asset's first frame.
|
|
2568
|
+
*
|
|
2569
|
+
* Contains the assetId and the url of the first frame.
|
|
2570
|
+
*/
|
|
2571
|
+
firstFrame?: AssetListResponse.FirstFrame;
|
|
2572
|
+
|
|
2573
|
+
/**
|
|
2574
|
+
* Whether the asset is hidden.
|
|
2575
|
+
*/
|
|
2576
|
+
isHidden?: boolean;
|
|
2577
|
+
|
|
2578
|
+
/**
|
|
2579
|
+
* The video asset's last frame.
|
|
2580
|
+
*
|
|
2581
|
+
* Contains the assetId and the url of the last frame.
|
|
2582
|
+
*/
|
|
2583
|
+
lastFrame?: AssetListResponse.LastFrame;
|
|
2584
|
+
|
|
2585
|
+
/**
|
|
2586
|
+
* The NSFW labels
|
|
2587
|
+
*/
|
|
2588
|
+
nsfw?: Array<string>;
|
|
2589
|
+
|
|
2590
|
+
/**
|
|
2591
|
+
* The original file url.
|
|
2592
|
+
*
|
|
2593
|
+
* Contains the url of the original file. without any conversion. Only available
|
|
2594
|
+
* for some specific video, audio and threeD assets. Is only specified if the given
|
|
2595
|
+
* asset data has been replaced with a new file during the creation of the asset.
|
|
2596
|
+
*/
|
|
2597
|
+
originalFileUrl?: string;
|
|
2598
|
+
|
|
2599
|
+
/**
|
|
2600
|
+
* The output index of the asset within a job This index is an positive integer
|
|
2601
|
+
* that starts at 0 It is used to differentiate between multiple outputs of the
|
|
2602
|
+
* same job If the job has only one output, this index is 0
|
|
2603
|
+
*/
|
|
2604
|
+
outputIndex?: number;
|
|
2605
|
+
|
|
2606
|
+
/**
|
|
2607
|
+
* The asset's preview.
|
|
2608
|
+
*
|
|
2609
|
+
* Contains the assetId and the url of the preview.
|
|
2610
|
+
*/
|
|
2611
|
+
preview?: AssetListResponse.Preview;
|
|
2612
|
+
|
|
2613
|
+
/**
|
|
2614
|
+
* The asset's thumbnail.
|
|
2615
|
+
*
|
|
2616
|
+
* Contains the assetId and the url of the thumbnail.
|
|
2617
|
+
*/
|
|
2618
|
+
thumbnail?: AssetListResponse.Thumbnail;
|
|
2619
|
+
}
|
|
2620
|
+
|
|
2621
|
+
export namespace AssetListResponse {
|
|
2622
|
+
/**
|
|
2623
|
+
* Metadata of the asset with some additional information
|
|
2624
|
+
*/
|
|
2625
|
+
export interface Metadata {
|
|
2626
|
+
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
2440
2627
|
|
|
2441
2628
|
/**
|
|
2442
|
-
*
|
|
2629
|
+
* The type of the asset. Ex: 'inference-txt2img' will represent an asset generated
|
|
2630
|
+
* from a text to image model
|
|
2443
2631
|
*/
|
|
2444
|
-
|
|
2632
|
+
type:
|
|
2633
|
+
| '3d-texture'
|
|
2634
|
+
| '3d-texture-albedo'
|
|
2635
|
+
| '3d-texture-metallic'
|
|
2636
|
+
| '3d-texture-mtl'
|
|
2637
|
+
| '3d-texture-normal'
|
|
2638
|
+
| '3d-texture-roughness'
|
|
2445
2639
|
| '3d23d'
|
|
2446
|
-
| '3d23d
|
|
2447
|
-
| '3d:texture'
|
|
2448
|
-
| '3d:texture:albedo'
|
|
2449
|
-
| '3d:texture:metallic'
|
|
2450
|
-
| '3d:texture:mtl'
|
|
2451
|
-
| '3d:texture:normal'
|
|
2452
|
-
| '3d:texture:roughness'
|
|
2640
|
+
| '3d23d-texture'
|
|
2453
2641
|
| 'audio2audio'
|
|
2454
2642
|
| 'background-removal'
|
|
2455
2643
|
| 'canvas'
|
|
@@ -2461,23 +2649,23 @@ export namespace AssetListResponse {
|
|
|
2461
2649
|
| 'img23d'
|
|
2462
2650
|
| 'img2img'
|
|
2463
2651
|
| 'img2video'
|
|
2464
|
-
| 'inference-
|
|
2465
|
-
| 'inference-
|
|
2466
|
-
| 'inference-
|
|
2467
|
-
| 'inference-
|
|
2468
|
-
| 'inference-
|
|
2469
|
-
| 'inference-
|
|
2470
|
-
| 'inference-
|
|
2471
|
-
| 'inference-
|
|
2472
|
-
| 'inference-
|
|
2473
|
-
| 'inference-
|
|
2474
|
-
| 'inference-
|
|
2475
|
-
| 'inference-
|
|
2652
|
+
| 'inference-controlnet'
|
|
2653
|
+
| 'inference-controlnet-img2img'
|
|
2654
|
+
| 'inference-controlnet-inpaint'
|
|
2655
|
+
| 'inference-controlnet-inpaint-ip-adapter'
|
|
2656
|
+
| 'inference-controlnet-ip-adapter'
|
|
2657
|
+
| 'inference-controlnet-reference'
|
|
2658
|
+
| 'inference-controlnet-texture'
|
|
2659
|
+
| 'inference-img2img'
|
|
2660
|
+
| 'inference-img2img-ip-adapter'
|
|
2661
|
+
| 'inference-img2img-texture'
|
|
2662
|
+
| 'inference-inpaint'
|
|
2663
|
+
| 'inference-inpaint-ip-adapter'
|
|
2476
2664
|
| 'inference-reference'
|
|
2477
2665
|
| 'inference-reference-texture'
|
|
2478
|
-
| 'inference-
|
|
2479
|
-
| 'inference-
|
|
2480
|
-
| 'inference-
|
|
2666
|
+
| 'inference-txt2img'
|
|
2667
|
+
| 'inference-txt2img-ip-adapter'
|
|
2668
|
+
| 'inference-txt2img-texture'
|
|
2481
2669
|
| 'patch'
|
|
2482
2670
|
| 'pixelization'
|
|
2483
2671
|
| 'reframe'
|
|
@@ -2489,13 +2677,13 @@ export namespace AssetListResponse {
|
|
|
2489
2677
|
| 'skybox-base-360'
|
|
2490
2678
|
| 'skybox-hdri'
|
|
2491
2679
|
| 'texture'
|
|
2492
|
-
| 'texture
|
|
2493
|
-
| 'texture
|
|
2494
|
-
| 'texture
|
|
2495
|
-
| 'texture
|
|
2496
|
-
| 'texture
|
|
2497
|
-
| 'texture
|
|
2498
|
-
| 'texture
|
|
2680
|
+
| 'texture-albedo'
|
|
2681
|
+
| 'texture-ao'
|
|
2682
|
+
| 'texture-edge'
|
|
2683
|
+
| 'texture-height'
|
|
2684
|
+
| 'texture-metallic'
|
|
2685
|
+
| 'texture-normal'
|
|
2686
|
+
| 'texture-smoothness'
|
|
2499
2687
|
| 'txt23d'
|
|
2500
2688
|
| 'txt2audio'
|
|
2501
2689
|
| 'txt2img'
|
|
@@ -2517,963 +2705,779 @@ export namespace AssetListResponse {
|
|
|
2517
2705
|
| 'voice-clone';
|
|
2518
2706
|
|
|
2519
2707
|
/**
|
|
2520
|
-
*
|
|
2708
|
+
* How angular is the surface? 0 is like a sphere, 1 is like a mechanical object
|
|
2521
2709
|
*/
|
|
2522
|
-
|
|
2710
|
+
angular?: number;
|
|
2523
2711
|
|
|
2524
2712
|
/**
|
|
2525
|
-
* The
|
|
2713
|
+
* The optional aspect ratio given for the generation, only applicable for some
|
|
2714
|
+
* models
|
|
2526
2715
|
*/
|
|
2527
|
-
|
|
2716
|
+
aspectRatio?: string;
|
|
2528
2717
|
|
|
2529
2718
|
/**
|
|
2530
|
-
*
|
|
2531
|
-
*
|
|
2719
|
+
* Int to set between 0 and 255 for the opacity of the background in the result
|
|
2720
|
+
* images.
|
|
2532
2721
|
*/
|
|
2533
|
-
|
|
2722
|
+
backgroundOpacity?: number;
|
|
2534
2723
|
|
|
2535
2724
|
/**
|
|
2536
|
-
*
|
|
2725
|
+
* The baseModelId that maybe changed at inference time
|
|
2537
2726
|
*/
|
|
2538
|
-
|
|
2727
|
+
baseModelId?: string;
|
|
2539
2728
|
|
|
2540
2729
|
/**
|
|
2541
|
-
*
|
|
2730
|
+
* A bounding box around the object of interest, in the format [x1, y1, x2, y2].
|
|
2542
2731
|
*/
|
|
2543
|
-
|
|
2732
|
+
bbox?: Array<number>;
|
|
2544
2733
|
|
|
2545
2734
|
/**
|
|
2546
|
-
*
|
|
2547
|
-
*
|
|
2548
|
-
* - the manual description
|
|
2549
|
-
* - the advanced captioning when the asset is used in training flow
|
|
2550
|
-
* - the automatic captioning
|
|
2735
|
+
* Remove small dark spots (i.e. “pepper”) and connect small bright cracks.
|
|
2551
2736
|
*/
|
|
2552
|
-
|
|
2737
|
+
betterQuality?: boolean;
|
|
2553
2738
|
|
|
2554
2739
|
/**
|
|
2555
|
-
* The
|
|
2556
|
-
*
|
|
2557
|
-
* Only available when an asset can be embedded (ie: not Detection maps)
|
|
2740
|
+
* The control image already processed by canny detector. Must reference an
|
|
2741
|
+
* existing AssetId.
|
|
2558
2742
|
*/
|
|
2559
|
-
|
|
2743
|
+
cannyStructureImage?: string;
|
|
2560
2744
|
|
|
2561
2745
|
/**
|
|
2562
|
-
*
|
|
2563
|
-
*
|
|
2564
|
-
* Contains the assetId and the url of the first frame.
|
|
2746
|
+
* Activate clustering.
|
|
2565
2747
|
*/
|
|
2566
|
-
|
|
2748
|
+
clustering?: boolean;
|
|
2567
2749
|
|
|
2568
2750
|
/**
|
|
2569
|
-
*
|
|
2751
|
+
* Ensure upscaled tile have the same color histogram as original tile.
|
|
2570
2752
|
*/
|
|
2571
|
-
|
|
2753
|
+
colorCorrection?: boolean;
|
|
2754
|
+
|
|
2755
|
+
colorMode?: string;
|
|
2756
|
+
|
|
2757
|
+
colorPrecision?: number;
|
|
2572
2758
|
|
|
2573
2759
|
/**
|
|
2574
|
-
*
|
|
2575
|
-
*
|
|
2576
|
-
* Contains the assetId and the url of the last frame.
|
|
2760
|
+
* Flux Kontext LoRA to style the image. For Flux Kontext Prompt Editing.
|
|
2577
2761
|
*/
|
|
2578
|
-
|
|
2762
|
+
concepts?: Array<Metadata.Concept>;
|
|
2763
|
+
|
|
2764
|
+
contours?: Array<Array<Array<Array<number>>>>;
|
|
2579
2765
|
|
|
2580
2766
|
/**
|
|
2581
|
-
*
|
|
2767
|
+
* End step for control.
|
|
2582
2768
|
*/
|
|
2583
|
-
|
|
2769
|
+
controlEnd?: number;
|
|
2584
2770
|
|
|
2585
2771
|
/**
|
|
2586
|
-
* The
|
|
2587
|
-
*
|
|
2588
|
-
* Contains the url of the original file. without any conversion. Only available
|
|
2589
|
-
* for some specific video, audio and threeD assets. Is only specified if the given
|
|
2590
|
-
* asset data has been replaced with a new file during the creation of the asset.
|
|
2772
|
+
* The date when the asset was copied to a project
|
|
2591
2773
|
*/
|
|
2592
|
-
|
|
2774
|
+
copiedAt?: string;
|
|
2775
|
+
|
|
2776
|
+
cornerThreshold?: number;
|
|
2593
2777
|
|
|
2594
2778
|
/**
|
|
2595
|
-
*
|
|
2596
|
-
*
|
|
2597
|
-
*
|
|
2779
|
+
* Allow the generation of "hallucinations" during the upscale process, which adds
|
|
2780
|
+
* additional details and deviates from the original image. Default: optimized for
|
|
2781
|
+
* your preset and style.
|
|
2598
2782
|
*/
|
|
2599
|
-
|
|
2783
|
+
creativity?: number;
|
|
2600
2784
|
|
|
2601
2785
|
/**
|
|
2602
|
-
* The
|
|
2603
|
-
*
|
|
2604
|
-
* Contains the assetId and the url of the preview.
|
|
2786
|
+
* Amount of decay in creativity over the upscale process. The lowest the value,
|
|
2787
|
+
* the less the creativity will be preserved over the upscale process.
|
|
2605
2788
|
*/
|
|
2606
|
-
|
|
2789
|
+
creativityDecay?: number;
|
|
2607
2790
|
|
|
2608
2791
|
/**
|
|
2609
|
-
*
|
|
2610
|
-
*
|
|
2611
|
-
* Contains the assetId and the url of the thumbnail.
|
|
2792
|
+
* If true, use the default parameters
|
|
2612
2793
|
*/
|
|
2613
|
-
|
|
2614
|
-
}
|
|
2794
|
+
defaultParameters?: boolean;
|
|
2615
2795
|
|
|
2616
|
-
export namespace Asset {
|
|
2617
2796
|
/**
|
|
2618
|
-
*
|
|
2797
|
+
* The depth fidelity if a depth image provided
|
|
2619
2798
|
*/
|
|
2620
|
-
|
|
2621
|
-
kind: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
|
|
2622
|
-
|
|
2623
|
-
/**
|
|
2624
|
-
* The type of the asset. Ex: 'inference-txt2img' will represent an asset generated
|
|
2625
|
-
* from a text to image model
|
|
2626
|
-
*/
|
|
2627
|
-
type:
|
|
2628
|
-
| '3d-texture'
|
|
2629
|
-
| '3d-texture-albedo'
|
|
2630
|
-
| '3d-texture-metallic'
|
|
2631
|
-
| '3d-texture-mtl'
|
|
2632
|
-
| '3d-texture-normal'
|
|
2633
|
-
| '3d-texture-roughness'
|
|
2634
|
-
| '3d23d'
|
|
2635
|
-
| '3d23d-texture'
|
|
2636
|
-
| 'audio2audio'
|
|
2637
|
-
| 'background-removal'
|
|
2638
|
-
| 'canvas'
|
|
2639
|
-
| 'canvas-drawing'
|
|
2640
|
-
| 'canvas-export'
|
|
2641
|
-
| 'detection'
|
|
2642
|
-
| 'generative-fill'
|
|
2643
|
-
| 'image-prompt-editing'
|
|
2644
|
-
| 'img23d'
|
|
2645
|
-
| 'img2img'
|
|
2646
|
-
| 'img2video'
|
|
2647
|
-
| 'inference-controlnet'
|
|
2648
|
-
| 'inference-controlnet-img2img'
|
|
2649
|
-
| 'inference-controlnet-inpaint'
|
|
2650
|
-
| 'inference-controlnet-inpaint-ip-adapter'
|
|
2651
|
-
| 'inference-controlnet-ip-adapter'
|
|
2652
|
-
| 'inference-controlnet-reference'
|
|
2653
|
-
| 'inference-controlnet-texture'
|
|
2654
|
-
| 'inference-img2img'
|
|
2655
|
-
| 'inference-img2img-ip-adapter'
|
|
2656
|
-
| 'inference-img2img-texture'
|
|
2657
|
-
| 'inference-inpaint'
|
|
2658
|
-
| 'inference-inpaint-ip-adapter'
|
|
2659
|
-
| 'inference-reference'
|
|
2660
|
-
| 'inference-reference-texture'
|
|
2661
|
-
| 'inference-txt2img'
|
|
2662
|
-
| 'inference-txt2img-ip-adapter'
|
|
2663
|
-
| 'inference-txt2img-texture'
|
|
2664
|
-
| 'patch'
|
|
2665
|
-
| 'pixelization'
|
|
2666
|
-
| 'reframe'
|
|
2667
|
-
| 'restyle'
|
|
2668
|
-
| 'segment'
|
|
2669
|
-
| 'segmentation-image'
|
|
2670
|
-
| 'segmentation-mask'
|
|
2671
|
-
| 'skybox-3d'
|
|
2672
|
-
| 'skybox-base-360'
|
|
2673
|
-
| 'skybox-hdri'
|
|
2674
|
-
| 'texture'
|
|
2675
|
-
| 'texture-albedo'
|
|
2676
|
-
| 'texture-ao'
|
|
2677
|
-
| 'texture-edge'
|
|
2678
|
-
| 'texture-height'
|
|
2679
|
-
| 'texture-metallic'
|
|
2680
|
-
| 'texture-normal'
|
|
2681
|
-
| 'texture-smoothness'
|
|
2682
|
-
| 'txt23d'
|
|
2683
|
-
| 'txt2audio'
|
|
2684
|
-
| 'txt2img'
|
|
2685
|
-
| 'txt2video'
|
|
2686
|
-
| 'unknown'
|
|
2687
|
-
| 'uploaded'
|
|
2688
|
-
| 'uploaded-3d'
|
|
2689
|
-
| 'uploaded-audio'
|
|
2690
|
-
| 'uploaded-avatar'
|
|
2691
|
-
| 'uploaded-video'
|
|
2692
|
-
| 'upscale'
|
|
2693
|
-
| 'upscale-skybox'
|
|
2694
|
-
| 'upscale-texture'
|
|
2695
|
-
| 'upscale-video'
|
|
2696
|
-
| 'vectorization'
|
|
2697
|
-
| 'video23d'
|
|
2698
|
-
| 'video2img'
|
|
2699
|
-
| 'video2video'
|
|
2700
|
-
| 'voice-clone';
|
|
2701
|
-
|
|
2702
|
-
/**
|
|
2703
|
-
* How angular is the surface? 0 is like a sphere, 1 is like a mechanical object
|
|
2704
|
-
*/
|
|
2705
|
-
angular?: number;
|
|
2706
|
-
|
|
2707
|
-
/**
|
|
2708
|
-
* The optional aspect ratio given for the generation, only applicable for some
|
|
2709
|
-
* models
|
|
2710
|
-
*/
|
|
2711
|
-
aspectRatio?: string;
|
|
2712
|
-
|
|
2713
|
-
/**
|
|
2714
|
-
* Int to set between 0 and 255 for the opacity of the background in the result
|
|
2715
|
-
* images.
|
|
2716
|
-
*/
|
|
2717
|
-
backgroundOpacity?: number;
|
|
2718
|
-
|
|
2719
|
-
/**
|
|
2720
|
-
* The baseModelId that maybe changed at inference time
|
|
2721
|
-
*/
|
|
2722
|
-
baseModelId?: string;
|
|
2723
|
-
|
|
2724
|
-
/**
|
|
2725
|
-
* A bounding box around the object of interest, in the format [x1, y1, x2, y2].
|
|
2726
|
-
*/
|
|
2727
|
-
bbox?: Array<number>;
|
|
2728
|
-
|
|
2729
|
-
/**
|
|
2730
|
-
* Remove small dark spots (i.e. “pepper”) and connect small bright cracks.
|
|
2731
|
-
*/
|
|
2732
|
-
betterQuality?: boolean;
|
|
2733
|
-
|
|
2734
|
-
/**
|
|
2735
|
-
* The control image already processed by canny detector. Must reference an
|
|
2736
|
-
* existing AssetId.
|
|
2737
|
-
*/
|
|
2738
|
-
cannyStructureImage?: string;
|
|
2739
|
-
|
|
2740
|
-
/**
|
|
2741
|
-
* Activate clustering.
|
|
2742
|
-
*/
|
|
2743
|
-
clustering?: boolean;
|
|
2744
|
-
|
|
2745
|
-
/**
|
|
2746
|
-
* Ensure upscaled tile have the same color histogram as original tile.
|
|
2747
|
-
*/
|
|
2748
|
-
colorCorrection?: boolean;
|
|
2749
|
-
|
|
2750
|
-
colorMode?: string;
|
|
2751
|
-
|
|
2752
|
-
colorPrecision?: number;
|
|
2753
|
-
|
|
2754
|
-
/**
|
|
2755
|
-
* Flux Kontext LoRA to style the image. For Flux Kontext Prompt Editing.
|
|
2756
|
-
*/
|
|
2757
|
-
concepts?: Array<Metadata.Concept>;
|
|
2758
|
-
|
|
2759
|
-
contours?: Array<Array<Array<Array<number>>>>;
|
|
2760
|
-
|
|
2761
|
-
/**
|
|
2762
|
-
* End step for control.
|
|
2763
|
-
*/
|
|
2764
|
-
controlEnd?: number;
|
|
2765
|
-
|
|
2766
|
-
/**
|
|
2767
|
-
* The date when the asset was copied to a project
|
|
2768
|
-
*/
|
|
2769
|
-
copiedAt?: string;
|
|
2770
|
-
|
|
2771
|
-
cornerThreshold?: number;
|
|
2772
|
-
|
|
2773
|
-
/**
|
|
2774
|
-
* Allow the generation of "hallucinations" during the upscale process, which adds
|
|
2775
|
-
* additional details and deviates from the original image. Default: optimized for
|
|
2776
|
-
* your preset and style.
|
|
2777
|
-
*/
|
|
2778
|
-
creativity?: number;
|
|
2779
|
-
|
|
2780
|
-
/**
|
|
2781
|
-
* Amount of decay in creativity over the upscale process. The lowest the value,
|
|
2782
|
-
* the less the creativity will be preserved over the upscale process.
|
|
2783
|
-
*/
|
|
2784
|
-
creativityDecay?: number;
|
|
2785
|
-
|
|
2786
|
-
/**
|
|
2787
|
-
* If true, use the default parameters
|
|
2788
|
-
*/
|
|
2789
|
-
defaultParameters?: boolean;
|
|
2790
|
-
|
|
2791
|
-
/**
|
|
2792
|
-
* The depth fidelity if a depth image provided
|
|
2793
|
-
*/
|
|
2794
|
-
depthFidelity?: number;
|
|
2795
|
-
|
|
2796
|
-
/**
|
|
2797
|
-
* The control image processed by depth estimator. Must reference an existing
|
|
2798
|
-
* AssetId.
|
|
2799
|
-
*/
|
|
2800
|
-
depthImage?: string;
|
|
2801
|
-
|
|
2802
|
-
/**
|
|
2803
|
-
* Amount of details to remove or add
|
|
2804
|
-
*/
|
|
2805
|
-
detailsLevel?: number;
|
|
2806
|
-
|
|
2807
|
-
/**
|
|
2808
|
-
* The number of pixels to dilate the result masks.
|
|
2809
|
-
*/
|
|
2810
|
-
dilate?: number;
|
|
2799
|
+
depthFidelity?: number;
|
|
2811
2800
|
|
|
2812
|
-
|
|
2813
|
-
|
|
2814
|
-
|
|
2815
|
-
|
|
2816
|
-
|
|
2817
|
-
filterSpeckle?: number;
|
|
2818
|
-
|
|
2819
|
-
/**
|
|
2820
|
-
* Determine the scale at which the upscale process works.
|
|
2821
|
-
*
|
|
2822
|
-
* - With a small value, the upscale works at the largest scale, resulting in fewer
|
|
2823
|
-
* added details and more coherent images. Ideal for portraits, for example.
|
|
2824
|
-
* - With a large value, the upscale works at the smallest scale, resulting in more
|
|
2825
|
-
* added details and more hallucinations. Ideal for landscapes, for example.
|
|
2826
|
-
*
|
|
2827
|
-
* (info): A small value is slower and more expensive to run.
|
|
2828
|
-
*/
|
|
2829
|
-
fractality?: number;
|
|
2830
|
-
|
|
2831
|
-
/**
|
|
2832
|
-
* Apply extra control to the Skybox 360 geometry. The higher the value, the more
|
|
2833
|
-
* the 360 geometry will influence the generated skybox image.
|
|
2834
|
-
*
|
|
2835
|
-
* Use with caution. Default is adapted to the other parameters.
|
|
2836
|
-
*/
|
|
2837
|
-
geometryEnforcement?: number;
|
|
2838
|
-
|
|
2839
|
-
/**
|
|
2840
|
-
* The guidance used to generate this asset
|
|
2841
|
-
*/
|
|
2842
|
-
guidance?: number;
|
|
2843
|
-
|
|
2844
|
-
halfMode?: boolean;
|
|
2845
|
-
|
|
2846
|
-
hdr?: number;
|
|
2847
|
-
|
|
2848
|
-
height?: number;
|
|
2849
|
-
|
|
2850
|
-
/**
|
|
2851
|
-
* High threshold for Canny detector
|
|
2852
|
-
*/
|
|
2853
|
-
highThreshold?: number;
|
|
2854
|
-
|
|
2855
|
-
/**
|
|
2856
|
-
* (deprecated) Horizontal expansion ratio.
|
|
2857
|
-
*/
|
|
2858
|
-
horizontalExpansionRatio?: number;
|
|
2801
|
+
/**
|
|
2802
|
+
* The control image processed by depth estimator. Must reference an existing
|
|
2803
|
+
* AssetId.
|
|
2804
|
+
*/
|
|
2805
|
+
depthImage?: string;
|
|
2859
2806
|
|
|
2860
|
-
|
|
2861
|
-
|
|
2862
|
-
|
|
2863
|
-
|
|
2807
|
+
/**
|
|
2808
|
+
* Amount of details to remove or add
|
|
2809
|
+
*/
|
|
2810
|
+
detailsLevel?: number;
|
|
2864
2811
|
|
|
2865
|
-
|
|
2866
|
-
|
|
2867
|
-
|
|
2868
|
-
|
|
2869
|
-
imageFidelity?: number;
|
|
2812
|
+
/**
|
|
2813
|
+
* The number of pixels to dilate the result masks.
|
|
2814
|
+
*/
|
|
2815
|
+
dilate?: number;
|
|
2870
2816
|
|
|
2871
|
-
|
|
2872
|
-
|
|
2873
|
-
|
|
2874
|
-
|
|
2875
|
-
imageType?: 'seamfull' | 'skybox' | 'texture';
|
|
2817
|
+
/**
|
|
2818
|
+
* Contrast factor for Grayscale detector
|
|
2819
|
+
*/
|
|
2820
|
+
factor?: number;
|
|
2876
2821
|
|
|
2877
|
-
|
|
2878
|
-
* The id of the Inference describing how this image was generated
|
|
2879
|
-
*/
|
|
2880
|
-
inferenceId?: string;
|
|
2822
|
+
filterSpeckle?: number;
|
|
2881
2823
|
|
|
2882
|
-
|
|
2883
|
-
|
|
2884
|
-
|
|
2885
|
-
|
|
2886
|
-
|
|
2887
|
-
|
|
2888
|
-
|
|
2889
|
-
|
|
2890
|
-
|
|
2891
|
-
|
|
2892
|
-
|
|
2893
|
-
*/
|
|
2894
|
-
inputFidelity?: 'high' | 'low';
|
|
2824
|
+
/**
|
|
2825
|
+
* Determine the scale at which the upscale process works.
|
|
2826
|
+
*
|
|
2827
|
+
* - With a small value, the upscale works at the largest scale, resulting in fewer
|
|
2828
|
+
* added details and more coherent images. Ideal for portraits, for example.
|
|
2829
|
+
* - With a large value, the upscale works at the smallest scale, resulting in more
|
|
2830
|
+
* added details and more hallucinations. Ideal for landscapes, for example.
|
|
2831
|
+
*
|
|
2832
|
+
* (info): A small value is slower and more expensive to run.
|
|
2833
|
+
*/
|
|
2834
|
+
fractality?: number;
|
|
2895
2835
|
|
|
2896
|
-
|
|
2897
|
-
|
|
2898
|
-
|
|
2899
|
-
|
|
2836
|
+
/**
|
|
2837
|
+
* Apply extra control to the Skybox 360 geometry. The higher the value, the more
|
|
2838
|
+
* the 360 geometry will influence the generated skybox image.
|
|
2839
|
+
*
|
|
2840
|
+
* Use with caution. Default is adapted to the other parameters.
|
|
2841
|
+
*/
|
|
2842
|
+
geometryEnforcement?: number;
|
|
2900
2843
|
|
|
2901
|
-
|
|
2902
|
-
|
|
2903
|
-
|
|
2904
|
-
|
|
2844
|
+
/**
|
|
2845
|
+
* The guidance used to generate this asset
|
|
2846
|
+
*/
|
|
2847
|
+
guidance?: number;
|
|
2905
2848
|
|
|
2906
|
-
|
|
2907
|
-
* How polished is the surface? 0 is like a rough surface, 1 is like a mirror
|
|
2908
|
-
*/
|
|
2909
|
-
keypointThreshold?: number;
|
|
2849
|
+
halfMode?: boolean;
|
|
2910
2850
|
|
|
2911
|
-
|
|
2851
|
+
hdr?: number;
|
|
2912
2852
|
|
|
2913
|
-
|
|
2853
|
+
height?: number;
|
|
2914
2854
|
|
|
2915
|
-
|
|
2916
|
-
|
|
2917
|
-
|
|
2918
|
-
|
|
2855
|
+
/**
|
|
2856
|
+
* High threshold for Canny detector
|
|
2857
|
+
*/
|
|
2858
|
+
highThreshold?: number;
|
|
2919
2859
|
|
|
2920
|
-
|
|
2921
|
-
|
|
2922
|
-
|
|
2923
|
-
|
|
2860
|
+
/**
|
|
2861
|
+
* (deprecated) Horizontal expansion ratio.
|
|
2862
|
+
*/
|
|
2863
|
+
horizontalExpansionRatio?: number;
|
|
2924
2864
|
|
|
2925
|
-
|
|
2926
|
-
|
|
2927
|
-
|
|
2928
|
-
|
|
2865
|
+
/**
|
|
2866
|
+
* The input image to process. Must reference an existing AssetId or be a data URL.
|
|
2867
|
+
*/
|
|
2868
|
+
image?: string;
|
|
2929
2869
|
|
|
2930
|
-
|
|
2870
|
+
/**
|
|
2871
|
+
* Strengthen the similarity to the original image during the upscale. Default:
|
|
2872
|
+
* optimized for your preset and style.
|
|
2873
|
+
*/
|
|
2874
|
+
imageFidelity?: number;
|
|
2931
2875
|
|
|
2932
|
-
|
|
2933
|
-
|
|
2934
|
-
|
|
2935
|
-
|
|
2876
|
+
/**
|
|
2877
|
+
* Preserve the seamless properties of skybox or texture images. Input has to be of
|
|
2878
|
+
* same type (seamless).
|
|
2879
|
+
*/
|
|
2880
|
+
imageType?: 'seamfull' | 'skybox' | 'texture';
|
|
2936
2881
|
|
|
2937
|
-
|
|
2938
|
-
|
|
2939
|
-
|
|
2940
|
-
|
|
2882
|
+
/**
|
|
2883
|
+
* The id of the Inference describing how this image was generated
|
|
2884
|
+
*/
|
|
2885
|
+
inferenceId?: string;
|
|
2941
2886
|
|
|
2942
|
-
|
|
2943
|
-
|
|
2944
|
-
|
|
2945
|
-
|
|
2946
|
-
|
|
2947
|
-
|
|
2948
|
-
|
|
2949
|
-
|
|
2950
|
-
|
|
2951
|
-
|
|
2952
|
-
|
|
2953
|
-
|
|
2954
|
-
|
|
2955
|
-
| 'sketch';
|
|
2887
|
+
/**
|
|
2888
|
+
* When set to `high`, allows to better preserve details from the input images in
|
|
2889
|
+
* the output. This is especially useful when using images that contain elements
|
|
2890
|
+
* like faces or logos that require accurate preservation in the generated image.
|
|
2891
|
+
*
|
|
2892
|
+
* You can provide multiple input images that will all be preserved with high
|
|
2893
|
+
* fidelity, but keep in mind that the first image will be preserved with richer
|
|
2894
|
+
* textures and finer details, so if you include elements such as faces, consider
|
|
2895
|
+
* placing them in the first image.
|
|
2896
|
+
*
|
|
2897
|
+
* Only available for the `gpt-image-1` model.
|
|
2898
|
+
*/
|
|
2899
|
+
inputFidelity?: 'high' | 'low';
|
|
2956
2900
|
|
|
2957
|
-
|
|
2901
|
+
/**
|
|
2902
|
+
* Location of the input image in the output.
|
|
2903
|
+
*/
|
|
2904
|
+
inputLocation?: 'bottom' | 'left' | 'middle' | 'right' | 'top';
|
|
2958
2905
|
|
|
2959
|
-
|
|
2960
|
-
|
|
2961
|
-
|
|
2962
|
-
|
|
2906
|
+
/**
|
|
2907
|
+
* To invert the relief
|
|
2908
|
+
*/
|
|
2909
|
+
invert?: boolean;
|
|
2963
2910
|
|
|
2964
|
-
|
|
2965
|
-
|
|
2966
|
-
|
|
2967
|
-
|
|
2968
|
-
| 'custom'
|
|
2969
|
-
| 'elevenlabs-voice'
|
|
2970
|
-
| 'flux.1'
|
|
2971
|
-
| 'flux.1-composition'
|
|
2972
|
-
| 'flux.1-kontext-dev'
|
|
2973
|
-
| 'flux.1-kontext-lora'
|
|
2974
|
-
| 'flux.1-krea-dev'
|
|
2975
|
-
| 'flux.1-krea-lora'
|
|
2976
|
-
| 'flux.1-lora'
|
|
2977
|
-
| 'flux.1-pro'
|
|
2978
|
-
| 'flux.1.1-pro-ultra'
|
|
2979
|
-
| 'flux.2-dev-edit-lora'
|
|
2980
|
-
| 'flux.2-dev-lora'
|
|
2981
|
-
| 'flux.2-klein-4b-edit-lora'
|
|
2982
|
-
| 'flux.2-klein-4b-lora'
|
|
2983
|
-
| 'flux.2-klein-9b-edit-lora'
|
|
2984
|
-
| 'flux.2-klein-9b-lora'
|
|
2985
|
-
| 'flux.2-klein-base-4b-edit-lora'
|
|
2986
|
-
| 'flux.2-klein-base-4b-lora'
|
|
2987
|
-
| 'flux.2-klein-base-9b-edit-lora'
|
|
2988
|
-
| 'flux.2-klein-base-9b-lora'
|
|
2989
|
-
| 'flux1.1-pro'
|
|
2990
|
-
| 'gpt-image-1'
|
|
2991
|
-
| 'qwen-image-2512-lora'
|
|
2992
|
-
| 'qwen-image-edit-2509-lora'
|
|
2993
|
-
| 'qwen-image-edit-2511-lora'
|
|
2994
|
-
| 'qwen-image-edit-lora'
|
|
2995
|
-
| 'qwen-image-lora'
|
|
2996
|
-
| 'sd-1_5'
|
|
2997
|
-
| 'sd-1_5-composition'
|
|
2998
|
-
| 'sd-1_5-lora'
|
|
2999
|
-
| 'sd-xl'
|
|
3000
|
-
| 'sd-xl-composition'
|
|
3001
|
-
| 'sd-xl-lora'
|
|
3002
|
-
| 'zimage-de-turbo-lora'
|
|
3003
|
-
| 'zimage-lora'
|
|
3004
|
-
| 'zimage-turbo-lora';
|
|
2911
|
+
/**
|
|
2912
|
+
* How polished is the surface? 0 is like a rough surface, 1 is like a mirror
|
|
2913
|
+
*/
|
|
2914
|
+
keypointThreshold?: number;
|
|
3005
2915
|
|
|
3006
|
-
|
|
2916
|
+
layerDifference?: number;
|
|
3007
2917
|
|
|
3008
|
-
|
|
2918
|
+
lengthThreshold?: number;
|
|
3009
2919
|
|
|
3010
|
-
|
|
3011
|
-
|
|
3012
|
-
|
|
3013
|
-
|
|
2920
|
+
/**
|
|
2921
|
+
* The ISO timestamp when the lock on the canvas will expire
|
|
2922
|
+
*/
|
|
2923
|
+
lockExpiresAt?: string;
|
|
3014
2924
|
|
|
3015
|
-
|
|
3016
|
-
|
|
3017
|
-
|
|
3018
|
-
|
|
3019
|
-
*/
|
|
3020
|
-
negativePromptStrength?: number;
|
|
2925
|
+
/**
|
|
2926
|
+
* Low threshold for Canny detector
|
|
2927
|
+
*/
|
|
2928
|
+
lowThreshold?: number;
|
|
3021
2929
|
|
|
3022
|
-
|
|
3023
|
-
|
|
3024
|
-
|
|
3025
|
-
|
|
2930
|
+
/**
|
|
2931
|
+
* The mask used for the asset generation or editing
|
|
2932
|
+
*/
|
|
2933
|
+
mask?: string;
|
|
3026
2934
|
|
|
3027
|
-
|
|
3028
|
-
* The number of outputs to generate.
|
|
3029
|
-
*/
|
|
3030
|
-
numOutputs?: number;
|
|
2935
|
+
maxIterations?: number;
|
|
3031
2936
|
|
|
3032
|
-
|
|
2937
|
+
/**
|
|
2938
|
+
* Maximum threshold for Grayscale conversion
|
|
2939
|
+
*/
|
|
2940
|
+
maxThreshold?: number;
|
|
3033
2941
|
|
|
3034
|
-
|
|
2942
|
+
/**
|
|
2943
|
+
* Minimum threshold for Grayscale conversion
|
|
2944
|
+
*/
|
|
2945
|
+
minThreshold?: number;
|
|
3035
2946
|
|
|
3036
|
-
|
|
3037
|
-
|
|
3038
|
-
|
|
3039
|
-
|
|
2947
|
+
/**
|
|
2948
|
+
* Modality to detect
|
|
2949
|
+
*/
|
|
2950
|
+
modality?:
|
|
2951
|
+
| 'canny'
|
|
2952
|
+
| 'depth'
|
|
2953
|
+
| 'grayscale'
|
|
2954
|
+
| 'lineart_anime'
|
|
2955
|
+
| 'mlsd'
|
|
2956
|
+
| 'normal'
|
|
2957
|
+
| 'pose'
|
|
2958
|
+
| 'scribble'
|
|
2959
|
+
| 'segmentation'
|
|
2960
|
+
| 'sketch';
|
|
3040
2961
|
|
|
3041
|
-
|
|
3042
|
-
* Override the embeddings of the model. Only your prompt and negativePrompt will
|
|
3043
|
-
* be used. Use with caution.
|
|
3044
|
-
*/
|
|
3045
|
-
overrideEmbeddings?: boolean;
|
|
2962
|
+
mode?: string;
|
|
3046
2963
|
|
|
3047
|
-
|
|
2964
|
+
/**
|
|
2965
|
+
* The modelId used to generate this asset
|
|
2966
|
+
*/
|
|
2967
|
+
modelId?: string;
|
|
3048
2968
|
|
|
3049
|
-
|
|
2969
|
+
/**
|
|
2970
|
+
* The type of the generator used
|
|
2971
|
+
*/
|
|
2972
|
+
modelType?:
|
|
2973
|
+
| 'custom'
|
|
2974
|
+
| 'elevenlabs-voice'
|
|
2975
|
+
| 'flux.1'
|
|
2976
|
+
| 'flux.1-composition'
|
|
2977
|
+
| 'flux.1-kontext-dev'
|
|
2978
|
+
| 'flux.1-kontext-lora'
|
|
2979
|
+
| 'flux.1-krea-dev'
|
|
2980
|
+
| 'flux.1-krea-lora'
|
|
2981
|
+
| 'flux.1-lora'
|
|
2982
|
+
| 'flux.1-pro'
|
|
2983
|
+
| 'flux.1.1-pro-ultra'
|
|
2984
|
+
| 'flux.2-dev-edit-lora'
|
|
2985
|
+
| 'flux.2-dev-lora'
|
|
2986
|
+
| 'flux.2-klein-4b-edit-lora'
|
|
2987
|
+
| 'flux.2-klein-4b-lora'
|
|
2988
|
+
| 'flux.2-klein-9b-edit-lora'
|
|
2989
|
+
| 'flux.2-klein-9b-lora'
|
|
2990
|
+
| 'flux.2-klein-base-4b-edit-lora'
|
|
2991
|
+
| 'flux.2-klein-base-4b-lora'
|
|
2992
|
+
| 'flux.2-klein-base-9b-edit-lora'
|
|
2993
|
+
| 'flux.2-klein-base-9b-lora'
|
|
2994
|
+
| 'flux1.1-pro'
|
|
2995
|
+
| 'gpt-image-1'
|
|
2996
|
+
| 'qwen-image-2512-lora'
|
|
2997
|
+
| 'qwen-image-edit-2509-lora'
|
|
2998
|
+
| 'qwen-image-edit-2511-lora'
|
|
2999
|
+
| 'qwen-image-edit-lora'
|
|
3000
|
+
| 'qwen-image-lora'
|
|
3001
|
+
| 'sd-1_5'
|
|
3002
|
+
| 'sd-1_5-composition'
|
|
3003
|
+
| 'sd-1_5-lora'
|
|
3004
|
+
| 'sd-xl'
|
|
3005
|
+
| 'sd-xl-composition'
|
|
3006
|
+
| 'sd-xl-lora'
|
|
3007
|
+
| 'zimage-de-turbo-lora'
|
|
3008
|
+
| 'zimage-lora'
|
|
3009
|
+
| 'zimage-turbo-lora';
|
|
3050
3010
|
|
|
3051
|
-
|
|
3011
|
+
name?: string;
|
|
3052
3012
|
|
|
3053
|
-
|
|
3054
|
-
* List of points (label, x, y) in the image where label = 0 for background and 1
|
|
3055
|
-
* for object.
|
|
3056
|
-
*/
|
|
3057
|
-
points?: Array<Array<number>>;
|
|
3013
|
+
nbMasks?: number;
|
|
3058
3014
|
|
|
3059
|
-
|
|
3060
|
-
|
|
3061
|
-
|
|
3062
|
-
|
|
3015
|
+
/**
|
|
3016
|
+
* The negative prompt used to generate this asset
|
|
3017
|
+
*/
|
|
3018
|
+
negativePrompt?: string;
|
|
3063
3019
|
|
|
3064
|
-
|
|
3020
|
+
/**
|
|
3021
|
+
* Controls the influence of the negative prompt. Default 0 means the negative
|
|
3022
|
+
* prompt has no effect. Higher values increase negative prompt influence. Must
|
|
3023
|
+
* be > 0 if negativePrompt is provided.
|
|
3024
|
+
*/
|
|
3025
|
+
negativePromptStrength?: number;
|
|
3065
3026
|
|
|
3066
|
-
|
|
3027
|
+
/**
|
|
3028
|
+
* The number of denoising steps for each image generation.
|
|
3029
|
+
*/
|
|
3030
|
+
numInferenceSteps?: number;
|
|
3067
3031
|
|
|
3068
|
-
|
|
3069
|
-
|
|
3070
|
-
|
|
3071
|
-
|
|
3032
|
+
/**
|
|
3033
|
+
* The number of outputs to generate.
|
|
3034
|
+
*/
|
|
3035
|
+
numOutputs?: number;
|
|
3072
3036
|
|
|
3073
|
-
|
|
3074
|
-
* Increase the fidelity to the prompt during upscale. Default: optimized for your
|
|
3075
|
-
* preset and style.
|
|
3076
|
-
*/
|
|
3077
|
-
promptFidelity?: number;
|
|
3037
|
+
originalAssetId?: string;
|
|
3078
3038
|
|
|
3079
|
-
|
|
3080
|
-
* How raised is the surface? 0 is flat like water, 1 is like a very rough rock
|
|
3081
|
-
*/
|
|
3082
|
-
raised?: number;
|
|
3039
|
+
outputIndex?: number;
|
|
3083
3040
|
|
|
3084
|
-
|
|
3085
|
-
|
|
3086
|
-
|
|
3087
|
-
|
|
3041
|
+
/**
|
|
3042
|
+
* Overlap percentage for the output image.
|
|
3043
|
+
*/
|
|
3044
|
+
overlapPercentage?: number;
|
|
3088
3045
|
|
|
3089
|
-
|
|
3090
|
-
|
|
3091
|
-
|
|
3092
|
-
|
|
3093
|
-
|
|
3094
|
-
* applied refinementSteps times.
|
|
3095
|
-
*/
|
|
3096
|
-
refinementSteps?: number;
|
|
3046
|
+
/**
|
|
3047
|
+
* Override the embeddings of the model. Only your prompt and negativePrompt will
|
|
3048
|
+
* be used. Use with caution.
|
|
3049
|
+
*/
|
|
3050
|
+
overrideEmbeddings?: boolean;
|
|
3097
3051
|
|
|
3098
|
-
|
|
3099
|
-
* Remove background for Grayscale detector
|
|
3100
|
-
*/
|
|
3101
|
-
removeBackground?: boolean;
|
|
3052
|
+
parentId?: string;
|
|
3102
3053
|
|
|
3103
|
-
|
|
3104
|
-
* Size proportion of the input image in the output.
|
|
3105
|
-
*/
|
|
3106
|
-
resizeOption?: number;
|
|
3054
|
+
parentJobId?: string;
|
|
3107
3055
|
|
|
3108
|
-
|
|
3109
|
-
|
|
3110
|
-
|
|
3111
|
-
|
|
3056
|
+
pathPrecision?: number;
|
|
3057
|
+
|
|
3058
|
+
/**
|
|
3059
|
+
* List of points (label, x, y) in the image where label = 0 for background and 1
|
|
3060
|
+
* for object.
|
|
3061
|
+
*/
|
|
3062
|
+
points?: Array<Array<number>>;
|
|
3112
3063
|
|
|
3113
|
-
|
|
3114
|
-
|
|
3115
|
-
|
|
3116
|
-
|
|
3064
|
+
/**
|
|
3065
|
+
* How polished is the surface? 0 is like a rough surface, 1 is like a mirror
|
|
3066
|
+
*/
|
|
3067
|
+
polished?: number;
|
|
3117
3068
|
|
|
3118
|
-
|
|
3119
|
-
* Boolean to able return the masks (binary image) in the response.
|
|
3120
|
-
*/
|
|
3121
|
-
resultMask?: boolean;
|
|
3069
|
+
preset?: string;
|
|
3122
3070
|
|
|
3123
|
-
|
|
3071
|
+
progressPercent?: number;
|
|
3124
3072
|
|
|
3125
|
-
|
|
3126
|
-
|
|
3127
|
-
|
|
3128
|
-
|
|
3129
|
-
saveFlipbook?: boolean;
|
|
3073
|
+
/**
|
|
3074
|
+
* The prompt that guided the asset generation or editing
|
|
3075
|
+
*/
|
|
3076
|
+
prompt?: string;
|
|
3130
3077
|
|
|
3131
|
-
|
|
3132
|
-
|
|
3133
|
-
|
|
3134
|
-
|
|
3078
|
+
/**
|
|
3079
|
+
* Increase the fidelity to the prompt during upscale. Default: optimized for your
|
|
3080
|
+
* preset and style.
|
|
3081
|
+
*/
|
|
3082
|
+
promptFidelity?: number;
|
|
3135
3083
|
|
|
3136
|
-
|
|
3137
|
-
|
|
3138
|
-
|
|
3139
|
-
|
|
3084
|
+
/**
|
|
3085
|
+
* How raised is the surface? 0 is flat like water, 1 is like a very rough rock
|
|
3086
|
+
*/
|
|
3087
|
+
raised?: number;
|
|
3140
3088
|
|
|
3141
|
-
|
|
3142
|
-
|
|
3143
|
-
|
|
3144
|
-
|
|
3145
|
-
seed?: string;
|
|
3089
|
+
/**
|
|
3090
|
+
* The reference images used for the asset generation or editing
|
|
3091
|
+
*/
|
|
3092
|
+
referenceImages?: Array<string>;
|
|
3146
3093
|
|
|
3147
|
-
|
|
3148
|
-
|
|
3149
|
-
|
|
3150
|
-
|
|
3094
|
+
/**
|
|
3095
|
+
* Additional refinement steps before scaling.
|
|
3096
|
+
*
|
|
3097
|
+
* If scalingFactor == 1, the refinement process will be applied (1 +
|
|
3098
|
+
* refinementSteps) times. If scalingFactor > 1, the refinement process will be
|
|
3099
|
+
* applied refinementSteps times.
|
|
3100
|
+
*/
|
|
3101
|
+
refinementSteps?: number;
|
|
3151
3102
|
|
|
3152
|
-
|
|
3153
|
-
|
|
3154
|
-
|
|
3155
|
-
|
|
3103
|
+
/**
|
|
3104
|
+
* Remove background for Grayscale detector
|
|
3105
|
+
*/
|
|
3106
|
+
removeBackground?: boolean;
|
|
3156
3107
|
|
|
3157
|
-
|
|
3108
|
+
/**
|
|
3109
|
+
* Size proportion of the input image in the output.
|
|
3110
|
+
*/
|
|
3111
|
+
resizeOption?: number;
|
|
3158
3112
|
|
|
3159
|
-
|
|
3160
|
-
|
|
3161
|
-
|
|
3162
|
-
|
|
3113
|
+
/**
|
|
3114
|
+
* Boolean to output the contours.
|
|
3115
|
+
*/
|
|
3116
|
+
resultContours?: boolean;
|
|
3163
3117
|
|
|
3164
|
-
|
|
3118
|
+
/**
|
|
3119
|
+
* Boolean to able output the cut out object.
|
|
3120
|
+
*/
|
|
3121
|
+
resultImage?: boolean;
|
|
3165
3122
|
|
|
3166
|
-
|
|
3123
|
+
/**
|
|
3124
|
+
* Boolean to able return the masks (binary image) in the response.
|
|
3125
|
+
*/
|
|
3126
|
+
resultMask?: boolean;
|
|
3167
3127
|
|
|
3168
|
-
|
|
3169
|
-
* The strength
|
|
3170
|
-
*
|
|
3171
|
-
* Only available for the `flux-kontext` LoRA model.
|
|
3172
|
-
*/
|
|
3173
|
-
strength?: number;
|
|
3128
|
+
rootParentId?: string;
|
|
3174
3129
|
|
|
3175
|
-
|
|
3176
|
-
|
|
3177
|
-
|
|
3178
|
-
|
|
3130
|
+
/**
|
|
3131
|
+
* Save a flipbook of the texture. Deactivated when the input texture is larger
|
|
3132
|
+
* than 2048x2048px
|
|
3133
|
+
*/
|
|
3134
|
+
saveFlipbook?: boolean;
|
|
3179
3135
|
|
|
3180
|
-
|
|
3181
|
-
|
|
3182
|
-
|
|
3183
|
-
|
|
3184
|
-
structureImage?: string;
|
|
3136
|
+
/**
|
|
3137
|
+
* Scaling factor (when `targetWidth` not specified)
|
|
3138
|
+
*/
|
|
3139
|
+
scalingFactor?: number;
|
|
3185
3140
|
|
|
3186
|
-
|
|
3187
|
-
|
|
3188
|
-
|
|
3189
|
-
|
|
3190
|
-
| 'cartoon'
|
|
3191
|
-
| 'cinematic'
|
|
3192
|
-
| 'claymation'
|
|
3193
|
-
| 'cloud-skydome'
|
|
3194
|
-
| 'comic'
|
|
3195
|
-
| 'cyberpunk'
|
|
3196
|
-
| 'enchanted'
|
|
3197
|
-
| 'fantasy'
|
|
3198
|
-
| 'ink'
|
|
3199
|
-
| 'manga'
|
|
3200
|
-
| 'manga-color'
|
|
3201
|
-
| 'minimalist'
|
|
3202
|
-
| 'neon-tron'
|
|
3203
|
-
| 'oil-painting'
|
|
3204
|
-
| 'pastel'
|
|
3205
|
-
| 'photo'
|
|
3206
|
-
| 'photography'
|
|
3207
|
-
| 'psychedelic'
|
|
3208
|
-
| 'retro-fantasy'
|
|
3209
|
-
| 'scifi-concept-art'
|
|
3210
|
-
| 'space'
|
|
3211
|
-
| 'standard'
|
|
3212
|
-
| 'whimsical';
|
|
3141
|
+
/**
|
|
3142
|
+
* The scheduler used to generate this asset
|
|
3143
|
+
*/
|
|
3144
|
+
scheduler?: string;
|
|
3213
3145
|
|
|
3214
|
-
|
|
3215
|
-
|
|
3216
|
-
|
|
3217
|
-
|
|
3146
|
+
/**
|
|
3147
|
+
* The seed used to generate this asset. <!> Can be a string or a number in some
|
|
3148
|
+
* cases <!>.
|
|
3149
|
+
*/
|
|
3150
|
+
seed?: string;
|
|
3218
3151
|
|
|
3219
|
-
|
|
3220
|
-
|
|
3221
|
-
|
|
3222
|
-
|
|
3223
|
-
styleImages?: Array<string>;
|
|
3152
|
+
/**
|
|
3153
|
+
* Sharpen tiles.
|
|
3154
|
+
*/
|
|
3155
|
+
sharpen?: boolean;
|
|
3224
3156
|
|
|
3225
|
-
|
|
3226
|
-
|
|
3227
|
-
|
|
3228
|
-
|
|
3229
|
-
styleImagesFidelity?: number;
|
|
3157
|
+
/**
|
|
3158
|
+
* How shiny is the surface? 0 is like a matte surface, 1 is like a diamond
|
|
3159
|
+
*/
|
|
3160
|
+
shiny?: number;
|
|
3230
3161
|
|
|
3231
|
-
|
|
3232
|
-
* The target height of the output image.
|
|
3233
|
-
*/
|
|
3234
|
-
targetHeight?: number;
|
|
3162
|
+
size?: number;
|
|
3235
3163
|
|
|
3236
|
-
|
|
3237
|
-
|
|
3238
|
-
|
|
3239
|
-
|
|
3164
|
+
/**
|
|
3165
|
+
* Activate sketch detection instead of canny.
|
|
3166
|
+
*/
|
|
3167
|
+
sketch?: boolean;
|
|
3240
3168
|
|
|
3241
|
-
|
|
3242
|
-
* A textual description / keywords describing the object of interest.
|
|
3243
|
-
*/
|
|
3244
|
-
text?: string;
|
|
3169
|
+
sourceProjectId?: string;
|
|
3245
3170
|
|
|
3246
|
-
|
|
3247
|
-
* The asset to convert in texture maps. Must reference an existing AssetId.
|
|
3248
|
-
*/
|
|
3249
|
-
texture?: string;
|
|
3171
|
+
spliceThreshold?: number;
|
|
3250
3172
|
|
|
3251
|
-
|
|
3252
|
-
|
|
3253
|
-
|
|
3254
|
-
|
|
3173
|
+
/**
|
|
3174
|
+
* The strength
|
|
3175
|
+
*
|
|
3176
|
+
* Only available for the `flux-kontext` LoRA model.
|
|
3177
|
+
*/
|
|
3178
|
+
strength?: number;
|
|
3255
3179
|
|
|
3256
|
-
|
|
3257
|
-
|
|
3258
|
-
|
|
3259
|
-
|
|
3260
|
-
*/
|
|
3261
|
-
tileStyle?: boolean;
|
|
3180
|
+
/**
|
|
3181
|
+
* Strength for the input image structure preservation
|
|
3182
|
+
*/
|
|
3183
|
+
structureFidelity?: number;
|
|
3262
3184
|
|
|
3263
|
-
|
|
3185
|
+
/**
|
|
3186
|
+
* The control image for structure. A canny detector will be applied to this image.
|
|
3187
|
+
* Must reference an existing AssetId.
|
|
3188
|
+
*/
|
|
3189
|
+
structureImage?: string;
|
|
3264
3190
|
|
|
3265
|
-
|
|
3266
|
-
|
|
3267
|
-
|
|
3268
|
-
|
|
3191
|
+
style?:
|
|
3192
|
+
| '3d-cartoon'
|
|
3193
|
+
| '3d-rendered'
|
|
3194
|
+
| 'anime'
|
|
3195
|
+
| 'cartoon'
|
|
3196
|
+
| 'cinematic'
|
|
3197
|
+
| 'claymation'
|
|
3198
|
+
| 'cloud-skydome'
|
|
3199
|
+
| 'comic'
|
|
3200
|
+
| 'cyberpunk'
|
|
3201
|
+
| 'enchanted'
|
|
3202
|
+
| 'fantasy'
|
|
3203
|
+
| 'ink'
|
|
3204
|
+
| 'manga'
|
|
3205
|
+
| 'manga-color'
|
|
3206
|
+
| 'minimalist'
|
|
3207
|
+
| 'neon-tron'
|
|
3208
|
+
| 'oil-painting'
|
|
3209
|
+
| 'pastel'
|
|
3210
|
+
| 'photo'
|
|
3211
|
+
| 'photography'
|
|
3212
|
+
| 'psychedelic'
|
|
3213
|
+
| 'retro-fantasy'
|
|
3214
|
+
| 'scifi-concept-art'
|
|
3215
|
+
| 'space'
|
|
3216
|
+
| 'standard'
|
|
3217
|
+
| 'whimsical';
|
|
3269
3218
|
|
|
3270
|
-
|
|
3271
|
-
|
|
3272
|
-
|
|
3273
|
-
|
|
3274
|
-
}
|
|
3219
|
+
/**
|
|
3220
|
+
* The higher the value the more it will look like the style image(s)
|
|
3221
|
+
*/
|
|
3222
|
+
styleFidelity?: number;
|
|
3275
3223
|
|
|
3276
|
-
|
|
3277
|
-
|
|
3278
|
-
|
|
3279
|
-
|
|
3280
|
-
|
|
3281
|
-
modelId: string;
|
|
3224
|
+
/**
|
|
3225
|
+
* List of style images. Most of the time, only one image is enough. It must be
|
|
3226
|
+
* existing AssetIds.
|
|
3227
|
+
*/
|
|
3228
|
+
styleImages?: Array<string>;
|
|
3282
3229
|
|
|
3283
|
-
|
|
3284
|
-
|
|
3285
|
-
|
|
3286
|
-
|
|
3287
|
-
|
|
3230
|
+
/**
|
|
3231
|
+
* Condition the influence of the style image(s). The higher the value, the more
|
|
3232
|
+
* the style images will influence the upscaled image.
|
|
3233
|
+
*/
|
|
3234
|
+
styleImagesFidelity?: number;
|
|
3288
3235
|
|
|
3289
|
-
|
|
3290
|
-
|
|
3291
|
-
|
|
3292
|
-
|
|
3293
|
-
modelEpoch?: string;
|
|
3294
|
-
}
|
|
3236
|
+
/**
|
|
3237
|
+
* The target height of the output image.
|
|
3238
|
+
*/
|
|
3239
|
+
targetHeight?: number;
|
|
3295
3240
|
|
|
3296
|
-
|
|
3297
|
-
|
|
3298
|
-
|
|
3299
|
-
|
|
3300
|
-
/**
|
|
3301
|
-
* The AssetId of the image used as a thumbnail for the canvas (example:
|
|
3302
|
-
* "asset_GTrL3mq4SXWyMxkOHRxlpw")
|
|
3303
|
-
*/
|
|
3304
|
-
assetId: string;
|
|
3241
|
+
/**
|
|
3242
|
+
* Target width for the upscaled image, take priority over scaling factor
|
|
3243
|
+
*/
|
|
3244
|
+
targetWidth?: number;
|
|
3305
3245
|
|
|
3306
|
-
|
|
3307
|
-
|
|
3308
|
-
|
|
3309
|
-
|
|
3310
|
-
}
|
|
3311
|
-
}
|
|
3246
|
+
/**
|
|
3247
|
+
* A textual description / keywords describing the object of interest.
|
|
3248
|
+
*/
|
|
3249
|
+
text?: string;
|
|
3312
3250
|
|
|
3313
3251
|
/**
|
|
3314
|
-
* The
|
|
3252
|
+
* The asset to convert in texture maps. Must reference an existing AssetId.
|
|
3315
3253
|
*/
|
|
3316
|
-
|
|
3317
|
-
size: number;
|
|
3254
|
+
texture?: string;
|
|
3318
3255
|
|
|
3319
|
-
|
|
3320
|
-
|
|
3321
|
-
|
|
3322
|
-
|
|
3256
|
+
/**
|
|
3257
|
+
* The thumbnail of the canvas
|
|
3258
|
+
*/
|
|
3259
|
+
thumbnail?: Metadata.Thumbnail;
|
|
3323
3260
|
|
|
3324
|
-
|
|
3325
|
-
|
|
3326
|
-
|
|
3327
|
-
|
|
3261
|
+
/**
|
|
3262
|
+
* If set to true, during the upscaling process, the model will match tiles of the
|
|
3263
|
+
* source image with tiles of the style image(s). This will result in a more
|
|
3264
|
+
* coherent restyle. Works best with style images that have a similar composition.
|
|
3265
|
+
*/
|
|
3266
|
+
tileStyle?: boolean;
|
|
3328
3267
|
|
|
3329
|
-
|
|
3330
|
-
* Number of bones if skeleton exists
|
|
3331
|
-
*/
|
|
3332
|
-
boneCount?: number;
|
|
3268
|
+
trainingImage?: boolean;
|
|
3333
3269
|
|
|
3334
|
-
|
|
3335
|
-
|
|
3336
|
-
|
|
3337
|
-
|
|
3270
|
+
/**
|
|
3271
|
+
* (deprecated) Vertical expansion ratio.
|
|
3272
|
+
*/
|
|
3273
|
+
verticalExpansionRatio?: number;
|
|
3338
3274
|
|
|
3339
|
-
|
|
3340
|
-
|
|
3341
|
-
|
|
3342
|
-
|
|
3275
|
+
/**
|
|
3276
|
+
* The width of the rendered image.
|
|
3277
|
+
*/
|
|
3278
|
+
width?: number;
|
|
3279
|
+
}
|
|
3343
3280
|
|
|
3281
|
+
export namespace Metadata {
|
|
3282
|
+
export interface Concept {
|
|
3344
3283
|
/**
|
|
3345
|
-
*
|
|
3284
|
+
* The model ID (example: "model_eyVcnFJcR92BxBkz7N6g5w")
|
|
3346
3285
|
*/
|
|
3347
|
-
|
|
3286
|
+
modelId: string;
|
|
3348
3287
|
|
|
3349
3288
|
/**
|
|
3350
|
-
*
|
|
3289
|
+
* The scale of the model (example: 1.0) For Flux Kontext Prompt Editing, the scale
|
|
3290
|
+
* is between 0 and 2.
|
|
3351
3291
|
*/
|
|
3352
|
-
|
|
3292
|
+
scale: number;
|
|
3353
3293
|
|
|
3354
3294
|
/**
|
|
3355
|
-
*
|
|
3295
|
+
* The epoch of the model (example: "000001") Only available for Flux Lora Trained
|
|
3296
|
+
* models
|
|
3356
3297
|
*/
|
|
3357
|
-
|
|
3298
|
+
modelEpoch?: string;
|
|
3299
|
+
}
|
|
3358
3300
|
|
|
3301
|
+
/**
|
|
3302
|
+
* The thumbnail of the canvas
|
|
3303
|
+
*/
|
|
3304
|
+
export interface Thumbnail {
|
|
3359
3305
|
/**
|
|
3360
|
-
*
|
|
3306
|
+
* The AssetId of the image used as a thumbnail for the canvas (example:
|
|
3307
|
+
* "asset_GTrL3mq4SXWyMxkOHRxlpw")
|
|
3361
3308
|
*/
|
|
3362
|
-
|
|
3309
|
+
assetId: string;
|
|
3363
3310
|
|
|
3364
3311
|
/**
|
|
3365
|
-
*
|
|
3312
|
+
* The url of the image used as a thumbnail for the canvas
|
|
3366
3313
|
*/
|
|
3367
|
-
|
|
3314
|
+
url: string;
|
|
3315
|
+
}
|
|
3316
|
+
}
|
|
3368
3317
|
|
|
3369
|
-
|
|
3370
|
-
|
|
3371
|
-
|
|
3372
|
-
|
|
3318
|
+
/**
|
|
3319
|
+
* The properties of the asset, content may depend on the kind of asset returned
|
|
3320
|
+
*/
|
|
3321
|
+
export interface Properties {
|
|
3322
|
+
size: number;
|
|
3373
3323
|
|
|
3374
|
-
|
|
3375
|
-
|
|
3376
|
-
|
|
3377
|
-
|
|
3324
|
+
/**
|
|
3325
|
+
* Number of animation frames if animations exist
|
|
3326
|
+
*/
|
|
3327
|
+
animationFrameCount?: number;
|
|
3378
3328
|
|
|
3379
|
-
|
|
3380
|
-
|
|
3381
|
-
|
|
3382
|
-
|
|
3329
|
+
/**
|
|
3330
|
+
* Bitrate of the media in bits per second
|
|
3331
|
+
*/
|
|
3332
|
+
bitrate?: number;
|
|
3383
3333
|
|
|
3384
|
-
|
|
3385
|
-
|
|
3386
|
-
|
|
3387
|
-
|
|
3334
|
+
/**
|
|
3335
|
+
* Number of bones if skeleton exists
|
|
3336
|
+
*/
|
|
3337
|
+
boneCount?: number;
|
|
3388
3338
|
|
|
3389
|
-
|
|
3390
|
-
|
|
3391
|
-
|
|
3392
|
-
|
|
3339
|
+
/**
|
|
3340
|
+
* Number of channels of the audio
|
|
3341
|
+
*/
|
|
3342
|
+
channels?: number;
|
|
3393
3343
|
|
|
3394
|
-
|
|
3395
|
-
|
|
3396
|
-
|
|
3397
|
-
|
|
3344
|
+
/**
|
|
3345
|
+
* Classification of the audio
|
|
3346
|
+
*/
|
|
3347
|
+
classification?: 'effect' | 'interview' | 'music' | 'other' | 'sound' | 'speech' | 'text' | 'unknown';
|
|
3398
3348
|
|
|
3399
|
-
|
|
3349
|
+
/**
|
|
3350
|
+
* Codec name of the media
|
|
3351
|
+
*/
|
|
3352
|
+
codecName?: string;
|
|
3400
3353
|
|
|
3401
|
-
|
|
3402
|
-
|
|
3403
|
-
|
|
3404
|
-
|
|
3354
|
+
/**
|
|
3355
|
+
* Description of the audio
|
|
3356
|
+
*/
|
|
3357
|
+
description?: string;
|
|
3405
3358
|
|
|
3406
|
-
|
|
3407
|
-
|
|
3408
|
-
|
|
3409
|
-
|
|
3359
|
+
/**
|
|
3360
|
+
* Bounding box dimensions [width, height, depth]
|
|
3361
|
+
*/
|
|
3362
|
+
dimensions?: Array<number>;
|
|
3410
3363
|
|
|
3411
|
-
|
|
3412
|
-
|
|
3413
|
-
|
|
3414
|
-
|
|
3364
|
+
/**
|
|
3365
|
+
* Duration of the media in seconds
|
|
3366
|
+
*/
|
|
3367
|
+
duration?: number;
|
|
3415
3368
|
|
|
3416
|
-
|
|
3417
|
-
|
|
3418
|
-
|
|
3419
|
-
|
|
3369
|
+
/**
|
|
3370
|
+
* Number of faces/triangles in the mesh
|
|
3371
|
+
*/
|
|
3372
|
+
faceCount?: number;
|
|
3420
3373
|
|
|
3421
|
-
|
|
3422
|
-
|
|
3374
|
+
/**
|
|
3375
|
+
* Format of the mesh file (e.g. 'glb', etc.)
|
|
3376
|
+
*/
|
|
3377
|
+
format?: string;
|
|
3423
3378
|
|
|
3424
|
-
|
|
3425
|
-
|
|
3426
|
-
|
|
3427
|
-
|
|
3428
|
-
export interface Transcription {
|
|
3429
|
-
text: string;
|
|
3430
|
-
}
|
|
3431
|
-
}
|
|
3379
|
+
/**
|
|
3380
|
+
* Frame rate of the video in frames per second
|
|
3381
|
+
*/
|
|
3382
|
+
frameRate?: number;
|
|
3432
3383
|
|
|
3433
3384
|
/**
|
|
3434
|
-
*
|
|
3435
|
-
*
|
|
3436
|
-
* Contains the assetId and the url of the first frame.
|
|
3385
|
+
* Whether the mesh has animations
|
|
3437
3386
|
*/
|
|
3438
|
-
|
|
3439
|
-
assetId: string;
|
|
3387
|
+
hasAnimations?: boolean;
|
|
3440
3388
|
|
|
3441
|
-
|
|
3442
|
-
|
|
3389
|
+
/**
|
|
3390
|
+
* Whether the mesh has normal vectors
|
|
3391
|
+
*/
|
|
3392
|
+
hasNormals?: boolean;
|
|
3443
3393
|
|
|
3444
3394
|
/**
|
|
3445
|
-
*
|
|
3446
|
-
*
|
|
3447
|
-
* Contains the assetId and the url of the last frame.
|
|
3395
|
+
* Whether the mesh has bones/skeleton
|
|
3448
3396
|
*/
|
|
3449
|
-
|
|
3450
|
-
assetId: string;
|
|
3397
|
+
hasSkeleton?: boolean;
|
|
3451
3398
|
|
|
3452
|
-
|
|
3453
|
-
|
|
3399
|
+
/**
|
|
3400
|
+
* Whether the mesh has UV coordinates
|
|
3401
|
+
*/
|
|
3402
|
+
hasUVs?: boolean;
|
|
3403
|
+
|
|
3404
|
+
height?: number;
|
|
3454
3405
|
|
|
3455
3406
|
/**
|
|
3456
|
-
*
|
|
3457
|
-
*
|
|
3458
|
-
* Contains the assetId and the url of the preview.
|
|
3407
|
+
* Number of frames in the video
|
|
3459
3408
|
*/
|
|
3460
|
-
|
|
3461
|
-
assetId: string;
|
|
3409
|
+
nbFrames?: number;
|
|
3462
3410
|
|
|
3463
|
-
|
|
3464
|
-
|
|
3411
|
+
/**
|
|
3412
|
+
* Sample rate of the media in Hz
|
|
3413
|
+
*/
|
|
3414
|
+
sampleRate?: number;
|
|
3465
3415
|
|
|
3466
3416
|
/**
|
|
3467
|
-
*
|
|
3468
|
-
*
|
|
3469
|
-
* Contains the assetId and the url of the thumbnail.
|
|
3417
|
+
* Transcription of the audio
|
|
3470
3418
|
*/
|
|
3471
|
-
|
|
3472
|
-
assetId: string;
|
|
3419
|
+
transcription?: Properties.Transcription;
|
|
3473
3420
|
|
|
3474
|
-
|
|
3421
|
+
/**
|
|
3422
|
+
* Number of vertices in the mesh
|
|
3423
|
+
*/
|
|
3424
|
+
vertexCount?: number;
|
|
3425
|
+
|
|
3426
|
+
width?: number;
|
|
3427
|
+
}
|
|
3428
|
+
|
|
3429
|
+
export namespace Properties {
|
|
3430
|
+
/**
|
|
3431
|
+
* Transcription of the audio
|
|
3432
|
+
*/
|
|
3433
|
+
export interface Transcription {
|
|
3434
|
+
text: string;
|
|
3475
3435
|
}
|
|
3476
3436
|
}
|
|
3437
|
+
|
|
3438
|
+
/**
|
|
3439
|
+
* The video asset's first frame.
|
|
3440
|
+
*
|
|
3441
|
+
* Contains the assetId and the url of the first frame.
|
|
3442
|
+
*/
|
|
3443
|
+
export interface FirstFrame {
|
|
3444
|
+
assetId: string;
|
|
3445
|
+
|
|
3446
|
+
url: string;
|
|
3447
|
+
}
|
|
3448
|
+
|
|
3449
|
+
/**
|
|
3450
|
+
* The video asset's last frame.
|
|
3451
|
+
*
|
|
3452
|
+
* Contains the assetId and the url of the last frame.
|
|
3453
|
+
*/
|
|
3454
|
+
export interface LastFrame {
|
|
3455
|
+
assetId: string;
|
|
3456
|
+
|
|
3457
|
+
url: string;
|
|
3458
|
+
}
|
|
3459
|
+
|
|
3460
|
+
/**
|
|
3461
|
+
* The asset's preview.
|
|
3462
|
+
*
|
|
3463
|
+
* Contains the assetId and the url of the preview.
|
|
3464
|
+
*/
|
|
3465
|
+
export interface Preview {
|
|
3466
|
+
assetId: string;
|
|
3467
|
+
|
|
3468
|
+
url: string;
|
|
3469
|
+
}
|
|
3470
|
+
|
|
3471
|
+
/**
|
|
3472
|
+
* The asset's thumbnail.
|
|
3473
|
+
*
|
|
3474
|
+
* Contains the assetId and the url of the thumbnail.
|
|
3475
|
+
*/
|
|
3476
|
+
export interface Thumbnail {
|
|
3477
|
+
assetId: string;
|
|
3478
|
+
|
|
3479
|
+
url: string;
|
|
3480
|
+
}
|
|
3477
3481
|
}
|
|
3478
3482
|
|
|
3479
3483
|
export type AssetDeleteMultipleResponse = unknown;
|
|
@@ -5703,24 +5707,13 @@ export namespace AssetGetBulkResponse {
|
|
|
5703
5707
|
}
|
|
5704
5708
|
|
|
5705
5709
|
export interface AssetListSnapshotsResponse {
|
|
5706
|
-
|
|
5707
|
-
|
|
5708
|
-
/**
|
|
5709
|
-
* A token to query the next page of snapshots
|
|
5710
|
-
*/
|
|
5711
|
-
nextPaginationToken?: string;
|
|
5712
|
-
}
|
|
5713
|
-
|
|
5714
|
-
export namespace AssetListSnapshotsResponse {
|
|
5715
|
-
export interface Snapshot {
|
|
5716
|
-
authorId: string;
|
|
5710
|
+
authorId: string;
|
|
5717
5711
|
|
|
5718
|
-
|
|
5712
|
+
hash: string;
|
|
5719
5713
|
|
|
5720
|
-
|
|
5714
|
+
rawData: string;
|
|
5721
5715
|
|
|
5722
|
-
|
|
5723
|
-
}
|
|
5716
|
+
takenAt: number;
|
|
5724
5717
|
}
|
|
5725
5718
|
|
|
5726
5719
|
export interface AssetLockResponse {
|
|
@@ -10078,7 +10071,7 @@ export interface AssetUpdateParams {
|
|
|
10078
10071
|
thumbnail?: string;
|
|
10079
10072
|
}
|
|
10080
10073
|
|
|
10081
|
-
export interface AssetListParams {
|
|
10074
|
+
export interface AssetListParams extends AssetsCursorParams {
|
|
10082
10075
|
/**
|
|
10083
10076
|
* List assets generated by a specific author (the user that created the asset)
|
|
10084
10077
|
*/
|
|
@@ -10120,11 +10113,6 @@ export interface AssetListParams {
|
|
|
10120
10113
|
*/
|
|
10121
10114
|
pageSize?: number;
|
|
10122
10115
|
|
|
10123
|
-
/**
|
|
10124
|
-
* A token you received in a previous request to query the next page of items
|
|
10125
|
-
*/
|
|
10126
|
-
paginationToken?: string;
|
|
10127
|
-
|
|
10128
10116
|
/**
|
|
10129
10117
|
* List all the children assets that were generated from a specific parent asset
|
|
10130
10118
|
*/
|
|
@@ -10274,7 +10262,80 @@ export interface AssetListParams {
|
|
|
10274
10262
|
* img2img, txt2video, uploaded, uploaded-video, uploaded-audio, uploaded-3d,
|
|
10275
10263
|
* uploaded-avatar, upscale-video
|
|
10276
10264
|
*/
|
|
10277
|
-
types?:
|
|
10265
|
+
types?:
|
|
10266
|
+
| 'inference-txt2img'
|
|
10267
|
+
| 'inference-txt2img-ip-adapter'
|
|
10268
|
+
| 'inference-txt2img-texture'
|
|
10269
|
+
| 'inference-img2img'
|
|
10270
|
+
| 'inference-img2img-ip-adapter'
|
|
10271
|
+
| 'inference-img2img-texture'
|
|
10272
|
+
| 'inference-inpaint'
|
|
10273
|
+
| 'inference-inpaint-ip-adapter'
|
|
10274
|
+
| 'inference-reference'
|
|
10275
|
+
| 'inference-reference-texture'
|
|
10276
|
+
| 'inference-controlnet'
|
|
10277
|
+
| 'inference-controlnet-ip-adapter'
|
|
10278
|
+
| 'inference-controlnet-img2img'
|
|
10279
|
+
| 'inference-controlnet-reference'
|
|
10280
|
+
| 'inference-controlnet-inpaint'
|
|
10281
|
+
| 'inference-controlnet-inpaint-ip-adapter'
|
|
10282
|
+
| 'inference-controlnet-texture'
|
|
10283
|
+
| 'background-removal'
|
|
10284
|
+
| 'canvas'
|
|
10285
|
+
| 'canvas-export'
|
|
10286
|
+
| 'canvas-drawing'
|
|
10287
|
+
| 'detection'
|
|
10288
|
+
| 'patch'
|
|
10289
|
+
| 'pixelization'
|
|
10290
|
+
| 'upscale'
|
|
10291
|
+
| 'upscale-texture'
|
|
10292
|
+
| 'upscale-skybox'
|
|
10293
|
+
| 'vectorization'
|
|
10294
|
+
| 'segment'
|
|
10295
|
+
| 'segmentation-image'
|
|
10296
|
+
| 'segmentation-mask'
|
|
10297
|
+
| 'skybox-base-360'
|
|
10298
|
+
| 'skybox-hdri'
|
|
10299
|
+
| 'skybox-3d'
|
|
10300
|
+
| 'restyle'
|
|
10301
|
+
| 'reframe'
|
|
10302
|
+
| 'generative-fill'
|
|
10303
|
+
| 'texture'
|
|
10304
|
+
| 'texture-height'
|
|
10305
|
+
| 'texture-normal'
|
|
10306
|
+
| 'texture-smoothness'
|
|
10307
|
+
| 'texture-metallic'
|
|
10308
|
+
| 'texture-edge'
|
|
10309
|
+
| 'texture-ao'
|
|
10310
|
+
| 'texture-albedo'
|
|
10311
|
+
| 'image-prompt-editing'
|
|
10312
|
+
| 'unknown'
|
|
10313
|
+
| 'img23d'
|
|
10314
|
+
| 'txt23d'
|
|
10315
|
+
| 'video23d'
|
|
10316
|
+
| '3d23d'
|
|
10317
|
+
| '3d23d-texture'
|
|
10318
|
+
| '3d-texture'
|
|
10319
|
+
| '3d-texture-mtl'
|
|
10320
|
+
| '3d-texture-albedo'
|
|
10321
|
+
| '3d-texture-normal'
|
|
10322
|
+
| '3d-texture-roughness'
|
|
10323
|
+
| '3d-texture-metallic'
|
|
10324
|
+
| 'img2video'
|
|
10325
|
+
| 'txt2audio'
|
|
10326
|
+
| 'audio2audio'
|
|
10327
|
+
| 'voice-clone'
|
|
10328
|
+
| 'video2video'
|
|
10329
|
+
| 'video2img'
|
|
10330
|
+
| 'txt2img'
|
|
10331
|
+
| 'img2img'
|
|
10332
|
+
| 'txt2video'
|
|
10333
|
+
| 'uploaded'
|
|
10334
|
+
| 'uploaded-video'
|
|
10335
|
+
| 'uploaded-audio'
|
|
10336
|
+
| 'uploaded-3d'
|
|
10337
|
+
| 'uploaded-avatar'
|
|
10338
|
+
| 'upscale-video';
|
|
10278
10339
|
|
|
10279
10340
|
/**
|
|
10280
10341
|
* Filter results to only return assets updated after the specified ISO string date
|
|
@@ -10289,6 +10350,13 @@ export interface AssetListParams {
|
|
|
10289
10350
|
updatedBefore?: string;
|
|
10290
10351
|
}
|
|
10291
10352
|
|
|
10353
|
+
export interface AssetDeleteMultipleParams {
|
|
10354
|
+
/**
|
|
10355
|
+
* The ids of the assets to delete. (Max 100 at once)
|
|
10356
|
+
*/
|
|
10357
|
+
assetIds: Array<string>;
|
|
10358
|
+
}
|
|
10359
|
+
|
|
10292
10360
|
export interface AssetDuplicateParams {
|
|
10293
10361
|
/**
|
|
10294
10362
|
* Query param: If set to true, returns the original asset without transformation
|
|
@@ -10315,17 +10383,12 @@ export interface AssetGetBulkParams {
|
|
|
10315
10383
|
assetIds?: Array<string>;
|
|
10316
10384
|
}
|
|
10317
10385
|
|
|
10318
|
-
export interface AssetListSnapshotsParams {
|
|
10386
|
+
export interface AssetListSnapshotsParams extends SnapshotsCursorParams {
|
|
10319
10387
|
/**
|
|
10320
10388
|
* The number of items to return in the response. The default value is 10, maximum
|
|
10321
10389
|
* value is 100, minimum value is 10
|
|
10322
10390
|
*/
|
|
10323
10391
|
pageSize?: number;
|
|
10324
|
-
|
|
10325
|
-
/**
|
|
10326
|
-
* A token you received in a previous request to query the next page of items
|
|
10327
|
-
*/
|
|
10328
|
-
paginationToken?: string;
|
|
10329
10392
|
}
|
|
10330
10393
|
|
|
10331
10394
|
export interface AssetLockParams {
|
|
@@ -10439,9 +10502,12 @@ export declare namespace Assets {
|
|
|
10439
10502
|
type AssetUnlockResponse as AssetUnlockResponse,
|
|
10440
10503
|
type AssetUpdateTagsResponse as AssetUpdateTagsResponse,
|
|
10441
10504
|
type AssetUploadResponse as AssetUploadResponse,
|
|
10505
|
+
type AssetListResponsesAssetsCursor as AssetListResponsesAssetsCursor,
|
|
10506
|
+
type AssetListSnapshotsResponsesSnapshotsCursor as AssetListSnapshotsResponsesSnapshotsCursor,
|
|
10442
10507
|
type AssetRetrieveParams as AssetRetrieveParams,
|
|
10443
10508
|
type AssetUpdateParams as AssetUpdateParams,
|
|
10444
10509
|
type AssetListParams as AssetListParams,
|
|
10510
|
+
type AssetDeleteMultipleParams as AssetDeleteMultipleParams,
|
|
10445
10511
|
type AssetDuplicateParams as AssetDuplicateParams,
|
|
10446
10512
|
type AssetGetBulkParams as AssetGetBulkParams,
|
|
10447
10513
|
type AssetListSnapshotsParams as AssetListSnapshotsParams,
|