@scenario-labs/sdk 3.1.0 → 3.2.0

package/src/resources/models/train.ts

@@ -14,9 +14,9 @@ export class Train extends APIResource {
     params: TrainActionParams,
     options?: RequestOptions,
   ): APIPromise<TrainActionResponse> {
-    const { originalAssets, projectId, ...body } = params;
+    const { projectId, ...body } = params;
     return this._client.post(path`/models/${modelID}/train/action`, {
-      query: { originalAssets, projectId },
+      query: { projectId },
       body,
       ...options,
     });
@@ -493,7 +493,9 @@ export namespace TrainActionResponse {
        * 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';
 
@@ -521,8 +523,9 @@ export namespace TrainActionResponse {
       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;
 
@@ -539,8 +542,9 @@ export namespace TrainActionResponse {
       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;
 
@@ -1236,6 +1240,11 @@ export namespace TrainActionResponse {
        */
       lorasComponent?: UiConfig.LorasComponent;
 
+      /**
+       * Configuration for the provider outputs exposed by `exposeOutput`
+       */
+      outputProperties?: { [key: string]: UiConfig.OutputProperties };
+
       /**
        * Configuration for the presets
        */
@@ -1290,6 +1299,10 @@ export namespace TrainActionResponse {
         modelIdInput?: string;
       }
 
+      export interface OutputProperties {
+        label: string;
+      }
+
       export interface Preset {
         fields: Array<string>;
 
@@ -1362,8 +1375,8 @@ export interface TrainTriggerResponse {
   /**
    * Compute Units cost per billing action for this request, after discount. Values
    * sum to `creativeUnitsCost`. Only Compute-Units-consuming actions with a non-zero
-   * charge appear. Lets clients split the total (e.g. generation vs
-   * `slop-detection`) — including on dryRun estimates.
+   * charge appear. Lets clients split the total (e.g. generation vs `quality-gate`)
+   * — including on dryRun estimates.
    */
   costDetails?: TrainTriggerResponse.CostDetails;
 
@@ -1754,7 +1767,9 @@ export namespace TrainTriggerResponse {
            * 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';
 
@@ -1782,8 +1797,9 @@ export namespace TrainTriggerResponse {
           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;
 
@@ -1800,8 +1816,9 @@ export namespace TrainTriggerResponse {
           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;
 
@@ -1981,7 +1998,9 @@ export namespace TrainTriggerResponse {
              * 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';
 
@@ -2009,8 +2028,9 @@ export namespace TrainTriggerResponse {
             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;
 
@@ -2027,8 +2047,9 @@ export namespace TrainTriggerResponse {
             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;
 
@@ -2333,7 +2354,7 @@ export namespace TrainTriggerResponse {
 
       /**
        * 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.
@@ -2363,7 +2384,7 @@ export namespace TrainTriggerResponse {
     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.
@@ -2383,7 +2404,7 @@ export namespace TrainTriggerResponse {
       export interface CuCostDetails {
         'ip-detection'?: number;
 
-        'slop-detection'?: number;
+        'quality-gate'?: number;
       }
     }
   }
@@ -2837,7 +2858,9 @@ export namespace TrainTriggerResponse {
        * 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';
 
@@ -2865,8 +2888,9 @@ export namespace TrainTriggerResponse {
       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;
 
@@ -2883,8 +2907,9 @@ export namespace TrainTriggerResponse {
       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;
 
@@ -3580,6 +3605,11 @@ export namespace TrainTriggerResponse {
        */
       lorasComponent?: UiConfig.LorasComponent;
 
+      /**
+       * Configuration for the provider outputs exposed by `exposeOutput`
+       */
+      outputProperties?: { [key: string]: UiConfig.OutputProperties };
+
       /**
        * Configuration for the presets
        */
@@ -3634,6 +3664,10 @@ export namespace TrainTriggerResponse {
         modelIdInput?: string;
       }
 
+      export interface OutputProperties {
+        label: string;
+      }
+
       export interface Preset {
         fields: Array<string>;
 
@@ -3700,8 +3734,8 @@ export namespace TrainTriggerResponse {
   /**
    * Compute Units cost per billing action for this request, after discount. Values
    * sum to `creativeUnitsCost`. Only Compute-Units-consuming actions with a non-zero
-   * charge appear. Lets clients split the total (e.g. generation vs
-   * `slop-detection`) — including on dryRun estimates.
+   * charge appear. Lets clients split the total (e.g. generation vs `quality-gate`)
+   * — including on dryRun estimates.
    */
   export interface CostDetails {
     'assistant-message'?: number;
@@ -3726,6 +3760,8 @@ export namespace TrainTriggerResponse {
 
     prompt?: number;
 
+    'quality-gate'?: number;
+
     'remove-background'?: number;
 
     repaint?: number;
@@ -3738,8 +3774,6 @@ export namespace TrainTriggerResponse {
 
     'skybox-upscale-360'?: number;
 
-    'slop-detection'?: number;
-
     texture?: number;
 
     'train-model'?: number;
@@ -3761,8 +3795,16 @@ export namespace TrainTriggerResponse {
     action: 'allowed' | 'blocked' | 'flagged';
 
     /**
-     * IP-detection CU fee, separate from creativeUnitsCost: a fixed base fee plus a
-     * per-image fee for each analyzed input image.
+     * Number of images the detectors actually analyzed — a video counts as each of its
+     * extracted frames, and an image that could not be read is excluded (and not
+     * billed). Each of them is priced once per enabled filter.
+     */
+    analyzedImagesCount: number;
+
+    /**
+     * IP-detection CU fee, separate from creativeUnitsCost: it follows the provider
+     * tokens the run sends — the prompt plus every analyzed image, once per enabled
+     * filter — with a 1 CU minimum per run.
      */
     creativeUnitsCharged: number;
 
@@ -3777,7 +3819,8 @@ export namespace TrainTriggerResponse {
     findings: Array<IPDetection.Finding>;
 
     /**
-     * Convenience flag; always true when action is not 'allowed'.
+     * Whether a filter considered the inputs an IP risk. Independent of `action`: a
+     * request blocked because a detector errored is `blocked` and NOT flagged.
      */
     flagged: boolean;
 
@@ -3836,11 +3879,6 @@ export interface TrainActionParams {
    */
   action: 'cancel';
 
-  /**
-   * Query param: If set to true, returns the original asset without transformation
-   */
-  originalAssets?: boolean;
-
   /**
    * Query param: The projectId used for ownership resource management. Either to
    * assert ownership or to set the owner of the resource(s)
@@ -3850,9 +3888,10 @@ export interface TrainActionParams {
 
 export interface TrainTriggerParams {
   /**
-   * Query param
+   * Query param: Estimate the operation instead of running it: the call returns a
+   * 269 response carrying the creative units cost. `api` estimates at the API tier.
    */
-  dryRun?: unknown;
+  dryRun?: 'true' | 'api';
 
   /**
    * Query param: If set to true, returns the original asset without transformation
@@ -3866,7 +3905,8 @@ export interface TrainTriggerParams {
   projectId?: string;
 
   /**
-   * Query param: Simulate the number of training images, used for dryRun purpose
+   * Query param: Simulate the number of training images, used for dryRun purpose.
+   * Ignored if the model already has training images.
    */
   trainingImagesCount?: number;
 

package/src/resources/search.ts

@@ -34,9 +34,26 @@ export class Search extends APIResource {
     params: SearchModelSearchParams,
     options?: RequestOptions,
   ): PagePromise<SearchModelSearchResponsesSearchHitsOffset, SearchModelSearchResponse> {
-    const { originalAssets, originalModels, projectId, ...body } = params;
+    const { originalAssets, projectId, ...body } = params;
     return this._client.getAPIList('/search/models', SearchHitsOffset<SearchModelSearchResponse>, {
-      query: { originalAssets, originalModels, projectId },
+      query: { originalAssets, projectId },
+      body,
+      method: 'post',
+      ...options,
+    });
+  }
+
+  /**
+   * Search for workflows. At least one of the following fields must have a value:
+   * `query` or `filter`.
+   */
+  workflowSearch(
+    params: SearchWorkflowSearchParams,
+    options?: RequestOptions,
+  ): PagePromise<SearchWorkflowSearchResponsesSearchHitsOffset, SearchWorkflowSearchResponse> {
+    const { originalAssets, projectId, ...body } = params;
+    return this._client.getAPIList('/search/workflows', SearchHitsOffset<SearchWorkflowSearchResponse>, {
+      query: { originalAssets, projectId },
       body,
       method: 'post',
       ...options,
@@ -48,6 +65,8 @@ export type SearchAssetSearchResponsesSearchHitsOffset = SearchHitsOffset<Search
 
 export type SearchModelSearchResponsesSearchHitsOffset = SearchHitsOffset<SearchModelSearchResponse>;
 
+export type SearchWorkflowSearchResponsesSearchHitsOffset = SearchHitsOffset<SearchWorkflowSearchResponse>;
+
 export interface SearchAssetSearchResponse {
   /**
    * Unique identifier for the asset (e.g., "asset_GTrL3mq4SXWyMxkOHRxlpw")
@@ -413,6 +432,141 @@ export namespace SearchModelSearchResponse {
   }
 }
 
+export interface SearchWorkflowSearchResponse {
+  /**
+   * Unique identifier for the workflow (e.g., "workflow_abc123")
+   */
+  id: string;
+
+  /**
+   * User ID of the workflow creator/author
+   */
+  authorId: string;
+
+  /**
+   * Array of collection IDs this workflow belongs to
+   */
+  collectionIds: Array<string>;
+
+  /**
+   * Creation timestamp in ISO 8601 format (e.g., "2025-01-16T11:19:41.579Z")
+   */
+  createdAt: string;
+
+  /**
+   * Full description of the workflow
+   */
+  description: string;
+
+  /**
+   * Display name of the workflow
+   */
+  name: string;
+
+  /**
+   * Project ID of the workflow owner
+   */
+  ownerId: string;
+
+  /**
+   * Privacy setting of the workflow ("public", "private", or "unlisted")
+   */
+  privacy: string;
+
+  /**
+   * Status of the workflow (e.g., "ready", "draft", "deleted")
+   */
+  status: string;
+
+  /**
+   * Array of user-assigned tags for categorization
+   */
+  tags: Array<string>;
+
+  /**
+   * Team ID of the workflow owner
+   */
+  teamId: string;
+
+  /**
+   * Last modification timestamp in ISO 8601 format (e.g.,
+   * "2025-01-16T11:19:41.579Z")
+   */
+  updatedAt: string;
+
+  /**
+   * After image information for the workflow
+   */
+  after?: SearchWorkflowSearchResponse.After;
+
+  /**
+   * Before image information for the workflow
+   */
+  before?: SearchWorkflowSearchResponse.Before;
+
+  /**
+   * Score assigned to the workflow based on usage and popularity
+   */
+  score?: number;
+
+  /**
+   * Short description of the workflow
+   */
+  shortDescription?: string;
+
+  /**
+   * Thumbnail image information for the workflow
+   */
+  thumbnail?: SearchWorkflowSearchResponse.Thumbnail;
+}
+
+export namespace SearchWorkflowSearchResponse {
+  /**
+   * After image information for the workflow
+   */
+  export interface After {
+    /**
+     * ID of the asset used as after image
+     */
+    assetId: string;
+
+    /**
+     * Signed URL of the after image
+     */
+    url: string;
+  }
+
+  /**
+   * Before image information for the workflow
+   */
+  export interface Before {
+    /**
+     * ID of the asset used as before image
+     */
+    assetId: string;
+
+    /**
+     * Signed URL of the before image
+     */
+    url: string;
+  }
+
+  /**
+   * Thumbnail image information for the workflow
+   */
+  export interface Thumbnail {
+    /**
+     * ID of the asset used as thumbnail
+     */
+    assetId: string;
+
+    /**
+     * Signed URL of the thumbnail
+     */
+    url: string;
+  }
+}
+
 export interface SearchAssetSearchParams extends SearchHitsOffsetParams {
   /**
    * Query param: If set to true, returns the original asset without transformation
@@ -522,11 +676,6 @@ export interface SearchModelSearchParams extends SearchHitsOffsetParams {
    */
   originalAssets?: boolean;
 
-  /**
-   * Query param
-   */
-  originalModels?: unknown;
-
   /**
    * Query param: The projectId used for ownership resource management. Either to
    * assert ownership or to set the owner of the resource(s)
@@ -624,13 +773,75 @@ export namespace SearchModelSearchParams {
   }
 }
 
+export interface SearchWorkflowSearchParams extends SearchHitsOffsetParams {
+  /**
+   * Query param: If set to true, returns the original asset without transformation
+   */
+  originalAssets?: boolean;
+
+  /**
+   * Query param: The projectId used for ownership resource management. Either to
+   * assert ownership or to set the owner of the resource(s)
+   */
+  projectId?: string;
+
+  /**
+   * Body param: Filter queries by an attribute's value
+   */
+  filter?: string;
+
+  /**
+   * Body param: Maximum number of documents returned for a page. Must be used with
+   * `page`.
+   */
+  hitsPerPage?: number;
+
+  /**
+   * Body param: Maximum number of documents returned. Must be used with `offset`.
+   */
+  limit?: number;
+
+  /**
+   * Body param: Request a specific page of results. Must be used with `hitsPerPage`.
+   */
+  page?: number;
+
+  /**
+   * Body param: Search for public workflows not necessarily belonging to the current
+   * `ownerId`
+   */
+  public?: boolean;
+
+  /**
+   * Body param: A string used for querying search results.
+   */
+  query?: string;
+
+  /**
+   * Body param: Query embedding for hybrid search, if possible
+   */
+  querySemanticRatio?: number;
+
+  /**
+   * Body param: Sort the search results by the given attributes. Each attribute in
+   * the list must be followed by a colon (`:`) and the preferred sorting order:
+   * either ascending (`asc`) or descending (`desc`).
+   *
+   * Example: `['createdAt:desc']`
+   */
+  sortBy?: Array<string>;
+}
+
 export declare namespace Search {
   export {
     type SearchAssetSearchResponse as SearchAssetSearchResponse,
     type SearchModelSearchResponse as SearchModelSearchResponse,
+    type SearchWorkflowSearchResponse as SearchWorkflowSearchResponse,
     type SearchAssetSearchResponsesSearchHitsOffset as SearchAssetSearchResponsesSearchHitsOffset,
     type SearchModelSearchResponsesSearchHitsOffset as SearchModelSearchResponsesSearchHitsOffset,
+    type SearchWorkflowSearchResponsesSearchHitsOffset as SearchWorkflowSearchResponsesSearchHitsOffset,
     type SearchAssetSearchParams as SearchAssetSearchParams,
     type SearchModelSearchParams as SearchModelSearchParams,
+    type SearchWorkflowSearchParams as SearchWorkflowSearchParams,
   };
 }

package/src/resources/uploads.ts

@@ -11,8 +11,8 @@ export class Uploads extends APIResource {
    * list of URLs for each part of the file.
    */
   create(params: UploadCreateParams, options?: RequestOptions): APIPromise<UploadCreateResponse> {
-    const { projectId, ...body } = params;
-    return this._client.post('/uploads', { query: { projectId }, body, ...options });
+    const { dryRun, projectId, ...body } = params;
+    return this._client.post('/uploads', { query: { dryRun, projectId }, body, ...options });
   }
 
   /**
@@ -280,6 +280,12 @@ export namespace UploadTriggerActionResponse {
 }
 
 export interface UploadCreateParams {
+  /**
+   * Query param: Estimate the operation instead of running it: the call returns a
+   * 269 response carrying the creative units cost. `api` estimates at the API tier.
+   */
+  dryRun?: 'true' | 'api';
+
   /**
    * Query param: The projectId used for ownership resource management. Either to
    * assert ownership or to set the owner of the resource(s)
@@ -365,7 +371,11 @@ export namespace UploadCreateParams {
 }
 
 export interface UploadRetrieveParams {
-  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 UploadTriggerActionParams {
@@ -376,9 +386,10 @@ export interface UploadTriggerActionParams {
   action: 'complete';
 
   /**
-   * Query param
+   * Query param: The projectId used for ownership resource management. Either to
+   * assert ownership or to set the owner of the resource(s)
    */
-  projectId?: unknown;
+  projectId?: string;
 }
 
 export declare namespace Uploads {