@worldlabsai/client 0.3.0 → 0.4.0

package/dist/generated/developer-api.gen.d.ts

@@ -429,6 +429,11 @@ export interface components {
              * @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.
              */
             contentPath?: string | null;
+            /**
+             * Url
+             * @description Unsigned content URL for the asset, ``baseUrl + contentPath``. It does not grant access by itself: the web app's read-prefix cookie authorizes it, and an API client appends ``?`` and a read prefix's ``signedQuery`` or uses ``assets/{asset}:createReadUrl`` instead. Null whenever ``contentPath`` is.
+             */
+            url?: string | null;
         };
         /**
          * AssetCreate
@@ -485,7 +490,7 @@ export interface components {
             operation: string;
             /**
              * Task
-             * @description The task that produced them, e.g. ``image2DraftSplats``.
+             * @description The task that produced them, e.g. ``atlasGenerate``.
              */
             task?: string | null;
             /** Assets */
@@ -635,9 +640,14 @@ export interface components {
             purgeContentOnOperationCompletion?: boolean | null;
             /**
              * Contextframes
-             * @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.
+             * @description Posed depth frames, one per target camera and posed at it, in target order; each camera is 1280x720. Frames may also carry an imageAsset (the view's known pixels) and a maskAsset (8-bit grayscale, white where the frame's image and depth are known), each on every frame or on none: the model keeps the image where the mask is set and generates the rest, takes frames without masks as fully known, and conditions on the depth alone for frames without an image. Frames carry no depth confidenceAsset. Leave empty to generate from the prompt alone.
              */
             contextFrames?: components["schemas"]["PosedDepthAsset"][];
+            /**
+             * Sourceframes
+             * @description Posed RGB photographs of the scene, each an image and its camera in the targets' coordinate convention and scale. The generated views stay consistent with them: the servable feeds them to the model as views it has already committed, so a target that sees the same surfaces keeps their materials, colors, and lighting. Any cameras and any resolution; each is cover-resized and center-cropped onto 1280x720. Frames carry no maskAsset or depth. Together with contextFrames and targetCameras they fill at most 128 views of the servable's rollout, where a context frame costs 3 and a photograph or target one.
+             */
+            sourceFrames?: components["schemas"]["PosedRGBAsset"][];
             /**
              * Targetcameras
              * @description Pinhole cameras at 1280x720 for the views to generate, in output order, returned in `frames`. At most 32.
@@ -668,7 +678,7 @@ export interface components {
             modelParameters?: components["schemas"]["AtlasChiselModelParameters"];
             /**
              * Returndepth
-             * @description Return the generated frames as posed RGBD: they are reconstructed together so the depth lands in the request's own camera frame and scale, and every entry in `frames` then carries a `depth` buffer. The contextFrames' own depth is not reconstructed or returned. Needs at least two target cameras. Limitation: the depth scale is recovered from the target cameras' centres, so targets that share one centre (a pure-rotation rig) come back with a 0.0 or NaN scale and a success status.
+             * @description Return the generated frames as posed RGBD: they are reconstructed together so the depth lands in the request's own camera frame and scale, and every entry in `frames` then carries a `depth` buffer. The contextFrames' own depth is not reconstructed or returned. A source photograph joins the reconstruction as an anchor, and gets no depth back, only when its image is at the generated resolution and its camera's principal point is centered. Needs at least two target cameras. Limitation: the depth scale is recovered from the camera centers that joined, so targets that share one center (a pure-rotation rig) and no anchor come back with a 0.0 or NaN scale and a success status.
              * @default false
              */
             returnDepth?: boolean;
@@ -718,13 +728,11 @@ export interface components {
             } | null;
             /**
              * Done
-             * @description Whether the operation is terminal. When false, both ``response`` and ``error`` are null.
+             * @description Whether the operation is terminal. When true, a non-null ``error`` indicates failure; otherwise the operation succeeded.
              */
             done: boolean;
             /** @description Failure details when ``done`` is true and the task failed; null while running and after success. */
             error?: components["schemas"]["OperationError"] | null;
-            /** @description ``AtlasChiselResponse`` result when ``done`` is true and the task succeeded; null while running and after failure. */
-            response?: components["schemas"]["AtlasChiselResponse"] | null;
             /**
              * Expiresatsecs
              * @description Task execution deadline as Unix seconds, when one is exposed. This is not an asset URL expiration.
@@ -735,6 +743,8 @@ export interface components {
              * @description Unix seconds when the operation was accepted.
              */
             createdAtSecs?: number | null;
+            /** @description ``AtlasChiselResponse`` result when ``done`` is true and the task succeeded; null while running and after failure. */
+            response?: components["schemas"]["AtlasChiselResponse"] | null;
             /**
              * Name
              * @description Full resource name for the operation.
@@ -777,9 +787,15 @@ export interface components {
              * @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.
              */
             purgeContentOnOperationCompletion?: boolean | null;
+            /**
+             * Base64Outputs
+             * @description When a ?wait=true submission is answered inline, return each output file as base64 in that response rather than by assetId and url. This skips storing the files before the answer and the caller's download after it. Any other submission, and every later read of the operation, names the outputs by assetId and url.
+             * @default false
+             */
+            base64Outputs?: boolean;
             /**
              * Contextframes
-             * @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.
+             * @description Posed RGBD context views: each an image, its depth buffer, and its camera, all required. All context cameras must declare the same width and height. 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.
              */
             contextFrames: components["schemas"]["PosedRGBDAsset"][];
             /**
@@ -800,7 +816,7 @@ export interface components {
             enhancePrompt?: boolean;
             /**
              * Returndepth
-             * @description Return the generated frames as posed RGBD: they are reconstructed together with the context frames so the depth lands in the request's own camera frame and scale, and every entry in `frames` then carries a `depth` buffer. A context frame joins that reconstruction only when its image is at the generated resolution and its camera's principal point is centered. The scale is recovered from the camera centres that joined, so a request whose joined cameras all share one centre (a pure-rotation rig) is rejected.
+             * @description Return the generated frames as posed RGBD: they are reconstructed together with the context frames so the depth lands in the request's own camera frame and scale, and every entry in `frames` then carries a `depth` buffer. The scale is recovered from camera centres, so a request whose cameras all share one centre (a pure-rotation rig) is rejected. On the hero base route, with more than 19 context frames, or with a masked context frame, a context frame joins the reconstruction only when its image is at the generated resolution and its camera's principal point is centered.
              * @default false
              */
             returnDepth?: boolean;
@@ -852,13 +868,11 @@ export interface components {
             } | null;
             /**
              * Done
-             * @description Whether the operation is terminal. When false, both ``response`` and ``error`` are null.
+             * @description Whether the operation is terminal. When true, a non-null ``error`` indicates failure; otherwise the operation succeeded.
              */
             done: boolean;
             /** @description Failure details when ``done`` is true and the task failed; null while running and after success. */
             error?: components["schemas"]["OperationError"] | null;
-            /** @description ``AtlasGenerateResponse`` result when ``done`` is true and the task succeeded; null while running and after failure. */
-            response?: components["schemas"]["AtlasGenerateResponse"] | null;
             /**
              * Expiresatsecs
              * @description Task execution deadline as Unix seconds, when one is exposed. This is not an asset URL expiration.
@@ -869,6 +883,8 @@ export interface components {
              * @description Unix seconds when the operation was accepted.
              */
             createdAtSecs?: number | null;
+            /** @description ``AtlasGenerateResponse`` result when ``done`` is true and the task succeeded; null while running and after failure. */
+            response?: components["schemas"]["AtlasGenerateResponse"] | null;
             /**
              * Name
              * @description Full resource name for the operation.
@@ -987,13 +1003,11 @@ export interface components {
             } | null;
             /**
              * Done
-             * @description Whether the operation is terminal. When false, both ``response`` and ``error`` are null.
+             * @description Whether the operation is terminal. When true, a non-null ``error`` indicates failure; otherwise the operation succeeded.
              */
             done: boolean;
             /** @description Failure details when ``done`` is true and the task failed; null while running and after success. */
             error?: components["schemas"]["OperationError"] | null;
-            /** @description ``AtlasMaskedResponse`` result when ``done`` is true and the task succeeded; null while running and after failure. */
-            response?: components["schemas"]["AtlasMaskedResponse"] | null;
             /**
              * Expiresatsecs
              * @description Task execution deadline as Unix seconds, when one is exposed. This is not an asset URL expiration.
@@ -1004,6 +1018,8 @@ export interface components {
              * @description Unix seconds when the operation was accepted.
              */
             createdAtSecs?: number | null;
+            /** @description ``AtlasMaskedResponse`` result when ``done`` is true and the task succeeded; null while running and after failure. */
+            response?: components["schemas"]["AtlasMaskedResponse"] | null;
             /**
              * Name
              * @description Full resource name for the operation.
@@ -1112,13 +1128,11 @@ export interface components {
             } | null;
             /**
              * Done
-             * @description Whether the operation is terminal. When false, both ``response`` and ``error`` are null.
+             * @description Whether the operation is terminal. When true, a non-null ``error`` indicates failure; otherwise the operation succeeded.
              */
             done: boolean;
             /** @description Failure details when ``done`` is true and the task failed; null while running and after success. */
             error?: components["schemas"]["OperationError"] | null;
-            /** @description ``AtlasTextToImageResponse`` result when ``done`` is true and the task succeeded; null while running and after failure. */
-            response?: components["schemas"]["AtlasTextToImageResponse"] | null;
             /**
              * Expiresatsecs
              * @description Task execution deadline as Unix seconds, when one is exposed. This is not an asset URL expiration.
@@ -1129,6 +1143,8 @@ export interface components {
              * @description Unix seconds when the operation was accepted.
              */
             createdAtSecs?: number | null;
+            /** @description ``AtlasTextToImageResponse`` result when ``done`` is true and the task succeeded; null while running and after failure. */
+            response?: components["schemas"]["AtlasTextToImageResponse"] | null;
             /**
              * Name
              * @description Full resource name for the operation.
@@ -1354,6 +1370,11 @@ export interface components {
              * @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.
              */
             contentPath?: string | null;
+            /**
+             * Url
+             * @description Unsigned content URL for the asset, ``baseUrl + contentPath``. It does not grant access by itself: the web app's read-prefix cookie authorizes it, and an API client appends ``?`` and a read prefix's ``signedQuery`` or uses ``assets/{asset}:createReadUrl`` instead. Null whenever ``contentPath`` is.
+             */
+            url?: string | null;
             /**
              * Uploads
              * @description One grant per declared part; empty for URL or inline ingestion.
@@ -1541,6 +1562,12 @@ export interface components {
              * @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.
              */
             purgeContentOnOperationCompletion?: boolean | null;
+            /**
+             * Base64Outputs
+             * @description When a ?wait=true submission is answered inline, return each output file as base64 in that response rather than by assetId and url. This skips storing the files before the answer and the caller's download after it. Any other submission, and every later read of the operation, names the outputs by assetId and url.
+             * @default false
+             */
+            base64Outputs?: boolean;
             /**
              * Frames
              * @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.
@@ -1611,13 +1638,11 @@ export interface components {
             } | null;
             /**
              * Done
-             * @description Whether the operation is terminal. When false, both ``response`` and ``error`` are null.
+             * @description Whether the operation is terminal. When true, a non-null ``error`` indicates failure; otherwise the operation succeeded.
              */
             done: boolean;
             /** @description Failure details when ``done`` is true and the task failed; null while running and after success. */
             error?: components["schemas"]["OperationError"] | null;
-            /** @description ``Images2PosedRGBDResponse`` result when ``done`` is true and the task succeeded; null while running and after failure. */
-            response?: components["schemas"]["Images2PosedRGBDResponse"] | null;
             /**
              * Expiresatsecs
              * @description Task execution deadline as Unix seconds, when one is exposed. This is not an asset URL expiration.
@@ -1628,6 +1653,8 @@ export interface components {
              * @description Unix seconds when the operation was accepted.
              */
             createdAtSecs?: number | null;
+            /** @description ``Images2PosedRGBDResponse`` result when ``done`` is true and the task succeeded; null while running and after failure. */
+            response?: components["schemas"]["Images2PosedRGBDResponse"] | null;
             /**
              * Name
              * @description Full resource name for the operation.
@@ -1677,7 +1704,7 @@ export interface components {
         };
         /**
          * ListedOperation
-         * @description An Operation as the Marble API lists it: with its callback's progress.
+         * @description An operation summary with callback progress; GET it for the result.
          */
         ListedOperation: {
             /**
@@ -1699,18 +1726,11 @@ export interface components {
             } | null;
             /**
              * Done
-             * @description Whether the operation is terminal. When false, both ``response`` and ``error`` are null.
+             * @description Whether the operation is terminal. When true, a non-null ``error`` indicates failure; otherwise the operation succeeded.
              */
             done: boolean;
             /** @description Failure details when ``done`` is true and the task failed; null while running and after success. */
             error?: components["schemas"]["OperationError"] | null;
-            /**
-             * Response
-             * @description Task-specific result when ``done`` is true and the task succeeded; null while running and after failure.
-             */
-            response?: {
-                [key: string]: unknown;
-            } | null;
             /**
              * Expiresatsecs
              * @description Task execution deadline as Unix seconds, when one is exposed. This is not an asset URL expiration.
@@ -1771,7 +1791,7 @@ export interface components {
         };
         /**
          * Operation
-         * @description The common envelope used to track an asynchronous task.
+         * @description An operation with its result, available through singular reads.
          */
         Operation: {
             /**
@@ -1793,18 +1813,11 @@ export interface components {
             } | null;
             /**
              * Done
-             * @description Whether the operation is terminal. When false, both ``response`` and ``error`` are null.
+             * @description Whether the operation is terminal. When true, a non-null ``error`` indicates failure; otherwise the operation succeeded.
              */
             done: boolean;
             /** @description Failure details when ``done`` is true and the task failed; null while running and after success. */
             error?: components["schemas"]["OperationError"] | null;
-            /**
-             * Response
-             * @description Task-specific result when ``done`` is true and the task succeeded; null while running and after failure.
-             */
-            response?: {
-                [key: string]: unknown;
-            } | null;
             /**
              * Expiresatsecs
              * @description Task execution deadline as Unix seconds, when one is exposed. This is not an asset URL expiration.
@@ -1815,6 +1828,13 @@ export interface components {
              * @description Unix seconds when the operation was accepted.
              */
             createdAtSecs?: number | null;
+            /**
+             * Response
+             * @description Task-specific result when ``done`` is true and the task succeeded; null while running and after failure.
+             */
+            response?: {
+                [key: string]: unknown;
+            } | null;
             /**
              * Name
              * @description Full resource name for the operation.
@@ -2014,7 +2034,7 @@ export interface components {
             session?: string | null;
             /**
              * Task
-             * @description The task that produced it, e.g. ``image2DraftSplats``.
+             * @description The task that produced it, e.g. ``atlasGenerate``.
              */
             task?: string | null;
             /**
@@ -2042,8 +2062,8 @@ export interface components {
             renderHw?: number;
             /**
              * Renderhwsecondary
-             * @description Height and width of the secondary views, in pixels. The anchor strategies sample extra cameras around each anchor and render them here, covering what the main views miss. `exterior_sphere` and a supplied camera list render no secondary views and ignore this.
-             * @default 640
+             * @description Height and width of the secondary views, in pixels. The anchor strategies place extra cameras from the anchors and render them here, covering what the main views miss. `exterior_sphere` and a supplied camera list render no secondary views and ignore this.
+             * @default 256
              */
             renderHwSecondary?: number;
             /**
@@ -2053,6 +2073,13 @@ export interface components {
              * @enum {string}
              */
             normalSource?: "depth" | "render";
+            /**
+             * Depthsource
+             * @description Depth of the main views. `render` uses the splats' rendered depth; `stereo` measures it by stereo matching each view against a second render from a camera shifted sideways, which is sharper where the splats are fuzzy and slower to compute. Pixels stereo cannot match keep the rendered depth.
+             * @default render
+             * @enum {string}
+             */
+            depthSource?: "render" | "stereo";
             /**
              * Resolution
              * @description Resolution of the grid the implicit surface is built on, across the region's longest side. Powers of two only. This sets the finest detail the mesh can carry.
@@ -2194,13 +2221,11 @@ export interface components {
             } | null;
             /**
              * Done
-             * @description Whether the operation is terminal. When false, both ``response`` and ``error`` are null.
+             * @description Whether the operation is terminal. When true, a non-null ``error`` indicates failure; otherwise the operation succeeded.
              */
             done: boolean;
             /** @description Failure details when ``done`` is true and the task failed; null while running and after success. */
             error?: components["schemas"]["OperationError"] | null;
-            /** @description ``Splats2MeshResponse`` result when ``done`` is true and the task succeeded; null while running and after failure. */
-            response?: components["schemas"]["Splats2MeshResponse"] | null;
             /**
              * Expiresatsecs
              * @description Task execution deadline as Unix seconds, when one is exposed. This is not an asset URL expiration.
@@ -2211,6 +2236,8 @@ export interface components {
              * @description Unix seconds when the operation was accepted.
              */
             createdAtSecs?: number | null;
+            /** @description ``Splats2MeshResponse`` result when ``done`` is true and the task succeeded; null while running and after failure. */
+            response?: components["schemas"]["Splats2MeshResponse"] | null;
             /**
              * Name
              * @description Full resource name for the operation.
@@ -2228,7 +2255,9 @@ export interface components {
          *     A task response names each output by id and url together: the url expires,
          *     the id does not. The pair is accepted as input as well, so a response can
          *     be handed straight back to the next task; the id names the media and the
-         *     url is ignored. Inline base64 is an input form only, and stands alone.
+         *     url is ignored. Inline base64 stands alone. A response returns it only
+         *     when a task is answered at submission; the stored operation names the
+         *     same output by id and url.
          */
         TaskAsset: {
             /**
@@ -2238,7 +2267,7 @@ export interface components {
             assetId?: string | null;
             /**
              * Base64
-             * @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.
+             * @description Base64-encoded media bytes, with or without a data URL prefix. Decoded size must be less than 10 MiB. A task response carries inline bytes only when it is returned from the submission; the stored operation names the same output by `assetId` and `url`.
              */
             base64?: string | null;
             /**
@@ -2973,7 +3002,7 @@ export interface operations {
                 mimeType?: string | null;
                 /** @description Only assets this Operation produced. */
                 operation?: string | null;
-                /** @description Only assets this task produced, e.g. `image2DraftSplats`. */
+                /** @description Only assets this task produced, e.g. `atlasGenerate`. */
                 task?: string | null;
                 /** @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. */
                 producer?: components["schemas"]["AssetProducer"] | null;