@scenario-labs/sdk 2.2.1 → 2.4.0-alpha.1

package/resources/generate.d.mts

@@ -63,6 +63,10 @@ export interface GenerateCaptionResponse {
      * ignored.
      */
     detailsLevel?: 'action' | 'action+style';
+    /**
+     * IP detection findings, when detection ran for this request.
+     */
+    ipDetection?: GenerateCaptionResponse.IPDetection;
 }
 export declare namespace GenerateCaptionResponse {
     interface Job {
@@ -169,7 +173,7 @@ export declare namespace GenerateCaptionResponse {
                 /**
                  * The status of the node. Only available for WorkflowJob nodes.
                  */
-                status: 'failure' | 'pending' | 'processing' | 'skipped' | 'success';
+                status: 'failure' | 'pending' | 'processing' | 'rejected' | 'skipped' | 'success';
                 /**
                  * The type of the job for the node.
                  */
@@ -748,6 +752,71 @@ export declare namespace GenerateCaptionResponse {
             cuDiscount: number;
         }
     }
+    /**
+     * IP detection findings, when detection ran for this request.
+     */
+    interface IPDetection {
+        /**
+         * Whether and how detection affected the request.
+         */
+        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.
+         */
+        creativeUnitsCharged: number;
+        /**
+         * Number of enabled filters evaluated for this request.
+         */
+        evaluatedFilters: number;
+        /**
+         * Per-filter verdicts gathered for this request.
+         */
+        findings: Array<IPDetection.Finding>;
+        /**
+         * Convenience flag; always true when action is not 'allowed'.
+         */
+        flagged: boolean;
+        /**
+         * True if one or more detectors errored while evaluating this request.
+         */
+        hasDetectorError?: boolean;
+    }
+    namespace IPDetection {
+        /**
+         * A single filter's verdict.
+         */
+        interface Finding {
+            /**
+             * Category of the filter that produced this verdict.
+             */
+            category: 'artist-style' | 'brand-trademark' | 'celebrity-likeness' | 'custom' | 'fictional-character';
+            /**
+             * Confidence score from 0 (low) to 1 (high).
+             */
+            confidence: number;
+            /**
+             * Identifier of the filter that produced this verdict.
+             */
+            filterId: string;
+            /**
+             * Display name of the filter that produced this verdict.
+             */
+            filterName: string;
+            /**
+             * Whether this filter considered the request an IP risk.
+             */
+            flagged: boolean;
+            /**
+             * Short, user-facing explanation of the verdict.
+             */
+            reason: string;
+            /**
+             * Named entities the filter recognized (e.g. characters, brands, people).
+             */
+            entities?: Array<string>;
+        }
+    }
 }
 export interface GenerateDescribeStyleResponse {
     /**
@@ -767,6 +836,10 @@ export interface GenerateDescribeStyleResponse {
      * The Creative Units discount for the request billed
      */
     creativeUnitsDiscount?: number;
+    /**
+     * IP detection findings, when detection ran for this request.
+     */
+    ipDetection?: GenerateDescribeStyleResponse.IPDetection;
 }
 export declare namespace GenerateDescribeStyleResponse {
     interface Job {
@@ -873,7 +946,7 @@ export declare namespace GenerateDescribeStyleResponse {
                 /**
                  * The status of the node. Only available for WorkflowJob nodes.
                  */
-                status: 'failure' | 'pending' | 'processing' | 'skipped' | 'success';
+                status: 'failure' | 'pending' | 'processing' | 'rejected' | 'skipped' | 'success';
                 /**
                  * The type of the job for the node.
                  */
@@ -1452,6 +1525,71 @@ export declare namespace GenerateDescribeStyleResponse {
             cuDiscount: number;
         }
     }
+    /**
+     * IP detection findings, when detection ran for this request.
+     */
+    interface IPDetection {
+        /**
+         * Whether and how detection affected the request.
+         */
+        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.
+         */
+        creativeUnitsCharged: number;
+        /**
+         * Number of enabled filters evaluated for this request.
+         */
+        evaluatedFilters: number;
+        /**
+         * Per-filter verdicts gathered for this request.
+         */
+        findings: Array<IPDetection.Finding>;
+        /**
+         * Convenience flag; always true when action is not 'allowed'.
+         */
+        flagged: boolean;
+        /**
+         * True if one or more detectors errored while evaluating this request.
+         */
+        hasDetectorError?: boolean;
+    }
+    namespace IPDetection {
+        /**
+         * A single filter's verdict.
+         */
+        interface Finding {
+            /**
+             * Category of the filter that produced this verdict.
+             */
+            category: 'artist-style' | 'brand-trademark' | 'celebrity-likeness' | 'custom' | 'fictional-character';
+            /**
+             * Confidence score from 0 (low) to 1 (high).
+             */
+            confidence: number;
+            /**
+             * Identifier of the filter that produced this verdict.
+             */
+            filterId: string;
+            /**
+             * Display name of the filter that produced this verdict.
+             */
+            filterName: string;
+            /**
+             * Whether this filter considered the request an IP risk.
+             */
+            flagged: boolean;
+            /**
+             * Short, user-facing explanation of the verdict.
+             */
+            reason: string;
+            /**
+             * Named entities the filter recognized (e.g. characters, brands, people).
+             */
+            entities?: Array<string>;
+        }
+    }
 }
 export interface GenerateDetectResponse {
     job: GenerateDetectResponse.Job;
@@ -1464,6 +1602,10 @@ export interface GenerateDetectResponse {
      * The Creative Units discount for the request billed
      */
     creativeUnitsDiscount?: number;
+    /**
+     * IP detection findings, when detection ran for this request.
+     */
+    ipDetection?: GenerateDetectResponse.IPDetection;
 }
 export declare namespace GenerateDetectResponse {
     interface Job {
@@ -1570,7 +1712,7 @@ export declare namespace GenerateDetectResponse {
                 /**
                  * The status of the node. Only available for WorkflowJob nodes.
                  */
-                status: 'failure' | 'pending' | 'processing' | 'skipped' | 'success';
+                status: 'failure' | 'pending' | 'processing' | 'rejected' | 'skipped' | 'success';
                 /**
                  * The type of the job for the node.
                  */
@@ -2870,6 +3012,71 @@ export declare namespace GenerateDetectResponse {
             url: string;
         }
     }
+    /**
+     * IP detection findings, when detection ran for this request.
+     */
+    interface IPDetection {
+        /**
+         * Whether and how detection affected the request.
+         */
+        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.
+         */
+        creativeUnitsCharged: number;
+        /**
+         * Number of enabled filters evaluated for this request.
+         */
+        evaluatedFilters: number;
+        /**
+         * Per-filter verdicts gathered for this request.
+         */
+        findings: Array<IPDetection.Finding>;
+        /**
+         * Convenience flag; always true when action is not 'allowed'.
+         */
+        flagged: boolean;
+        /**
+         * True if one or more detectors errored while evaluating this request.
+         */
+        hasDetectorError?: boolean;
+    }
+    namespace IPDetection {
+        /**
+         * A single filter's verdict.
+         */
+        interface Finding {
+            /**
+             * Category of the filter that produced this verdict.
+             */
+            category: 'artist-style' | 'brand-trademark' | 'celebrity-likeness' | 'custom' | 'fictional-character';
+            /**
+             * Confidence score from 0 (low) to 1 (high).
+             */
+            confidence: number;
+            /**
+             * Identifier of the filter that produced this verdict.
+             */
+            filterId: string;
+            /**
+             * Display name of the filter that produced this verdict.
+             */
+            filterName: string;
+            /**
+             * Whether this filter considered the request an IP risk.
+             */
+            flagged: boolean;
+            /**
+             * Short, user-facing explanation of the verdict.
+             */
+            reason: string;
+            /**
+             * Named entities the filter recognized (e.g. characters, brands, people).
+             */
+            entities?: Array<string>;
+        }
+    }
 }
 export interface GenerateEmbedResponse {
     /**
@@ -2887,6 +3094,10 @@ export interface GenerateEmbedResponse {
      * The Creative Units discount for the request billed
      */
     creativeUnitsDiscount?: number;
+    /**
+     * IP detection findings, when detection ran for this request.
+     */
+    ipDetection?: GenerateEmbedResponse.IPDetection;
 }
 export declare namespace GenerateEmbedResponse {
     interface Job {
@@ -2993,7 +3204,7 @@ export declare namespace GenerateEmbedResponse {
                 /**
                  * The status of the node. Only available for WorkflowJob nodes.
                  */
-                status: 'failure' | 'pending' | 'processing' | 'skipped' | 'success';
+                status: 'failure' | 'pending' | 'processing' | 'rejected' | 'skipped' | 'success';
                 /**
                  * The type of the job for the node.
                  */
@@ -3572,6 +3783,71 @@ export declare namespace GenerateEmbedResponse {
             cuDiscount: number;
         }
     }
+    /**
+     * IP detection findings, when detection ran for this request.
+     */
+    interface IPDetection {
+        /**
+         * Whether and how detection affected the request.
+         */
+        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.
+         */
+        creativeUnitsCharged: number;
+        /**
+         * Number of enabled filters evaluated for this request.
+         */
+        evaluatedFilters: number;
+        /**
+         * Per-filter verdicts gathered for this request.
+         */
+        findings: Array<IPDetection.Finding>;
+        /**
+         * Convenience flag; always true when action is not 'allowed'.
+         */
+        flagged: boolean;
+        /**
+         * True if one or more detectors errored while evaluating this request.
+         */
+        hasDetectorError?: boolean;
+    }
+    namespace IPDetection {
+        /**
+         * A single filter's verdict.
+         */
+        interface Finding {
+            /**
+             * Category of the filter that produced this verdict.
+             */
+            category: 'artist-style' | 'brand-trademark' | 'celebrity-likeness' | 'custom' | 'fictional-character';
+            /**
+             * Confidence score from 0 (low) to 1 (high).
+             */
+            confidence: number;
+            /**
+             * Identifier of the filter that produced this verdict.
+             */
+            filterId: string;
+            /**
+             * Display name of the filter that produced this verdict.
+             */
+            filterName: string;
+            /**
+             * Whether this filter considered the request an IP risk.
+             */
+            flagged: boolean;
+            /**
+             * Short, user-facing explanation of the verdict.
+             */
+            reason: string;
+            /**
+             * Named entities the filter recognized (e.g. characters, brands, people).
+             */
+            entities?: Array<string>;
+        }
+    }
 }
 export interface GeneratePatchResponse {
     job: GeneratePatchResponse.Job;
@@ -3584,6 +3860,10 @@ export interface GeneratePatchResponse {
      * The Creative Units discount for the request billed
      */
     creativeUnitsDiscount?: number;
+    /**
+     * IP detection findings, when detection ran for this request.
+     */
+    ipDetection?: GeneratePatchResponse.IPDetection;
 }
 export declare namespace GeneratePatchResponse {
     interface Job {
@@ -3690,7 +3970,7 @@ export declare namespace GeneratePatchResponse {
                 /**
                  * The status of the node. Only available for WorkflowJob nodes.
                  */
-                status: 'failure' | 'pending' | 'processing' | 'skipped' | 'success';
+                status: 'failure' | 'pending' | 'processing' | 'rejected' | 'skipped' | 'success';
                 /**
                  * The type of the job for the node.
                  */
@@ -4990,6 +5270,71 @@ export declare namespace GeneratePatchResponse {
             url: string;
         }
     }
+    /**
+     * IP detection findings, when detection ran for this request.
+     */
+    interface IPDetection {
+        /**
+         * Whether and how detection affected the request.
+         */
+        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.
+         */
+        creativeUnitsCharged: number;
+        /**
+         * Number of enabled filters evaluated for this request.
+         */
+        evaluatedFilters: number;
+        /**
+         * Per-filter verdicts gathered for this request.
+         */
+        findings: Array<IPDetection.Finding>;
+        /**
+         * Convenience flag; always true when action is not 'allowed'.
+         */
+        flagged: boolean;
+        /**
+         * True if one or more detectors errored while evaluating this request.
+         */
+        hasDetectorError?: boolean;
+    }
+    namespace IPDetection {
+        /**
+         * A single filter's verdict.
+         */
+        interface Finding {
+            /**
+             * Category of the filter that produced this verdict.
+             */
+            category: 'artist-style' | 'brand-trademark' | 'celebrity-likeness' | 'custom' | 'fictional-character';
+            /**
+             * Confidence score from 0 (low) to 1 (high).
+             */
+            confidence: number;
+            /**
+             * Identifier of the filter that produced this verdict.
+             */
+            filterId: string;
+            /**
+             * Display name of the filter that produced this verdict.
+             */
+            filterName: string;
+            /**
+             * Whether this filter considered the request an IP risk.
+             */
+            flagged: boolean;
+            /**
+             * Short, user-facing explanation of the verdict.
+             */
+            reason: string;
+            /**
+             * Named entities the filter recognized (e.g. characters, brands, people).
+             */
+            entities?: Array<string>;
+        }
+    }
 }
 export interface GeneratePromptResponse {
     job: GeneratePromptResponse.Job;
@@ -4997,6 +5342,11 @@ export interface GeneratePromptResponse {
      * The generated prompts.
      */
     prompts: Array<string>;
+    /**
+     * The full ready-to-run model calls, index-aligned with `prompts`: `prompts[i]` is
+     * the prompt text of `calls[i]`.
+     */
+    calls?: Array<GeneratePromptResponse.Call>;
     /**
      * The Creative Units cost for the request billed
      */
@@ -5005,10 +5355,14 @@ export interface GeneratePromptResponse {
      * The Creative Units discount for the request billed
      */
     creativeUnitsDiscount?: number;
+    /**
+     * IP detection findings, when detection ran for this request.
+     */
+    ipDetection?: GeneratePromptResponse.IPDetection;
     /**
      * The mode used to generate new prompt(s).
      */
-    mode?: 'completion' | 'contextual' | 'image-editing' | 'inventive' | 'structured';
+    mode?: 'completion' | 'contextual' | 'contextual-v2' | 'image-editing' | 'inventive' | 'structured';
 }
 export declare namespace GeneratePromptResponse {
     interface Job {
@@ -5115,7 +5469,7 @@ export declare namespace GeneratePromptResponse {
                 /**
                  * The status of the node. Only available for WorkflowJob nodes.
                  */
-                status: 'failure' | 'pending' | 'processing' | 'skipped' | 'success';
+                status: 'failure' | 'pending' | 'processing' | 'rejected' | 'skipped' | 'success';
                 /**
                  * The type of the job for the node.
                  */
@@ -5694,6 +6048,92 @@ export declare namespace GeneratePromptResponse {
             cuDiscount: number;
         }
     }
+    /**
+     * A complete, ready-to-run model call proposed by Prompt Spark v3.
+     *
+     * The prompt text is carried inside `parameters` under the target model's prompt
+     * input (when the model defines one). For models without a prompt input, the text
+     * is only available in the index-aligned `prompts` array.
+     */
+    interface Call {
+        /**
+         * The target model the call is for.
+         */
+        modelId: string;
+        /**
+         * Schema-valid dynamic parameters for the target model, prompt included.
+         */
+        parameters: unknown;
+        /**
+         * Optional rationale for the proposed call.
+         */
+        rationale?: string;
+    }
+    /**
+     * IP detection findings, when detection ran for this request.
+     */
+    interface IPDetection {
+        /**
+         * Whether and how detection affected the request.
+         */
+        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.
+         */
+        creativeUnitsCharged: number;
+        /**
+         * Number of enabled filters evaluated for this request.
+         */
+        evaluatedFilters: number;
+        /**
+         * Per-filter verdicts gathered for this request.
+         */
+        findings: Array<IPDetection.Finding>;
+        /**
+         * Convenience flag; always true when action is not 'allowed'.
+         */
+        flagged: boolean;
+        /**
+         * True if one or more detectors errored while evaluating this request.
+         */
+        hasDetectorError?: boolean;
+    }
+    namespace IPDetection {
+        /**
+         * A single filter's verdict.
+         */
+        interface Finding {
+            /**
+             * Category of the filter that produced this verdict.
+             */
+            category: 'artist-style' | 'brand-trademark' | 'celebrity-likeness' | 'custom' | 'fictional-character';
+            /**
+             * Confidence score from 0 (low) to 1 (high).
+             */
+            confidence: number;
+            /**
+             * Identifier of the filter that produced this verdict.
+             */
+            filterId: string;
+            /**
+             * Display name of the filter that produced this verdict.
+             */
+            filterName: string;
+            /**
+             * Whether this filter considered the request an IP risk.
+             */
+            flagged: boolean;
+            /**
+             * Short, user-facing explanation of the verdict.
+             */
+            reason: string;
+            /**
+             * Named entities the filter recognized (e.g. characters, brands, people).
+             */
+            entities?: Array<string>;
+        }
+    }
 }
 export interface GenerateRunModelResponse {
     job: GenerateRunModelResponse.Job;
@@ -5705,6 +6145,10 @@ export interface GenerateRunModelResponse {
      * The Creative Units discount for the request billed
      */
     creativeUnitsDiscount?: number;
+    /**
+     * IP detection findings, when detection ran for this request.
+     */
+    ipDetection?: GenerateRunModelResponse.IPDetection;
 }
 export declare namespace GenerateRunModelResponse {
     interface Job {
@@ -5811,7 +6255,7 @@ export declare namespace GenerateRunModelResponse {
                 /**
                  * The status of the node. Only available for WorkflowJob nodes.
                  */
-                status: 'failure' | 'pending' | 'processing' | 'skipped' | 'success';
+                status: 'failure' | 'pending' | 'processing' | 'rejected' | 'skipped' | 'success';
                 /**
                  * The type of the job for the node.
                  */
@@ -6390,6 +6834,71 @@ export declare namespace GenerateRunModelResponse {
             cuDiscount: number;
         }
     }
+    /**
+     * IP detection findings, when detection ran for this request.
+     */
+    interface IPDetection {
+        /**
+         * Whether and how detection affected the request.
+         */
+        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.
+         */
+        creativeUnitsCharged: number;
+        /**
+         * Number of enabled filters evaluated for this request.
+         */
+        evaluatedFilters: number;
+        /**
+         * Per-filter verdicts gathered for this request.
+         */
+        findings: Array<IPDetection.Finding>;
+        /**
+         * Convenience flag; always true when action is not 'allowed'.
+         */
+        flagged: boolean;
+        /**
+         * True if one or more detectors errored while evaluating this request.
+         */
+        hasDetectorError?: boolean;
+    }
+    namespace IPDetection {
+        /**
+         * A single filter's verdict.
+         */
+        interface Finding {
+            /**
+             * Category of the filter that produced this verdict.
+             */
+            category: 'artist-style' | 'brand-trademark' | 'celebrity-likeness' | 'custom' | 'fictional-character';
+            /**
+             * Confidence score from 0 (low) to 1 (high).
+             */
+            confidence: number;
+            /**
+             * Identifier of the filter that produced this verdict.
+             */
+            filterId: string;
+            /**
+             * Display name of the filter that produced this verdict.
+             */
+            filterName: string;
+            /**
+             * Whether this filter considered the request an IP risk.
+             */
+            flagged: boolean;
+            /**
+             * Short, user-facing explanation of the verdict.
+             */
+            reason: string;
+            /**
+             * Named entities the filter recognized (e.g. characters, brands, people).
+             */
+            entities?: Array<string>;
+        }
+    }
 }
 export interface GenerateTranslateResponse {
     /**
@@ -6409,6 +6918,10 @@ export interface GenerateTranslateResponse {
      * The Creative Units discount for the request billed
      */
     creativeUnitsDiscount?: number;
+    /**
+     * IP detection findings, when detection ran for this request.
+     */
+    ipDetection?: GenerateTranslateResponse.IPDetection;
 }
 export declare namespace GenerateTranslateResponse {
     interface Job {
@@ -6515,7 +7028,7 @@ export declare namespace GenerateTranslateResponse {
                 /**
                  * The status of the node. Only available for WorkflowJob nodes.
                  */
-                status: 'failure' | 'pending' | 'processing' | 'skipped' | 'success';
+                status: 'failure' | 'pending' | 'processing' | 'rejected' | 'skipped' | 'success';
                 /**
                  * The type of the job for the node.
                  */
@@ -7094,6 +7607,71 @@ export declare namespace GenerateTranslateResponse {
             cuDiscount: number;
         }
     }
+    /**
+     * IP detection findings, when detection ran for this request.
+     */
+    interface IPDetection {
+        /**
+         * Whether and how detection affected the request.
+         */
+        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.
+         */
+        creativeUnitsCharged: number;
+        /**
+         * Number of enabled filters evaluated for this request.
+         */
+        evaluatedFilters: number;
+        /**
+         * Per-filter verdicts gathered for this request.
+         */
+        findings: Array<IPDetection.Finding>;
+        /**
+         * Convenience flag; always true when action is not 'allowed'.
+         */
+        flagged: boolean;
+        /**
+         * True if one or more detectors errored while evaluating this request.
+         */
+        hasDetectorError?: boolean;
+    }
+    namespace IPDetection {
+        /**
+         * A single filter's verdict.
+         */
+        interface Finding {
+            /**
+             * Category of the filter that produced this verdict.
+             */
+            category: 'artist-style' | 'brand-trademark' | 'celebrity-likeness' | 'custom' | 'fictional-character';
+            /**
+             * Confidence score from 0 (low) to 1 (high).
+             */
+            confidence: number;
+            /**
+             * Identifier of the filter that produced this verdict.
+             */
+            filterId: string;
+            /**
+             * Display name of the filter that produced this verdict.
+             */
+            filterName: string;
+            /**
+             * Whether this filter considered the request an IP risk.
+             */
+            flagged: boolean;
+            /**
+             * Short, user-facing explanation of the verdict.
+             */
+            reason: string;
+            /**
+             * Named entities the filter recognized (e.g. characters, brands, people).
+             */
+            entities?: Array<string>;
+        }
+    }
 }
 export interface GenerateCaptionParams {
     /**
@@ -7387,7 +7965,7 @@ export interface GeneratePromptParams {
     /**
      * Body param: The mode used to generate new prompt(s).
      */
-    mode: 'completion' | 'contextual' | 'image-editing' | 'inventive' | 'structured';
+    mode: 'completion' | 'contextual' | 'contextual-v2' | 'image-editing' | 'inventive' | 'structured';
     /**
      * Query param
      */
@@ -7482,6 +8060,12 @@ export interface GenerateRunModelParams {
      * Query param
      */
     dryRun?: unknown;
+    /**
+     * Query param: Set to "true" to run an IP-detection preflight on this request.
+     * Combine with ?dryRun=true for an advisory check that returns findings without
+     * generating.
+     */
+    ipDetection?: boolean;
 }
 export interface GenerateTranslateParams {
     /**