@scenario-labs/sdk 0.3.0 → 1.1.0

package/src/resources/generate.ts

@@ -50,6 +50,14 @@ export class Generate extends APIResource {
     return this._client.post('/generate/patch', { query: { dryRun, originalAssets }, body, ...options });
   }
 
+  /**
+   * Generate, complete or invent new prompts.
+   */
+  prompt(params: GeneratePromptParams, options?: RequestOptions): APIPromise<GeneratePromptResponse> {
+    const { dryRun, ...body } = params;
+    return this._client.post('/generate/prompt', { query: { dryRun }, body, ...options });
+  }
+
   /**
    * Generate with any model (Image, Video, Audio, 3d).
    *
@@ -3076,6 +3084,7 @@ export namespace GenerateDetectResponse {
       | '3d:texture:normal'
       | '3d:texture:roughness'
       | 'audio2audio'
+      | 'audio2video'
       | 'background-removal'
       | 'canvas'
       | 'canvas-drawing'
@@ -3137,6 +3146,7 @@ export namespace GenerateDetectResponse {
       | 'upscale-video'
       | 'vectorization'
       | 'video23d'
+      | 'video2audio'
       | 'video2img'
       | 'video2video'
       | 'voice-clone';
@@ -3259,6 +3269,7 @@ export namespace GenerateDetectResponse {
         | '3d23d'
         | '3d23d-texture'
         | 'audio2audio'
+        | 'audio2video'
         | 'background-removal'
         | 'canvas'
         | 'canvas-drawing'
@@ -3320,6 +3331,7 @@ export namespace GenerateDetectResponse {
         | 'upscale-video'
         | 'vectorization'
         | 'video23d'
+        | 'video2audio'
         | 'video2img'
         | 'video2video'
         | 'voice-clone';
@@ -6115,6 +6127,7 @@ export namespace GeneratePatchResponse {
       | '3d:texture:normal'
       | '3d:texture:roughness'
       | 'audio2audio'
+      | 'audio2video'
       | 'background-removal'
       | 'canvas'
       | 'canvas-drawing'
@@ -6176,6 +6189,7 @@ export namespace GeneratePatchResponse {
       | 'upscale-video'
       | 'vectorization'
       | 'video23d'
+      | 'video2audio'
       | 'video2img'
       | 'video2video'
       | 'voice-clone';
@@ -6298,6 +6312,7 @@ export namespace GeneratePatchResponse {
         | '3d23d'
         | '3d23d-texture'
         | 'audio2audio'
+        | 'audio2video'
         | 'background-removal'
         | 'canvas'
         | 'canvas-drawing'
@@ -6359,6 +6374,7 @@ export namespace GeneratePatchResponse {
         | 'upscale-video'
         | 'vectorization'
         | 'video23d'
+        | 'video2audio'
         | 'video2img'
         | 'video2video'
         | 'voice-clone';
@@ -7140,8 +7156,13 @@ export namespace GeneratePatchResponse {
   }
 }
 
-export interface GenerateRunModelResponse {
-  job: GenerateRunModelResponse.Job;
+export interface GeneratePromptResponse {
+  job: GeneratePromptResponse.Job;
+
+  /**
+   * The generated prompts.
+   */
+  prompts: Array<string>;
 
   /**
    * The Creative Units cost for the request billed
@@ -7152,9 +7173,14 @@ export interface GenerateRunModelResponse {
    * The Creative Units discount for the request billed
    */
   creativeUnitsDiscount?: number;
+
+  /**
+   * The mode used to generate new prompt(s).
+   */
+  mode?: 'completion' | 'contextual' | 'image-editing' | 'inventive' | 'structured';
 }
 
-export namespace GenerateRunModelResponse {
+export namespace GeneratePromptResponse {
   export interface Job {
     /**
      * The job creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
@@ -8102,18 +8128,8 @@ export namespace GenerateRunModelResponse {
   }
 }
 
-export interface GenerateTranslateResponse {
-  /**
-   * Detected language of the input.
-   */
-  detectedLanguage: string;
-
-  job: GenerateTranslateResponse.Job;
-
-  /**
-   * The translated prompt.
-   */
-  translation: string;
+export interface GenerateRunModelResponse {
+  job: GenerateRunModelResponse.Job;
 
   /**
    * The Creative Units cost for the request billed
@@ -8126,7 +8142,7 @@ export interface GenerateTranslateResponse {
   creativeUnitsDiscount?: number;
 }
 
-export namespace GenerateTranslateResponse {
+export namespace GenerateRunModelResponse {
   export interface Job {
     /**
      * The job creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
@@ -9074,149 +9090,1121 @@ export namespace GenerateTranslateResponse {
   }
 }
 
-export interface GenerateCaptionParams {
-  /**
-   * Body param: List of images used to generate captions. Results are returned in
-   * the same order as the given images.
-   *
-   * Images are set a data URLs (example:
-   * \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVQYV2NgYAAAAAMAAWgmWQ0AAAAASUVORK5CYII=\")
-   * or the asset IDs (example: \"asset_GTrL3mq4SXWyMxkOHRxlpw\").
-   *
-   * Notes:
-   *
-   * - if both `modelId` and `images` are provided, `modelId`'s examples and training
-   *   images will be used to influence the caption structure of the images
-   * - if only `images` are provided, the captions will be conditioned by the
-   *   `detailsLevel` parameter
-   * - Replaces `assetIds` parameter
-   * - if you want to caption multiple images at a time, please prefer using asset
-   *   ids instead of data url
-   */
-  images: Array<string>;
-
+export interface GenerateTranslateResponse {
   /**
-   * Query param
+   * Detected language of the input.
    */
-  dryRun?: unknown;
+  detectedLanguage: string;
 
-  /**
-   * Body param: The assetIds to generate captions. Results are returned in the same
-   * order as the given assetIds. Deprecated, use `images` parameter instead.
-   */
-  assetIds?: Array<string>;
+  job: GenerateTranslateResponse.Job;
 
   /**
-   * Body param: The details level used to generate the captions.
-   *
-   * When a modelId is provided and examples are available, the details level is
-   * ignored.
+   * The translated prompt.
    */
-  detailsLevel?: 'action' | 'action+style';
+  translation: string;
 
   /**
-   * Body param: Whether we try to ensure IP removal for new prompt generation.
+   * The Creative Units cost for the request billed
    */
-  ensureIPCleared?: boolean;
+  creativeUnitsCost?: number;
 
   /**
-   * Body param: When provided, the model will follow the model's training images and
-   * examples' prompt to generate the captions.
+   * The Creative Units discount for the request billed
    */
-  modelId?: string;
+  creativeUnitsDiscount?: number;
+}
 
-  /**
-   * Body param: If specified, the API will make a best effort to produce the same
-   * results, such that repeated requests with the same `seed` and parameters should
-   * return the same outputs. Must be used along with the same parameters including
-   * prompt, model's state, etc..
-   */
-  seed?: number;
+export namespace GenerateTranslateResponse {
+  export interface Job {
+    /**
+     * The job creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+     */
+    createdAt: string;
 
-  /**
-   * Body param: The sampling temperature to use. Higher values like `0.8` will make
-   * the output more random, while lower values like `0.2` will make it more focused
-   * and deterministic.
-   *
-   * We generally recommend altering this or `topP` but not both.
-   */
-  temperature?: number;
+    /**
+     * The job ID (example: "job_ocZCnG1Df35XRL1QyCZSRxAG8")
+     */
+    jobId: string;
 
-  /**
-   * Body param: An alternative to sampling with temperature, called nucleus
-   * sampling, where the model considers the results of the tokens with top_p
-   * probability mass. So `0.1` means only the tokens comprising the top `10%`
-   * probability mass are considered.
-   *
-   * We generally recommend altering this or `temperature` but not both.
-   */
-  topP?: number;
+    /**
+     * The type of job
+     */
+    jobType:
+      | 'assets-download'
+      | 'canvas-export'
+      | 'caption'
+      | 'caption-llava'
+      | 'custom'
+      | 'describe-style'
+      | 'detection'
+      | 'embed'
+      | 'flux'
+      | 'flux-model-training'
+      | 'generate-prompt'
+      | 'image-generation'
+      | 'image-prompt-editing'
+      | 'inference'
+      | 'mesh-preview-rendering'
+      | 'model-download'
+      | 'model-import'
+      | 'model-training'
+      | 'musubi-model-training'
+      | 'openai-image-generation'
+      | 'patch-image'
+      | 'pixelate'
+      | 'reframe'
+      | 'remove-background'
+      | 'repaint'
+      | 'restyle'
+      | 'segment'
+      | 'skybox-3d'
+      | 'skybox-base-360'
+      | 'skybox-hdri'
+      | 'skybox-upscale-360'
+      | 'texture'
+      | 'translate'
+      | 'upload'
+      | 'upscale'
+      | 'upscale-skybox'
+      | 'upscale-texture'
+      | 'vectorize'
+      | 'workflow';
 
-  /**
-   * Body param: Optional list of words sequences that should not be present in the
-   * generated prompts.
-   */
-  unwantedSequences?: Array<string>;
-}
+    /**
+     * Metadata of the job with some additional information
+     */
+    metadata: Job.Metadata;
 
-export interface GenerateDescribeStyleParams {
-  /**
-   * Query param
-   */
-  dryRun?: unknown;
+    /**
+     * Progress of the job (between 0 and 1)
+     */
+    progress: number;
 
-  /**
-   * Body param: The asset ids used to condition the generation.
-   */
-  assetIds?: Array<string>;
+    /**
+     * The current status of the job
+     */
+    status:
+      | 'canceled'
+      | 'failure'
+      | 'finalizing'
+      | 'in-progress'
+      | 'pending'
+      | 'queued'
+      | 'success'
+      | 'warming-up';
 
-  /**
-   * Body param: Whether we try to ensure IP removal for new prompt generation.
-   */
-  ensureIPCleared?: boolean;
+    /**
+     * The history of the different statuses the job went through with the ISO string
+     * date of when the job reached each statuses.
+     */
+    statusHistory: Array<Job.StatusHistory>;
 
-  /**
-   * Body param: List of images used to condition the generation.
-   *
-   * Images are set a data URLs (example:
-   * \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVQYV2NgYAAAAAMAAWgmWQ0AAAAASUVORK5CYII=\")
-   * or the asset IDs (example: \"asset_GTrL3mq4SXWyMxkOHRxlpw\").
-   *
-   * Notes:
-   *
-   * - in `contextual` mode, images condition prompt generation by using their actual
-   *   descriptions as context
-   * - in all other modes, it supersedes the `modelId` parameter when provided.
-   */
-  images?: Array<string>;
+    /**
+     * The job last update date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+     */
+    updatedAt: string;
 
-  /**
-   * Body param: The modelId used to condition the generation.
-   *
-   * When provided, the generation will take into account model's training images,
-   * examples.
-   *
-   * In `contextual` mode, the modelId is used to retrieve additional context from
-   * the model such as its type and capabilities.
-   */
-  modelId?: string;
+    /**
+     * The author user ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")
+     */
+    authorId?: string;
 
-  /**
-   * Body param: If specified, the API will make a best effort to produce the same
-   * results, such that repeated requests with the same `seed` and parameters should
-   * return the same outputs. Must be used along with the same parameters including
-   * prompt, model's state, etc..
-   */
-  seed?: number;
+    /**
+     * The billing of the job
+     */
+    billing?: Job.Billing;
 
-  /**
-   * Body param: The sampling temperature to use. Higher values like `0.8` will make
-   * the output more random, while lower values like `0.2` will make it more focused
-   * and deterministic.
-   *
-   * We generally recommend altering this or `topP` but not both.
-   */
-  temperature?: number;
+    /**
+     * The owner ID (example: "team_U3Qmc8PCdWXwAQJ4Dvw4tV6D")
+     */
+    ownerId?: string;
+  }
+
+  export namespace Job {
+    /**
+     * Metadata of the job with some additional information
+     */
+    export interface Metadata {
+      /**
+       * List of produced assets for this job
+       */
+      assetIds?: Array<string>;
+
+      /**
+       * Eventual error for the job
+       */
+      error?: string | null;
+
+      /**
+       * The flow of the job. Only available for workflow jobs.
+       */
+      flow?: Array<Metadata.Flow>;
+
+      /**
+       * Actionable hint for the user explaining what went wrong and how to resolve it.
+       */
+      hint?: string;
+
+      /**
+       * The inputs for the job
+       */
+      input?: { [key: string]: unknown };
+
+      /**
+       * May contain the output of the job for specific custom models jobs. Only
+       * available for custom models which generate non-assets outputs. Example: LLM text
+       * results.
+       */
+      output?: { [key: string]: unknown };
+
+      /**
+       * For voice-clone jobs: the ID of the model being trained.
+       */
+      outputModelId?: string;
+
+      /**
+       * The workflow ID of the job if job is part of a workflow.
+       */
+      workflowId?: string;
+
+      /**
+       * The workflow job ID of the job if job is part of a workflow job.
+       */
+      workflowJobId?: string;
+    }
+
+    export namespace Metadata {
+      export interface Flow {
+        /**
+         * The id of the node.
+         */
+        id: string;
+
+        /**
+         * The status of the node. Only available for WorkflowJob nodes.
+         */
+        status: 'failure' | 'pending' | 'processing' | 'skipped' | 'success';
+
+        /**
+         * The type of the job for the node.
+         */
+        type:
+          | 'custom-model'
+          | 'for-each'
+          | 'generate-prompt'
+          | 'list'
+          | 'logic'
+          | 'model'
+          | 'remove-background'
+          | 'transform'
+          | 'user-approval'
+          | 'workflow';
+
+        /**
+         * List of produced assets for this node.
+         */
+        assets?: Array<Flow.Asset>;
+
+        /**
+         * Fixed number of iterations for a ForEach node. When set, the loop runs exactly
+         * `count` times regardless of array input. When not set, the loop iterates over
+         * the resolved array input. Only available for ForEach nodes.
+         */
+        count?: number;
+
+        /**
+         * The nodes that this node depends on. Only available for nodes that have
+         * dependencies. Mainly used for user approval nodes.
+         */
+        dependsOn?: Array<string>;
+
+        /**
+         * If true, the outputs of this node will be included in the workflow job's final
+         * output. Only applicable to producing nodes (custom-model, inference, etc.). By
+         * default, only last nodes (nodes not referenced by other nodes) contribute to
+         * outputs. Set this to true to also include intermediate nodes in the final
+         * output. Note: This should only be set to `true` or left undefined.
+         */
+        includeOutputsInWorkflowJob?: true;
+
+        /**
+         * The inputs of the node.
+         */
+        inputs?: Array<Flow.Input>;
+
+        /**
+         * Statically-configured items for a List node. The node outputs this array as-is
+         * when executed. Only available for List nodes. The values can be strings,
+         * numbers, or asset IDs.
+         */
+        items?: Array<string>;
+
+        /**
+         * Zero-based index of the iteration this node copy belongs to. Set on
+         * dynamically-created copies of loop body nodes.
+         */
+        iterationIndex?: number;
+
+        /**
+         * If the flow is part of a WorkflowJob, this is the jobId for the node. jobId is
+         * only available for nodes started. A node "Pending" for a running workflow job is
+         * not started.
+         */
+        jobId?: string;
+
+        /**
+         * The logic of the node. Only available for logic nodes.
+         */
+        logic?: Flow.Logic;
+
+        /**
+         * The type of the logic for the node. Only available for logic nodes.
+         */
+        logicType?: 'if-else';
+
+        /**
+         * IDs of the body template nodes that belong to this ForEach loop. At runtime
+         * these templates are cloned once per iteration and marked Skipped. Only available
+         * for ForEach nodes.
+         */
+        loopBodyNodeIds?: Array<string>;
+
+        /**
+         * ID of the ForEach node that spawned this iteration copy. Set on
+         * dynamically-created copies of loop body nodes.
+         */
+        loopNodeId?: string;
+
+        /**
+         * The model id for the node. Mainly used for custom model tasks.
+         */
+        modelId?: string;
+
+        /**
+         * The output of the node. Only available for logic nodes.
+         */
+        output?: unknown;
+
+        /**
+         * The workflow id for the node. Mainly used for workflow tasks.
+         */
+        workflowId?: string;
+      }
+
+      export namespace Flow {
+        export interface Asset {
+          assetId: string;
+
+          url: string;
+        }
+
+        /**
+         * This is used to run the flow.
+         */
+        export interface Input {
+          /**
+           * The name that must be user to call the model through the API
+           */
+          name: string;
+
+          /**
+           * The data type of the input
+           */
+          type:
+            | 'boolean'
+            | 'file'
+            | 'file_array'
+            | 'inputs_array'
+            | 'model'
+            | 'model_array'
+            | 'number'
+            | 'number_array'
+            | 'string'
+            | 'string_array';
+
+          /**
+           * The allowed values for the input. For \`string\` or \`number\` types, creates a
+           * single-select dropdown. For \`string_array\` type, creates a multi-select
+           * dropdown.
+           */
+          allowedValues?: Array<unknown>;
+
+          /**
+           * Specifies the background behavior for the input. Only available for \`file\` and
+           * \`file_array\` input types with kind \`image\`.
+           */
+          backgroundBehavior?: 'opaque' | 'transparent';
+
+          /**
+           * Whether the input is a color or not. Only available for \`string\` input type.
+           */
+          color?: boolean;
+
+          /**
+           * Whether this input affects the model's cost calculation
+           */
+          costImpact?: boolean;
+
+          /**
+           * The default value for the input
+           */
+          default?: unknown;
+
+          /**
+           * Help text displayed in the UI to provide additional information about the input
+           */
+          description?: string;
+
+          /**
+           * Used to visually group inputs together in the UI. Inputs with the same group
+           * value appear consecutively in the UI.
+           */
+          group?: string;
+
+          /**
+           * Hint text displayed in the UI as a tooltip to guide the user
+           */
+          hint?: string;
+
+          /**
+           * The list of inputs which form an object within a container array. All inputs are
+           * the same as the current object. This is only available for type inputs_array
+           * inputs.
+           */
+          inputs?: Array<{ [key: string]: unknown }>;
+
+          /**
+           * The configured items for inputs_array type inputs. Each item is an array of
+           * SubNodeInput that need ref/value resolution. Only available for inputs_array
+           * type.
+           */
+          items?: Array<Array<Input.Item>>;
+
+          /**
+           * 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
+           */
+          kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+
+          /**
+           * The label displayed in the UI for this input
+           */
+          label?: string;
+
+          /**
+           * The name of the file input field to use as the mask source
+           */
+          maskFrom?: string;
+
+          /**
+           * The maximum allowed value. Only available for \`number\` and \`array\` input
+           * types.
+           */
+          max?: number;
+
+          /**
+           * The maximum allowed length for \`string\` inputs. Also applies to each item in
+           * \`string_array\`.
+           */
+          maxLength?: number;
+
+          /**
+           * The maximum allowed file size in bytes. Only applies to \`file\` and
+           * \`file_array\` input types. Validated against \`asset.properties.size\` at job
+           * creation time.
+           */
+          maxSize?: number;
+
+          /**
+           * The minimum allowed value. Only available for \`number\` and array input types.
+           */
+          min?: number;
+
+          /**
+           * The minimum allowed length for string inputs. Also applies to each item in
+           * \`string_array\`.
+           */
+          minLength?: number;
+
+          /**
+           * The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
+           * available for \`model_array\` input type.
+           */
+          modelTypes?: Array<
+            | 'custom'
+            | 'elevenlabs-voice'
+            | 'flux.1'
+            | 'flux.1-composition'
+            | 'flux.1-kontext-dev'
+            | 'flux.1-kontext-lora'
+            | 'flux.1-krea-dev'
+            | 'flux.1-krea-lora'
+            | 'flux.1-lora'
+            | 'flux.1-pro'
+            | 'flux.1.1-pro-ultra'
+            | 'flux.2-dev-edit-lora'
+            | 'flux.2-dev-lora'
+            | 'flux.2-klein-4b-edit-lora'
+            | 'flux.2-klein-4b-lora'
+            | 'flux.2-klein-9b-edit-lora'
+            | 'flux.2-klein-9b-lora'
+            | 'flux.2-klein-base-4b-edit-lora'
+            | 'flux.2-klein-base-4b-lora'
+            | 'flux.2-klein-base-9b-edit-lora'
+            | 'flux.2-klein-base-9b-lora'
+            | 'flux1.1-pro'
+            | 'gpt-image-1'
+            | 'qwen-image-2512-lora'
+            | 'qwen-image-edit-2509-lora'
+            | 'qwen-image-edit-2511-lora'
+            | 'qwen-image-edit-lora'
+            | 'qwen-image-lora'
+            | 'sd-1_5'
+            | 'sd-1_5-composition'
+            | 'sd-1_5-lora'
+            | 'sd-xl'
+            | 'sd-xl-composition'
+            | 'sd-xl-lora'
+            | 'zimage-de-turbo-lora'
+            | 'zimage-lora'
+            | 'zimage-turbo-lora'
+          >;
+
+          /**
+           * Whether this input represents a parent asset to assign to the produced assets.
+           * Only available for \`file\` and \`file_array\` input types.
+           *
+           * For \`file_array\`, the parent asset is the first item in the array.
+           */
+          parent?: boolean;
+
+          /**
+           * Placeholder text for the input. Only available for 'string' input type.
+           */
+          placeholder?: string;
+
+          /**
+           * Whether the input is a prompt. When true, displays as a text area with prompt
+           * spark feature. Only available for \`string\` input type.
+           */
+          prompt?: boolean;
+
+          /**
+           * Whether the input is used with prompt spark. Only available for \`string\` input
+           * type.
+           */
+          promptSpark?: boolean;
+
+          /**
+           * The reference to another input or output of the same workflow. Must have at
+           * least one of node or conditional.
+           */
+          ref?: Input.Ref;
+
+          /**
+           * Set of rules that describes when this input is required:
+           *
+           * - \`always\`: Input is always required
+           * - \`ifNotDefined\`: Input is required when another specified input is not
+           *   defined
+           * - \`ifDefined\`: Input is required when another specified input is defined
+           * - \`conditionalValues\`: Input is required when another input has a specific
+           *   value
+           *
+           * By default, the input is not required.
+           */
+          required?: Input.Required;
+
+          /**
+           * The step increment for numeric inputs. Only available for \`number\` input type.
+           */
+          step?: number;
+
+          /**
+           * The value of the input. This is the value of the input that will be used to run
+           * the node. Only available for flows managed by a WorkflowJob.
+           */
+          value?: unknown;
+        }
+
+        export namespace Input {
+          /**
+           * A sub-input within an inputs_array item. Same as NodeInput but without the
+           * recursive items field.
+           */
+          export interface Item {
+            /**
+             * The name that must be user to call the model through the API
+             */
+            name: string;
+
+            /**
+             * The data type of the input
+             */
+            type:
+              | 'boolean'
+              | 'file'
+              | 'file_array'
+              | 'inputs_array'
+              | 'model'
+              | 'model_array'
+              | 'number'
+              | 'number_array'
+              | 'string'
+              | 'string_array';
+
+            /**
+             * The allowed values for the input. For \`string\` or \`number\` types, creates a
+             * single-select dropdown. For \`string_array\` type, creates a multi-select
+             * dropdown.
+             */
+            allowedValues?: Array<unknown>;
+
+            /**
+             * Specifies the background behavior for the input. Only available for \`file\` and
+             * \`file_array\` input types with kind \`image\`.
+             */
+            backgroundBehavior?: 'opaque' | 'transparent';
+
+            /**
+             * Whether the input is a color or not. Only available for \`string\` input type.
+             */
+            color?: boolean;
+
+            /**
+             * Whether this input affects the model's cost calculation
+             */
+            costImpact?: boolean;
+
+            /**
+             * The default value for the input
+             */
+            default?: unknown;
+
+            /**
+             * Help text displayed in the UI to provide additional information about the input
+             */
+            description?: string;
+
+            /**
+             * Used to visually group inputs together in the UI. Inputs with the same group
+             * value appear consecutively in the UI.
+             */
+            group?: string;
+
+            /**
+             * Hint text displayed in the UI as a tooltip to guide the user
+             */
+            hint?: string;
+
+            /**
+             * The list of inputs which form an object within a container array. All inputs are
+             * the same as the current object. This is only available for type inputs_array
+             * inputs.
+             */
+            inputs?: Array<{ [key: string]: unknown }>;
+
+            /**
+             * 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
+             */
+            kind?: '3d' | 'audio' | 'document' | 'image' | 'image-hdr' | 'json' | 'video';
+
+            /**
+             * The label displayed in the UI for this input
+             */
+            label?: string;
+
+            /**
+             * The name of the file input field to use as the mask source
+             */
+            maskFrom?: string;
+
+            /**
+             * The maximum allowed value. Only available for \`number\` and \`array\` input
+             * types.
+             */
+            max?: number;
+
+            /**
+             * The maximum allowed length for \`string\` inputs. Also applies to each item in
+             * \`string_array\`.
+             */
+            maxLength?: number;
+
+            /**
+             * The maximum allowed file size in bytes. Only applies to \`file\` and
+             * \`file_array\` input types. Validated against \`asset.properties.size\` at job
+             * creation time.
+             */
+            maxSize?: number;
+
+            /**
+             * The minimum allowed value. Only available for \`number\` and array input types.
+             */
+            min?: number;
+
+            /**
+             * The minimum allowed length for string inputs. Also applies to each item in
+             * \`string_array\`.
+             */
+            minLength?: number;
+
+            /**
+             * The allowed model types for this input. Example: \`["flux.1-lora"]\`. Only
+             * available for \`model_array\` input type.
+             */
+            modelTypes?: Array<
+              | 'custom'
+              | 'elevenlabs-voice'
+              | 'flux.1'
+              | 'flux.1-composition'
+              | 'flux.1-kontext-dev'
+              | 'flux.1-kontext-lora'
+              | 'flux.1-krea-dev'
+              | 'flux.1-krea-lora'
+              | 'flux.1-lora'
+              | 'flux.1-pro'
+              | 'flux.1.1-pro-ultra'
+              | 'flux.2-dev-edit-lora'
+              | 'flux.2-dev-lora'
+              | 'flux.2-klein-4b-edit-lora'
+              | 'flux.2-klein-4b-lora'
+              | 'flux.2-klein-9b-edit-lora'
+              | 'flux.2-klein-9b-lora'
+              | 'flux.2-klein-base-4b-edit-lora'
+              | 'flux.2-klein-base-4b-lora'
+              | 'flux.2-klein-base-9b-edit-lora'
+              | 'flux.2-klein-base-9b-lora'
+              | 'flux1.1-pro'
+              | 'gpt-image-1'
+              | 'qwen-image-2512-lora'
+              | 'qwen-image-edit-2509-lora'
+              | 'qwen-image-edit-2511-lora'
+              | 'qwen-image-edit-lora'
+              | 'qwen-image-lora'
+              | 'sd-1_5'
+              | 'sd-1_5-composition'
+              | 'sd-1_5-lora'
+              | 'sd-xl'
+              | 'sd-xl-composition'
+              | 'sd-xl-lora'
+              | 'zimage-de-turbo-lora'
+              | 'zimage-lora'
+              | 'zimage-turbo-lora'
+            >;
+
+            /**
+             * Whether this input represents a parent asset to assign to the produced assets.
+             * Only available for \`file\` and \`file_array\` input types.
+             *
+             * For \`file_array\`, the parent asset is the first item in the array.
+             */
+            parent?: boolean;
+
+            /**
+             * Placeholder text for the input. Only available for 'string' input type.
+             */
+            placeholder?: string;
+
+            /**
+             * Whether the input is a prompt. When true, displays as a text area with prompt
+             * spark feature. Only available for \`string\` input type.
+             */
+            prompt?: boolean;
+
+            /**
+             * Whether the input is used with prompt spark. Only available for \`string\` input
+             * type.
+             */
+            promptSpark?: boolean;
+
+            /**
+             * The reference to another input or output of the same workflow. Must have at
+             * least one of node or conditional.
+             */
+            ref?: Item.Ref;
+
+            /**
+             * Set of rules that describes when this input is required:
+             *
+             * - \`always\`: Input is always required
+             * - \`ifNotDefined\`: Input is required when another specified input is not
+             *   defined
+             * - \`ifDefined\`: Input is required when another specified input is defined
+             * - \`conditionalValues\`: Input is required when another input has a specific
+             *   value
+             *
+             * By default, the input is not required.
+             */
+            required?: Item.Required;
+
+            /**
+             * The step increment for numeric inputs. Only available for \`number\` input type.
+             */
+            step?: number;
+
+            /**
+             * The value of the input. This is the value of the input that will be used to run
+             * the node. Only available for flows managed by a WorkflowJob.
+             */
+            value?: unknown;
+          }
+
+          export namespace Item {
+            /**
+             * The reference to another input or output of the same workflow. Must have at
+             * least one of node or conditional.
+             */
+            export interface Ref {
+              /**
+               * The conditional nodes to reference. If the conditional nodes are successful, the
+               * node will be successful. If the conditional nodes are skipped, the node will be
+               * skipped. Contains an array of node ids used to check the status of the nodes.
+               */
+              conditional?: Array<string>;
+
+              /**
+               * This is the desired node output value if ref is an if/else node.
+               */
+              equal?: string;
+
+              /**
+               * The name of the input or output to reference. If the type is 'workflow', the
+               * name is the name of the input of the workflow is required If the type is 'node',
+               * the name is not mandatory, except if you want all outputs of the node. To get
+               * all outputs of a node, you can use the name 'all'.
+               */
+              name?: string;
+
+              /**
+               * The node id or 'workflow' if the source is a workflow input.
+               */
+              node?: string;
+            }
+
+            /**
+             * Set of rules that describes when this input is required:
+             *
+             * - \`always\`: Input is always required
+             * - \`ifNotDefined\`: Input is required when another specified input is not
+             *   defined
+             * - \`ifDefined\`: Input is required when another specified input is defined
+             * - \`conditionalValues\`: Input is required when another input has a specific
+             *   value
+             *
+             * By default, the input is not required.
+             */
+            export interface Required {
+              /**
+               * Whether the input is always required
+               */
+              always?: boolean;
+
+              /**
+               * Makes this input required when another input has a specific value:
+               *
+               * - Key: name of the input to check
+               * - Value: operation and allowed values that trigger the requirement
+               */
+              conditionalValues?: unknown;
+
+              /**
+               * Makes this input required when another input is defined:
+               *
+               * - Key: name of the input that must be defined
+               * - Value: message to display when this input is required
+               */
+              ifDefined?: unknown;
+
+              /**
+               * Makes this input required when another input is not defined:
+               *
+               * - Key: name of the input that must be undefined
+               * - Value: message to display when this input is required
+               */
+              ifNotDefined?: unknown;
+            }
+          }
+
+          /**
+           * The reference to another input or output of the same workflow. Must have at
+           * least one of node or conditional.
+           */
+          export interface Ref {
+            /**
+             * The conditional nodes to reference. If the conditional nodes are successful, the
+             * node will be successful. If the conditional nodes are skipped, the node will be
+             * skipped. Contains an array of node ids used to check the status of the nodes.
+             */
+            conditional?: Array<string>;
+
+            /**
+             * This is the desired node output value if ref is an if/else node.
+             */
+            equal?: string;
+
+            /**
+             * The name of the input or output to reference. If the type is 'workflow', the
+             * name is the name of the input of the workflow is required If the type is 'node',
+             * the name is not mandatory, except if you want all outputs of the node. To get
+             * all outputs of a node, you can use the name 'all'.
+             */
+            name?: string;
+
+            /**
+             * The node id or 'workflow' if the source is a workflow input.
+             */
+            node?: string;
+          }
+
+          /**
+           * Set of rules that describes when this input is required:
+           *
+           * - \`always\`: Input is always required
+           * - \`ifNotDefined\`: Input is required when another specified input is not
+           *   defined
+           * - \`ifDefined\`: Input is required when another specified input is defined
+           * - \`conditionalValues\`: Input is required when another input has a specific
+           *   value
+           *
+           * By default, the input is not required.
+           */
+          export interface Required {
+            /**
+             * Whether the input is always required
+             */
+            always?: boolean;
+
+            /**
+             * Makes this input required when another input has a specific value:
+             *
+             * - Key: name of the input to check
+             * - Value: operation and allowed values that trigger the requirement
+             */
+            conditionalValues?: unknown;
+
+            /**
+             * Makes this input required when another input is defined:
+             *
+             * - Key: name of the input that must be defined
+             * - Value: message to display when this input is required
+             */
+            ifDefined?: unknown;
+
+            /**
+             * Makes this input required when another input is not defined:
+             *
+             * - Key: name of the input that must be undefined
+             * - Value: message to display when this input is required
+             */
+            ifNotDefined?: unknown;
+          }
+        }
+
+        /**
+         * The logic of the node. Only available for logic nodes.
+         */
+        export interface Logic {
+          /**
+           * The cases of the logic. Only available for if/else nodes.
+           */
+          cases?: Array<Logic.Case>;
+
+          /**
+           * The default case of the logic. Contains the id/output of the node to execute if
+           * no case is matched. Only available for if/else nodes.
+           */
+          default?: string;
+
+          /**
+           * The transform of the logic. Only available for transform nodes.
+           */
+          transform?: string;
+        }
+
+        export namespace Logic {
+          export interface Case {
+            condition: string;
+
+            value: string;
+          }
+        }
+      }
+    }
+
+    export interface StatusHistory {
+      date: string;
+
+      status:
+        | 'canceled'
+        | 'failure'
+        | 'finalizing'
+        | 'in-progress'
+        | 'pending'
+        | 'queued'
+        | 'success'
+        | 'warming-up';
+    }
+
+    /**
+     * The billing of the job
+     */
+    export interface Billing {
+      cuCost: number;
+
+      cuDiscount: number;
+    }
+  }
+}
+
+export interface GenerateCaptionParams {
+  /**
+   * Body param: List of images used to generate captions. Results are returned in
+   * the same order as the given images.
+   *
+   * Images are set a data URLs (example:
+   * \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVQYV2NgYAAAAAMAAWgmWQ0AAAAASUVORK5CYII=\")
+   * or the asset IDs (example: \"asset_GTrL3mq4SXWyMxkOHRxlpw\").
+   *
+   * Notes:
+   *
+   * - if both `modelId` and `images` are provided, `modelId`'s examples and training
+   *   images will be used to influence the caption structure of the images
+   * - if only `images` are provided, the captions will be conditioned by the
+   *   `detailsLevel` parameter
+   * - Replaces `assetIds` parameter
+   * - if you want to caption multiple images at a time, please prefer using asset
+   *   ids instead of data url
+   */
+  images: Array<string>;
+
+  /**
+   * Query param
+   */
+  dryRun?: unknown;
+
+  /**
+   * Body param: The assetIds to generate captions. Results are returned in the same
+   * order as the given assetIds. Deprecated, use `images` parameter instead.
+   */
+  assetIds?: Array<string>;
+
+  /**
+   * Body param: The details level used to generate the captions.
+   *
+   * When a modelId is provided and examples are available, the details level is
+   * ignored.
+   */
+  detailsLevel?: 'action' | 'action+style';
+
+  /**
+   * Body param: Whether we try to ensure IP removal for new prompt generation.
+   */
+  ensureIPCleared?: boolean;
+
+  /**
+   * Body param: When provided, the model will follow the model's training images and
+   * examples' prompt to generate the captions.
+   */
+  modelId?: string;
+
+  /**
+   * Body param: If specified, the API will make a best effort to produce the same
+   * results, such that repeated requests with the same `seed` and parameters should
+   * return the same outputs. Must be used along with the same parameters including
+   * prompt, model's state, etc..
+   */
+  seed?: number;
+
+  /**
+   * Body param: The sampling temperature to use. Higher values like `0.8` will make
+   * the output more random, while lower values like `0.2` will make it more focused
+   * and deterministic.
+   *
+   * We generally recommend altering this or `topP` but not both.
+   */
+  temperature?: number;
+
+  /**
+   * Body param: An alternative to sampling with temperature, called nucleus
+   * sampling, where the model considers the results of the tokens with top_p
+   * probability mass. So `0.1` means only the tokens comprising the top `10%`
+   * probability mass are considered.
+   *
+   * We generally recommend altering this or `temperature` but not both.
+   */
+  topP?: number;
+
+  /**
+   * Body param: Optional list of words sequences that should not be present in the
+   * generated prompts.
+   */
+  unwantedSequences?: Array<string>;
+}
+
+export interface GenerateDescribeStyleParams {
+  /**
+   * Query param
+   */
+  dryRun?: unknown;
+
+  /**
+   * Body param: The asset ids used to condition the generation.
+   */
+  assetIds?: Array<string>;
+
+  /**
+   * Body param: Whether we try to ensure IP removal for new prompt generation.
+   */
+  ensureIPCleared?: boolean;
+
+  /**
+   * Body param: List of images used to condition the generation.
+   *
+   * Images are set a data URLs (example:
+   * \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVQYV2NgYAAAAAMAAWgmWQ0AAAAASUVORK5CYII=\")
+   * or the asset IDs (example: \"asset_GTrL3mq4SXWyMxkOHRxlpw\").
+   *
+   * Notes:
+   *
+   * - in `contextual` mode, images condition prompt generation by using their actual
+   *   descriptions as context
+   * - in all other modes, it supersedes the `modelId` parameter when provided.
+   */
+  images?: Array<string>;
+
+  /**
+   * Body param: The modelId used to condition the generation.
+   *
+   * When provided, the generation will take into account model's training images,
+   * examples.
+   *
+   * In `contextual` mode, the modelId is used to retrieve additional context from
+   * the model such as its type and capabilities.
+   */
+  modelId?: string;
+
+  /**
+   * Body param: If specified, the API will make a best effort to produce the same
+   * results, such that repeated requests with the same `seed` and parameters should
+   * return the same outputs. Must be used along with the same parameters including
+   * prompt, model's state, etc..
+   */
+  seed?: number;
+
+  /**
+   * Body param: The sampling temperature to use. Higher values like `0.8` will make
+   * the output more random, while lower values like `0.2` will make it more focused
+   * and deterministic.
+   *
+   * We generally recommend altering this or `topP` but not both.
+   */
+  temperature?: number;
 
   /**
    * Body param: An alternative to sampling with temperature, called nucleus
@@ -9423,6 +10411,107 @@ export namespace GeneratePatchParams {
   }
 }
 
+export interface GeneratePromptParams {
+  /**
+   * Body param: The mode used to generate new prompt(s).
+   */
+  mode: 'completion' | 'contextual' | 'image-editing' | 'inventive' | 'structured';
+
+  /**
+   * Query param
+   */
+  dryRun?: unknown;
+
+  /**
+   * Body param: The asset ids used to condition the generation.
+   *
+   * Notes:
+   *
+   * - supersedes the `modelId` parameter when provided.
+   * - ignored when `mode` is `image-editing-prompt`.
+   */
+  assetIds?: Array<string>;
+
+  /**
+   * Body param: Whether we try to ensure IP removal for new prompt generation.
+   */
+  ensureIPCleared?: boolean;
+
+  /**
+   * Body param: The input image as a data URL (example:
+   * "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVQYV2NgYAAAAAMAAWgmWQ0AAAAASUVORK5CYII=")
+   * or the asset ID (example: "asset_GTrL3mq4SXWyMxkOHRxlpw")
+   *
+   * Required when `mode` is `image-editing-prompt`.
+   */
+  image?: string;
+
+  /**
+   * Body param: List of images used to condition the generation.
+   *
+   * Images are set a data URLs (example:
+   * \"data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAAAEAAAABCAQAAAC1HAwCAAAAC0lEQVQYV2NgYAAAAAMAAWgmWQ0AAAAASUVORK5CYII=\")
+   * or the asset IDs (example: \"asset_GTrL3mq4SXWyMxkOHRxlpw\").
+   *
+   * Notes:
+   *
+   * - in `contextual` mode, images condition prompt generation by using their actual
+   *   descriptions as context
+   * - in all other modes, it supersedes the `modelId` parameter when provided.
+   */
+  images?: Array<string>;
+
+  /**
+   * Body param: The modelId used to condition the generation.
+   *
+   * When provided, the generation will take into account model's training images,
+   * examples.
+   *
+   * Only supports 'gemini-2.0-flash', 'gemini-2.5-flash', 'gpt-image-1',
+   * 'flux-kontext' and 'runway-gen4-image' for now when `mode` is
+   * `image-editing-prompt`.
+   */
+  modelId?: string;
+
+  /**
+   * Body param: The number of results to return.
+   */
+  numResults?: number;
+
+  /**
+   * Body param: The initial prompt spark feed to `completion`, `inventive` or
+   * `structured` modes.
+   */
+  prompt?: string;
+
+  /**
+   * Body param: If specified, the API will make a best effort to produce the same
+   * results, such that repeated requests with the same `seed` and parameters should
+   * return the same outputs. Must be used along with the same parameters including
+   * prompt, model's state, etc..
+   */
+  seed?: number;
+
+  /**
+   * Body param: The sampling temperature to use. Higher values like `0.8` will make
+   * the output more random, while lower values like `0.2` will make it more focused
+   * and deterministic.
+   *
+   * We generally recommend altering this or `topP` but not both.
+   */
+  temperature?: number;
+
+  /**
+   * Body param: An alternative to sampling with temperature, called nucleus
+   * sampling, where the model considers the results of the tokens with top_p
+   * probability mass. So `0.1` means only the tokens comprising the top `10%`
+   * probability mass are considered.
+   *
+   * We generally recommend altering this or `temperature` but not both.
+   */
+  topP?: number;
+}
+
 export interface GenerateRunModelParams {
   /**
    * Body param: The request body for the custom generation must be retrieve from GET
@@ -9502,6 +10591,7 @@ export declare namespace Generate {
     type GenerateDetectResponse as GenerateDetectResponse,
     type GenerateEmbedResponse as GenerateEmbedResponse,
     type GeneratePatchResponse as GeneratePatchResponse,
+    type GeneratePromptResponse as GeneratePromptResponse,
     type GenerateRunModelResponse as GenerateRunModelResponse,
     type GenerateTranslateResponse as GenerateTranslateResponse,
     type GenerateCaptionParams as GenerateCaptionParams,
@@ -9509,6 +10599,7 @@ export declare namespace Generate {
     type GenerateDetectParams as GenerateDetectParams,
     type GenerateEmbedParams as GenerateEmbedParams,
     type GeneratePatchParams as GeneratePatchParams,
+    type GeneratePromptParams as GeneratePromptParams,
     type GenerateRunModelParams as GenerateRunModelParams,
     type GenerateTranslateParams as GenerateTranslateParams,
   };