boltz-api 0.44.1 → 0.45.0

package/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## 0.45.0 (2026-06-15)
+
+Full Changelog: [v0.44.1...v0.45.0](https://github.com/boltz-bio/boltz-api-typescript/compare/v0.44.1...v0.45.0)
+
+### Features
+
+* **compute-api:** rename public pipeline identifiers ([d19af6e](https://github.com/boltz-bio/boltz-api-typescript/commit/d19af6e265bd696e125744104a3537a0aae7d358))
+
 ## 0.44.1 (2026-06-15)
 
 Full Changelog: [v0.44.0...v0.44.1](https://github.com/boltz-bio/boltz-api-typescript/compare/v0.44.0...v0.44.1)

package/client.d.mts

@@ -183,11 +183,11 @@ export declare class Boltz {
      */
     predictions: API.Predictions;
     /**
-     * Small Molecule Engine — design novel small molecules and screen compound libraries against protein targets. Includes de novo generation and virtual screening.
+     * Small Molecule Pipeline — design novel small molecules and screen compound libraries against protein targets. Includes de novo generation and virtual screening.
      */
     smallMolecule: API.SmallMolecule;
     /**
-     * Protein Engine — design novel protein binders and screen protein libraries against targets. Includes de novo protein design and library screening.
+     * Protein Pipeline — design novel protein binders and screen protein libraries against targets. Includes de novo protein design and library screening.
      */
     protein: API.Protein;
     /**

package/client.d.ts

@@ -183,11 +183,11 @@ export declare class Boltz {
      */
     predictions: API.Predictions;
     /**
-     * Small Molecule Engine — design novel small molecules and screen compound libraries against protein targets. Includes de novo generation and virtual screening.
+     * Small Molecule Pipeline — design novel small molecules and screen compound libraries against protein targets. Includes de novo generation and virtual screening.
      */
     smallMolecule: API.SmallMolecule;
     /**
-     * Protein Engine — design novel protein binders and screen protein libraries against targets. Includes de novo protein design and library screening.
+     * Protein Pipeline — design novel protein binders and screen protein libraries against targets. Includes de novo protein design and library screening.
      */
     protein: API.Protein;
     /**

package/client.js

@@ -52,11 +52,11 @@ class Boltz {
          */
         this.predictions = new API.Predictions(this);
         /**
-         * Small Molecule Engine — design novel small molecules and screen compound libraries against protein targets. Includes de novo generation and virtual screening.
+         * Small Molecule Pipeline — design novel small molecules and screen compound libraries against protein targets. Includes de novo generation and virtual screening.
          */
         this.smallMolecule = new API.SmallMolecule(this);
         /**
-         * Protein Engine — design novel protein binders and screen protein libraries against targets. Includes de novo protein design and library screening.
+         * Protein Pipeline — design novel protein binders and screen protein libraries against targets. Includes de novo protein design and library screening.
          */
         this.protein = new API.Protein(this);
         /**

package/client.mjs

@@ -49,11 +49,11 @@ export class Boltz {
          */
         this.predictions = new API.Predictions(this);
         /**
-         * Small Molecule Engine — design novel small molecules and screen compound libraries against protein targets. Includes de novo generation and virtual screening.
+         * Small Molecule Pipeline — design novel small molecules and screen compound libraries against protein targets. Includes de novo generation and virtual screening.
          */
         this.smallMolecule = new API.SmallMolecule(this);
         /**
-         * Protein Engine — design novel protein binders and screen protein libraries against targets. Includes de novo protein design and library screening.
+         * Protein Pipeline — design novel protein binders and screen protein libraries against targets. Includes de novo protein design and library screening.
          */
         this.protein = new API.Protein(this);
         /**

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "boltz-api",
-  "version": "0.44.1",
+  "version": "0.45.0",
   "description": "The official TypeScript library for the Boltz API",
   "author": "Boltz <contact@boltz.bio>",
   "types": "./index.d.ts",

package/resources/admin/workspaces.d.mts

@@ -3,7 +3,7 @@ import { APIPromise } from "../../core/api-promise.mjs";
 import { CursorPage, type CursorPageParams, PagePromise } from "../../core/pagination.mjs";
 import { RequestOptions } from "../../internal/request-options.mjs";
 /**
- * Workspaces provide isolated environments for organizing predictions and engine runs across teams, projects, or customers. Each workspace has independent data retention settings and can be associated with workspace API keys.
+ * Workspaces provide isolated environments for organizing predictions and pipeline runs across teams, projects, or customers. Each workspace has independent data retention settings and can be associated with workspace API keys.
  */
 export declare class Workspaces extends APIResource {
     /**

package/resources/admin/workspaces.d.ts

@@ -3,7 +3,7 @@ import { APIPromise } from "../../core/api-promise.js";
 import { CursorPage, type CursorPageParams, PagePromise } from "../../core/pagination.js";
 import { RequestOptions } from "../../internal/request-options.js";
 /**
- * Workspaces provide isolated environments for organizing predictions and engine runs across teams, projects, or customers. Each workspace has independent data retention settings and can be associated with workspace API keys.
+ * Workspaces provide isolated environments for organizing predictions and pipeline runs across teams, projects, or customers. Each workspace has independent data retention settings and can be associated with workspace API keys.
  */
 export declare class Workspaces extends APIResource {
     /**

package/resources/admin/workspaces.js

@@ -6,7 +6,7 @@ const resource_1 = require("../../core/resource.js");
 const pagination_1 = require("../../core/pagination.js");
 const path_1 = require("../../internal/utils/path.js");
 /**
- * Workspaces provide isolated environments for organizing predictions and engine runs across teams, projects, or customers. Each workspace has independent data retention settings and can be associated with workspace API keys.
+ * Workspaces provide isolated environments for organizing predictions and pipeline runs across teams, projects, or customers. Each workspace has independent data retention settings and can be associated with workspace API keys.
  */
 class Workspaces extends resource_1.APIResource {
     /**

package/resources/admin/workspaces.mjs

@@ -3,7 +3,7 @@ import { APIResource } from "../../core/resource.mjs";
 import { CursorPage } from "../../core/pagination.mjs";
 import { path } from "../../internal/utils/path.mjs";
 /**
- * Workspaces provide isolated environments for organizing predictions and engine runs across teams, projects, or customers. Each workspace has independent data retention settings and can be associated with workspace API keys.
+ * Workspaces provide isolated environments for organizing predictions and pipeline runs across teams, projects, or customers. Each workspace has independent data retention settings and can be associated with workspace API keys.
  */
 export class Workspaces extends APIResource {
     /**

package/resources/protein/design.d.mts

@@ -136,7 +136,7 @@ export declare class Design extends APIResource {
 export type DesignListResponsesCursorPage = CursorPage<DesignListResponse>;
 export type DesignListResultsResponsesCursorPage = CursorPage<DesignListResultsResponse>;
 /**
- * A protein design engine run that generates novel protein binders
+ * A protein design pipeline run that generates novel protein binders
  */
 export interface DesignRetrieveResponse {
     /**
@@ -151,13 +151,13 @@ export interface DesignRetrieveResponse {
      */
     data_deleted_at: string | null;
     /**
-     * Engine used for protein design
+     * @deprecated Use pipeline instead.
      */
-    engine: 'boltz-protein-design';
+    engine: 'boltzprot';
     /**
-     * Engine version used for protein design
+     * @deprecated Use pipeline_version instead.
      */
-    engine_version: string;
+    engine_version: '1.0';
     error: DesignRetrieveResponse.Error | null;
     /**
      * Pipeline input (null if data deleted)
@@ -167,6 +167,14 @@ export interface DesignRetrieveResponse {
      * Whether this resource was created with a live API key.
      */
     livemode: boolean;
+    /**
+     * Pipeline used for protein design
+     */
+    pipeline: 'boltzprot';
+    /**
+     * Pipeline version used for protein design
+     */
+    pipeline_version: '1.0';
     progress: DesignRetrieveResponse.Progress | null;
     started_at: string | null;
     status: 'pending' | 'running' | 'succeeded' | 'failed' | 'stopped';
@@ -227,14 +235,15 @@ export declare namespace DesignRetrieveResponse {
          * Binder specification starting from an existing 3D structure. Upload a CIF/PDB
          * file and select which chains to include, which residues to keep, and which
          * regions to redesign. Only chains included in chain_selection are part of the
-         * engine run.
+         * pipeline run.
          */
         interface StructureTemplateBinderSpecResponse {
             /**
              * Chains selected from the uploaded binder structure, keyed by chain ID. Only
-             * chains listed here are included in the engine run — any chains omitted from this
-             * mapping are ignored. Each value defines which residues to keep (crop_residues).
-             * Omit design_motifs to include the chain as fixed scaffold context.
+             * chains listed here are included in the pipeline run — any chains omitted from
+             * this mapping are ignored. Each value defines which residues to keep
+             * (crop_residues). Omit design_motifs to include the chain as fixed scaffold
+             * context.
              */
             chain_selection: {
                 [key: string]: StructureTemplateBinderSpecResponse.StructureTemplatePolymerChainSpec | StructureTemplateBinderSpecResponse.StructureTemplateLigandChainSpec;
@@ -747,7 +756,7 @@ export declare namespace DesignRetrieveResponse {
         interface StructureTemplateTargetResponse {
             /**
              * Chains selected from the uploaded structure, keyed by chain ID. Only chains
-             * listed here are included in the engine run — any chains omitted from this
+             * listed here are included in the pipeline run — any chains omitted from this
              * mapping are ignored. Each value defines which residues to keep, which are
              * epitope residues, which are non-binding residues, and which are flexible.
              */
@@ -766,7 +775,7 @@ export declare namespace DesignRetrieveResponse {
                 chain_type: 'polymer';
                 /**
                  * 0-indexed residue indices to retain from this chain, or 'all' to keep all
-                 * residues. Residues not listed are excluded from the engine run.
+                 * residues. Residues not listed are excluded from the pipeline run.
                  */
                 crop_residues: Array<number> | 'all';
                 /**
@@ -1197,7 +1206,7 @@ export declare namespace DesignRetrieveResponse {
     }
 }
 /**
- * Summary of a protein design engine run (excludes input)
+ * Summary of a protein design pipeline run (excludes input)
  */
 export interface DesignListResponse {
     /**
@@ -1212,18 +1221,26 @@ export interface DesignListResponse {
      */
     data_deleted_at: string | null;
     /**
-     * Engine used for protein design
+     * @deprecated Use pipeline instead.
      */
-    engine: 'boltz-protein-design';
+    engine: 'boltzprot';
     /**
-     * Engine version used for protein design
+     * @deprecated Use pipeline_version instead.
      */
-    engine_version: string;
+    engine_version: '1.0';
     error: DesignListResponse.Error | null;
     /**
      * Whether this resource was created with a live API key.
      */
     livemode: boolean;
+    /**
+     * Pipeline used for protein design
+     */
+    pipeline: 'boltzprot';
+    /**
+     * Pipeline version used for protein design
+     */
+    pipeline_version: '1.0';
     progress: DesignListResponse.Progress | null;
     started_at: string | null;
     status: 'pending' | 'running' | 'succeeded' | 'failed' | 'stopped';
@@ -1559,7 +1576,7 @@ export declare namespace DesignListResultsResponse {
     }
 }
 /**
- * A protein design engine run that generates novel protein binders
+ * A protein design pipeline run that generates novel protein binders
  */
 export interface DesignStartResponse {
     /**
@@ -1574,13 +1591,13 @@ export interface DesignStartResponse {
      */
     data_deleted_at: string | null;
     /**
-     * Engine used for protein design
+     * @deprecated Use pipeline instead.
      */
-    engine: 'boltz-protein-design';
+    engine: 'boltzprot';
     /**
-     * Engine version used for protein design
+     * @deprecated Use pipeline_version instead.
      */
-    engine_version: string;
+    engine_version: '1.0';
     error: DesignStartResponse.Error | null;
     /**
      * Pipeline input (null if data deleted)
@@ -1590,6 +1607,14 @@ export interface DesignStartResponse {
      * Whether this resource was created with a live API key.
      */
     livemode: boolean;
+    /**
+     * Pipeline used for protein design
+     */
+    pipeline: 'boltzprot';
+    /**
+     * Pipeline version used for protein design
+     */
+    pipeline_version: '1.0';
     progress: DesignStartResponse.Progress | null;
     started_at: string | null;
     status: 'pending' | 'running' | 'succeeded' | 'failed' | 'stopped';
@@ -1650,14 +1675,15 @@ export declare namespace DesignStartResponse {
          * Binder specification starting from an existing 3D structure. Upload a CIF/PDB
          * file and select which chains to include, which residues to keep, and which
          * regions to redesign. Only chains included in chain_selection are part of the
-         * engine run.
+         * pipeline run.
          */
         interface StructureTemplateBinderSpecResponse {
             /**
              * Chains selected from the uploaded binder structure, keyed by chain ID. Only
-             * chains listed here are included in the engine run — any chains omitted from this
-             * mapping are ignored. Each value defines which residues to keep (crop_residues).
-             * Omit design_motifs to include the chain as fixed scaffold context.
+             * chains listed here are included in the pipeline run — any chains omitted from
+             * this mapping are ignored. Each value defines which residues to keep
+             * (crop_residues). Omit design_motifs to include the chain as fixed scaffold
+             * context.
              */
             chain_selection: {
                 [key: string]: StructureTemplateBinderSpecResponse.StructureTemplatePolymerChainSpec | StructureTemplateBinderSpecResponse.StructureTemplateLigandChainSpec;
@@ -2170,7 +2196,7 @@ export declare namespace DesignStartResponse {
         interface StructureTemplateTargetResponse {
             /**
              * Chains selected from the uploaded structure, keyed by chain ID. Only chains
-             * listed here are included in the engine run — any chains omitted from this
+             * listed here are included in the pipeline run — any chains omitted from this
              * mapping are ignored. Each value defines which residues to keep, which are
              * epitope residues, which are non-binding residues, and which are flexible.
              */
@@ -2189,7 +2215,7 @@ export declare namespace DesignStartResponse {
                 chain_type: 'polymer';
                 /**
                  * 0-indexed residue indices to retain from this chain, or 'all' to keep all
-                 * residues. Residues not listed are excluded from the engine run.
+                 * residues. Residues not listed are excluded from the pipeline run.
                  */
                 crop_residues: Array<number> | 'all';
                 /**
@@ -2620,7 +2646,7 @@ export declare namespace DesignStartResponse {
     }
 }
 /**
- * A protein design engine run that generates novel protein binders
+ * A protein design pipeline run that generates novel protein binders
  */
 export interface DesignStopResponse {
     /**
@@ -2635,13 +2661,13 @@ export interface DesignStopResponse {
      */
     data_deleted_at: string | null;
     /**
-     * Engine used for protein design
+     * @deprecated Use pipeline instead.
      */
-    engine: 'boltz-protein-design';
+    engine: 'boltzprot';
     /**
-     * Engine version used for protein design
+     * @deprecated Use pipeline_version instead.
      */
-    engine_version: string;
+    engine_version: '1.0';
     error: DesignStopResponse.Error | null;
     /**
      * Pipeline input (null if data deleted)
@@ -2651,6 +2677,14 @@ export interface DesignStopResponse {
      * Whether this resource was created with a live API key.
      */
     livemode: boolean;
+    /**
+     * Pipeline used for protein design
+     */
+    pipeline: 'boltzprot';
+    /**
+     * Pipeline version used for protein design
+     */
+    pipeline_version: '1.0';
     progress: DesignStopResponse.Progress | null;
     started_at: string | null;
     status: 'pending' | 'running' | 'succeeded' | 'failed' | 'stopped';
@@ -2711,14 +2745,15 @@ export declare namespace DesignStopResponse {
          * Binder specification starting from an existing 3D structure. Upload a CIF/PDB
          * file and select which chains to include, which residues to keep, and which
          * regions to redesign. Only chains included in chain_selection are part of the
-         * engine run.
+         * pipeline run.
          */
         interface StructureTemplateBinderSpecResponse {
             /**
              * Chains selected from the uploaded binder structure, keyed by chain ID. Only
-             * chains listed here are included in the engine run — any chains omitted from this
-             * mapping are ignored. Each value defines which residues to keep (crop_residues).
-             * Omit design_motifs to include the chain as fixed scaffold context.
+             * chains listed here are included in the pipeline run — any chains omitted from
+             * this mapping are ignored. Each value defines which residues to keep
+             * (crop_residues). Omit design_motifs to include the chain as fixed scaffold
+             * context.
              */
             chain_selection: {
                 [key: string]: StructureTemplateBinderSpecResponse.StructureTemplatePolymerChainSpec | StructureTemplateBinderSpecResponse.StructureTemplateLigandChainSpec;
@@ -3231,7 +3266,7 @@ export declare namespace DesignStopResponse {
         interface StructureTemplateTargetResponse {
             /**
              * Chains selected from the uploaded structure, keyed by chain ID. Only chains
-             * listed here are included in the engine run — any chains omitted from this
+             * listed here are included in the pipeline run — any chains omitted from this
              * mapping are ignored. Each value defines which residues to keep, which are
              * epitope residues, which are non-binding residues, and which are flexible.
              */
@@ -3250,7 +3285,7 @@ export declare namespace DesignStopResponse {
                 chain_type: 'polymer';
                 /**
                  * 0-indexed residue indices to retain from this chain, or 'all' to keep all
-                 * residues. Residues not listed are excluded from the engine run.
+                 * residues. Residues not listed are excluded from the pipeline run.
                  */
                 crop_residues: Array<number> | 'all';
                 /**
@@ -3724,14 +3759,15 @@ export declare namespace DesignEstimateCostParams {
      * Binder specification starting from an existing 3D structure. Upload a CIF/PDB
      * file and select which chains to include, which residues to keep, and which
      * regions to redesign. Only chains included in chain_selection are part of the
-     * engine run.
+     * pipeline run.
      */
     interface StructureTemplateBinderSpec {
         /**
          * Chains selected from the uploaded binder structure, keyed by chain ID. Only
-         * chains listed here are included in the engine run — any chains omitted from this
-         * mapping are ignored. Each value defines which residues to keep (crop_residues).
-         * Omit design_motifs to include the chain as fixed scaffold context.
+         * chains listed here are included in the pipeline run — any chains omitted from
+         * this mapping are ignored. Each value defines which residues to keep
+         * (crop_residues). Omit design_motifs to include the chain as fixed scaffold
+         * context.
          */
         chain_selection: {
             [key: string]: StructureTemplateBinderSpec.StructureTemplatePolymerChainSpec | StructureTemplateBinderSpec.StructureTemplateLigandChainSpec;
@@ -4253,7 +4289,7 @@ export declare namespace DesignEstimateCostParams {
     interface StructureTemplateTarget {
         /**
          * Chains selected from the uploaded structure, keyed by chain ID. Only chains
-         * listed here are included in the engine run — any chains omitted from this
+         * listed here are included in the pipeline run — any chains omitted from this
          * mapping are ignored. Each value defines which residues to keep, which are
          * epitope residues, which are non-binding residues, and which are flexible.
          */
@@ -4276,7 +4312,7 @@ export declare namespace DesignEstimateCostParams {
             chain_type: 'polymer';
             /**
              * 0-indexed residue indices to retain from this chain, or 'all' to keep all
-             * residues. Residues not listed are excluded from the engine run.
+             * residues. Residues not listed are excluded from the pipeline run.
              */
             crop_residues: Array<number> | 'all';
             /**
@@ -4732,14 +4768,15 @@ export declare namespace DesignStartParams {
      * Binder specification starting from an existing 3D structure. Upload a CIF/PDB
      * file and select which chains to include, which residues to keep, and which
      * regions to redesign. Only chains included in chain_selection are part of the
-     * engine run.
+     * pipeline run.
      */
     interface StructureTemplateBinderSpec {
         /**
          * Chains selected from the uploaded binder structure, keyed by chain ID. Only
-         * chains listed here are included in the engine run — any chains omitted from this
-         * mapping are ignored. Each value defines which residues to keep (crop_residues).
-         * Omit design_motifs to include the chain as fixed scaffold context.
+         * chains listed here are included in the pipeline run — any chains omitted from
+         * this mapping are ignored. Each value defines which residues to keep
+         * (crop_residues). Omit design_motifs to include the chain as fixed scaffold
+         * context.
          */
         chain_selection: {
             [key: string]: StructureTemplateBinderSpec.StructureTemplatePolymerChainSpec | StructureTemplateBinderSpec.StructureTemplateLigandChainSpec;
@@ -5261,7 +5298,7 @@ export declare namespace DesignStartParams {
     interface StructureTemplateTarget {
         /**
          * Chains selected from the uploaded structure, keyed by chain ID. Only chains
-         * listed here are included in the engine run — any chains omitted from this
+         * listed here are included in the pipeline run — any chains omitted from this
          * mapping are ignored. Each value defines which residues to keep, which are
          * epitope residues, which are non-binding residues, and which are flexible.
          */
@@ -5284,7 +5321,7 @@ export declare namespace DesignStartParams {
             chain_type: 'polymer';
             /**
              * 0-indexed residue indices to retain from this chain, or 'all' to keep all
-             * residues. Residues not listed are excluded from the engine run.
+             * residues. Residues not listed are excluded from the pipeline run.
              */
             crop_residues: Array<number> | 'all';
             /**