@worldlabsai/client 0.1.0 → 0.2.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.
@@ -29,7 +29,7 @@ export interface paths {
29
29
  };
30
30
  get?: never;
31
31
  put?: never;
32
- /** Submit a atlasChisel task */
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 a atlasGenerate task */
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 a atlasMasked task */
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 a atlasTextToImage task */
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 a images2PosedRGBD task */
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 a splats2Mesh task */
117
+ /** Submit the splats2Mesh task */
118
118
  post: operations["submit_splats2Mesh_api_v2_tasks_splats2Mesh_post"];
119
119
  delete?: never;
120
120
  options?: never;
@@ -346,13 +346,16 @@ export interface components {
346
346
  * Displayname
347
347
  * @description User-visible label.
348
348
  */
349
- displayName: string;
349
+ displayName: string | null;
350
350
  /**
351
351
  * Mimetype
352
352
  * @description Media MIME type, e.g. ``image/png``.
353
353
  */
354
354
  mimeType: string;
355
- /** @default CREATED */
355
+ /**
356
+ * @description Lifecycle state. Only ``READY`` assets can be read or used by a task.
357
+ * @default CREATED
358
+ */
356
359
  state?: components["schemas"]["AssetState"];
357
360
  /**
358
361
  * Width
@@ -371,7 +374,7 @@ export interface components {
371
374
  sizeBytes?: string | null;
372
375
  /**
373
376
  * Checksum
374
- * @description Checksum the store reports, e.g. ``crc32c:...``.
377
+ * @description Checksum when available.
375
378
  */
376
379
  checksum?: string | null;
377
380
  /**
@@ -400,7 +403,7 @@ export interface components {
400
403
  producedBy?: components["schemas"]["ProducedBy"] | null;
401
404
  /**
402
405
  * Contentpath
403
- * @description Where the asset's bytes sit under the project's content prefix, ``<class>/<asset>[/<role>]``, each segment percent-encoded as a URL path segment. Appended to a read prefix's ``baseUrl`` and followed by its ``signedQuery`` it addresses the bytes on the content edge; on its own it grants nothing. A read prefix is minted per project by ``:createReadPrefix`` (on the project for web sessions, on ``/assets`` for API keys); ``:createReadUrl`` stays the single-object download. Null until the bytes exist.
406
+ * @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
407
  */
405
408
  contentPath?: string | null;
406
409
  };
@@ -413,7 +416,7 @@ export interface components {
413
416
  * Displayname
414
417
  * @description User-visible label.
415
418
  */
416
- displayName: string;
419
+ displayName?: string | null;
417
420
  /**
418
421
  * Type
419
422
  * @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 +441,13 @@ export interface components {
438
441
  base64?: string | null;
439
442
  /**
440
443
  * Url
441
- * @description A URL the platform fetches. The asset comes back ``READY``. The address is opened by a sandboxed workload, never by the API.
444
+ * @description A public URL the platform fetches. The asset comes back ``READY``.
442
445
  */
443
446
  url?: string | null;
444
447
  };
445
448
  /**
446
449
  * AssetPart
447
450
  * @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
451
  */
453
452
  AssetPart: {
454
453
  /**
@@ -478,7 +477,7 @@ export interface components {
478
477
  sizeBytes?: string | null;
479
478
  /**
480
479
  * Checksum
481
- * @description Checksum the store reports, e.g. ``crc32c:...``.
480
+ * @description Checksum when available.
482
481
  */
483
482
  checksum?: string | null;
484
483
  /**
@@ -498,13 +497,19 @@ export interface components {
498
497
  * AssetPartDeclaration
499
498
  * @description A part the client intends to upload.
500
499
  *
501
- * The content type and length are signed into the upload URL, so they bound
502
- * what may be sent rather than describing what the asset is.
500
+ * The upload must use the declared content type and contain exactly the
501
+ * declared number of bytes.
503
502
  */
504
503
  AssetPartDeclaration: {
505
- /** Role */
504
+ /**
505
+ * Role
506
+ * @description Role this file fills in the asset type, e.g. ``rgb``, ``mask`` or ``depth``.
507
+ */
506
508
  role: string;
507
- /** Contenttype */
509
+ /**
510
+ * Contenttype
511
+ * @description MIME type that will be sent with the upload, e.g. ``image/png``.
512
+ */
508
513
  contentType: string;
509
514
  /**
510
515
  * Contentlength
@@ -614,35 +619,54 @@ export interface components {
614
619
  */
615
620
  requestId?: string | null;
616
621
  };
617
- /** AtlasChiselResponseOperation */
622
+ /**
623
+ * AtlasChiselResponseOperation
624
+ * @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.
625
+ */
618
626
  AtlasChiselResponseOperation: {
619
- /** Id */
627
+ /**
628
+ * Id
629
+ * @description Short operation id used in ``/operations/{operation}`` paths.
630
+ */
620
631
  id: string;
621
- /** Ownerid */
632
+ /**
633
+ * Ownerid
634
+ * @description Account that owns the operation.
635
+ */
622
636
  ownerId: string;
623
- /** Metadata */
637
+ /**
638
+ * Metadata
639
+ * @description Task information and optional progress details. Use ``metadata.task`` to interpret a generic operation response, and use ``done`` to determine completion.
640
+ */
624
641
  metadata?: {
625
642
  [key: string]: unknown;
626
643
  } | null;
627
- /** Done */
644
+ /**
645
+ * Done
646
+ * @description Whether the operation is terminal. When false, both ``response`` and ``error`` are null.
647
+ */
628
648
  done: boolean;
649
+ /** @description Failure details when ``done`` is true and the task failed; null while running and after success. */
629
650
  error?: components["schemas"]["OperationError"] | null;
630
- /** @description Task response payload when the operation is done. */
651
+ /** @description ``AtlasChiselResponse`` result when ``done`` is true and the task succeeded; null while running and after failure. */
631
652
  response?: components["schemas"]["AtlasChiselResponse"] | null;
632
- /** Expiresatsecs */
653
+ /**
654
+ * Expiresatsecs
655
+ * @description Task execution deadline as Unix seconds, when one is exposed. This is not an asset URL expiration.
656
+ */
633
657
  expiresAtSecs?: number | null;
634
658
  /**
635
659
  * Createdatsecs
636
- * @description Unix seconds when the operation was created (output-only).
660
+ * @description Unix seconds when the operation was accepted.
637
661
  */
638
662
  createdAtSecs?: number | null;
639
663
  /**
640
664
  * Name
641
- * @description Canonical resource name ``accounts/{account}/operations/{operation}``.
665
+ * @description Full resource name for the operation.
642
666
  *
643
- * ``owner_id`` is the owning account, so the public name is derived, not
644
- * stored. Output-only: serialized for clients (AIP-style), and harmlessly
645
- * ignored when the LRO client deserializes a service response.
667
+ * For project operations:
668
+ * ``accounts/{account}/projects/{project}/operations/{operation}``.
669
+ * Operation paths accept the short ``id``.
646
670
  */
647
671
  readonly name: string;
648
672
  };
@@ -726,35 +750,54 @@ export interface components {
726
750
  */
727
751
  requestId?: string | null;
728
752
  };
729
- /** AtlasGenerateResponseOperation */
753
+ /**
754
+ * AtlasGenerateResponseOperation
755
+ * @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.
756
+ */
730
757
  AtlasGenerateResponseOperation: {
731
- /** Id */
758
+ /**
759
+ * Id
760
+ * @description Short operation id used in ``/operations/{operation}`` paths.
761
+ */
732
762
  id: string;
733
- /** Ownerid */
763
+ /**
764
+ * Ownerid
765
+ * @description Account that owns the operation.
766
+ */
734
767
  ownerId: string;
735
- /** Metadata */
768
+ /**
769
+ * Metadata
770
+ * @description Task information and optional progress details. Use ``metadata.task`` to interpret a generic operation response, and use ``done`` to determine completion.
771
+ */
736
772
  metadata?: {
737
773
  [key: string]: unknown;
738
774
  } | null;
739
- /** Done */
775
+ /**
776
+ * Done
777
+ * @description Whether the operation is terminal. When false, both ``response`` and ``error`` are null.
778
+ */
740
779
  done: boolean;
780
+ /** @description Failure details when ``done`` is true and the task failed; null while running and after success. */
741
781
  error?: components["schemas"]["OperationError"] | null;
742
- /** @description Task response payload when the operation is done. */
782
+ /** @description ``AtlasGenerateResponse`` result when ``done`` is true and the task succeeded; null while running and after failure. */
743
783
  response?: components["schemas"]["AtlasGenerateResponse"] | null;
744
- /** Expiresatsecs */
784
+ /**
785
+ * Expiresatsecs
786
+ * @description Task execution deadline as Unix seconds, when one is exposed. This is not an asset URL expiration.
787
+ */
745
788
  expiresAtSecs?: number | null;
746
789
  /**
747
790
  * Createdatsecs
748
- * @description Unix seconds when the operation was created (output-only).
791
+ * @description Unix seconds when the operation was accepted.
749
792
  */
750
793
  createdAtSecs?: number | null;
751
794
  /**
752
795
  * Name
753
- * @description Canonical resource name ``accounts/{account}/operations/{operation}``.
796
+ * @description Full resource name for the operation.
754
797
  *
755
- * ``owner_id`` is the owning account, so the public name is derived, not
756
- * stored. Output-only: serialized for clients (AIP-style), and harmlessly
757
- * ignored when the LRO client deserializes a service response.
798
+ * For project operations:
799
+ * ``accounts/{account}/projects/{project}/operations/{operation}``.
800
+ * Operation paths accept the short ``id``.
758
801
  */
759
802
  readonly name: string;
760
803
  };
@@ -838,35 +881,54 @@ export interface components {
838
881
  */
839
882
  requestId?: string | null;
840
883
  };
841
- /** AtlasMaskedResponseOperation */
884
+ /**
885
+ * AtlasMaskedResponseOperation
886
+ * @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.
887
+ */
842
888
  AtlasMaskedResponseOperation: {
843
- /** Id */
889
+ /**
890
+ * Id
891
+ * @description Short operation id used in ``/operations/{operation}`` paths.
892
+ */
844
893
  id: string;
845
- /** Ownerid */
894
+ /**
895
+ * Ownerid
896
+ * @description Account that owns the operation.
897
+ */
846
898
  ownerId: string;
847
- /** Metadata */
899
+ /**
900
+ * Metadata
901
+ * @description Task information and optional progress details. Use ``metadata.task`` to interpret a generic operation response, and use ``done`` to determine completion.
902
+ */
848
903
  metadata?: {
849
904
  [key: string]: unknown;
850
905
  } | null;
851
- /** Done */
906
+ /**
907
+ * Done
908
+ * @description Whether the operation is terminal. When false, both ``response`` and ``error`` are null.
909
+ */
852
910
  done: boolean;
911
+ /** @description Failure details when ``done`` is true and the task failed; null while running and after success. */
853
912
  error?: components["schemas"]["OperationError"] | null;
854
- /** @description Task response payload when the operation is done. */
913
+ /** @description ``AtlasMaskedResponse`` result when ``done`` is true and the task succeeded; null while running and after failure. */
855
914
  response?: components["schemas"]["AtlasMaskedResponse"] | null;
856
- /** Expiresatsecs */
915
+ /**
916
+ * Expiresatsecs
917
+ * @description Task execution deadline as Unix seconds, when one is exposed. This is not an asset URL expiration.
918
+ */
857
919
  expiresAtSecs?: number | null;
858
920
  /**
859
921
  * Createdatsecs
860
- * @description Unix seconds when the operation was created (output-only).
922
+ * @description Unix seconds when the operation was accepted.
861
923
  */
862
924
  createdAtSecs?: number | null;
863
925
  /**
864
926
  * Name
865
- * @description Canonical resource name ``accounts/{account}/operations/{operation}``.
927
+ * @description Full resource name for the operation.
866
928
  *
867
- * ``owner_id`` is the owning account, so the public name is derived, not
868
- * stored. Output-only: serialized for clients (AIP-style), and harmlessly
869
- * ignored when the LRO client deserializes a service response.
929
+ * For project operations:
930
+ * ``accounts/{account}/projects/{project}/operations/{operation}``.
931
+ * Operation paths accept the short ``id``.
870
932
  */
871
933
  readonly name: string;
872
934
  };
@@ -913,7 +975,7 @@ export interface components {
913
975
  numSamples?: number | null;
914
976
  /**
915
977
  * Returndepth
916
- * @description Also return each image as a posed RGBD frame in `frames`: depth is estimated per image (metric, single-view) along with the camera it was estimated under.
978
+ * @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
979
  * @default false
918
980
  */
919
981
  returnDepth?: boolean;
@@ -924,72 +986,69 @@ export interface components {
924
986
  */
925
987
  AtlasTextToImageResponse: {
926
988
  /**
927
- * Generationid
928
- * @description Stable id for this generation run.
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.
989
+ * Frames
990
+ * @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
991
  */
947
- prompt?: string | null;
992
+ frames: components["schemas"]["FrameRGBAsset"][];
948
993
  /**
949
- * Modelname
950
- * @description Resolved model display name or slug.
994
+ * Promptused
995
+ * @description Final prompt supplied to inference, if any.
951
996
  */
952
- modelName?: string | null;
997
+ promptUsed?: string | null;
953
998
  /**
954
999
  * Aspectratio
955
1000
  * @description Resolved width-to-height ratio used for generation.
956
1001
  */
957
1002
  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
1003
  };
964
- /** AtlasTextToImageResponseOperation */
1004
+ /**
1005
+ * AtlasTextToImageResponseOperation
1006
+ * @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.
1007
+ */
965
1008
  AtlasTextToImageResponseOperation: {
966
- /** Id */
1009
+ /**
1010
+ * Id
1011
+ * @description Short operation id used in ``/operations/{operation}`` paths.
1012
+ */
967
1013
  id: string;
968
- /** Ownerid */
1014
+ /**
1015
+ * Ownerid
1016
+ * @description Account that owns the operation.
1017
+ */
969
1018
  ownerId: string;
970
- /** Metadata */
1019
+ /**
1020
+ * Metadata
1021
+ * @description Task information and optional progress details. Use ``metadata.task`` to interpret a generic operation response, and use ``done`` to determine completion.
1022
+ */
971
1023
  metadata?: {
972
1024
  [key: string]: unknown;
973
1025
  } | null;
974
- /** Done */
1026
+ /**
1027
+ * Done
1028
+ * @description Whether the operation is terminal. When false, both ``response`` and ``error`` are null.
1029
+ */
975
1030
  done: boolean;
1031
+ /** @description Failure details when ``done`` is true and the task failed; null while running and after success. */
976
1032
  error?: components["schemas"]["OperationError"] | null;
977
- /** @description Task response payload when the operation is done. */
1033
+ /** @description ``AtlasTextToImageResponse`` result when ``done`` is true and the task succeeded; null while running and after failure. */
978
1034
  response?: components["schemas"]["AtlasTextToImageResponse"] | null;
979
- /** Expiresatsecs */
1035
+ /**
1036
+ * Expiresatsecs
1037
+ * @description Task execution deadline as Unix seconds, when one is exposed. This is not an asset URL expiration.
1038
+ */
980
1039
  expiresAtSecs?: number | null;
981
1040
  /**
982
1041
  * Createdatsecs
983
- * @description Unix seconds when the operation was created (output-only).
1042
+ * @description Unix seconds when the operation was accepted.
984
1043
  */
985
1044
  createdAtSecs?: number | null;
986
1045
  /**
987
1046
  * Name
988
- * @description Canonical resource name ``accounts/{account}/operations/{operation}``.
1047
+ * @description Full resource name for the operation.
989
1048
  *
990
- * ``owner_id`` is the owning account, so the public name is derived, not
991
- * stored. Output-only: serialized for clients (AIP-style), and harmlessly
992
- * ignored when the LRO client deserializes a service response.
1049
+ * For project operations:
1050
+ * ``accounts/{account}/projects/{project}/operations/{operation}``.
1051
+ * Operation paths accept the short ``id``.
993
1052
  */
994
1053
  readonly name: string;
995
1054
  };
@@ -1067,7 +1126,7 @@ export interface components {
1067
1126
  reason?: string | null;
1068
1127
  /**
1069
1128
  * Requestid
1070
- * @description Stable cancellation request id; supply to make retries idempotent. Server generates one if omitted.
1129
+ * @description Cancellation idempotency key, at most 36 characters; supply to make retries idempotent. Server generates one if omitted.
1071
1130
  */
1072
1131
  requestId?: string | null;
1073
1132
  };
@@ -1125,6 +1184,7 @@ export interface components {
1125
1184
  * @description Optional client-supplied resource id.
1126
1185
  */
1127
1186
  assetId?: string | null;
1187
+ /** @description Asset metadata and ingestion source. */
1128
1188
  asset: components["schemas"]["AssetCreate"];
1129
1189
  };
1130
1190
  /**
@@ -1141,13 +1201,16 @@ export interface components {
1141
1201
  * Displayname
1142
1202
  * @description User-visible label.
1143
1203
  */
1144
- displayName: string;
1204
+ displayName: string | null;
1145
1205
  /**
1146
1206
  * Mimetype
1147
1207
  * @description Media MIME type, e.g. ``image/png``.
1148
1208
  */
1149
1209
  mimeType: string;
1150
- /** @default CREATED */
1210
+ /**
1211
+ * @description Lifecycle state. Only ``READY`` assets can be read or used by a task.
1212
+ * @default CREATED
1213
+ */
1151
1214
  state?: components["schemas"]["AssetState"];
1152
1215
  /**
1153
1216
  * Width
@@ -1166,7 +1229,7 @@ export interface components {
1166
1229
  sizeBytes?: string | null;
1167
1230
  /**
1168
1231
  * Checksum
1169
- * @description Checksum the store reports, e.g. ``crc32c:...``.
1232
+ * @description Checksum when available.
1170
1233
  */
1171
1234
  checksum?: string | null;
1172
1235
  /**
@@ -1195,49 +1258,55 @@ export interface components {
1195
1258
  producedBy?: components["schemas"]["ProducedBy"] | null;
1196
1259
  /**
1197
1260
  * Contentpath
1198
- * @description Where the asset's bytes sit under the project's content prefix, ``<class>/<asset>[/<role>]``, each segment percent-encoded as a URL path segment. Appended to a read prefix's ``baseUrl`` and followed by its ``signedQuery`` it addresses the bytes on the content edge; on its own it grants nothing. A read prefix is minted per project by ``:createReadPrefix`` (on the project for web sessions, on ``/assets`` for API keys); ``:createReadUrl`` stays the single-object download. Null until the bytes exist.
1261
+ * @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
1262
  */
1200
1263
  contentPath?: string | null;
1201
- /** Uploads */
1264
+ /**
1265
+ * Uploads
1266
+ * @description One grant per declared part; empty for URL or inline ingestion.
1267
+ */
1202
1268
  uploads?: components["schemas"]["UploadGrant"][];
1203
1269
  };
1204
1270
  /**
1205
1271
  * CreateReadPrefixResponse
1206
- * @description One credential for a project's whole library on the content edge.
1272
+ * @description A short-lived credential for a project's whole asset library.
1207
1273
  *
1208
- * A Cloud CDN prefix-signed URL: append an asset's ``contentPath`` to
1209
- * ``baseUrl`` and then ``?`` plus ``signedQuery`` to address its bytes.
1210
- * The same ``signedQuery`` serves every asset of the project until
1211
- * ``expiresAt``; the edge validates it on every request.
1274
+ * Build one download URL as ``baseUrl + contentPath + "?" + signedQuery``.
1275
+ * The same credential serves every ready asset in the project until
1276
+ * ``expiresAt``. Treat it as a secret because it grants that broad access.
1212
1277
  */
1213
1278
  CreateReadPrefixResponse: {
1214
1279
  /**
1215
1280
  * Baseurl
1216
- * @description The project's content prefix on the edge, ending in ``/``. Append an asset's ``contentPath`` to address its bytes.
1281
+ * @description Project content prefix, ending in ``/``. Append an asset's already encoded ``contentPath`` unchanged.
1217
1282
  */
1218
1283
  baseUrl: string;
1219
1284
  /**
1220
1285
  * Signedquery
1221
- * @description Query string (without the leading ``?``) authorizing every URL under ``baseUrl``: ``URLPrefix``, ``Expires``, ``KeyName`` and ``Signature`` as Cloud CDN defines them. Knowledge of it grants read access to the project's library until it expires; mint a fresh one rather than persisting this.
1286
+ * @description Opaque, already encoded query string without the leading ``?``. Append it unchanged after ``baseUrl + contentPath``; do not parse or edit it.
1222
1287
  */
1223
1288
  signedQuery: string;
1224
1289
  /**
1225
1290
  * Expiresat
1226
1291
  * Format: date-time
1227
- * @description When the signature stops admitting reads; mint again after.
1292
+ * @description When this read credential expires; create a new one after.
1228
1293
  */
1229
1294
  expiresAt: string;
1230
1295
  };
1231
- /** CreateReadUrlResponse */
1296
+ /**
1297
+ * CreateReadUrlResponse
1298
+ * @description A short-lived credential for downloading one asset.
1299
+ */
1232
1300
  CreateReadUrlResponse: {
1233
1301
  /**
1234
1302
  * Readurl
1235
- * @description Short-lived signed URL for the asset's bytes. Knowledge of the URL grants read access until it expires; mint a fresh one rather than persisting this.
1303
+ * @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
1304
  */
1237
1305
  readUrl: string;
1238
1306
  /**
1239
1307
  * Expiresat
1240
1308
  * Format: date-time
1309
+ * @description When ``readUrl`` stops authorizing the download.
1241
1310
  */
1242
1311
  expiresAt: string;
1243
1312
  };
@@ -1263,7 +1332,10 @@ export interface components {
1263
1332
  * @description Upload ticket for a project-owned Asset.
1264
1333
  */
1265
1334
  CreateUploadUrlResponse: {
1266
- /** Uploadurl */
1335
+ /**
1336
+ * Uploadurl
1337
+ * @description Short-lived upload URL. Send the bytes here without the World Labs API key.
1338
+ */
1267
1339
  uploadUrl: string;
1268
1340
  /**
1269
1341
  * Method
@@ -1273,6 +1345,7 @@ export interface components {
1273
1345
  /**
1274
1346
  * Expiresat
1275
1347
  * Format: date-time
1348
+ * @description When this upload grant expires; create a new one after.
1276
1349
  */
1277
1350
  expiresAt: string;
1278
1351
  /**
@@ -1290,13 +1363,19 @@ export interface components {
1290
1363
  CreateUploadUrlsRequest: {
1291
1364
  /**
1292
1365
  * Roles
1293
- * @description Parts to re-mint. Empty grants every declared part.
1366
+ * @description Parts that need new upload grants. Empty selects every declared part.
1294
1367
  */
1295
1368
  roles?: string[];
1296
1369
  };
1297
- /** CreateUploadUrlsResponse */
1370
+ /**
1371
+ * CreateUploadUrlsResponse
1372
+ * @description New upload grants for the requested asset parts.
1373
+ */
1298
1374
  CreateUploadUrlsResponse: {
1299
- /** Uploads */
1375
+ /**
1376
+ * Uploads
1377
+ * @description One new upload grant per requested part role.
1378
+ */
1300
1379
  uploads?: components["schemas"]["UploadGrant"][];
1301
1380
  };
1302
1381
  /**
@@ -1326,31 +1405,6 @@ export interface components {
1326
1405
  /** Detail */
1327
1406
  detail?: components["schemas"]["ValidationError"][];
1328
1407
  };
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
1408
  /**
1355
1409
  * Images2PosedRGBDPerImageResult
1356
1410
  * @description Per-image reconstruction output.
@@ -1414,40 +1468,59 @@ export interface components {
1414
1468
  */
1415
1469
  Images2PosedRGBDResponse: {
1416
1470
  /**
1417
- * Results
1418
- * @description One result per input image.
1471
+ * Frames
1472
+ * @description One reconstructed frame per input image, in request order.
1419
1473
  */
1420
- results: components["schemas"]["Images2PosedRGBDPerImageResult"][];
1474
+ frames: components["schemas"]["Images2PosedRGBDPerImageResult"][];
1421
1475
  };
1422
- /** Images2PosedRGBDResponseOperation */
1476
+ /**
1477
+ * Images2PosedRGBDResponseOperation
1478
+ * @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.
1479
+ */
1423
1480
  Images2PosedRGBDResponseOperation: {
1424
- /** Id */
1481
+ /**
1482
+ * Id
1483
+ * @description Short operation id used in ``/operations/{operation}`` paths.
1484
+ */
1425
1485
  id: string;
1426
- /** Ownerid */
1486
+ /**
1487
+ * Ownerid
1488
+ * @description Account that owns the operation.
1489
+ */
1427
1490
  ownerId: string;
1428
- /** Metadata */
1491
+ /**
1492
+ * Metadata
1493
+ * @description Task information and optional progress details. Use ``metadata.task`` to interpret a generic operation response, and use ``done`` to determine completion.
1494
+ */
1429
1495
  metadata?: {
1430
1496
  [key: string]: unknown;
1431
1497
  } | null;
1432
- /** Done */
1498
+ /**
1499
+ * Done
1500
+ * @description Whether the operation is terminal. When false, both ``response`` and ``error`` are null.
1501
+ */
1433
1502
  done: boolean;
1503
+ /** @description Failure details when ``done`` is true and the task failed; null while running and after success. */
1434
1504
  error?: components["schemas"]["OperationError"] | null;
1435
- /** @description Task response payload when the operation is done. */
1505
+ /** @description ``Images2PosedRGBDResponse`` result when ``done`` is true and the task succeeded; null while running and after failure. */
1436
1506
  response?: components["schemas"]["Images2PosedRGBDResponse"] | null;
1437
- /** Expiresatsecs */
1507
+ /**
1508
+ * Expiresatsecs
1509
+ * @description Task execution deadline as Unix seconds, when one is exposed. This is not an asset URL expiration.
1510
+ */
1438
1511
  expiresAtSecs?: number | null;
1439
1512
  /**
1440
1513
  * Createdatsecs
1441
- * @description Unix seconds when the operation was created (output-only).
1514
+ * @description Unix seconds when the operation was accepted.
1442
1515
  */
1443
1516
  createdAtSecs?: number | null;
1444
1517
  /**
1445
1518
  * Name
1446
- * @description Canonical resource name ``accounts/{account}/operations/{operation}``.
1519
+ * @description Full resource name for the operation.
1447
1520
  *
1448
- * ``owner_id`` is the owning account, so the public name is derived, not
1449
- * stored. Output-only: serialized for clients (AIP-style), and harmlessly
1450
- * ignored when the LRO client deserializes a service response.
1521
+ * For project operations:
1522
+ * ``accounts/{account}/projects/{project}/operations/{operation}``.
1523
+ * Operation paths accept the short ``id``.
1451
1524
  */
1452
1525
  readonly name: string;
1453
1526
  };
@@ -1461,12 +1534,19 @@ export interface components {
1461
1534
  /** @description EXR of linear depth in world units, as a URL or inline asset. */
1462
1535
  depthAsset: components["schemas"]["TaskAsset"];
1463
1536
  };
1464
- /** ListAssetsResponse */
1537
+ /**
1538
+ * ListAssetsResponse
1539
+ * @description One page of non-deleted project assets.
1540
+ */
1465
1541
  ListAssetsResponse: {
1466
- /** Assets */
1542
+ /**
1543
+ * Assets
1544
+ * @description Assets in the selected page.
1545
+ */
1467
1546
  assets?: components["schemas"]["Asset"][];
1468
1547
  /**
1469
1548
  * Nextpagetoken
1549
+ * @description Opaque token for the next page; empty on the final page.
1470
1550
  * @default
1471
1551
  */
1472
1552
  nextPageToken?: string;
@@ -1476,7 +1556,10 @@ export interface components {
1476
1556
  * @description A page of operations, newest first.
1477
1557
  */
1478
1558
  ListOperationsResponse: {
1479
- /** Operations */
1559
+ /**
1560
+ * Operations
1561
+ * @description Operations ordered from newest to oldest.
1562
+ */
1480
1563
  operations: components["schemas"]["Operation"][];
1481
1564
  /**
1482
1565
  * Nextpagetoken
@@ -1504,65 +1587,59 @@ export interface components {
1504
1587
  */
1505
1588
  zMax: number;
1506
1589
  };
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
1590
  /**
1533
1591
  * Operation
1534
- * @description An asynchronous long-running task operation.
1592
+ * @description The common envelope used to track an asynchronous task.
1535
1593
  */
1536
1594
  Operation: {
1537
- /** Id */
1595
+ /**
1596
+ * Id
1597
+ * @description Short operation id used in ``/operations/{operation}`` paths.
1598
+ */
1538
1599
  id: string;
1539
- /** Ownerid */
1600
+ /**
1601
+ * Ownerid
1602
+ * @description Account that owns the operation.
1603
+ */
1540
1604
  ownerId: string;
1541
- /** Metadata */
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
+ */
1542
1609
  metadata?: {
1543
1610
  [key: string]: unknown;
1544
1611
  } | null;
1545
- /** Done */
1612
+ /**
1613
+ * Done
1614
+ * @description Whether the operation is terminal. When false, both ``response`` and ``error`` are null.
1615
+ */
1546
1616
  done: boolean;
1617
+ /** @description Failure details when ``done`` is true and the task failed; null while running and after success. */
1547
1618
  error?: components["schemas"]["OperationError"] | null;
1548
- /** Response */
1619
+ /**
1620
+ * Response
1621
+ * @description Task-specific result when ``done`` is true and the task succeeded; null while running and after failure.
1622
+ */
1549
1623
  response?: {
1550
1624
  [key: string]: unknown;
1551
1625
  } | null;
1552
- /** Expiresatsecs */
1626
+ /**
1627
+ * Expiresatsecs
1628
+ * @description Task execution deadline as Unix seconds, when one is exposed. This is not an asset URL expiration.
1629
+ */
1553
1630
  expiresAtSecs?: number | null;
1554
1631
  /**
1555
1632
  * Createdatsecs
1556
- * @description Unix seconds when the operation was created (output-only).
1633
+ * @description Unix seconds when the operation was accepted.
1557
1634
  */
1558
1635
  createdAtSecs?: number | null;
1559
1636
  /**
1560
1637
  * Name
1561
- * @description Canonical resource name ``accounts/{account}/operations/{operation}``.
1638
+ * @description Full resource name for the operation.
1562
1639
  *
1563
- * ``owner_id`` is the owning account, so the public name is derived, not
1564
- * stored. Output-only: serialized for clients (AIP-style), and harmlessly
1565
- * ignored when the LRO client deserializes a service response.
1640
+ * For project operations:
1641
+ * ``accounts/{account}/projects/{project}/operations/{operation}``.
1642
+ * Operation paths accept the short ``id``.
1566
1643
  */
1567
1644
  readonly name: string;
1568
1645
  };
@@ -1844,8 +1921,8 @@ export interface components {
1844
1921
  * @description Public response projected into the completed Operation.
1845
1922
  */
1846
1923
  Splats2MeshResponse: {
1847
- /** @description The generated mesh. The GLB is at `files.meshes.mesh`. */
1848
- assetOutput?: components["schemas"]["MeshAssetOutput"] | null;
1924
+ /** @description The generated GLB mesh. */
1925
+ mesh: components["schemas"]["TaskAsset"];
1849
1926
  /**
1850
1927
  * Anchorpositions
1851
1928
  * @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 +1941,65 @@ export interface components {
1864
1941
  [key: string]: string;
1865
1942
  };
1866
1943
  };
1867
- /** Splats2MeshResponseOperation */
1944
+ /**
1945
+ * Splats2MeshResponseOperation
1946
+ * @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.
1947
+ */
1868
1948
  Splats2MeshResponseOperation: {
1869
- /** Id */
1949
+ /**
1950
+ * Id
1951
+ * @description Short operation id used in ``/operations/{operation}`` paths.
1952
+ */
1870
1953
  id: string;
1871
- /** Ownerid */
1954
+ /**
1955
+ * Ownerid
1956
+ * @description Account that owns the operation.
1957
+ */
1872
1958
  ownerId: string;
1873
- /** Metadata */
1959
+ /**
1960
+ * Metadata
1961
+ * @description Task information and optional progress details. Use ``metadata.task`` to interpret a generic operation response, and use ``done`` to determine completion.
1962
+ */
1874
1963
  metadata?: {
1875
1964
  [key: string]: unknown;
1876
1965
  } | null;
1877
- /** Done */
1966
+ /**
1967
+ * Done
1968
+ * @description Whether the operation is terminal. When false, both ``response`` and ``error`` are null.
1969
+ */
1878
1970
  done: boolean;
1971
+ /** @description Failure details when ``done`` is true and the task failed; null while running and after success. */
1879
1972
  error?: components["schemas"]["OperationError"] | null;
1880
- /** @description Task response payload when the operation is done. */
1973
+ /** @description ``Splats2MeshResponse`` result when ``done`` is true and the task succeeded; null while running and after failure. */
1881
1974
  response?: components["schemas"]["Splats2MeshResponse"] | null;
1882
- /** Expiresatsecs */
1975
+ /**
1976
+ * Expiresatsecs
1977
+ * @description Task execution deadline as Unix seconds, when one is exposed. This is not an asset URL expiration.
1978
+ */
1883
1979
  expiresAtSecs?: number | null;
1884
1980
  /**
1885
1981
  * Createdatsecs
1886
- * @description Unix seconds when the operation was created (output-only).
1982
+ * @description Unix seconds when the operation was accepted.
1887
1983
  */
1888
1984
  createdAtSecs?: number | null;
1889
1985
  /**
1890
1986
  * Name
1891
- * @description Canonical resource name ``accounts/{account}/operations/{operation}``.
1987
+ * @description Full resource name for the operation.
1892
1988
  *
1893
- * ``owner_id`` is the owning account, so the public name is derived, not
1894
- * stored. Output-only: serialized for clients (AIP-style), and harmlessly
1895
- * ignored when the LRO client deserializes a service response.
1989
+ * For project operations:
1990
+ * ``accounts/{account}/projects/{project}/operations/{operation}``.
1991
+ * Operation paths accept the short ``id``.
1896
1992
  */
1897
1993
  readonly name: string;
1898
1994
  };
1899
1995
  /**
1900
1996
  * TaskAsset
1901
- * @description Media input supplied by asset id, inline base64, or public URL.
1997
+ * @description Media named by asset id, inline base64, or public URL.
1998
+ *
1999
+ * A task response names each output by id and url together: the url expires,
2000
+ * the id does not. The pair is accepted as input as well, so a response can
2001
+ * be handed straight back to the next task; the id names the media and the
2002
+ * url is ignored. Inline base64 is an input form only, and stands alone.
1902
2003
  */
1903
2004
  TaskAsset: {
1904
2005
  /**
@@ -1908,28 +2009,34 @@ export interface components {
1908
2009
  assetId?: string | null;
1909
2010
  /**
1910
2011
  * Base64
1911
- * @description Base64-encoded media bytes, with or without a data URL prefix. Decoded size must be less than 10 MiB.
2012
+ * @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
2013
  */
1913
2014
  base64?: string | null;
1914
2015
  /**
1915
2016
  * Url
1916
- * @description Public HTTP(S) URL containing the media.
2017
+ * @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
2018
  */
1918
2019
  url?: string | null;
1919
2020
  };
1920
2021
  /**
1921
2022
  * UploadGrant
1922
- * @description Permission to upload one part's bytes, straight to the store.
2023
+ * @description Permission to upload one asset part.
1923
2024
  */
1924
2025
  UploadGrant: {
1925
- /** Role */
2026
+ /**
2027
+ * Role
2028
+ * @description Declared asset-part role this upload fills.
2029
+ */
1926
2030
  role: string;
1927
2031
  /**
1928
2032
  * Method
1929
2033
  * @description HTTP verb to use for the upload, e.g. PUT.
1930
2034
  */
1931
2035
  method: string;
1932
- /** Url */
2036
+ /**
2037
+ * Url
2038
+ * @description Short-lived upload URL. Send the bytes here without the World Labs API key.
2039
+ */
1933
2040
  url: string;
1934
2041
  /**
1935
2042
  * Headers
@@ -1941,6 +2048,7 @@ export interface components {
1941
2048
  /**
1942
2049
  * Expiresat
1943
2050
  * Format: date-time
2051
+ * @description When this upload grant expires; create a new one after.
1944
2052
  */
1945
2053
  expiresAt: string;
1946
2054
  };
@@ -2012,9 +2120,6 @@ export type CreateUploadUrlsResponse = components['schemas']['CreateUploadUrlsRe
2012
2120
  export type Empty = components['schemas']['Empty'];
2013
2121
  export type FrameRGBAsset = components['schemas']['FrameRGBAsset'];
2014
2122
  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
2123
  export type Images2PosedRGBDPerImageResult = components['schemas']['Images2PosedRGBDPerImageResult'];
2019
2124
  export type Images2PosedRGBDRequest = components['schemas']['Images2PosedRGBDRequest'];
2020
2125
  export type Images2PosedRGBDResponse = components['schemas']['Images2PosedRGBDResponse'];
@@ -2023,9 +2128,6 @@ export type LinearDepthBufferAsset = components['schemas']['LinearDepthBufferAss
2023
2128
  export type ListAssetsResponse = components['schemas']['ListAssetsResponse'];
2024
2129
  export type ListOperationsResponse = components['schemas']['ListOperationsResponse'];
2025
2130
  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
2131
  export type Operation = components['schemas']['Operation'];
2030
2132
  export type OperationError = components['schemas']['OperationError'];
2031
2133
  export type OperationTrace = components['schemas']['OperationTrace'];
@@ -2476,6 +2578,8 @@ export interface operations {
2476
2578
  parameters: {
2477
2579
  query?: {
2478
2580
  origin?: components["schemas"]["ResourceOrigin"] | null;
2581
+ /** @description Filter by state. Omit for all non-deleted states. */
2582
+ state?: components["schemas"]["AssetState"] | null;
2479
2583
  pageSize?: number;
2480
2584
  pageToken?: string | null;
2481
2585
  };