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