@worldlabsai/client 0.1.1 → 0.3.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/README.md +1 -2
- package/dist/core/assets.d.ts +9 -4
- package/dist/core/assets.d.ts.map +1 -1
- package/dist/generated/developer-api.gen.d.ts +772 -269
- package/dist/generated/developer-api.gen.d.ts.map +1 -1
- package/dist/generated/tasks.gen.d.ts +6 -6
- package/dist/generated/tasks.gen.d.ts.map +1 -1
- package/dist/generated/tasks.gen.js +6 -6
- package/examples/posing.ts +1 -1
- package/package.json +2 -2
- package/src/generated/developer-api.gen.ts +772 -269
- package/src/generated/tasks.gen.ts +6 -6
|
@@ -30,7 +30,7 @@ export interface paths {
|
|
|
30
30
|
};
|
|
31
31
|
get?: never;
|
|
32
32
|
put?: never;
|
|
33
|
-
/** Submit
|
|
33
|
+
/** Submit the atlasChisel task */
|
|
34
34
|
post: operations["submit_atlasChisel_api_v2_tasks_atlasChisel_post"];
|
|
35
35
|
delete?: never;
|
|
36
36
|
options?: never;
|
|
@@ -47,7 +47,7 @@ export interface paths {
|
|
|
47
47
|
};
|
|
48
48
|
get?: never;
|
|
49
49
|
put?: never;
|
|
50
|
-
/** Submit
|
|
50
|
+
/** Submit the atlasGenerate task */
|
|
51
51
|
post: operations["submit_atlasGenerate_api_v2_tasks_atlasGenerate_post"];
|
|
52
52
|
delete?: never;
|
|
53
53
|
options?: never;
|
|
@@ -64,7 +64,7 @@ export interface paths {
|
|
|
64
64
|
};
|
|
65
65
|
get?: never;
|
|
66
66
|
put?: never;
|
|
67
|
-
/** Submit
|
|
67
|
+
/** Submit the atlasMasked task */
|
|
68
68
|
post: operations["submit_atlasMasked_api_v2_tasks_atlasMasked_post"];
|
|
69
69
|
delete?: never;
|
|
70
70
|
options?: never;
|
|
@@ -81,7 +81,7 @@ export interface paths {
|
|
|
81
81
|
};
|
|
82
82
|
get?: never;
|
|
83
83
|
put?: never;
|
|
84
|
-
/** Submit
|
|
84
|
+
/** Submit the atlasTextToImage task */
|
|
85
85
|
post: operations["submit_atlasTextToImage_api_v2_tasks_atlasTextToImage_post"];
|
|
86
86
|
delete?: never;
|
|
87
87
|
options?: never;
|
|
@@ -98,7 +98,7 @@ export interface paths {
|
|
|
98
98
|
};
|
|
99
99
|
get?: never;
|
|
100
100
|
put?: never;
|
|
101
|
-
/** Submit
|
|
101
|
+
/** Submit the images2PosedRGBD task */
|
|
102
102
|
post: operations["submit_images2PosedRGBD_api_v2_tasks_images2PosedRGBD_post"];
|
|
103
103
|
delete?: never;
|
|
104
104
|
options?: never;
|
|
@@ -115,7 +115,7 @@ export interface paths {
|
|
|
115
115
|
};
|
|
116
116
|
get?: never;
|
|
117
117
|
put?: never;
|
|
118
|
-
/** Submit
|
|
118
|
+
/** Submit the splats2Mesh task */
|
|
119
119
|
post: operations["submit_splats2Mesh_api_v2_tasks_splats2Mesh_post"];
|
|
120
120
|
delete?: never;
|
|
121
121
|
options?: never;
|
|
@@ -191,6 +191,23 @@ export interface paths {
|
|
|
191
191
|
patch?: never;
|
|
192
192
|
trace?: never;
|
|
193
193
|
};
|
|
194
|
+
"/api/v2/operations/{operation}/webhookDelivery": {
|
|
195
|
+
parameters: {
|
|
196
|
+
query?: never;
|
|
197
|
+
header?: never;
|
|
198
|
+
path?: never;
|
|
199
|
+
cookie?: never;
|
|
200
|
+
};
|
|
201
|
+
/** Get the webhook delivery record for an operation */
|
|
202
|
+
get: operations["get_webhook_delivery_api_v2_operations__operation__webhookDelivery_get"];
|
|
203
|
+
put?: never;
|
|
204
|
+
post?: never;
|
|
205
|
+
delete?: never;
|
|
206
|
+
options?: never;
|
|
207
|
+
head?: never;
|
|
208
|
+
patch?: never;
|
|
209
|
+
trace?: never;
|
|
210
|
+
};
|
|
194
211
|
"/api/v2/operations/{operation}": {
|
|
195
212
|
parameters: {
|
|
196
213
|
query?: never;
|
|
@@ -347,13 +364,16 @@ export interface components {
|
|
|
347
364
|
* Displayname
|
|
348
365
|
* @description User-visible label.
|
|
349
366
|
*/
|
|
350
|
-
displayName: string;
|
|
367
|
+
displayName: string | null;
|
|
351
368
|
/**
|
|
352
369
|
* Mimetype
|
|
353
370
|
* @description Media MIME type, e.g. ``image/png``.
|
|
354
371
|
*/
|
|
355
372
|
mimeType: string;
|
|
356
|
-
/**
|
|
373
|
+
/**
|
|
374
|
+
* @description Lifecycle state. Only ``READY`` assets can be read or used by a task.
|
|
375
|
+
* @default CREATED
|
|
376
|
+
*/
|
|
357
377
|
state?: components["schemas"]["AssetState"];
|
|
358
378
|
/**
|
|
359
379
|
* Width
|
|
@@ -372,7 +392,7 @@ export interface components {
|
|
|
372
392
|
sizeBytes?: string | null;
|
|
373
393
|
/**
|
|
374
394
|
* Checksum
|
|
375
|
-
* @description Checksum
|
|
395
|
+
* @description Checksum when available.
|
|
376
396
|
*/
|
|
377
397
|
checksum?: string | null;
|
|
378
398
|
/**
|
|
@@ -397,11 +417,17 @@ export interface components {
|
|
|
397
417
|
structure?: {
|
|
398
418
|
[key: string]: unknown;
|
|
399
419
|
} | null;
|
|
400
|
-
/** @description
|
|
420
|
+
/** @description How the asset came to exist, when that was recorded. */
|
|
401
421
|
producedBy?: components["schemas"]["ProducedBy"] | null;
|
|
422
|
+
/**
|
|
423
|
+
* Transient
|
|
424
|
+
* @description True when the bytes are not retained: an upload made while the account does not retain content, or an output of an operation that purges. Both are deleted an hour after the last operation that names them finishes; an upload no operation consumes is deleted by age instead. ``contentPath`` is null for such an asset; read it through ``:createReadUrl``.
|
|
425
|
+
* @default false
|
|
426
|
+
*/
|
|
427
|
+
transient?: boolean;
|
|
402
428
|
/**
|
|
403
429
|
* Contentpath
|
|
404
|
-
* @description
|
|
430
|
+
* @description Already percent-encoded path for the asset. Append it unchanged to ``baseUrl`` before ``?`` and ``signedQuery``. This path does not grant access by itself. Null until the asset is ``READY`` or when unavailable; use ``assets/{asset}:createReadUrl`` as a fallback.
|
|
405
431
|
*/
|
|
406
432
|
contentPath?: string | null;
|
|
407
433
|
};
|
|
@@ -414,7 +440,12 @@ export interface components {
|
|
|
414
440
|
* Displayname
|
|
415
441
|
* @description User-visible label.
|
|
416
442
|
*/
|
|
417
|
-
displayName
|
|
443
|
+
displayName?: string | null;
|
|
444
|
+
/**
|
|
445
|
+
* Session
|
|
446
|
+
* @description The Web API session this upload belongs to. The session must be in the same project; the asset inherits its applet.
|
|
447
|
+
*/
|
|
448
|
+
session?: string | null;
|
|
418
449
|
/**
|
|
419
450
|
* Type
|
|
420
451
|
* @description Asset type, e.g. ``image``. Decides which part roles the asset may carry and what each may hold. Omit for a single untyped object uploaded through ``:createUploadUrl``.
|
|
@@ -439,17 +470,47 @@ export interface components {
|
|
|
439
470
|
base64?: string | null;
|
|
440
471
|
/**
|
|
441
472
|
* Url
|
|
442
|
-
* @description A URL the platform fetches. The asset comes back ``READY``.
|
|
473
|
+
* @description A public URL the platform fetches. The asset comes back ``READY``.
|
|
443
474
|
*/
|
|
444
475
|
url?: string | null;
|
|
445
476
|
};
|
|
477
|
+
/**
|
|
478
|
+
* AssetGroup
|
|
479
|
+
* @description The assets one Operation produced, in the page's order.
|
|
480
|
+
*/
|
|
481
|
+
AssetGroup: {
|
|
482
|
+
/**
|
|
483
|
+
* Operation
|
|
484
|
+
* @description The Operation that produced them.
|
|
485
|
+
*/
|
|
486
|
+
operation: string;
|
|
487
|
+
/**
|
|
488
|
+
* Task
|
|
489
|
+
* @description The task that produced them, e.g. ``image2DraftSplats``.
|
|
490
|
+
*/
|
|
491
|
+
task?: string | null;
|
|
492
|
+
/** Assets */
|
|
493
|
+
assets?: components["schemas"]["Asset"][];
|
|
494
|
+
};
|
|
495
|
+
/**
|
|
496
|
+
* AssetGrouping
|
|
497
|
+
* @description What a listing collects its assets under.
|
|
498
|
+
* @enum {string}
|
|
499
|
+
*/
|
|
500
|
+
AssetGrouping: "OPERATION";
|
|
501
|
+
/**
|
|
502
|
+
* AssetOrder
|
|
503
|
+
* @description How a listing orders its page.
|
|
504
|
+
*
|
|
505
|
+
* A grouped page orders on each group's leading asset -- its newest running
|
|
506
|
+
* newest-first, its oldest running the other way -- so a group sorts where
|
|
507
|
+
* its nearest asset would have in the flat listing.
|
|
508
|
+
* @enum {string}
|
|
509
|
+
*/
|
|
510
|
+
AssetOrder: "CREATE_TIME_DESC" | "CREATE_TIME_ASC";
|
|
446
511
|
/**
|
|
447
512
|
* AssetPart
|
|
448
513
|
* @description One media file belonging to an asset.
|
|
449
|
-
*
|
|
450
|
-
* Every field but the role is what the store and the bytes reported at
|
|
451
|
-
* ``:completeUpload``; nothing here is echoed back from the request that
|
|
452
|
-
* declared the part.
|
|
453
514
|
*/
|
|
454
515
|
AssetPart: {
|
|
455
516
|
/**
|
|
@@ -479,7 +540,7 @@ export interface components {
|
|
|
479
540
|
sizeBytes?: string | null;
|
|
480
541
|
/**
|
|
481
542
|
* Checksum
|
|
482
|
-
* @description Checksum
|
|
543
|
+
* @description Checksum when available.
|
|
483
544
|
*/
|
|
484
545
|
checksum?: string | null;
|
|
485
546
|
/**
|
|
@@ -499,17 +560,23 @@ export interface components {
|
|
|
499
560
|
* AssetPartDeclaration
|
|
500
561
|
* @description A part the client intends to upload.
|
|
501
562
|
*
|
|
502
|
-
* The
|
|
503
|
-
*
|
|
563
|
+
* The upload must use the declared content type and contain exactly the
|
|
564
|
+
* declared number of bytes.
|
|
504
565
|
*/
|
|
505
566
|
AssetPartDeclaration: {
|
|
506
|
-
/**
|
|
567
|
+
/**
|
|
568
|
+
* Role
|
|
569
|
+
* @description Role this file fills in the asset type, e.g. ``rgb``, ``mask`` or ``depth``.
|
|
570
|
+
*/
|
|
507
571
|
role: string;
|
|
508
|
-
/**
|
|
572
|
+
/**
|
|
573
|
+
* Contenttype
|
|
574
|
+
* @description MIME type that will be sent with the upload, e.g. ``image/png``.
|
|
575
|
+
*/
|
|
509
576
|
contentType: string;
|
|
510
577
|
/**
|
|
511
578
|
* Contentlength
|
|
512
|
-
* @description Upload size in bytes, serialized on the wire as a string.
|
|
579
|
+
* @description Upload size in bytes, serialized on the wire as a string. Capped at 1 GiB.
|
|
513
580
|
*/
|
|
514
581
|
contentLength: number;
|
|
515
582
|
/**
|
|
@@ -520,6 +587,16 @@ export interface components {
|
|
|
520
587
|
[key: string]: unknown;
|
|
521
588
|
} | null;
|
|
522
589
|
};
|
|
590
|
+
/**
|
|
591
|
+
* AssetProducer
|
|
592
|
+
* @description The act that produced an asset.
|
|
593
|
+
*
|
|
594
|
+
* A customer's own bytes are an UPLOAD however they arrived; bytes we
|
|
595
|
+
* fetched from an address they gave us are an IMPORT; a task's output is a
|
|
596
|
+
* TASK.
|
|
597
|
+
* @enum {string}
|
|
598
|
+
*/
|
|
599
|
+
AssetProducer: "UPLOAD" | "IMPORT" | "TASK";
|
|
523
600
|
/**
|
|
524
601
|
* AssetState
|
|
525
602
|
* @enum {string}
|
|
@@ -536,16 +613,9 @@ export interface components {
|
|
|
536
613
|
* @default 42
|
|
537
614
|
*/
|
|
538
615
|
seed?: number | null;
|
|
539
|
-
/**
|
|
540
|
-
* Cfg
|
|
541
|
-
* @description Classifier-free guidance scale.
|
|
542
|
-
* @default 2.5
|
|
543
|
-
*/
|
|
544
|
-
cfg?: number | null;
|
|
545
616
|
/**
|
|
546
617
|
* Numsteps
|
|
547
|
-
* @description Diffusion step count.
|
|
548
|
-
* @default 50
|
|
618
|
+
* @description Diffusion step count. Unset uses the served model's own sampler.
|
|
549
619
|
*/
|
|
550
620
|
numSteps?: number | null;
|
|
551
621
|
};
|
|
@@ -554,6 +624,16 @@ export interface components {
|
|
|
554
624
|
* @description Body of ``POST /api/v2/tasks:atlasChisel``.
|
|
555
625
|
*/
|
|
556
626
|
AtlasChiselRequest: {
|
|
627
|
+
/**
|
|
628
|
+
* Webhookurl
|
|
629
|
+
* @description Where Marble POSTs one signed task.succeeded or task.failed event when this operation finishes; retried for 24 hours. Verify the signature with the public keys at /.well-known/webhooks/jwks.json. Cannot be combined with ?wait=true. https on port 443 only, no IP literals. Developer API only.
|
|
630
|
+
*/
|
|
631
|
+
webhookUrl?: string | null;
|
|
632
|
+
/**
|
|
633
|
+
* Purgecontentonoperationcompletion
|
|
634
|
+
* @description Purge this operation's outputs and the transient uploads it consumed one hour after it finishes. Omitted, the account's setting applies; true raises it for this operation; false is refused when the account already purges. Uploads in the library are never purged by an operation.
|
|
635
|
+
*/
|
|
636
|
+
purgeContentOnOperationCompletion?: boolean | null;
|
|
557
637
|
/**
|
|
558
638
|
* Contextframes
|
|
559
639
|
* @description Posed depth frames, one per target camera and posed at it, in target order; each camera is 1280x720. Depth only: frames carry no imageAsset, maskAsset, or depth confidenceAsset. Leave empty to generate from the prompt alone.
|
|
@@ -615,35 +695,54 @@ export interface components {
|
|
|
615
695
|
*/
|
|
616
696
|
requestId?: string | null;
|
|
617
697
|
};
|
|
618
|
-
/**
|
|
698
|
+
/**
|
|
699
|
+
* AtlasChiselResponseOperation
|
|
700
|
+
* @description Long-running operation whose successful terminal ``response`` has type ``AtlasChiselResponse``. This is the common Operation envelope with a task-specific response type, not a separate operation resource.
|
|
701
|
+
*/
|
|
619
702
|
AtlasChiselResponseOperation: {
|
|
620
|
-
/**
|
|
703
|
+
/**
|
|
704
|
+
* Id
|
|
705
|
+
* @description Short operation id used in ``/operations/{operation}`` paths.
|
|
706
|
+
*/
|
|
621
707
|
id: string;
|
|
622
|
-
/**
|
|
708
|
+
/**
|
|
709
|
+
* Ownerid
|
|
710
|
+
* @description Account that owns the operation.
|
|
711
|
+
*/
|
|
623
712
|
ownerId: string;
|
|
624
|
-
/**
|
|
713
|
+
/**
|
|
714
|
+
* Metadata
|
|
715
|
+
* @description Task information and optional progress details. Use ``metadata.task`` to interpret a generic operation response, and use ``done`` to determine completion.
|
|
716
|
+
*/
|
|
625
717
|
metadata?: {
|
|
626
718
|
[key: string]: unknown;
|
|
627
719
|
} | null;
|
|
628
|
-
/**
|
|
720
|
+
/**
|
|
721
|
+
* Done
|
|
722
|
+
* @description Whether the operation is terminal. When false, both ``response`` and ``error`` are null.
|
|
723
|
+
*/
|
|
629
724
|
done: boolean;
|
|
725
|
+
/** @description Failure details when ``done`` is true and the task failed; null while running and after success. */
|
|
630
726
|
error?: components["schemas"]["OperationError"] | null;
|
|
631
|
-
/** @description
|
|
727
|
+
/** @description ``AtlasChiselResponse`` result when ``done`` is true and the task succeeded; null while running and after failure. */
|
|
632
728
|
response?: components["schemas"]["AtlasChiselResponse"] | null;
|
|
633
|
-
/**
|
|
729
|
+
/**
|
|
730
|
+
* Expiresatsecs
|
|
731
|
+
* @description Task execution deadline as Unix seconds, when one is exposed. This is not an asset URL expiration.
|
|
732
|
+
*/
|
|
634
733
|
expiresAtSecs?: number | null;
|
|
635
734
|
/**
|
|
636
735
|
* Createdatsecs
|
|
637
|
-
* @description Unix seconds when the operation was
|
|
736
|
+
* @description Unix seconds when the operation was accepted.
|
|
638
737
|
*/
|
|
639
738
|
createdAtSecs?: number | null;
|
|
640
739
|
/**
|
|
641
740
|
* Name
|
|
642
|
-
* @description
|
|
741
|
+
* @description Full resource name for the operation.
|
|
643
742
|
*
|
|
644
|
-
*
|
|
645
|
-
*
|
|
646
|
-
*
|
|
743
|
+
* For project operations:
|
|
744
|
+
* ``accounts/{account}/projects/{project}/operations/{operation}``.
|
|
745
|
+
* Operation paths accept the short ``id``.
|
|
647
746
|
*/
|
|
648
747
|
readonly name: string;
|
|
649
748
|
};
|
|
@@ -658,16 +757,9 @@ export interface components {
|
|
|
658
757
|
* @default 42
|
|
659
758
|
*/
|
|
660
759
|
seed?: number | null;
|
|
661
|
-
/**
|
|
662
|
-
* Cfg
|
|
663
|
-
* @description Classifier-free guidance scale.
|
|
664
|
-
* @default 2.5
|
|
665
|
-
*/
|
|
666
|
-
cfg?: number | null;
|
|
667
760
|
/**
|
|
668
761
|
* Numsteps
|
|
669
|
-
* @description Diffusion step
|
|
670
|
-
* @default 50
|
|
762
|
+
* @description Diffusion step-count override.
|
|
671
763
|
*/
|
|
672
764
|
numSteps?: number | null;
|
|
673
765
|
};
|
|
@@ -676,6 +768,16 @@ export interface components {
|
|
|
676
768
|
* @description Body of ``POST /api/v2/tasks:atlasGenerate``.
|
|
677
769
|
*/
|
|
678
770
|
AtlasGenerateRequest: {
|
|
771
|
+
/**
|
|
772
|
+
* Webhookurl
|
|
773
|
+
* @description Where Marble POSTs one signed task.succeeded or task.failed event when this operation finishes; retried for 24 hours. Verify the signature with the public keys at /.well-known/webhooks/jwks.json. Cannot be combined with ?wait=true. https on port 443 only, no IP literals. Developer API only.
|
|
774
|
+
*/
|
|
775
|
+
webhookUrl?: string | null;
|
|
776
|
+
/**
|
|
777
|
+
* Purgecontentonoperationcompletion
|
|
778
|
+
* @description Purge this operation's outputs and the transient uploads it consumed one hour after it finishes. Omitted, the account's setting applies; true raises it for this operation; false is refused when the account already purges. Uploads in the library are never purged by an operation.
|
|
779
|
+
*/
|
|
780
|
+
purgeContentOnOperationCompletion?: boolean | null;
|
|
679
781
|
/**
|
|
680
782
|
* Contextframes
|
|
681
783
|
* @description Posed RGBD context views: each an image, its depth buffer, and its camera, all required. On the reference-context warp route the depth conditions the generation geometrically, so the generated views stay consistent with the provided scene; the hero base checkpoint conditions on the posed images only and does not consume the depth.
|
|
@@ -727,35 +829,54 @@ export interface components {
|
|
|
727
829
|
*/
|
|
728
830
|
requestId?: string | null;
|
|
729
831
|
};
|
|
730
|
-
/**
|
|
832
|
+
/**
|
|
833
|
+
* AtlasGenerateResponseOperation
|
|
834
|
+
* @description Long-running operation whose successful terminal ``response`` has type ``AtlasGenerateResponse``. This is the common Operation envelope with a task-specific response type, not a separate operation resource.
|
|
835
|
+
*/
|
|
731
836
|
AtlasGenerateResponseOperation: {
|
|
732
|
-
/**
|
|
837
|
+
/**
|
|
838
|
+
* Id
|
|
839
|
+
* @description Short operation id used in ``/operations/{operation}`` paths.
|
|
840
|
+
*/
|
|
733
841
|
id: string;
|
|
734
|
-
/**
|
|
842
|
+
/**
|
|
843
|
+
* Ownerid
|
|
844
|
+
* @description Account that owns the operation.
|
|
845
|
+
*/
|
|
735
846
|
ownerId: string;
|
|
736
|
-
/**
|
|
847
|
+
/**
|
|
848
|
+
* Metadata
|
|
849
|
+
* @description Task information and optional progress details. Use ``metadata.task`` to interpret a generic operation response, and use ``done`` to determine completion.
|
|
850
|
+
*/
|
|
737
851
|
metadata?: {
|
|
738
852
|
[key: string]: unknown;
|
|
739
853
|
} | null;
|
|
740
|
-
/**
|
|
854
|
+
/**
|
|
855
|
+
* Done
|
|
856
|
+
* @description Whether the operation is terminal. When false, both ``response`` and ``error`` are null.
|
|
857
|
+
*/
|
|
741
858
|
done: boolean;
|
|
859
|
+
/** @description Failure details when ``done`` is true and the task failed; null while running and after success. */
|
|
742
860
|
error?: components["schemas"]["OperationError"] | null;
|
|
743
|
-
/** @description
|
|
861
|
+
/** @description ``AtlasGenerateResponse`` result when ``done`` is true and the task succeeded; null while running and after failure. */
|
|
744
862
|
response?: components["schemas"]["AtlasGenerateResponse"] | null;
|
|
745
|
-
/**
|
|
863
|
+
/**
|
|
864
|
+
* Expiresatsecs
|
|
865
|
+
* @description Task execution deadline as Unix seconds, when one is exposed. This is not an asset URL expiration.
|
|
866
|
+
*/
|
|
746
867
|
expiresAtSecs?: number | null;
|
|
747
868
|
/**
|
|
748
869
|
* Createdatsecs
|
|
749
|
-
* @description Unix seconds when the operation was
|
|
870
|
+
* @description Unix seconds when the operation was accepted.
|
|
750
871
|
*/
|
|
751
872
|
createdAtSecs?: number | null;
|
|
752
873
|
/**
|
|
753
874
|
* Name
|
|
754
|
-
* @description
|
|
875
|
+
* @description Full resource name for the operation.
|
|
755
876
|
*
|
|
756
|
-
*
|
|
757
|
-
*
|
|
758
|
-
*
|
|
877
|
+
* For project operations:
|
|
878
|
+
* ``accounts/{account}/projects/{project}/operations/{operation}``.
|
|
879
|
+
* Operation paths accept the short ``id``.
|
|
759
880
|
*/
|
|
760
881
|
readonly name: string;
|
|
761
882
|
};
|
|
@@ -770,12 +891,6 @@ export interface components {
|
|
|
770
891
|
* @default 42
|
|
771
892
|
*/
|
|
772
893
|
seed?: number | null;
|
|
773
|
-
/**
|
|
774
|
-
* Cfg
|
|
775
|
-
* @description Classifier-free guidance scale.
|
|
776
|
-
* @default 2.5
|
|
777
|
-
*/
|
|
778
|
-
cfg?: number | null;
|
|
779
894
|
/**
|
|
780
895
|
* Numsteps
|
|
781
896
|
* @description Diffusion step count.
|
|
@@ -788,6 +903,16 @@ export interface components {
|
|
|
788
903
|
* @description Body of ``POST /api/v2/tasks:atlasMasked``.
|
|
789
904
|
*/
|
|
790
905
|
AtlasMaskedRequest: {
|
|
906
|
+
/**
|
|
907
|
+
* Webhookurl
|
|
908
|
+
* @description Where Marble POSTs one signed task.succeeded or task.failed event when this operation finishes; retried for 24 hours. Verify the signature with the public keys at /.well-known/webhooks/jwks.json. Cannot be combined with ?wait=true. https on port 443 only, no IP literals. Developer API only.
|
|
909
|
+
*/
|
|
910
|
+
webhookUrl?: string | null;
|
|
911
|
+
/**
|
|
912
|
+
* Purgecontentonoperationcompletion
|
|
913
|
+
* @description Purge this operation's outputs and the transient uploads it consumed one hour after it finishes. Omitted, the account's setting applies; true raises it for this operation; false is refused when the account already purges. Uploads in the library are never purged by an operation.
|
|
914
|
+
*/
|
|
915
|
+
purgeContentOnOperationCompletion?: boolean | null;
|
|
791
916
|
/**
|
|
792
917
|
* Contextframes
|
|
793
918
|
* @description The views to complete, in output order: each an image, its alpha mask, and its camera. The mask is an 8-bit grayscale PNG on the image grid where 1 is kept -- those pixels are the observed image -- and 0 is what the model fills in. Each view is completed at its targetCameras entry of the same index.
|
|
@@ -800,13 +925,13 @@ export interface components {
|
|
|
800
925
|
targetCameras: components["schemas"]["PinholeCamera"][];
|
|
801
926
|
/**
|
|
802
927
|
* Prompt
|
|
803
|
-
* @description
|
|
928
|
+
* @description The edit to make. With enhancePrompt on (the default), write an instruction that names what to add, remove, replace, or restyle and where, such as 'replace the yellow car with a stone fountain in the middle of the courtyard'. The enhancer reads it with the original context images but not the masks. Without a prompt it describes the images as they are, which tends to restore masked objects, so state removals explicitly. With enhancePrompt false the model receives the text unchanged as a caption of the finished image, so describe the whole finished scene instead.
|
|
804
929
|
*/
|
|
805
930
|
prompt?: string | null;
|
|
806
931
|
/**
|
|
807
932
|
* Enhanceprompt
|
|
808
|
-
* @description
|
|
809
|
-
* @default
|
|
933
|
+
* @description Rewrite the prompt before inference: the edit instruction and the context images become a detailed description of the finished scene, returned as promptUsed. Set false to send the prompt exactly as given.
|
|
934
|
+
* @default true
|
|
810
935
|
*/
|
|
811
936
|
enhancePrompt?: boolean;
|
|
812
937
|
/**
|
|
@@ -839,35 +964,54 @@ export interface components {
|
|
|
839
964
|
*/
|
|
840
965
|
requestId?: string | null;
|
|
841
966
|
};
|
|
842
|
-
/**
|
|
967
|
+
/**
|
|
968
|
+
* AtlasMaskedResponseOperation
|
|
969
|
+
* @description Long-running operation whose successful terminal ``response`` has type ``AtlasMaskedResponse``. This is the common Operation envelope with a task-specific response type, not a separate operation resource.
|
|
970
|
+
*/
|
|
843
971
|
AtlasMaskedResponseOperation: {
|
|
844
|
-
/**
|
|
972
|
+
/**
|
|
973
|
+
* Id
|
|
974
|
+
* @description Short operation id used in ``/operations/{operation}`` paths.
|
|
975
|
+
*/
|
|
845
976
|
id: string;
|
|
846
|
-
/**
|
|
977
|
+
/**
|
|
978
|
+
* Ownerid
|
|
979
|
+
* @description Account that owns the operation.
|
|
980
|
+
*/
|
|
847
981
|
ownerId: string;
|
|
848
|
-
/**
|
|
982
|
+
/**
|
|
983
|
+
* Metadata
|
|
984
|
+
* @description Task information and optional progress details. Use ``metadata.task`` to interpret a generic operation response, and use ``done`` to determine completion.
|
|
985
|
+
*/
|
|
849
986
|
metadata?: {
|
|
850
987
|
[key: string]: unknown;
|
|
851
988
|
} | null;
|
|
852
|
-
/**
|
|
989
|
+
/**
|
|
990
|
+
* Done
|
|
991
|
+
* @description Whether the operation is terminal. When false, both ``response`` and ``error`` are null.
|
|
992
|
+
*/
|
|
853
993
|
done: boolean;
|
|
994
|
+
/** @description Failure details when ``done`` is true and the task failed; null while running and after success. */
|
|
854
995
|
error?: components["schemas"]["OperationError"] | null;
|
|
855
|
-
/** @description
|
|
996
|
+
/** @description ``AtlasMaskedResponse`` result when ``done`` is true and the task succeeded; null while running and after failure. */
|
|
856
997
|
response?: components["schemas"]["AtlasMaskedResponse"] | null;
|
|
857
|
-
/**
|
|
998
|
+
/**
|
|
999
|
+
* Expiresatsecs
|
|
1000
|
+
* @description Task execution deadline as Unix seconds, when one is exposed. This is not an asset URL expiration.
|
|
1001
|
+
*/
|
|
858
1002
|
expiresAtSecs?: number | null;
|
|
859
1003
|
/**
|
|
860
1004
|
* Createdatsecs
|
|
861
|
-
* @description Unix seconds when the operation was
|
|
1005
|
+
* @description Unix seconds when the operation was accepted.
|
|
862
1006
|
*/
|
|
863
1007
|
createdAtSecs?: number | null;
|
|
864
1008
|
/**
|
|
865
1009
|
* Name
|
|
866
|
-
* @description
|
|
1010
|
+
* @description Full resource name for the operation.
|
|
867
1011
|
*
|
|
868
|
-
*
|
|
869
|
-
*
|
|
870
|
-
*
|
|
1012
|
+
* For project operations:
|
|
1013
|
+
* ``accounts/{account}/projects/{project}/operations/{operation}``.
|
|
1014
|
+
* Operation paths accept the short ``id``.
|
|
871
1015
|
*/
|
|
872
1016
|
readonly name: string;
|
|
873
1017
|
};
|
|
@@ -876,6 +1020,16 @@ export interface components {
|
|
|
876
1020
|
* @description Body of ``POST /api/v2/tasks:atlasTextToImage``.
|
|
877
1021
|
*/
|
|
878
1022
|
AtlasTextToImageRequest: {
|
|
1023
|
+
/**
|
|
1024
|
+
* Webhookurl
|
|
1025
|
+
* @description Where Marble POSTs one signed task.succeeded or task.failed event when this operation finishes; retried for 24 hours. Verify the signature with the public keys at /.well-known/webhooks/jwks.json. Cannot be combined with ?wait=true. https on port 443 only, no IP literals. Developer API only.
|
|
1026
|
+
*/
|
|
1027
|
+
webhookUrl?: string | null;
|
|
1028
|
+
/**
|
|
1029
|
+
* Purgecontentonoperationcompletion
|
|
1030
|
+
* @description Purge this operation's outputs and the transient uploads it consumed one hour after it finishes. Omitted, the account's setting applies; true raises it for this operation; false is refused when the account already purges. Uploads in the library are never purged by an operation.
|
|
1031
|
+
*/
|
|
1032
|
+
purgeContentOnOperationCompletion?: boolean | null;
|
|
879
1033
|
/**
|
|
880
1034
|
* Prompt
|
|
881
1035
|
* @description Text prompt to generate from.
|
|
@@ -897,11 +1051,6 @@ export interface components {
|
|
|
897
1051
|
* @description Optional RNG seed.
|
|
898
1052
|
*/
|
|
899
1053
|
seed?: number | null;
|
|
900
|
-
/**
|
|
901
|
-
* Cfg
|
|
902
|
-
* @description Classifier-free guidance scale.
|
|
903
|
-
*/
|
|
904
|
-
cfg?: number | null;
|
|
905
1054
|
/**
|
|
906
1055
|
* Numsteps
|
|
907
1056
|
* @description Diffusion step count.
|
|
@@ -914,7 +1063,7 @@ export interface components {
|
|
|
914
1063
|
numSamples?: number | null;
|
|
915
1064
|
/**
|
|
916
1065
|
* Returndepth
|
|
917
|
-
* @description Also
|
|
1066
|
+
* @description Also estimate depth per image (metric, single-view): every frame in `frames` then carries a `depth` buffer and the camera it was estimated under.
|
|
918
1067
|
* @default false
|
|
919
1068
|
*/
|
|
920
1069
|
returnDepth?: boolean;
|
|
@@ -925,72 +1074,69 @@ export interface components {
|
|
|
925
1074
|
*/
|
|
926
1075
|
AtlasTextToImageResponse: {
|
|
927
1076
|
/**
|
|
928
|
-
*
|
|
929
|
-
* @description
|
|
930
|
-
*/
|
|
931
|
-
generationId: string;
|
|
932
|
-
/**
|
|
933
|
-
* Imageurls
|
|
934
|
-
* @description Public URLs of generated PNG images.
|
|
935
|
-
*/
|
|
936
|
-
imageUrls: string[];
|
|
937
|
-
/** @description Task outputs using the shared output URL contract. */
|
|
938
|
-
assetOutput?: components["schemas"]["ImageCollectionAssetOutput"] | null;
|
|
939
|
-
/**
|
|
940
|
-
* Enhancedprompt
|
|
941
|
-
* @description Prompt after enhancement, if any.
|
|
942
|
-
*/
|
|
943
|
-
enhancedPrompt?: string | null;
|
|
944
|
-
/**
|
|
945
|
-
* Prompt
|
|
946
|
-
* @description Original prompt submitted by the caller.
|
|
1077
|
+
* Frames
|
|
1078
|
+
* @description Generated images, one frame per sample in generation order. Every frame also carries its estimated camera and a `depth` buffer when the request set returnDepth.
|
|
947
1079
|
*/
|
|
948
|
-
|
|
1080
|
+
frames: components["schemas"]["FrameRGBAsset"][];
|
|
949
1081
|
/**
|
|
950
|
-
*
|
|
951
|
-
* @description
|
|
1082
|
+
* Promptused
|
|
1083
|
+
* @description Final prompt supplied to inference, if any.
|
|
952
1084
|
*/
|
|
953
|
-
|
|
1085
|
+
promptUsed?: string | null;
|
|
954
1086
|
/**
|
|
955
1087
|
* Aspectratio
|
|
956
1088
|
* @description Resolved width-to-height ratio used for generation.
|
|
957
1089
|
*/
|
|
958
1090
|
aspectRatio?: ("16:9" | "9:16" | "4:3" | "3:4" | "1:1") | null;
|
|
959
|
-
/**
|
|
960
|
-
* Frames
|
|
961
|
-
* @description Only with returnDepth: one posed RGBD frame per image, in imageUrls order, carrying the estimated camera and a `depth` buffer.
|
|
962
|
-
*/
|
|
963
|
-
frames?: components["schemas"]["PosedRGBAsset"][] | null;
|
|
964
1091
|
};
|
|
965
|
-
/**
|
|
1092
|
+
/**
|
|
1093
|
+
* AtlasTextToImageResponseOperation
|
|
1094
|
+
* @description Long-running operation whose successful terminal ``response`` has type ``AtlasTextToImageResponse``. This is the common Operation envelope with a task-specific response type, not a separate operation resource.
|
|
1095
|
+
*/
|
|
966
1096
|
AtlasTextToImageResponseOperation: {
|
|
967
|
-
/**
|
|
1097
|
+
/**
|
|
1098
|
+
* Id
|
|
1099
|
+
* @description Short operation id used in ``/operations/{operation}`` paths.
|
|
1100
|
+
*/
|
|
968
1101
|
id: string;
|
|
969
|
-
/**
|
|
1102
|
+
/**
|
|
1103
|
+
* Ownerid
|
|
1104
|
+
* @description Account that owns the operation.
|
|
1105
|
+
*/
|
|
970
1106
|
ownerId: string;
|
|
971
|
-
/**
|
|
1107
|
+
/**
|
|
1108
|
+
* Metadata
|
|
1109
|
+
* @description Task information and optional progress details. Use ``metadata.task`` to interpret a generic operation response, and use ``done`` to determine completion.
|
|
1110
|
+
*/
|
|
972
1111
|
metadata?: {
|
|
973
1112
|
[key: string]: unknown;
|
|
974
1113
|
} | null;
|
|
975
|
-
/**
|
|
1114
|
+
/**
|
|
1115
|
+
* Done
|
|
1116
|
+
* @description Whether the operation is terminal. When false, both ``response`` and ``error`` are null.
|
|
1117
|
+
*/
|
|
976
1118
|
done: boolean;
|
|
1119
|
+
/** @description Failure details when ``done`` is true and the task failed; null while running and after success. */
|
|
977
1120
|
error?: components["schemas"]["OperationError"] | null;
|
|
978
|
-
/** @description
|
|
1121
|
+
/** @description ``AtlasTextToImageResponse`` result when ``done`` is true and the task succeeded; null while running and after failure. */
|
|
979
1122
|
response?: components["schemas"]["AtlasTextToImageResponse"] | null;
|
|
980
|
-
/**
|
|
1123
|
+
/**
|
|
1124
|
+
* Expiresatsecs
|
|
1125
|
+
* @description Task execution deadline as Unix seconds, when one is exposed. This is not an asset URL expiration.
|
|
1126
|
+
*/
|
|
981
1127
|
expiresAtSecs?: number | null;
|
|
982
1128
|
/**
|
|
983
1129
|
* Createdatsecs
|
|
984
|
-
* @description Unix seconds when the operation was
|
|
1130
|
+
* @description Unix seconds when the operation was accepted.
|
|
985
1131
|
*/
|
|
986
1132
|
createdAtSecs?: number | null;
|
|
987
1133
|
/**
|
|
988
1134
|
* Name
|
|
989
|
-
* @description
|
|
1135
|
+
* @description Full resource name for the operation.
|
|
990
1136
|
*
|
|
991
|
-
*
|
|
992
|
-
*
|
|
993
|
-
*
|
|
1137
|
+
* For project operations:
|
|
1138
|
+
* ``accounts/{account}/projects/{project}/operations/{operation}``.
|
|
1139
|
+
* Operation paths accept the short ``id``.
|
|
994
1140
|
*/
|
|
995
1141
|
readonly name: string;
|
|
996
1142
|
};
|
|
@@ -1068,7 +1214,7 @@ export interface components {
|
|
|
1068
1214
|
reason?: string | null;
|
|
1069
1215
|
/**
|
|
1070
1216
|
* Requestid
|
|
1071
|
-
* @description
|
|
1217
|
+
* @description Cancellation idempotency key, at most 36 characters; supply to make retries idempotent. Server generates one if omitted.
|
|
1072
1218
|
*/
|
|
1073
1219
|
requestId?: string | null;
|
|
1074
1220
|
};
|
|
@@ -1126,6 +1272,7 @@ export interface components {
|
|
|
1126
1272
|
* @description Optional client-supplied resource id.
|
|
1127
1273
|
*/
|
|
1128
1274
|
assetId?: string | null;
|
|
1275
|
+
/** @description Asset metadata and ingestion source. */
|
|
1129
1276
|
asset: components["schemas"]["AssetCreate"];
|
|
1130
1277
|
};
|
|
1131
1278
|
/**
|
|
@@ -1142,13 +1289,16 @@ export interface components {
|
|
|
1142
1289
|
* Displayname
|
|
1143
1290
|
* @description User-visible label.
|
|
1144
1291
|
*/
|
|
1145
|
-
displayName: string;
|
|
1292
|
+
displayName: string | null;
|
|
1146
1293
|
/**
|
|
1147
1294
|
* Mimetype
|
|
1148
1295
|
* @description Media MIME type, e.g. ``image/png``.
|
|
1149
1296
|
*/
|
|
1150
1297
|
mimeType: string;
|
|
1151
|
-
/**
|
|
1298
|
+
/**
|
|
1299
|
+
* @description Lifecycle state. Only ``READY`` assets can be read or used by a task.
|
|
1300
|
+
* @default CREATED
|
|
1301
|
+
*/
|
|
1152
1302
|
state?: components["schemas"]["AssetState"];
|
|
1153
1303
|
/**
|
|
1154
1304
|
* Width
|
|
@@ -1167,7 +1317,7 @@ export interface components {
|
|
|
1167
1317
|
sizeBytes?: string | null;
|
|
1168
1318
|
/**
|
|
1169
1319
|
* Checksum
|
|
1170
|
-
* @description Checksum
|
|
1320
|
+
* @description Checksum when available.
|
|
1171
1321
|
*/
|
|
1172
1322
|
checksum?: string | null;
|
|
1173
1323
|
/**
|
|
@@ -1192,53 +1342,65 @@ export interface components {
|
|
|
1192
1342
|
structure?: {
|
|
1193
1343
|
[key: string]: unknown;
|
|
1194
1344
|
} | null;
|
|
1195
|
-
/** @description
|
|
1345
|
+
/** @description How the asset came to exist, when that was recorded. */
|
|
1196
1346
|
producedBy?: components["schemas"]["ProducedBy"] | null;
|
|
1347
|
+
/**
|
|
1348
|
+
* Transient
|
|
1349
|
+
* @description True when the bytes are not retained: an upload made while the account does not retain content, or an output of an operation that purges. Both are deleted an hour after the last operation that names them finishes; an upload no operation consumes is deleted by age instead. ``contentPath`` is null for such an asset; read it through ``:createReadUrl``.
|
|
1350
|
+
* @default false
|
|
1351
|
+
*/
|
|
1352
|
+
transient?: boolean;
|
|
1197
1353
|
/**
|
|
1198
1354
|
* Contentpath
|
|
1199
|
-
* @description
|
|
1355
|
+
* @description Already percent-encoded path for the asset. Append it unchanged to ``baseUrl`` before ``?`` and ``signedQuery``. This path does not grant access by itself. Null until the asset is ``READY`` or when unavailable; use ``assets/{asset}:createReadUrl`` as a fallback.
|
|
1200
1356
|
*/
|
|
1201
1357
|
contentPath?: string | null;
|
|
1202
|
-
/**
|
|
1358
|
+
/**
|
|
1359
|
+
* Uploads
|
|
1360
|
+
* @description One grant per declared part; empty for URL or inline ingestion.
|
|
1361
|
+
*/
|
|
1203
1362
|
uploads?: components["schemas"]["UploadGrant"][];
|
|
1204
1363
|
};
|
|
1205
1364
|
/**
|
|
1206
1365
|
* CreateReadPrefixResponse
|
|
1207
|
-
* @description
|
|
1366
|
+
* @description A short-lived credential for a project's whole asset library.
|
|
1208
1367
|
*
|
|
1209
|
-
*
|
|
1210
|
-
*
|
|
1211
|
-
*
|
|
1212
|
-
* ``expiresAt``; the edge validates it on every request.
|
|
1368
|
+
* Build one download URL as ``baseUrl + contentPath + "?" + signedQuery``.
|
|
1369
|
+
* The same credential serves every ready asset in the project until
|
|
1370
|
+
* ``expiresAt``. Treat it as a secret because it grants that broad access.
|
|
1213
1371
|
*/
|
|
1214
1372
|
CreateReadPrefixResponse: {
|
|
1215
1373
|
/**
|
|
1216
1374
|
* Baseurl
|
|
1217
|
-
* @description
|
|
1375
|
+
* @description Project content prefix, ending in ``/``. Append an asset's already encoded ``contentPath`` unchanged.
|
|
1218
1376
|
*/
|
|
1219
1377
|
baseUrl: string;
|
|
1220
1378
|
/**
|
|
1221
1379
|
* Signedquery
|
|
1222
|
-
* @description
|
|
1380
|
+
* @description Opaque, already encoded query string without the leading ``?``. Append it unchanged after ``baseUrl + contentPath``; do not parse or edit it.
|
|
1223
1381
|
*/
|
|
1224
1382
|
signedQuery: string;
|
|
1225
1383
|
/**
|
|
1226
1384
|
* Expiresat
|
|
1227
1385
|
* Format: date-time
|
|
1228
|
-
* @description When
|
|
1386
|
+
* @description When this read credential expires; create a new one after.
|
|
1229
1387
|
*/
|
|
1230
1388
|
expiresAt: string;
|
|
1231
1389
|
};
|
|
1232
|
-
/**
|
|
1390
|
+
/**
|
|
1391
|
+
* CreateReadUrlResponse
|
|
1392
|
+
* @description A short-lived credential for downloading one asset.
|
|
1393
|
+
*/
|
|
1233
1394
|
CreateReadUrlResponse: {
|
|
1234
1395
|
/**
|
|
1235
1396
|
* Readurl
|
|
1236
|
-
* @description Short-lived
|
|
1397
|
+
* @description Short-lived download URL for the asset's bytes. Anyone with the URL can read the asset until it expires; create a fresh one rather than persisting this.
|
|
1237
1398
|
*/
|
|
1238
1399
|
readUrl: string;
|
|
1239
1400
|
/**
|
|
1240
1401
|
* Expiresat
|
|
1241
1402
|
* Format: date-time
|
|
1403
|
+
* @description When ``readUrl`` stops authorizing the download.
|
|
1242
1404
|
*/
|
|
1243
1405
|
expiresAt: string;
|
|
1244
1406
|
};
|
|
@@ -1255,7 +1417,7 @@ export interface components {
|
|
|
1255
1417
|
contentType: string;
|
|
1256
1418
|
/**
|
|
1257
1419
|
* Contentlength
|
|
1258
|
-
* @description Expected upload size in bytes, serialized on the wire as a string.
|
|
1420
|
+
* @description Expected upload size in bytes, serialized on the wire as a string. Capped at 1 GiB.
|
|
1259
1421
|
*/
|
|
1260
1422
|
contentLength: number;
|
|
1261
1423
|
};
|
|
@@ -1264,7 +1426,10 @@ export interface components {
|
|
|
1264
1426
|
* @description Upload ticket for a project-owned Asset.
|
|
1265
1427
|
*/
|
|
1266
1428
|
CreateUploadUrlResponse: {
|
|
1267
|
-
/**
|
|
1429
|
+
/**
|
|
1430
|
+
* Uploadurl
|
|
1431
|
+
* @description Short-lived upload URL. Send the bytes here without the World Labs API key.
|
|
1432
|
+
*/
|
|
1268
1433
|
uploadUrl: string;
|
|
1269
1434
|
/**
|
|
1270
1435
|
* Method
|
|
@@ -1274,6 +1439,7 @@ export interface components {
|
|
|
1274
1439
|
/**
|
|
1275
1440
|
* Expiresat
|
|
1276
1441
|
* Format: date-time
|
|
1442
|
+
* @description When this upload grant expires; create a new one after.
|
|
1277
1443
|
*/
|
|
1278
1444
|
expiresAt: string;
|
|
1279
1445
|
/**
|
|
@@ -1291,13 +1457,19 @@ export interface components {
|
|
|
1291
1457
|
CreateUploadUrlsRequest: {
|
|
1292
1458
|
/**
|
|
1293
1459
|
* Roles
|
|
1294
|
-
* @description Parts
|
|
1460
|
+
* @description Parts that need new upload grants. Empty selects every declared part.
|
|
1295
1461
|
*/
|
|
1296
1462
|
roles?: string[];
|
|
1297
1463
|
};
|
|
1298
|
-
/**
|
|
1464
|
+
/**
|
|
1465
|
+
* CreateUploadUrlsResponse
|
|
1466
|
+
* @description New upload grants for the requested asset parts.
|
|
1467
|
+
*/
|
|
1299
1468
|
CreateUploadUrlsResponse: {
|
|
1300
|
-
/**
|
|
1469
|
+
/**
|
|
1470
|
+
* Uploads
|
|
1471
|
+
* @description One new upload grant per requested part role.
|
|
1472
|
+
*/
|
|
1301
1473
|
uploads?: components["schemas"]["UploadGrant"][];
|
|
1302
1474
|
};
|
|
1303
1475
|
/**
|
|
@@ -1327,31 +1499,6 @@ export interface components {
|
|
|
1327
1499
|
/** Detail */
|
|
1328
1500
|
detail?: components["schemas"]["ValidationError"][];
|
|
1329
1501
|
};
|
|
1330
|
-
/**
|
|
1331
|
-
* ImageCollectionAssetOutput
|
|
1332
|
-
* @description Asset output for tasks that return `files.images.images`.
|
|
1333
|
-
*/
|
|
1334
|
-
ImageCollectionAssetOutput: {
|
|
1335
|
-
files: components["schemas"]["ImageCollectionAssetOutputFiles"];
|
|
1336
|
-
};
|
|
1337
|
-
/**
|
|
1338
|
-
* ImageCollectionAssetOutputFiles
|
|
1339
|
-
* @description Asset output files for tasks that return an image collection.
|
|
1340
|
-
*/
|
|
1341
|
-
ImageCollectionAssetOutputFiles: {
|
|
1342
|
-
images: components["schemas"]["ImageCollectionFiles"];
|
|
1343
|
-
};
|
|
1344
|
-
/**
|
|
1345
|
-
* ImageCollectionFiles
|
|
1346
|
-
* @description Image family containing the image collection role.
|
|
1347
|
-
*/
|
|
1348
|
-
ImageCollectionFiles: {
|
|
1349
|
-
/**
|
|
1350
|
-
* Images
|
|
1351
|
-
* @description Generated image files.
|
|
1352
|
-
*/
|
|
1353
|
-
images: string[];
|
|
1354
|
-
};
|
|
1355
1502
|
/**
|
|
1356
1503
|
* Images2PosedRGBDPerImageResult
|
|
1357
1504
|
* @description Per-image reconstruction output.
|
|
@@ -1385,6 +1532,16 @@ export interface components {
|
|
|
1385
1532
|
* @description Body of ``POST /api/v2/tasks:images2PosedRGBD``.
|
|
1386
1533
|
*/
|
|
1387
1534
|
Images2PosedRGBDRequest: {
|
|
1535
|
+
/**
|
|
1536
|
+
* Webhookurl
|
|
1537
|
+
* @description Where Marble POSTs one signed task.succeeded or task.failed event when this operation finishes; retried for 24 hours. Verify the signature with the public keys at /.well-known/webhooks/jwks.json. Cannot be combined with ?wait=true. https on port 443 only, no IP literals. Developer API only.
|
|
1538
|
+
*/
|
|
1539
|
+
webhookUrl?: string | null;
|
|
1540
|
+
/**
|
|
1541
|
+
* Purgecontentonoperationcompletion
|
|
1542
|
+
* @description Purge this operation's outputs and the transient uploads it consumed one hour after it finishes. Omitted, the account's setting applies; true raises it for this operation; false is refused when the account already purges. Uploads in the library are never purged by an operation.
|
|
1543
|
+
*/
|
|
1544
|
+
purgeContentOnOperationCompletion?: boolean | null;
|
|
1388
1545
|
/**
|
|
1389
1546
|
* Frames
|
|
1390
1547
|
* @description Ordered image inputs (min 1). A frame that carries a camera, a depth buffer or a mask is rejected rather than quietly ignored: none of them reaches the reconstruction.
|
|
@@ -1408,6 +1565,12 @@ export interface components {
|
|
|
1408
1565
|
number,
|
|
1409
1566
|
number
|
|
1410
1567
|
] | null;
|
|
1568
|
+
/**
|
|
1569
|
+
* Refineposes
|
|
1570
|
+
* @description Bundle-adjust the estimated cameras against dense matches before answering. The backbone's poses are good to about half a degree, which is enough to reconstruct from and not enough to refine against: the residual shows up as blur wherever two views disagree. The solve anchors on the depth this task has just produced, so it costs a matcher pass and a solve rather than another reconstruction, and it needs two or more frames. A solve that moves the cameras further than the guards allow is thrown away and the unrefined reconstruction is returned, which is a success rather than an error.
|
|
1571
|
+
* @default false
|
|
1572
|
+
*/
|
|
1573
|
+
refinePoses?: boolean;
|
|
1411
1574
|
};
|
|
1412
1575
|
/**
|
|
1413
1576
|
* Images2PosedRGBDResponse
|
|
@@ -1415,40 +1578,64 @@ export interface components {
|
|
|
1415
1578
|
*/
|
|
1416
1579
|
Images2PosedRGBDResponse: {
|
|
1417
1580
|
/**
|
|
1418
|
-
*
|
|
1419
|
-
* @description One
|
|
1581
|
+
* Frames
|
|
1582
|
+
* @description One reconstructed frame per input image, in request order.
|
|
1583
|
+
*/
|
|
1584
|
+
frames: components["schemas"]["Images2PosedRGBDPerImageResult"][];
|
|
1585
|
+
/**
|
|
1586
|
+
* Poserefinementaccepted
|
|
1587
|
+
* @description When refinePoses was requested, whether the refined cameras were kept. False means the original reconstruction was returned; null means refinement was not requested.
|
|
1420
1588
|
*/
|
|
1421
|
-
|
|
1589
|
+
poseRefinementAccepted?: boolean | null;
|
|
1422
1590
|
};
|
|
1423
|
-
/**
|
|
1591
|
+
/**
|
|
1592
|
+
* Images2PosedRGBDResponseOperation
|
|
1593
|
+
* @description Long-running operation whose successful terminal ``response`` has type ``Images2PosedRGBDResponse``. This is the common Operation envelope with a task-specific response type, not a separate operation resource.
|
|
1594
|
+
*/
|
|
1424
1595
|
Images2PosedRGBDResponseOperation: {
|
|
1425
|
-
/**
|
|
1596
|
+
/**
|
|
1597
|
+
* Id
|
|
1598
|
+
* @description Short operation id used in ``/operations/{operation}`` paths.
|
|
1599
|
+
*/
|
|
1426
1600
|
id: string;
|
|
1427
|
-
/**
|
|
1601
|
+
/**
|
|
1602
|
+
* Ownerid
|
|
1603
|
+
* @description Account that owns the operation.
|
|
1604
|
+
*/
|
|
1428
1605
|
ownerId: string;
|
|
1429
|
-
/**
|
|
1606
|
+
/**
|
|
1607
|
+
* Metadata
|
|
1608
|
+
* @description Task information and optional progress details. Use ``metadata.task`` to interpret a generic operation response, and use ``done`` to determine completion.
|
|
1609
|
+
*/
|
|
1430
1610
|
metadata?: {
|
|
1431
1611
|
[key: string]: unknown;
|
|
1432
1612
|
} | null;
|
|
1433
|
-
/**
|
|
1613
|
+
/**
|
|
1614
|
+
* Done
|
|
1615
|
+
* @description Whether the operation is terminal. When false, both ``response`` and ``error`` are null.
|
|
1616
|
+
*/
|
|
1434
1617
|
done: boolean;
|
|
1618
|
+
/** @description Failure details when ``done`` is true and the task failed; null while running and after success. */
|
|
1435
1619
|
error?: components["schemas"]["OperationError"] | null;
|
|
1436
|
-
/** @description
|
|
1620
|
+
/** @description ``Images2PosedRGBDResponse`` result when ``done`` is true and the task succeeded; null while running and after failure. */
|
|
1437
1621
|
response?: components["schemas"]["Images2PosedRGBDResponse"] | null;
|
|
1438
|
-
/**
|
|
1622
|
+
/**
|
|
1623
|
+
* Expiresatsecs
|
|
1624
|
+
* @description Task execution deadline as Unix seconds, when one is exposed. This is not an asset URL expiration.
|
|
1625
|
+
*/
|
|
1439
1626
|
expiresAtSecs?: number | null;
|
|
1440
1627
|
/**
|
|
1441
1628
|
* Createdatsecs
|
|
1442
|
-
* @description Unix seconds when the operation was
|
|
1629
|
+
* @description Unix seconds when the operation was accepted.
|
|
1443
1630
|
*/
|
|
1444
1631
|
createdAtSecs?: number | null;
|
|
1445
1632
|
/**
|
|
1446
1633
|
* Name
|
|
1447
|
-
* @description
|
|
1634
|
+
* @description Full resource name for the operation.
|
|
1448
1635
|
*
|
|
1449
|
-
*
|
|
1450
|
-
*
|
|
1451
|
-
*
|
|
1636
|
+
* For project operations:
|
|
1637
|
+
* ``accounts/{account}/projects/{project}/operations/{operation}``.
|
|
1638
|
+
* Operation paths accept the short ``id``.
|
|
1452
1639
|
*/
|
|
1453
1640
|
readonly name: string;
|
|
1454
1641
|
};
|
|
@@ -1462,23 +1649,101 @@ export interface components {
|
|
|
1462
1649
|
/** @description EXR of linear depth in world units, as a URL or inline asset. */
|
|
1463
1650
|
depthAsset: components["schemas"]["TaskAsset"];
|
|
1464
1651
|
};
|
|
1465
|
-
/**
|
|
1652
|
+
/**
|
|
1653
|
+
* ListAssetsResponse
|
|
1654
|
+
* @description One page of a project's assets, flat or grouped.
|
|
1655
|
+
*
|
|
1656
|
+
* ``assets`` and ``groups`` are alternatives rather than a pair: a request
|
|
1657
|
+
* that named no ``groupBy`` fills the first and leaves the second empty, and
|
|
1658
|
+
* one that named a grouping does the reverse. The page token pages whichever
|
|
1659
|
+
* of the two was filled, so a grouped page counts groups.
|
|
1660
|
+
*/
|
|
1466
1661
|
ListAssetsResponse: {
|
|
1467
|
-
/**
|
|
1662
|
+
/**
|
|
1663
|
+
* Assets
|
|
1664
|
+
* @description Assets in the selected page. Empty when the request named a grouping.
|
|
1665
|
+
*/
|
|
1468
1666
|
assets?: components["schemas"]["Asset"][];
|
|
1667
|
+
/**
|
|
1668
|
+
* Groups
|
|
1669
|
+
* @description Set only when the request named a grouping. An asset the grouping cannot place is absent - uploads and imports have no producing task - so list without a grouping to reach those.
|
|
1670
|
+
*/
|
|
1671
|
+
groups?: components["schemas"]["AssetGroup"][];
|
|
1469
1672
|
/**
|
|
1470
1673
|
* Nextpagetoken
|
|
1674
|
+
* @description Opaque token for the next page; empty on the final page.
|
|
1471
1675
|
* @default
|
|
1472
1676
|
*/
|
|
1473
1677
|
nextPageToken?: string;
|
|
1474
1678
|
};
|
|
1475
1679
|
/**
|
|
1476
|
-
*
|
|
1680
|
+
* ListedOperation
|
|
1681
|
+
* @description An Operation as the Marble API lists it: with its callback's progress.
|
|
1682
|
+
*/
|
|
1683
|
+
ListedOperation: {
|
|
1684
|
+
/**
|
|
1685
|
+
* Id
|
|
1686
|
+
* @description Short operation id used in ``/operations/{operation}`` paths.
|
|
1687
|
+
*/
|
|
1688
|
+
id: string;
|
|
1689
|
+
/**
|
|
1690
|
+
* Ownerid
|
|
1691
|
+
* @description Account that owns the operation.
|
|
1692
|
+
*/
|
|
1693
|
+
ownerId: string;
|
|
1694
|
+
/**
|
|
1695
|
+
* Metadata
|
|
1696
|
+
* @description Task information and optional progress details. Use ``metadata.task`` to interpret a generic operation response, and use ``done`` to determine completion.
|
|
1697
|
+
*/
|
|
1698
|
+
metadata?: {
|
|
1699
|
+
[key: string]: unknown;
|
|
1700
|
+
} | null;
|
|
1701
|
+
/**
|
|
1702
|
+
* Done
|
|
1703
|
+
* @description Whether the operation is terminal. When false, both ``response`` and ``error`` are null.
|
|
1704
|
+
*/
|
|
1705
|
+
done: boolean;
|
|
1706
|
+
/** @description Failure details when ``done`` is true and the task failed; null while running and after success. */
|
|
1707
|
+
error?: components["schemas"]["OperationError"] | null;
|
|
1708
|
+
/**
|
|
1709
|
+
* Response
|
|
1710
|
+
* @description Task-specific result when ``done`` is true and the task succeeded; null while running and after failure.
|
|
1711
|
+
*/
|
|
1712
|
+
response?: {
|
|
1713
|
+
[key: string]: unknown;
|
|
1714
|
+
} | null;
|
|
1715
|
+
/**
|
|
1716
|
+
* Expiresatsecs
|
|
1717
|
+
* @description Task execution deadline as Unix seconds, when one is exposed. This is not an asset URL expiration.
|
|
1718
|
+
*/
|
|
1719
|
+
expiresAtSecs?: number | null;
|
|
1720
|
+
/**
|
|
1721
|
+
* Createdatsecs
|
|
1722
|
+
* @description Unix seconds when the operation was accepted.
|
|
1723
|
+
*/
|
|
1724
|
+
createdAtSecs?: number | null;
|
|
1725
|
+
/** @description Set for an operation that asked for a callback (webhookUrl). Absent on a cancelled operation, which sends no event, and when the webhook service could not be read. GET the operation's webhookDelivery for the full record. */
|
|
1726
|
+
webhookDelivery?: components["schemas"]["WebhookDeliverySummary"] | null;
|
|
1727
|
+
/**
|
|
1728
|
+
* Name
|
|
1729
|
+
* @description Full resource name for the operation.
|
|
1730
|
+
*
|
|
1731
|
+
* For project operations:
|
|
1732
|
+
* ``accounts/{account}/projects/{project}/operations/{operation}``.
|
|
1733
|
+
* Operation paths accept the short ``id``.
|
|
1734
|
+
*/
|
|
1735
|
+
readonly name: string;
|
|
1736
|
+
};
|
|
1737
|
+
/**
|
|
1738
|
+
* ListedOperationsResponse
|
|
1477
1739
|
* @description A page of operations, newest first.
|
|
1478
1740
|
*/
|
|
1479
|
-
|
|
1480
|
-
/**
|
|
1481
|
-
|
|
1741
|
+
ListedOperationsResponse: {
|
|
1742
|
+
/**
|
|
1743
|
+
* Operations
|
|
1744
|
+
* @description Operations ordered from newest to oldest.
|
|
1745
|
+
*/
|
|
1746
|
+
operations: components["schemas"]["ListedOperation"][];
|
|
1482
1747
|
/**
|
|
1483
1748
|
* Nextpagetoken
|
|
1484
1749
|
* @description Token for the next page; absent when there are no more.
|
|
@@ -1505,65 +1770,59 @@ export interface components {
|
|
|
1505
1770
|
*/
|
|
1506
1771
|
zMax: number;
|
|
1507
1772
|
};
|
|
1508
|
-
/**
|
|
1509
|
-
* MeshAssetOutput
|
|
1510
|
-
* @description Asset output for tasks that return `files.meshes.mesh`.
|
|
1511
|
-
*/
|
|
1512
|
-
MeshAssetOutput: {
|
|
1513
|
-
files: components["schemas"]["MeshAssetOutputFiles"];
|
|
1514
|
-
};
|
|
1515
|
-
/**
|
|
1516
|
-
* MeshAssetOutputFiles
|
|
1517
|
-
* @description Asset output files for mesh tasks.
|
|
1518
|
-
*/
|
|
1519
|
-
MeshAssetOutputFiles: {
|
|
1520
|
-
meshes: components["schemas"]["MeshFiles"];
|
|
1521
|
-
};
|
|
1522
|
-
/**
|
|
1523
|
-
* MeshFiles
|
|
1524
|
-
* @description Mesh family containing the generic mesh role.
|
|
1525
|
-
*/
|
|
1526
|
-
MeshFiles: {
|
|
1527
|
-
/**
|
|
1528
|
-
* Mesh
|
|
1529
|
-
* @description Generated mesh files.
|
|
1530
|
-
*/
|
|
1531
|
-
mesh: string[];
|
|
1532
|
-
};
|
|
1533
1773
|
/**
|
|
1534
1774
|
* Operation
|
|
1535
|
-
* @description
|
|
1775
|
+
* @description The common envelope used to track an asynchronous task.
|
|
1536
1776
|
*/
|
|
1537
1777
|
Operation: {
|
|
1538
|
-
/**
|
|
1778
|
+
/**
|
|
1779
|
+
* Id
|
|
1780
|
+
* @description Short operation id used in ``/operations/{operation}`` paths.
|
|
1781
|
+
*/
|
|
1539
1782
|
id: string;
|
|
1540
|
-
/**
|
|
1783
|
+
/**
|
|
1784
|
+
* Ownerid
|
|
1785
|
+
* @description Account that owns the operation.
|
|
1786
|
+
*/
|
|
1541
1787
|
ownerId: string;
|
|
1542
|
-
/**
|
|
1788
|
+
/**
|
|
1789
|
+
* Metadata
|
|
1790
|
+
* @description Task information and optional progress details. Use ``metadata.task`` to interpret a generic operation response, and use ``done`` to determine completion.
|
|
1791
|
+
*/
|
|
1543
1792
|
metadata?: {
|
|
1544
1793
|
[key: string]: unknown;
|
|
1545
1794
|
} | null;
|
|
1546
|
-
/**
|
|
1795
|
+
/**
|
|
1796
|
+
* Done
|
|
1797
|
+
* @description Whether the operation is terminal. When false, both ``response`` and ``error`` are null.
|
|
1798
|
+
*/
|
|
1547
1799
|
done: boolean;
|
|
1800
|
+
/** @description Failure details when ``done`` is true and the task failed; null while running and after success. */
|
|
1548
1801
|
error?: components["schemas"]["OperationError"] | null;
|
|
1549
|
-
/**
|
|
1802
|
+
/**
|
|
1803
|
+
* Response
|
|
1804
|
+
* @description Task-specific result when ``done`` is true and the task succeeded; null while running and after failure.
|
|
1805
|
+
*/
|
|
1550
1806
|
response?: {
|
|
1551
1807
|
[key: string]: unknown;
|
|
1552
1808
|
} | null;
|
|
1553
|
-
/**
|
|
1809
|
+
/**
|
|
1810
|
+
* Expiresatsecs
|
|
1811
|
+
* @description Task execution deadline as Unix seconds, when one is exposed. This is not an asset URL expiration.
|
|
1812
|
+
*/
|
|
1554
1813
|
expiresAtSecs?: number | null;
|
|
1555
1814
|
/**
|
|
1556
1815
|
* Createdatsecs
|
|
1557
|
-
* @description Unix seconds when the operation was
|
|
1816
|
+
* @description Unix seconds when the operation was accepted.
|
|
1558
1817
|
*/
|
|
1559
1818
|
createdAtSecs?: number | null;
|
|
1560
1819
|
/**
|
|
1561
1820
|
* Name
|
|
1562
|
-
* @description
|
|
1821
|
+
* @description Full resource name for the operation.
|
|
1563
1822
|
*
|
|
1564
|
-
*
|
|
1565
|
-
*
|
|
1566
|
-
*
|
|
1823
|
+
* For project operations:
|
|
1824
|
+
* ``accounts/{account}/projects/{project}/operations/{operation}``.
|
|
1825
|
+
* Operation paths accept the short ``id``.
|
|
1567
1826
|
*/
|
|
1568
1827
|
readonly name: string;
|
|
1569
1828
|
};
|
|
@@ -1590,9 +1849,19 @@ export interface components {
|
|
|
1590
1849
|
[key: string]: unknown;
|
|
1591
1850
|
}[];
|
|
1592
1851
|
};
|
|
1852
|
+
/**
|
|
1853
|
+
* OperationStatus
|
|
1854
|
+
* @description Coarse outcome filter derived from ``done`` and ``error``.
|
|
1855
|
+
*
|
|
1856
|
+
* FAILED is every done operation carrying an error, so cancelled and expired
|
|
1857
|
+
* operations count as failed; ``metadata.state`` keeps the finer lifecycle
|
|
1858
|
+
* value.
|
|
1859
|
+
* @enum {string}
|
|
1860
|
+
*/
|
|
1861
|
+
OperationStatus: "RUNNING" | "SUCCEEDED" | "FAILED";
|
|
1593
1862
|
/**
|
|
1594
1863
|
* OperationTrace
|
|
1595
|
-
* @description
|
|
1864
|
+
* @description The caller's recorded request beside the Operation's own response and error.
|
|
1596
1865
|
*/
|
|
1597
1866
|
OperationTrace: {
|
|
1598
1867
|
/** Operationid */
|
|
@@ -1601,14 +1870,22 @@ export interface components {
|
|
|
1601
1870
|
taskName: string;
|
|
1602
1871
|
/** Taskversion */
|
|
1603
1872
|
taskVersion: string;
|
|
1604
|
-
/**
|
|
1605
|
-
|
|
1873
|
+
/**
|
|
1874
|
+
* Request
|
|
1875
|
+
* @description The request as the caller sent it, projected through the task's current public schema when that schema still accepts it and as recorded otherwise. Null only for early operations that retained no caller-shaped request.
|
|
1876
|
+
*/
|
|
1877
|
+
request?: {
|
|
1606
1878
|
[key: string]: unknown;
|
|
1607
|
-
};
|
|
1608
|
-
/**
|
|
1879
|
+
} | null;
|
|
1880
|
+
/**
|
|
1881
|
+
* Response
|
|
1882
|
+
* @description The Operation's ``response``, served the same way.
|
|
1883
|
+
*/
|
|
1609
1884
|
response?: {
|
|
1610
1885
|
[key: string]: unknown;
|
|
1611
1886
|
} | null;
|
|
1887
|
+
/** @description The Operation's ``error``, served the same way. */
|
|
1888
|
+
error?: components["schemas"]["OperationError"] | null;
|
|
1612
1889
|
};
|
|
1613
1890
|
/**
|
|
1614
1891
|
* PinholeCamera
|
|
@@ -1714,9 +1991,28 @@ export interface components {
|
|
|
1714
1991
|
};
|
|
1715
1992
|
/**
|
|
1716
1993
|
* ProducedBy
|
|
1717
|
-
* @description
|
|
1994
|
+
* @description How the asset came to exist.
|
|
1995
|
+
*
|
|
1996
|
+
* Present on every asset whose provenance was recorded. ``producer`` says
|
|
1997
|
+
* which act made it, and the rest qualify that act: ``task`` and
|
|
1998
|
+
* ``operation`` are set only for ``TASK``, and ``applet`` and ``session``
|
|
1999
|
+
* only for work done through the Web API.
|
|
1718
2000
|
*/
|
|
1719
2001
|
ProducedBy: {
|
|
2002
|
+
/** @description The act that made the asset. */
|
|
2003
|
+
producer: components["schemas"]["AssetProducer"];
|
|
2004
|
+
/** @description The product surface the act came through. */
|
|
2005
|
+
origin?: components["schemas"]["ResourceOrigin"] | null;
|
|
2006
|
+
/**
|
|
2007
|
+
* Applet
|
|
2008
|
+
* @description The applet the asset came from, e.g. ``turntable``. Set for Web API work whose session named one.
|
|
2009
|
+
*/
|
|
2010
|
+
applet?: string | null;
|
|
2011
|
+
/**
|
|
2012
|
+
* Session
|
|
2013
|
+
* @description The Web API session the asset was made inside.
|
|
2014
|
+
*/
|
|
2015
|
+
session?: string | null;
|
|
1720
2016
|
/**
|
|
1721
2017
|
* Task
|
|
1722
2018
|
* @description The task that produced it, e.g. ``image2DraftSplats``.
|
|
@@ -1810,6 +2106,16 @@ export interface components {
|
|
|
1810
2106
|
* @description Body of a splats2Mesh request.
|
|
1811
2107
|
*/
|
|
1812
2108
|
Splats2MeshRequest: {
|
|
2109
|
+
/**
|
|
2110
|
+
* Webhookurl
|
|
2111
|
+
* @description Where Marble POSTs one signed task.succeeded or task.failed event when this operation finishes; retried for 24 hours. Verify the signature with the public keys at /.well-known/webhooks/jwks.json. Cannot be combined with ?wait=true. https on port 443 only, no IP literals. Developer API only.
|
|
2112
|
+
*/
|
|
2113
|
+
webhookUrl?: string | null;
|
|
2114
|
+
/**
|
|
2115
|
+
* Purgecontentonoperationcompletion
|
|
2116
|
+
* @description Purge this operation's outputs and the transient uploads it consumed one hour after it finishes. Omitted, the account's setting applies; true raises it for this operation; false is refused when the account already purges. Uploads in the library are never purged by an operation.
|
|
2117
|
+
*/
|
|
2118
|
+
purgeContentOnOperationCompletion?: boolean | null;
|
|
1813
2119
|
/**
|
|
1814
2120
|
* Cameras
|
|
1815
2121
|
* @description Cameras the splats are rendered from. The surface is reconstructed from those renders, so geometry no camera sees is not meshed. Name a strategy -- `auto_anchors` (the default) finds viewpoints in the scene's free space, `manual_anchors` takes them from the request, `exterior_sphere` rings the scene from outside for an object or turntable capture -- or pass a list of cameras to render as given, at most 512, sharing one width and height between 64 and 1024 that becomes the render resolution.
|
|
@@ -1845,8 +2151,8 @@ export interface components {
|
|
|
1845
2151
|
* @description Public response projected into the completed Operation.
|
|
1846
2152
|
*/
|
|
1847
2153
|
Splats2MeshResponse: {
|
|
1848
|
-
/** @description The generated
|
|
1849
|
-
|
|
2154
|
+
/** @description The generated GLB mesh. */
|
|
2155
|
+
mesh: components["schemas"]["TaskAsset"];
|
|
1850
2156
|
/**
|
|
1851
2157
|
* Anchorpositions
|
|
1852
2158
|
* @description Anchor positions the cameras were generated from, in Three.js coordinates. Null when no anchors were used: cameras were supplied directly, or `exterior_sphere` was chosen.
|
|
@@ -1865,41 +2171,65 @@ export interface components {
|
|
|
1865
2171
|
[key: string]: string;
|
|
1866
2172
|
};
|
|
1867
2173
|
};
|
|
1868
|
-
/**
|
|
2174
|
+
/**
|
|
2175
|
+
* Splats2MeshResponseOperation
|
|
2176
|
+
* @description Long-running operation whose successful terminal ``response`` has type ``Splats2MeshResponse``. This is the common Operation envelope with a task-specific response type, not a separate operation resource.
|
|
2177
|
+
*/
|
|
1869
2178
|
Splats2MeshResponseOperation: {
|
|
1870
|
-
/**
|
|
2179
|
+
/**
|
|
2180
|
+
* Id
|
|
2181
|
+
* @description Short operation id used in ``/operations/{operation}`` paths.
|
|
2182
|
+
*/
|
|
1871
2183
|
id: string;
|
|
1872
|
-
/**
|
|
2184
|
+
/**
|
|
2185
|
+
* Ownerid
|
|
2186
|
+
* @description Account that owns the operation.
|
|
2187
|
+
*/
|
|
1873
2188
|
ownerId: string;
|
|
1874
|
-
/**
|
|
2189
|
+
/**
|
|
2190
|
+
* Metadata
|
|
2191
|
+
* @description Task information and optional progress details. Use ``metadata.task`` to interpret a generic operation response, and use ``done`` to determine completion.
|
|
2192
|
+
*/
|
|
1875
2193
|
metadata?: {
|
|
1876
2194
|
[key: string]: unknown;
|
|
1877
2195
|
} | null;
|
|
1878
|
-
/**
|
|
2196
|
+
/**
|
|
2197
|
+
* Done
|
|
2198
|
+
* @description Whether the operation is terminal. When false, both ``response`` and ``error`` are null.
|
|
2199
|
+
*/
|
|
1879
2200
|
done: boolean;
|
|
2201
|
+
/** @description Failure details when ``done`` is true and the task failed; null while running and after success. */
|
|
1880
2202
|
error?: components["schemas"]["OperationError"] | null;
|
|
1881
|
-
/** @description
|
|
2203
|
+
/** @description ``Splats2MeshResponse`` result when ``done`` is true and the task succeeded; null while running and after failure. */
|
|
1882
2204
|
response?: components["schemas"]["Splats2MeshResponse"] | null;
|
|
1883
|
-
/**
|
|
2205
|
+
/**
|
|
2206
|
+
* Expiresatsecs
|
|
2207
|
+
* @description Task execution deadline as Unix seconds, when one is exposed. This is not an asset URL expiration.
|
|
2208
|
+
*/
|
|
1884
2209
|
expiresAtSecs?: number | null;
|
|
1885
2210
|
/**
|
|
1886
2211
|
* Createdatsecs
|
|
1887
|
-
* @description Unix seconds when the operation was
|
|
2212
|
+
* @description Unix seconds when the operation was accepted.
|
|
1888
2213
|
*/
|
|
1889
2214
|
createdAtSecs?: number | null;
|
|
1890
2215
|
/**
|
|
1891
2216
|
* Name
|
|
1892
|
-
* @description
|
|
2217
|
+
* @description Full resource name for the operation.
|
|
1893
2218
|
*
|
|
1894
|
-
*
|
|
1895
|
-
*
|
|
1896
|
-
*
|
|
2219
|
+
* For project operations:
|
|
2220
|
+
* ``accounts/{account}/projects/{project}/operations/{operation}``.
|
|
2221
|
+
* Operation paths accept the short ``id``.
|
|
1897
2222
|
*/
|
|
1898
2223
|
readonly name: string;
|
|
1899
2224
|
};
|
|
1900
2225
|
/**
|
|
1901
2226
|
* TaskAsset
|
|
1902
|
-
* @description Media
|
|
2227
|
+
* @description Media named by asset id, inline base64, or public URL.
|
|
2228
|
+
*
|
|
2229
|
+
* A task response names each output by id and url together: the url expires,
|
|
2230
|
+
* the id does not. The pair is accepted as input as well, so a response can
|
|
2231
|
+
* be handed straight back to the next task; the id names the media and the
|
|
2232
|
+
* url is ignored. Inline base64 is an input form only, and stands alone.
|
|
1903
2233
|
*/
|
|
1904
2234
|
TaskAsset: {
|
|
1905
2235
|
/**
|
|
@@ -1909,28 +2239,34 @@ export interface components {
|
|
|
1909
2239
|
assetId?: string | null;
|
|
1910
2240
|
/**
|
|
1911
2241
|
* Base64
|
|
1912
|
-
* @description Base64-encoded media bytes, with or without a data URL prefix. Decoded size must be less than 10 MiB.
|
|
2242
|
+
* @description Base64-encoded media bytes, with or without a data URL prefix. Decoded size must be less than 10 MiB. Input only: a task response never carries inline bytes.
|
|
1913
2243
|
*/
|
|
1914
2244
|
base64?: string | null;
|
|
1915
2245
|
/**
|
|
1916
2246
|
* Url
|
|
1917
|
-
* @description Public HTTP(S) URL containing the media.
|
|
2247
|
+
* @description Public HTTP(S) URL containing the media. On a task response this is a read URL for `assetId` and it expires; mint a fresh one with `assets/{asset}:createReadUrl`.
|
|
1918
2248
|
*/
|
|
1919
2249
|
url?: string | null;
|
|
1920
2250
|
};
|
|
1921
2251
|
/**
|
|
1922
2252
|
* UploadGrant
|
|
1923
|
-
* @description Permission to upload one part
|
|
2253
|
+
* @description Permission to upload one asset part.
|
|
1924
2254
|
*/
|
|
1925
2255
|
UploadGrant: {
|
|
1926
|
-
/**
|
|
2256
|
+
/**
|
|
2257
|
+
* Role
|
|
2258
|
+
* @description Declared asset-part role this upload fills.
|
|
2259
|
+
*/
|
|
1927
2260
|
role: string;
|
|
1928
2261
|
/**
|
|
1929
2262
|
* Method
|
|
1930
2263
|
* @description HTTP verb to use for the upload, e.g. PUT.
|
|
1931
2264
|
*/
|
|
1932
2265
|
method: string;
|
|
1933
|
-
/**
|
|
2266
|
+
/**
|
|
2267
|
+
* Url
|
|
2268
|
+
* @description Short-lived upload URL. Send the bytes here without the World Labs API key.
|
|
2269
|
+
*/
|
|
1934
2270
|
url: string;
|
|
1935
2271
|
/**
|
|
1936
2272
|
* Headers
|
|
@@ -1942,6 +2278,7 @@ export interface components {
|
|
|
1942
2278
|
/**
|
|
1943
2279
|
* Expiresat
|
|
1944
2280
|
* Format: date-time
|
|
2281
|
+
* @description When this upload grant expires; create a new one after.
|
|
1945
2282
|
*/
|
|
1946
2283
|
expiresAt: string;
|
|
1947
2284
|
};
|
|
@@ -1969,6 +2306,114 @@ export interface components {
|
|
|
1969
2306
|
*/
|
|
1970
2307
|
timeoutSecs?: number | null;
|
|
1971
2308
|
};
|
|
2309
|
+
/**
|
|
2310
|
+
* WebhookDelivery
|
|
2311
|
+
* @description The callback record for one operation.
|
|
2312
|
+
*/
|
|
2313
|
+
WebhookDelivery: {
|
|
2314
|
+
/**
|
|
2315
|
+
* Name
|
|
2316
|
+
* @description `accounts/{account}/projects/{project}/operations/{operation}/webhookDelivery`.
|
|
2317
|
+
*/
|
|
2318
|
+
name: string;
|
|
2319
|
+
/**
|
|
2320
|
+
* Deliveryid
|
|
2321
|
+
* @description The value sent in the `webhook-id` header; absent while SCHEDULED or PUBLISH_FAILED.
|
|
2322
|
+
*/
|
|
2323
|
+
deliveryId?: string | null;
|
|
2324
|
+
/**
|
|
2325
|
+
* Webhookurl
|
|
2326
|
+
* @description The accepted webhookUrl; absent once the operation's content was purged, while the delivery record itself stays.
|
|
2327
|
+
*/
|
|
2328
|
+
webhookUrl?: string | null;
|
|
2329
|
+
/**
|
|
2330
|
+
* State
|
|
2331
|
+
* @description SCHEDULED until the operation is terminal and handed over; PUBLISH_FAILED when Marble could not hand the completion to its webhook service (poll the operation instead); then the delivery's own state: PENDING (waiting for the next attempt), IN_FLIGHT, DELIVERED, SUPPRESSED (the receiver answered 410), EXHAUSTED (the 24-hour window closed, or after one attempt when the webhookUrl host resolves to a private address). A cancelled operation sends no event and answers 404.
|
|
2332
|
+
*/
|
|
2333
|
+
state: ("SCHEDULED" | "PUBLISH_FAILED") | ("PENDING" | "IN_FLIGHT" | "DELIVERED" | "SUPPRESSED" | "EXHAUSTED");
|
|
2334
|
+
/**
|
|
2335
|
+
* Event
|
|
2336
|
+
* @description The exact event body sent, once the delivery exists.
|
|
2337
|
+
*/
|
|
2338
|
+
event?: {
|
|
2339
|
+
[key: string]: unknown;
|
|
2340
|
+
} | null;
|
|
2341
|
+
/**
|
|
2342
|
+
* Attemptcount
|
|
2343
|
+
* @description Sends attempted so far; a claim counts before its outcome.
|
|
2344
|
+
* @default 0
|
|
2345
|
+
*/
|
|
2346
|
+
attemptCount?: number;
|
|
2347
|
+
/** Lastattempttime */
|
|
2348
|
+
lastAttemptTime?: string | null;
|
|
2349
|
+
lastAttempt?: components["schemas"]["WebhookDeliveryAttempt"] | null;
|
|
2350
|
+
/**
|
|
2351
|
+
* Nextattempttime
|
|
2352
|
+
* @description Scheduled time of the next attempt while PENDING.
|
|
2353
|
+
*/
|
|
2354
|
+
nextAttemptTime?: string | null;
|
|
2355
|
+
/**
|
|
2356
|
+
* Expiretime
|
|
2357
|
+
* @description End of the 24-hour window.
|
|
2358
|
+
*/
|
|
2359
|
+
expireTime?: string | null;
|
|
2360
|
+
/**
|
|
2361
|
+
* Finishtime
|
|
2362
|
+
* @description Set when terminal.
|
|
2363
|
+
*/
|
|
2364
|
+
finishTime?: string | null;
|
|
2365
|
+
/**
|
|
2366
|
+
* Purgetime
|
|
2367
|
+
* @description Expires 90 days after the webhook service accepted the delivery.
|
|
2368
|
+
*/
|
|
2369
|
+
purgeTime?: string | null;
|
|
2370
|
+
/**
|
|
2371
|
+
* Createtime
|
|
2372
|
+
* Format: date-time
|
|
2373
|
+
*/
|
|
2374
|
+
createTime: string;
|
|
2375
|
+
/**
|
|
2376
|
+
* Updatetime
|
|
2377
|
+
* Format: date-time
|
|
2378
|
+
*/
|
|
2379
|
+
updateTime: string;
|
|
2380
|
+
};
|
|
2381
|
+
/**
|
|
2382
|
+
* WebhookDeliveryAttempt
|
|
2383
|
+
* @description The latest send's outcome; never the receiver's body.
|
|
2384
|
+
*/
|
|
2385
|
+
WebhookDeliveryAttempt: {
|
|
2386
|
+
/**
|
|
2387
|
+
* Httpstatus
|
|
2388
|
+
* @description The receiver's status, if it answered.
|
|
2389
|
+
*/
|
|
2390
|
+
httpStatus?: number | null;
|
|
2391
|
+
/**
|
|
2392
|
+
* Errorcategory
|
|
2393
|
+
* @description Why the attempt did not get a status: a send that failed (timeout, connect_error, tls_error, internal, proxy_rejected:<reason> such as dns_error or private_address), or a close with no send (expired, purged, account_deleted); `publish_failed` while PUBLISH_FAILED.
|
|
2394
|
+
*/
|
|
2395
|
+
errorCategory?: string | null;
|
|
2396
|
+
};
|
|
2397
|
+
/**
|
|
2398
|
+
* WebhookDeliverySummary
|
|
2399
|
+
* @description A listed operation's callback at a glance; its webhookDelivery has the
|
|
2400
|
+
* full record.
|
|
2401
|
+
*/
|
|
2402
|
+
WebhookDeliverySummary: {
|
|
2403
|
+
/**
|
|
2404
|
+
* State
|
|
2405
|
+
* @description The state its webhookDelivery answers.
|
|
2406
|
+
*/
|
|
2407
|
+
state: ("SCHEDULED" | "PUBLISH_FAILED") | ("PENDING" | "IN_FLIGHT" | "DELIVERED" | "SUPPRESSED" | "EXHAUSTED");
|
|
2408
|
+
/**
|
|
2409
|
+
* Attemptcount
|
|
2410
|
+
* @description Sends attempted so far; a claim counts before its outcome.
|
|
2411
|
+
* @default 0
|
|
2412
|
+
*/
|
|
2413
|
+
attemptCount?: number;
|
|
2414
|
+
/** Lastattempttime */
|
|
2415
|
+
lastAttemptTime?: string | null;
|
|
2416
|
+
};
|
|
1972
2417
|
};
|
|
1973
2418
|
responses: never;
|
|
1974
2419
|
parameters: never;
|
|
@@ -1978,8 +2423,12 @@ export interface components {
|
|
|
1978
2423
|
}
|
|
1979
2424
|
export type Asset = components['schemas']['Asset'];
|
|
1980
2425
|
export type AssetCreate = components['schemas']['AssetCreate'];
|
|
2426
|
+
export type AssetGroup = components['schemas']['AssetGroup'];
|
|
2427
|
+
export type AssetGrouping = components['schemas']['AssetGrouping'];
|
|
2428
|
+
export type AssetOrder = components['schemas']['AssetOrder'];
|
|
1981
2429
|
export type AssetPart = components['schemas']['AssetPart'];
|
|
1982
2430
|
export type AssetPartDeclaration = components['schemas']['AssetPartDeclaration'];
|
|
2431
|
+
export type AssetProducer = components['schemas']['AssetProducer'];
|
|
1983
2432
|
export type AssetState = components['schemas']['AssetState'];
|
|
1984
2433
|
export type AtlasChiselModelParameters = components['schemas']['AtlasChiselModelParameters'];
|
|
1985
2434
|
export type AtlasChiselRequest = components['schemas']['AtlasChiselRequest'];
|
|
@@ -2013,22 +2462,18 @@ export type CreateUploadUrlsResponse = components['schemas']['CreateUploadUrlsRe
|
|
|
2013
2462
|
export type Empty = components['schemas']['Empty'];
|
|
2014
2463
|
export type FrameRGBAsset = components['schemas']['FrameRGBAsset'];
|
|
2015
2464
|
export type HTTPValidationError = components['schemas']['HTTPValidationError'];
|
|
2016
|
-
export type ImageCollectionAssetOutput = components['schemas']['ImageCollectionAssetOutput'];
|
|
2017
|
-
export type ImageCollectionAssetOutputFiles = components['schemas']['ImageCollectionAssetOutputFiles'];
|
|
2018
|
-
export type ImageCollectionFiles = components['schemas']['ImageCollectionFiles'];
|
|
2019
2465
|
export type Images2PosedRGBDPerImageResult = components['schemas']['Images2PosedRGBDPerImageResult'];
|
|
2020
2466
|
export type Images2PosedRGBDRequest = components['schemas']['Images2PosedRGBDRequest'];
|
|
2021
2467
|
export type Images2PosedRGBDResponse = components['schemas']['Images2PosedRGBDResponse'];
|
|
2022
2468
|
export type Images2PosedRGBDResponseOperation = components['schemas']['Images2PosedRGBDResponseOperation'];
|
|
2023
2469
|
export type LinearDepthBufferAsset = components['schemas']['LinearDepthBufferAsset'];
|
|
2024
2470
|
export type ListAssetsResponse = components['schemas']['ListAssetsResponse'];
|
|
2025
|
-
export type
|
|
2471
|
+
export type ListedOperation = components['schemas']['ListedOperation'];
|
|
2472
|
+
export type ListedOperationsResponse = components['schemas']['ListedOperationsResponse'];
|
|
2026
2473
|
export type LogDepthBufferAsset = components['schemas']['LogDepthBufferAsset'];
|
|
2027
|
-
export type MeshAssetOutput = components['schemas']['MeshAssetOutput'];
|
|
2028
|
-
export type MeshAssetOutputFiles = components['schemas']['MeshAssetOutputFiles'];
|
|
2029
|
-
export type MeshFiles = components['schemas']['MeshFiles'];
|
|
2030
2474
|
export type Operation = components['schemas']['Operation'];
|
|
2031
2475
|
export type OperationError = components['schemas']['OperationError'];
|
|
2476
|
+
export type OperationStatus = components['schemas']['OperationStatus'];
|
|
2032
2477
|
export type OperationTrace = components['schemas']['OperationTrace'];
|
|
2033
2478
|
export type PinholeCamera = components['schemas']['PinholeCamera'];
|
|
2034
2479
|
export type PinholeCameraIntrinsics = components['schemas']['PinholeCameraIntrinsics'];
|
|
@@ -2047,6 +2492,9 @@ export type TaskAsset = components['schemas']['TaskAsset'];
|
|
|
2047
2492
|
export type UploadGrant = components['schemas']['UploadGrant'];
|
|
2048
2493
|
export type ValidationError = components['schemas']['ValidationError'];
|
|
2049
2494
|
export type WaitOperationRequest = components['schemas']['WaitOperationRequest'];
|
|
2495
|
+
export type WebhookDelivery = components['schemas']['WebhookDelivery'];
|
|
2496
|
+
export type WebhookDeliveryAttempt = components['schemas']['WebhookDeliveryAttempt'];
|
|
2497
|
+
export type WebhookDeliverySummary = components['schemas']['WebhookDeliverySummary'];
|
|
2050
2498
|
export type $defs = Record<string, never>;
|
|
2051
2499
|
export interface operations {
|
|
2052
2500
|
api_health_api_v2_health_get: {
|
|
@@ -2309,6 +2757,14 @@ export interface operations {
|
|
|
2309
2757
|
parameters: {
|
|
2310
2758
|
query?: {
|
|
2311
2759
|
origin?: components["schemas"]["ResourceOrigin"] | null;
|
|
2760
|
+
/** @description Only operations of this task, as named in metadata.task. */
|
|
2761
|
+
task?: string | null;
|
|
2762
|
+
/** @description Only operations with this outcome. FAILED is every done operation carrying an error, including cancelled and expired ones. */
|
|
2763
|
+
status?: components["schemas"]["OperationStatus"] | null;
|
|
2764
|
+
/** @description Unix seconds; only operations accepted at or after this time. */
|
|
2765
|
+
createdAfter?: number | null;
|
|
2766
|
+
/** @description Unix seconds; only operations accepted before this time. */
|
|
2767
|
+
createdBefore?: number | null;
|
|
2312
2768
|
pageSize?: number;
|
|
2313
2769
|
pageToken?: string | null;
|
|
2314
2770
|
};
|
|
@@ -2324,7 +2780,7 @@ export interface operations {
|
|
|
2324
2780
|
[name: string]: unknown;
|
|
2325
2781
|
};
|
|
2326
2782
|
content: {
|
|
2327
|
-
"application/json": components["schemas"]["
|
|
2783
|
+
"application/json": components["schemas"]["ListedOperationsResponse"];
|
|
2328
2784
|
};
|
|
2329
2785
|
};
|
|
2330
2786
|
/** @description Validation Error */
|
|
@@ -2439,6 +2895,37 @@ export interface operations {
|
|
|
2439
2895
|
};
|
|
2440
2896
|
};
|
|
2441
2897
|
};
|
|
2898
|
+
get_webhook_delivery_api_v2_operations__operation__webhookDelivery_get: {
|
|
2899
|
+
parameters: {
|
|
2900
|
+
query?: never;
|
|
2901
|
+
header?: never;
|
|
2902
|
+
path: {
|
|
2903
|
+
operation: string;
|
|
2904
|
+
};
|
|
2905
|
+
cookie?: never;
|
|
2906
|
+
};
|
|
2907
|
+
requestBody?: never;
|
|
2908
|
+
responses: {
|
|
2909
|
+
/** @description Successful Response */
|
|
2910
|
+
200: {
|
|
2911
|
+
headers: {
|
|
2912
|
+
[name: string]: unknown;
|
|
2913
|
+
};
|
|
2914
|
+
content: {
|
|
2915
|
+
"application/json": components["schemas"]["WebhookDelivery"];
|
|
2916
|
+
};
|
|
2917
|
+
};
|
|
2918
|
+
/** @description Validation Error */
|
|
2919
|
+
422: {
|
|
2920
|
+
headers: {
|
|
2921
|
+
[name: string]: unknown;
|
|
2922
|
+
};
|
|
2923
|
+
content: {
|
|
2924
|
+
"application/json": components["schemas"]["HTTPValidationError"];
|
|
2925
|
+
};
|
|
2926
|
+
};
|
|
2927
|
+
};
|
|
2928
|
+
};
|
|
2442
2929
|
get_operation_api_v2_operations__operation__get: {
|
|
2443
2930
|
parameters: {
|
|
2444
2931
|
query?: {
|
|
@@ -2479,6 +2966,22 @@ export interface operations {
|
|
|
2479
2966
|
origin?: components["schemas"]["ResourceOrigin"] | null;
|
|
2480
2967
|
/** @description Filter by state. Omit for all non-deleted states. */
|
|
2481
2968
|
state?: components["schemas"]["AssetState"] | null;
|
|
2969
|
+
/** @description Only assets made inside this Web API session. */
|
|
2970
|
+
session?: string | null;
|
|
2971
|
+
/** @description Only assets that came from this applet. */
|
|
2972
|
+
applet?: string | null;
|
|
2973
|
+
/** @description Only assets of this media type. A trailing `/*`, as in `image/*`, matches every type in the family. */
|
|
2974
|
+
mimeType?: string | null;
|
|
2975
|
+
/** @description Only assets this Operation produced. */
|
|
2976
|
+
operation?: string | null;
|
|
2977
|
+
/** @description Only assets this task produced, e.g. `image2DraftSplats`. */
|
|
2978
|
+
task?: string | null;
|
|
2979
|
+
/** @description Only assets made this way, e.g. `UPLOAD` for the customer's own bytes. Assets recorded before the producer was stored match no value. */
|
|
2980
|
+
producer?: components["schemas"]["AssetProducer"] | null;
|
|
2981
|
+
/** @description Collect the assets under what produced them. The page then counts groups rather than assets. */
|
|
2982
|
+
groupBy?: components["schemas"]["AssetGrouping"] | null;
|
|
2983
|
+
/** @description Order of the page. A grouped page orders each group by its leading asset: its newest one descending, its oldest ascending. */
|
|
2984
|
+
orderBy?: components["schemas"]["AssetOrder"];
|
|
2482
2985
|
pageSize?: number;
|
|
2483
2986
|
pageToken?: string | null;
|
|
2484
2987
|
};
|