@scenario-labs/sdk 0.1.2

package/src/resources/jobs.ts

@@ -0,0 +1,1712 @@
+// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
+
+import { APIResource } from '../core/resource';
+import { APIPromise } from '../core/api-promise';
+import { RequestOptions } from '../internal/request-options';
+import { path } from '../internal/utils/path';
+
+export class Jobs extends APIResource {
+  /**
+   * Get job data by job ID
+   */
+  retrieve(jobID: string, options?: RequestOptions): APIPromise<JobRetrieveResponse> {
+    return this._client.get(path`/jobs/${jobID}`, options);
+  }
+
+  /**
+   * List all jobs matching the given filters. A job is a synchronous operation or an
+   * asynchronous task such as a training, a generation, etc. It offers a unified
+   * view of all operations running on the platform along with their status and
+   * results.
+   */
+  list(query: JobListParams | null | undefined = {}, options?: RequestOptions): APIPromise<JobListResponse> {
+    return this._client.get('/jobs', { query, ...options });
+  }
+
+  /**
+   * Trigger an action on a job: cancel
+   */
+  triggerAction(
+    jobID: string,
+    body: JobTriggerActionParams,
+    options?: RequestOptions,
+  ): APIPromise<JobTriggerActionResponse> {
+    return this._client.post(path`/jobs/${jobID}/action`, { body, ...options });
+  }
+}
+
+export interface JobRetrieveResponse {
+  job: JobRetrieveResponse.Job;
+}
+
+export namespace JobRetrieveResponse {
+  export interface Job {
+    /**
+     * The job creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+     */
+    createdAt: string;
+
+    /**
+     * The job ID (example: "job_ocZCnG1Df35XRL1QyCZSRxAG8")
+     */
+    jobId: string;
+
+    /**
+     * 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'
+      | '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';
+
+    /**
+     * Metadata of the job with some additional information
+     */
+    metadata: Job.Metadata;
+
+    /**
+     * Progress of the job (between 0 and 1)
+     */
+    progress: number;
+
+    /**
+     * The current status of the job
+     */
+    status:
+      | 'canceled'
+      | 'failure'
+      | 'finalizing'
+      | 'in-progress'
+      | 'pending'
+      | 'queued'
+      | 'success'
+      | 'warming-up';
+
+    /**
+     * 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>;
+
+    /**
+     * The job last update date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+     */
+    updatedAt: string;
+
+    /**
+     * The author user ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")
+     */
+    authorId?: string;
+
+    /**
+     * The billing of the job
+     */
+    billing?: Job.Billing;
+
+    /**
+     * 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>;
+
+      /**
+       * The flow of the job. Only available for workflow jobs.
+       */
+      flow?: Array<Metadata.Flow>;
+
+      /**
+       * The inputs for the job
+       */
+      input?: unknown;
+
+      /**
+       * The output of the job
+       */
+      output?: unknown;
+
+      /**
+       * 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'
+          | 'generate-prompt'
+          | 'logic'
+          | 'remove-background'
+          | 'transform'
+          | 'user-approval'
+          | 'workflow';
+
+        /**
+         * List of produced assets for this node.
+         */
+        assets?: Array<Flow.Asset>;
+
+        /**
+         * The nodes that this node depends on. Only available for nodes that have
+         * dependencies. Mainly used for user approval nodes.
+         */
+        dependsOn?: Array<string>;
+
+        /**
+         * The inputs of the node.
+         */
+        inputs?: Array<Flow.Input>;
+
+        /**
+         * 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';
+
+        /**
+         * The model id for the node. Mainly used for custom model tasks.
+         */
+        modelId?: string;
+
+        /**
+         * 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;
+
+          /**
+           * 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<unknown>;
+
+          /**
+           * The asset kind of the input. Only taken into account for \`file\` and
+           * \`file_array\` input types.
+           */
+          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 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'
+            | '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'
+            | 'flux1.1-pro'
+            | 'gpt-image-1'
+            | 'sd-1_5'
+            | 'sd-1_5-composition'
+            | 'sd-1_5-lora'
+            | 'sd-xl'
+            | 'sd-xl-composition'
+            | 'sd-xl-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;
+        }
+
+        export namespace Input {
+          /**
+           * 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 JobListResponse {
+  jobs: Array<JobListResponse.Job>;
+
+  /**
+   * A token to query the next page of jobs
+   */
+  nextPaginationToken?: string;
+}
+
+export namespace JobListResponse {
+  export interface Job {
+    /**
+     * The job creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+     */
+    createdAt: string;
+
+    /**
+     * The job ID (example: "job_ocZCnG1Df35XRL1QyCZSRxAG8")
+     */
+    jobId: string;
+
+    /**
+     * 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'
+      | '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';
+
+    /**
+     * Metadata of the job with some additional information
+     */
+    metadata: Job.Metadata;
+
+    /**
+     * Progress of the job (between 0 and 1)
+     */
+    progress: number;
+
+    /**
+     * The current status of the job
+     */
+    status:
+      | 'canceled'
+      | 'failure'
+      | 'finalizing'
+      | 'in-progress'
+      | 'pending'
+      | 'queued'
+      | 'success'
+      | 'warming-up';
+
+    /**
+     * 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>;
+
+    /**
+     * The job last update date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+     */
+    updatedAt: string;
+
+    /**
+     * The author user ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")
+     */
+    authorId?: string;
+
+    /**
+     * The billing of the job
+     */
+    billing?: Job.Billing;
+
+    /**
+     * 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>;
+
+      /**
+       * The flow of the job. Only available for workflow jobs.
+       */
+      flow?: Array<Metadata.Flow>;
+
+      /**
+       * The inputs for the job
+       */
+      input?: unknown;
+
+      /**
+       * The output of the job
+       */
+      output?: unknown;
+
+      /**
+       * 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'
+          | 'generate-prompt'
+          | 'logic'
+          | 'remove-background'
+          | 'transform'
+          | 'user-approval'
+          | 'workflow';
+
+        /**
+         * List of produced assets for this node.
+         */
+        assets?: Array<Flow.Asset>;
+
+        /**
+         * The nodes that this node depends on. Only available for nodes that have
+         * dependencies. Mainly used for user approval nodes.
+         */
+        dependsOn?: Array<string>;
+
+        /**
+         * The inputs of the node.
+         */
+        inputs?: Array<Flow.Input>;
+
+        /**
+         * 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';
+
+        /**
+         * The model id for the node. Mainly used for custom model tasks.
+         */
+        modelId?: string;
+
+        /**
+         * 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;
+
+          /**
+           * 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<unknown>;
+
+          /**
+           * The asset kind of the input. Only taken into account for \`file\` and
+           * \`file_array\` input types.
+           */
+          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 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'
+            | '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'
+            | 'flux1.1-pro'
+            | 'gpt-image-1'
+            | 'sd-1_5'
+            | 'sd-1_5-composition'
+            | 'sd-1_5-lora'
+            | 'sd-xl'
+            | 'sd-xl-composition'
+            | 'sd-xl-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;
+        }
+
+        export namespace Input {
+          /**
+           * 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 JobTriggerActionResponse {
+  job: JobTriggerActionResponse.Job;
+}
+
+export namespace JobTriggerActionResponse {
+  export interface Job {
+    /**
+     * The job creation date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+     */
+    createdAt: string;
+
+    /**
+     * The job ID (example: "job_ocZCnG1Df35XRL1QyCZSRxAG8")
+     */
+    jobId: string;
+
+    /**
+     * 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'
+      | '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';
+
+    /**
+     * Metadata of the job with some additional information
+     */
+    metadata: Job.Metadata;
+
+    /**
+     * Progress of the job (between 0 and 1)
+     */
+    progress: number;
+
+    /**
+     * The current status of the job
+     */
+    status:
+      | 'canceled'
+      | 'failure'
+      | 'finalizing'
+      | 'in-progress'
+      | 'pending'
+      | 'queued'
+      | 'success'
+      | 'warming-up';
+
+    /**
+     * 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>;
+
+    /**
+     * The job last update date as an ISO string (example: "2023-02-03T11:19:41.579Z")
+     */
+    updatedAt: string;
+
+    /**
+     * The author user ID (example: "dcf121faaa1a0a0bbbd9ca1b73d62aea")
+     */
+    authorId?: string;
+
+    /**
+     * The billing of the job
+     */
+    billing?: Job.Billing;
+
+    /**
+     * 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>;
+
+      /**
+       * The flow of the job. Only available for workflow jobs.
+       */
+      flow?: Array<Metadata.Flow>;
+
+      /**
+       * The inputs for the job
+       */
+      input?: unknown;
+
+      /**
+       * The output of the job
+       */
+      output?: unknown;
+
+      /**
+       * 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'
+          | 'generate-prompt'
+          | 'logic'
+          | 'remove-background'
+          | 'transform'
+          | 'user-approval'
+          | 'workflow';
+
+        /**
+         * List of produced assets for this node.
+         */
+        assets?: Array<Flow.Asset>;
+
+        /**
+         * The nodes that this node depends on. Only available for nodes that have
+         * dependencies. Mainly used for user approval nodes.
+         */
+        dependsOn?: Array<string>;
+
+        /**
+         * The inputs of the node.
+         */
+        inputs?: Array<Flow.Input>;
+
+        /**
+         * 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';
+
+        /**
+         * The model id for the node. Mainly used for custom model tasks.
+         */
+        modelId?: string;
+
+        /**
+         * 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;
+
+          /**
+           * 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<unknown>;
+
+          /**
+           * The asset kind of the input. Only taken into account for \`file\` and
+           * \`file_array\` input types.
+           */
+          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 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'
+            | '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'
+            | 'flux1.1-pro'
+            | 'gpt-image-1'
+            | 'sd-1_5'
+            | 'sd-1_5-composition'
+            | 'sd-1_5-lora'
+            | 'sd-xl'
+            | 'sd-xl-composition'
+            | 'sd-xl-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;
+        }
+
+        export namespace Input {
+          /**
+           * 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 JobListParams {
+  /**
+   * The authorId of the jobs to return. Optional.
+   */
+  authorId?: string;
+
+  /**
+   * If false, jobs containing the hideResults param will be not returned. Optional.
+   */
+  hideResults?: string;
+
+  /**
+   * The number of items to return in the response. The default value is 10, maximum
+   * value is 200, minimum value is 1
+   */
+  pageSize?: string;
+
+  /**
+   * A token you received in a previous request to query the next page of items
+   */
+  paginationToken?: string;
+
+  /**
+   * The status of the jobs to return. Optional.
+   */
+  status?: string;
+
+  /**
+   * The type of the jobs to return. If "types" is defined, "type" will be ignored.
+   * Optional.
+   */
+  type?: string;
+
+  /**
+   * The types of the jobs to return. If "types" is defined, "type" will be ignored.
+   * Optional.
+   */
+  types?: string;
+
+  workflowId?: string;
+}
+
+export interface JobTriggerActionParams {
+  /**
+   * The action to execute on the job, such as canceling it. Today only cancel on
+   * inference jobs is supported.
+   */
+  action?: 'cancel';
+}
+
+export declare namespace Jobs {
+  export {
+    type JobRetrieveResponse as JobRetrieveResponse,
+    type JobListResponse as JobListResponse,
+    type JobTriggerActionResponse as JobTriggerActionResponse,
+    type JobListParams as JobListParams,
+    type JobTriggerActionParams as JobTriggerActionParams,
+  };
+}