boltz-api 0.44.0 → 0.45.0

package/src/resources/protein/design.ts

@@ -184,7 +184,7 @@ 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 {
   /**
@@ -203,14 +203,14 @@ 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;
 
@@ -224,6 +224,16 @@ export interface DesignRetrieveResponse {
    */
   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;
@@ -301,14 +311,15 @@ export 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.
      */
     export 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]:
@@ -926,7 +937,7 @@ export namespace DesignRetrieveResponse {
     export 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.
        */
@@ -951,7 +962,7 @@ export namespace DesignRetrieveResponse {
 
         /**
          * 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';
 
@@ -1473,7 +1484,7 @@ export namespace DesignRetrieveResponse {
 }
 
 /**
- * Summary of a protein design engine run (excludes input)
+ * Summary of a protein design pipeline run (excludes input)
  */
 export interface DesignListResponse {
   /**
@@ -1492,14 +1503,14 @@ 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;
 
@@ -1508,6 +1519,16 @@ export interface DesignListResponse {
    */
   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;
@@ -1928,7 +1949,7 @@ export 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 {
   /**
@@ -1947,14 +1968,14 @@ 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;
 
@@ -1968,6 +1989,16 @@ export interface DesignStartResponse {
    */
   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;
@@ -2045,14 +2076,15 @@ export 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.
      */
     export 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]:
@@ -2670,7 +2702,7 @@ export namespace DesignStartResponse {
     export 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.
        */
@@ -2695,7 +2727,7 @@ export namespace DesignStartResponse {
 
         /**
          * 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';
 
@@ -3217,7 +3249,7 @@ export 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 {
   /**
@@ -3236,14 +3268,14 @@ 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;
 
@@ -3257,6 +3289,16 @@ export interface DesignStopResponse {
    */
   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;
@@ -3334,14 +3376,15 @@ export 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.
      */
     export 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]:
@@ -3959,7 +4002,7 @@ export namespace DesignStopResponse {
     export 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.
        */
@@ -3984,7 +4027,7 @@ export namespace DesignStopResponse {
 
         /**
          * 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';
 
@@ -4559,14 +4602,15 @@ export 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.
    */
   export 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]:
@@ -5195,7 +5239,7 @@ export namespace DesignEstimateCostParams {
   export 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.
      */
@@ -5224,7 +5268,7 @@ export namespace DesignEstimateCostParams {
 
       /**
        * 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';
 
@@ -5774,14 +5818,15 @@ export 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.
    */
   export 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]:
@@ -6410,7 +6455,7 @@ export namespace DesignStartParams {
   export 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.
      */
@@ -6439,7 +6484,7 @@ export namespace DesignStartParams {
 
       /**
        * 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';
 

package/src/resources/protein/library-screen.ts

@@ -189,7 +189,7 @@ export type LibraryScreenListResponsesCursorPage = CursorPage<LibraryScreenListR
 export type LibraryScreenListResultsResponsesCursorPage = CursorPage<LibraryScreenListResultsResponse>;
 
 /**
- * A protein library screening engine run
+ * A protein library screening pipeline run
  */
 export interface LibraryScreenRetrieveResponse {
   /**
@@ -208,14 +208,14 @@ export interface LibraryScreenRetrieveResponse {
   data_deleted_at: string | null;
 
   /**
-   * Engine used for protein library screen
+   * @deprecated Use pipeline instead.
    */
-  engine: 'boltz-protein-screen';
+  engine: 'boltzprot';
 
   /**
-   * Engine version used for protein library screen
+   * @deprecated Use pipeline_version instead.
    */
-  engine_version: string;
+  engine_version: '1.0';
 
   error: LibraryScreenRetrieveResponse.Error | null;
 
@@ -229,6 +229,16 @@ export interface LibraryScreenRetrieveResponse {
    */
   livemode: boolean;
 
+  /**
+   * Pipeline used for protein library screen
+   */
+  pipeline: 'boltzprot';
+
+  /**
+   * Pipeline version used for protein library screen
+   */
+  pipeline_version: '1.0';
+
   progress: LibraryScreenRetrieveResponse.Progress | null;
 
   started_at: string | null;
@@ -298,7 +308,7 @@ export namespace LibraryScreenRetrieveResponse {
     export 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.
        */
@@ -323,7 +333,7 @@ export namespace LibraryScreenRetrieveResponse {
 
         /**
          * 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';
 
@@ -850,7 +860,7 @@ export namespace LibraryScreenRetrieveResponse {
 }
 
 /**
- * Summary of a protein library screening engine run (excludes input)
+ * Summary of a protein library screening pipeline run (excludes input)
  */
 export interface LibraryScreenListResponse {
   /**
@@ -869,14 +879,14 @@ export interface LibraryScreenListResponse {
   data_deleted_at: string | null;
 
   /**
-   * Engine used for protein library screen
+   * @deprecated Use pipeline instead.
    */
-  engine: 'boltz-protein-screen';
+  engine: 'boltzprot';
 
   /**
-   * Engine version used for protein library screen
+   * @deprecated Use pipeline_version instead.
    */
-  engine_version: string;
+  engine_version: '1.0';
 
   error: LibraryScreenListResponse.Error | null;
 
@@ -885,6 +895,16 @@ export interface LibraryScreenListResponse {
    */
   livemode: boolean;
 
+  /**
+   * Pipeline used for protein library screen
+   */
+  pipeline: 'boltzprot';
+
+  /**
+   * Pipeline version used for protein library screen
+   */
+  pipeline_version: '1.0';
+
   progress: LibraryScreenListResponse.Progress | null;
 
   started_at: string | null;
@@ -1315,7 +1335,7 @@ export namespace LibraryScreenListResultsResponse {
 }
 
 /**
- * A protein library screening engine run
+ * A protein library screening pipeline run
  */
 export interface LibraryScreenStartResponse {
   /**
@@ -1334,14 +1354,14 @@ export interface LibraryScreenStartResponse {
   data_deleted_at: string | null;
 
   /**
-   * Engine used for protein library screen
+   * @deprecated Use pipeline instead.
    */
-  engine: 'boltz-protein-screen';
+  engine: 'boltzprot';
 
   /**
-   * Engine version used for protein library screen
+   * @deprecated Use pipeline_version instead.
    */
-  engine_version: string;
+  engine_version: '1.0';
 
   error: LibraryScreenStartResponse.Error | null;
 
@@ -1355,6 +1375,16 @@ export interface LibraryScreenStartResponse {
    */
   livemode: boolean;
 
+  /**
+   * Pipeline used for protein library screen
+   */
+  pipeline: 'boltzprot';
+
+  /**
+   * Pipeline version used for protein library screen
+   */
+  pipeline_version: '1.0';
+
   progress: LibraryScreenStartResponse.Progress | null;
 
   started_at: string | null;
@@ -1424,7 +1454,7 @@ export namespace LibraryScreenStartResponse {
     export 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.
        */
@@ -1449,7 +1479,7 @@ export namespace LibraryScreenStartResponse {
 
         /**
          * 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';
 
@@ -1976,7 +2006,7 @@ export namespace LibraryScreenStartResponse {
 }
 
 /**
- * A protein library screening engine run
+ * A protein library screening pipeline run
  */
 export interface LibraryScreenStopResponse {
   /**
@@ -1995,14 +2025,14 @@ export interface LibraryScreenStopResponse {
   data_deleted_at: string | null;
 
   /**
-   * Engine used for protein library screen
+   * @deprecated Use pipeline instead.
    */
-  engine: 'boltz-protein-screen';
+  engine: 'boltzprot';
 
   /**
-   * Engine version used for protein library screen
+   * @deprecated Use pipeline_version instead.
    */
-  engine_version: string;
+  engine_version: '1.0';
 
   error: LibraryScreenStopResponse.Error | null;
 
@@ -2016,6 +2046,16 @@ export interface LibraryScreenStopResponse {
    */
   livemode: boolean;
 
+  /**
+   * Pipeline used for protein library screen
+   */
+  pipeline: 'boltzprot';
+
+  /**
+   * Pipeline version used for protein library screen
+   */
+  pipeline_version: '1.0';
+
   progress: LibraryScreenStopResponse.Progress | null;
 
   started_at: string | null;
@@ -2085,7 +2125,7 @@ export namespace LibraryScreenStopResponse {
     export 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.
        */
@@ -2110,7 +2150,7 @@ export namespace LibraryScreenStopResponse {
 
         /**
          * 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';
 
@@ -2883,7 +2923,7 @@ export namespace LibraryScreenEstimateCostParams {
   export 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.
      */
@@ -2912,7 +2952,7 @@ export namespace LibraryScreenEstimateCostParams {
 
       /**
        * 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';
 
@@ -3653,7 +3693,7 @@ export namespace LibraryScreenStartParams {
   export 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.
      */
@@ -3682,7 +3722,7 @@ export namespace LibraryScreenStartParams {
 
       /**
        * 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';
 

package/src/resources/protein/protein.ts

@@ -39,7 +39,7 @@ import {
 } from './library-screen';
 
 /**
- * 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.
  */
 export class Protein extends APIResource {
   design: DesignAPI.Design = new DesignAPI.Design(this._client);