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