@scenario-labs/sdk 3.0.0 → 3.2.0

package/src/resources/index.ts

@@ -102,10 +102,13 @@ export {
   Search,
   type SearchAssetSearchResponse,
   type SearchModelSearchResponse,
+  type SearchWorkflowSearchResponse,
   type SearchAssetSearchParams,
   type SearchModelSearchParams,
+  type SearchWorkflowSearchParams,
   type SearchAssetSearchResponsesSearchHitsOffset,
   type SearchModelSearchResponsesSearchHitsOffset,
+  type SearchWorkflowSearchResponsesSearchHitsOffset,
 } from './search';
 export { Tags, type TagListResponse, type TagListParams, type TagListResponsesTagsCursor } from './tags';
 export {

package/src/resources/jobs.ts

@@ -39,12 +39,8 @@ export class Jobs extends APIResource {
     params: JobTriggerActionParams,
     options?: RequestOptions,
   ): APIPromise<JobTriggerActionResponse> {
-    const { originalAssets, projectId, ...body } = params;
-    return this._client.post(path`/jobs/${jobID}/action`, {
-      query: { originalAssets, projectId },
-      body,
-      ...options,
-    });
+    const { projectId, ...body } = params;
+    return this._client.post(path`/jobs/${jobID}/action`, { query: { projectId }, body, ...options });
   }
 }
 
@@ -425,7 +421,9 @@ export namespace JobRetrieveResponse {
            * The asset kind of the input. Only taken into account for \`file\` and
            * \`file_array\` input types. If model provides multiple kinds, the input will be
            * not able to create the asset on the flight on API side with dataurl without
-           * data:kind, prefix
+           * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
+           * a model does not declare one, \`image\` is returned, which is the kind used at
+           * generation time.
            */
           kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
@@ -453,8 +451,9 @@ export namespace JobRetrieveResponse {
           maxDuration?: number;
 
           /**
-           * The maximum allowed length for \`string\` inputs. Also applies to each item in
-           * \`string_array\`.
+           * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
+           * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+           * ITEMS instead — the length of each item is not constrained.
            */
           maxLength?: number;
 
@@ -471,8 +470,9 @@ export namespace JobRetrieveResponse {
           min?: number;
 
           /**
-           * The minimum allowed length for string inputs. Also applies to each item in
-           * \`string_array\`.
+           * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
+           * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+           * ITEMS instead — the length of each item is not constrained.
            */
           minLength?: number;
 
@@ -652,7 +652,9 @@ export namespace JobRetrieveResponse {
              * The asset kind of the input. Only taken into account for \`file\` and
              * \`file_array\` input types. If model provides multiple kinds, the input will be
              * not able to create the asset on the flight on API side with dataurl without
-             * data:kind, prefix
+             * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
+             * a model does not declare one, \`image\` is returned, which is the kind used at
+             * generation time.
              */
             kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
@@ -680,8 +682,9 @@ export namespace JobRetrieveResponse {
             maxDuration?: number;
 
             /**
-             * The maximum allowed length for \`string\` inputs. Also applies to each item in
-             * \`string_array\`.
+             * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
+             * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+             * ITEMS instead — the length of each item is not constrained.
              */
             maxLength?: number;
 
@@ -698,8 +701,9 @@ export namespace JobRetrieveResponse {
             min?: number;
 
             /**
-             * The minimum allowed length for string inputs. Also applies to each item in
-             * \`string_array\`.
+             * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
+             * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+             * ITEMS instead — the length of each item is not constrained.
              */
             minLength?: number;
 
@@ -1004,7 +1008,7 @@ export namespace JobRetrieveResponse {
 
       /**
        * Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
-       * top of the generation itself, such as `slop-detection`.
+       * top of the generation itself, such as `quality-gate`.
        *
        * `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
        * values here.
@@ -1034,7 +1038,7 @@ export namespace JobRetrieveResponse {
     export namespace Billing {
       /**
        * Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
-       * top of the generation itself, such as `slop-detection`.
+       * top of the generation itself, such as `quality-gate`.
        *
        * `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
        * values here.
@@ -1054,7 +1058,7 @@ export namespace JobRetrieveResponse {
       export interface CuCostDetails {
         'ip-detection'?: number;
 
-        'slop-detection'?: number;
+        'quality-gate'?: number;
       }
     }
   }
@@ -1430,7 +1434,9 @@ export namespace JobListResponse {
          * The asset kind of the input. Only taken into account for \`file\` and
          * \`file_array\` input types. If model provides multiple kinds, the input will be
          * not able to create the asset on the flight on API side with dataurl without
-         * data:kind, prefix
+         * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
+         * a model does not declare one, \`image\` is returned, which is the kind used at
+         * generation time.
          */
         kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
@@ -1458,8 +1464,9 @@ export namespace JobListResponse {
         maxDuration?: number;
 
         /**
-         * The maximum allowed length for \`string\` inputs. Also applies to each item in
-         * \`string_array\`.
+         * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
+         * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+         * ITEMS instead — the length of each item is not constrained.
          */
         maxLength?: number;
 
@@ -1476,8 +1483,9 @@ export namespace JobListResponse {
         min?: number;
 
         /**
-         * The minimum allowed length for string inputs. Also applies to each item in
-         * \`string_array\`.
+         * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
+         * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+         * ITEMS instead — the length of each item is not constrained.
          */
         minLength?: number;
 
@@ -1657,7 +1665,9 @@ export namespace JobListResponse {
            * The asset kind of the input. Only taken into account for \`file\` and
            * \`file_array\` input types. If model provides multiple kinds, the input will be
            * not able to create the asset on the flight on API side with dataurl without
-           * data:kind, prefix
+           * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
+           * a model does not declare one, \`image\` is returned, which is the kind used at
+           * generation time.
            */
           kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
@@ -1685,8 +1695,9 @@ export namespace JobListResponse {
           maxDuration?: number;
 
           /**
-           * The maximum allowed length for \`string\` inputs. Also applies to each item in
-           * \`string_array\`.
+           * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
+           * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+           * ITEMS instead — the length of each item is not constrained.
            */
           maxLength?: number;
 
@@ -1703,8 +1714,9 @@ export namespace JobListResponse {
           min?: number;
 
           /**
-           * The minimum allowed length for string inputs. Also applies to each item in
-           * \`string_array\`.
+           * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
+           * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+           * ITEMS instead — the length of each item is not constrained.
            */
           minLength?: number;
 
@@ -2009,7 +2021,7 @@ export namespace JobListResponse {
 
     /**
      * Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
-     * top of the generation itself, such as `slop-detection`.
+     * top of the generation itself, such as `quality-gate`.
      *
      * `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
      * values here.
@@ -2039,7 +2051,7 @@ export namespace JobListResponse {
   export namespace Billing {
     /**
      * Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
-     * top of the generation itself, such as `slop-detection`.
+     * top of the generation itself, such as `quality-gate`.
      *
      * `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
      * values here.
@@ -2059,7 +2071,7 @@ export namespace JobListResponse {
     export interface CuCostDetails {
       'ip-detection'?: number;
 
-      'slop-detection'?: number;
+      'quality-gate'?: number;
     }
   }
 }
@@ -2439,7 +2451,9 @@ export namespace JobTriggerActionResponse {
            * The asset kind of the input. Only taken into account for \`file\` and
            * \`file_array\` input types. If model provides multiple kinds, the input will be
            * not able to create the asset on the flight on API side with dataurl without
-           * data:kind, prefix
+           * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
+           * a model does not declare one, \`image\` is returned, which is the kind used at
+           * generation time.
            */
           kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
@@ -2467,8 +2481,9 @@ export namespace JobTriggerActionResponse {
           maxDuration?: number;
 
           /**
-           * The maximum allowed length for \`string\` inputs. Also applies to each item in
-           * \`string_array\`.
+           * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
+           * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+           * ITEMS instead — the length of each item is not constrained.
            */
           maxLength?: number;
 
@@ -2485,8 +2500,9 @@ export namespace JobTriggerActionResponse {
           min?: number;
 
           /**
-           * The minimum allowed length for string inputs. Also applies to each item in
-           * \`string_array\`.
+           * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
+           * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+           * ITEMS instead — the length of each item is not constrained.
            */
           minLength?: number;
 
@@ -2666,7 +2682,9 @@ export namespace JobTriggerActionResponse {
              * The asset kind of the input. Only taken into account for \`file\` and
              * \`file_array\` input types. If model provides multiple kinds, the input will be
              * not able to create the asset on the flight on API side with dataurl without
-             * data:kind, prefix
+             * data:kind, prefix \`file\` and \`file_array\` inputs always expose a kind: when
+             * a model does not declare one, \`image\` is returned, which is the kind used at
+             * generation time.
              */
             kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'text' | 'video';
 
@@ -2694,8 +2712,9 @@ export namespace JobTriggerActionResponse {
             maxDuration?: number;
 
             /**
-             * The maximum allowed length for \`string\` inputs. Also applies to each item in
-             * \`string_array\`.
+             * The maximum allowed length for \`string\` and \`model\` inputs, in characters.
+             * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+             * ITEMS instead — the length of each item is not constrained.
              */
             maxLength?: number;
 
@@ -2712,8 +2731,9 @@ export namespace JobTriggerActionResponse {
             min?: number;
 
             /**
-             * The minimum allowed length for string inputs. Also applies to each item in
-             * \`string_array\`.
+             * The minimum allowed length for \`string\` and \`model\` inputs, in characters.
+             * For the array types (\`string_array\`, \`model_array\`) it bounds the NUMBER OF
+             * ITEMS instead — the length of each item is not constrained.
              */
             minLength?: number;
 
@@ -3018,7 +3038,7 @@ export namespace JobTriggerActionResponse {
 
       /**
        * Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
-       * top of the generation itself, such as `slop-detection`.
+       * top of the generation itself, such as `quality-gate`.
        *
        * `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
        * values here.
@@ -3048,7 +3068,7 @@ export namespace JobTriggerActionResponse {
     export namespace Billing {
       /**
        * Compute Units charged for the ADD-ONS of this job, per action — the fees paid on
-       * top of the generation itself, such as `slop-detection`.
+       * top of the generation itself, such as `quality-gate`.
        *
        * `cuCost` above is the main action alone, so the job's total is `cuCost` plus the
        * values here.
@@ -3068,14 +3088,18 @@ export namespace JobTriggerActionResponse {
       export interface CuCostDetails {
         'ip-detection'?: number;
 
-        'slop-detection'?: number;
+        'quality-gate'?: number;
       }
     }
   }
 }
 
 export interface JobRetrieveParams {
-  projectId?: unknown;
+  /**
+   * The projectId used for ownership resource management. Either to assert ownership
+   * or to set the owner of the resource(s)
+   */
+  projectId?: string;
 }
 
 export interface JobListParams extends JobsCursorParams {
@@ -3095,7 +3119,11 @@ export interface JobListParams extends JobsCursorParams {
    */
   pageSize?: number;
 
-  projectId?: unknown;
+  /**
+   * The projectId used for ownership resource management. Either to assert ownership
+   * or to set the owner of the resource(s)
+   */
+  projectId?: string;
 
   /**
    * The status of the jobs to return. Optional.
@@ -3202,15 +3230,13 @@ export interface JobListParams extends JobsCursorParams {
     | 'workflow'
   >;
 
-  workflowId?: unknown;
-}
-
-export interface JobTriggerActionParams {
   /**
-   * Query param: If set to true, returns the original asset without transformation
+   * Only return the jobs produced by the given workflow. Optional.
    */
-  originalAssets?: boolean;
+  workflowId?: string;
+}
 
+export interface JobTriggerActionParams {
   /**
    * Query param: The projectId used for ownership resource management. Either to
    * assert ownership or to set the owner of the resource(s)

package/src/resources/models/description.ts

@@ -194,6 +194,64 @@ export namespace DescriptionRetrieveResponse {
        */
       originalFileUrl?: string;
 
+      /**
+       * The mime type of the original file url.
+       *
+       * The original file is stored under a key that carries no extension, so this is
+       * the only way to know which format `originalFileUrl` serves (e.g. an HDRi skybox
+       * exposes a JPEG preview as `url` and its `.exr` or `.hdr` file as the original).
+       * Omitted when the stored format could not be determined.
+       */
+      originalMimeType?:
+        | 'application/gzip'
+        | 'application/json'
+        | 'application/octet-stream'
+        | 'application/pdf'
+        | 'application/safetensors'
+        | 'application/vnd.autodesk.fbx'
+        | 'application/x-authorware-bin'
+        | 'application/x-zip-compressed'
+        | 'application/x.autodesk.fbx'
+        | 'application/zip'
+        | 'audio/m4a'
+        | 'audio/mpeg'
+        | 'audio/ogg'
+        | 'audio/wav'
+        | 'image/aces'
+        | 'image/avif'
+        | 'image/bmp'
+        | 'image/gif'
+        | 'image/heic'
+        | 'image/jpeg'
+        | 'image/png'
+        | 'image/svg+xml'
+        | 'image/tiff'
+        | 'image/vnd.radiance'
+        | 'image/webp'
+        | 'image/x-exr'
+        | 'model/glb'
+        | 'model/gltf+json'
+        | 'model/gltf-binary'
+        | 'model/ksplat'
+        | 'model/mtl'
+        | 'model/obj'
+        | 'model/ply'
+        | 'model/sog'
+        | 'model/splat'
+        | 'model/spz'
+        | 'model/stl'
+        | 'model/vnd.collada+xml'
+        | 'model/vnd.ms-package.3dmanufacturing-3dmodel+xml'
+        | 'model/x-3d-vox'
+        | 'model/x-fbx'
+        | 'model/x-maya-ascii'
+        | 'model/x-maya-binary'
+        | 'model/x3d+xml'
+        | 'text/plain'
+        | 'video/mp4'
+        | 'video/quicktime'
+        | 'video/webm';
+
       /**
        * The asset's preview.
        *
@@ -372,12 +430,12 @@ export namespace DescriptionRetrieveResponse {
           /**
            * Camera eye position in the splat's world frame.
            */
-          position: Array<unknown>;
+          position: Array<number>;
 
           /**
            * Look-at point in the splat's world frame.
            */
-          target: Array<unknown>;
+          target: Array<number>;
 
           /**
            * Vertical field of view in degrees (defaults to 50 in the renderer).
@@ -647,6 +705,64 @@ export namespace DescriptionUpdateResponse {
        */
       originalFileUrl?: string;
 
+      /**
+       * The mime type of the original file url.
+       *
+       * The original file is stored under a key that carries no extension, so this is
+       * the only way to know which format `originalFileUrl` serves (e.g. an HDRi skybox
+       * exposes a JPEG preview as `url` and its `.exr` or `.hdr` file as the original).
+       * Omitted when the stored format could not be determined.
+       */
+      originalMimeType?:
+        | 'application/gzip'
+        | 'application/json'
+        | 'application/octet-stream'
+        | 'application/pdf'
+        | 'application/safetensors'
+        | 'application/vnd.autodesk.fbx'
+        | 'application/x-authorware-bin'
+        | 'application/x-zip-compressed'
+        | 'application/x.autodesk.fbx'
+        | 'application/zip'
+        | 'audio/m4a'
+        | 'audio/mpeg'
+        | 'audio/ogg'
+        | 'audio/wav'
+        | 'image/aces'
+        | 'image/avif'
+        | 'image/bmp'
+        | 'image/gif'
+        | 'image/heic'
+        | 'image/jpeg'
+        | 'image/png'
+        | 'image/svg+xml'
+        | 'image/tiff'
+        | 'image/vnd.radiance'
+        | 'image/webp'
+        | 'image/x-exr'
+        | 'model/glb'
+        | 'model/gltf+json'
+        | 'model/gltf-binary'
+        | 'model/ksplat'
+        | 'model/mtl'
+        | 'model/obj'
+        | 'model/ply'
+        | 'model/sog'
+        | 'model/splat'
+        | 'model/spz'
+        | 'model/stl'
+        | 'model/vnd.collada+xml'
+        | 'model/vnd.ms-package.3dmanufacturing-3dmodel+xml'
+        | 'model/x-3d-vox'
+        | 'model/x-fbx'
+        | 'model/x-maya-ascii'
+        | 'model/x-maya-binary'
+        | 'model/x3d+xml'
+        | 'text/plain'
+        | 'video/mp4'
+        | 'video/quicktime'
+        | 'video/webm';
+
       /**
        * The asset's preview.
        *
@@ -825,12 +941,12 @@ export namespace DescriptionUpdateResponse {
           /**
            * Camera eye position in the splat's world frame.
            */
-          position: Array<unknown>;
+          position: Array<number>;
 
           /**
            * Look-at point in the splat's world frame.
            */
-          target: Array<unknown>;
+          target: Array<number>;
 
           /**
            * Vertical field of view in degrees (defaults to 50 in the renderer).