Boltz Api Tools#

Configuration File: boltz_api_tools.json Tool Type: Local Tools Count: 72

This page contains all tools defined in the boltz_api_tools.json configuration file.

Available Tools#

Boltz_archive_workspace (Type: BoltzAPITool)#

Archive an official Boltz workspace by workspace ID. This disables the remote workspace, requires…

Boltz_archive_workspace tool specification

Tool Information:

  • Name: Boltz_archive_workspace

  • Type: BoltzAPITool

  • Description: Archive an official Boltz workspace by workspace ID. This disables the remote workspace, requires an admin API key, and requires explicit confirmation before the mutation is sent.

Parameters:

  • workspace_id (string) (required) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

  • confirm (boolean) (required) confirm=true is required because archiving disables the workspace

Example Usage:

query = {
    "name": "Boltz_archive_workspace",
    "arguments": {
        "workspace_id": "example_value",
        "confirm": true
    }
}
result = tu.run(query)

Boltz_create_api_key (Type: BoltzAPITool)#

Create an official Boltz workspace API key with name, optional IP allow-list, expiry, mode, and w…

Boltz_create_api_key tool specification

Tool Information:

  • Name: Boltz_create_api_key

  • Type: BoltzAPITool

  • Description: Create an official Boltz workspace API key with name, optional IP allow-list, expiry, mode, and workspace. Requires an admin key and confirmation; the returned secret is shown only once.

Parameters:

  • name (string) (required) Human-readable workspace or API-key name, depending on the operation.

  • allowed_ips (array) (optional) Optional list of source IP addresses allowed to use the new API key; an empty list allows all IPs.

  • expires_in_days (integer) (optional) Optional API-key lifetime in days.

  • mode (string) (optional) Create a live or test workspace API key.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

  • confirm (boolean) (required) confirm=true is required because this creates a new credential whose secret is shown once

Example Usage:

query = {
    "name": "Boltz_create_api_key",
    "arguments": {
        "name": "example_value",
        "confirm": true
    }
}
result = tu.run(query)

Boltz_create_workspace (Type: BoltzAPITool)#

Create an official Boltz workspace with optional name, data-retention policy, and spending limit….

Boltz_create_workspace tool specification

Tool Information:

  • Name: Boltz_create_workspace

  • Type: BoltzAPITool

  • Description: Create an official Boltz workspace with optional name, data-retention policy, and spending limit. Requires an admin API key and explicit confirmation; returns the new workspace metadata.

Parameters:

  • data_retention (unknown) (optional) Workspace result-retention duration using the official hours/days object.

  • name (string) (optional) Human-readable workspace or API-key name, depending on the operation.

  • spending_limit (unknown) (optional) Optional workspace spending-limit object applied at creation.

  • confirm (boolean) (required) confirm=true is required because this creates an organization workspace

Example Usage:

query = {
    "name": "Boltz_create_workspace",
    "arguments": {
        "confirm": true
    }
}
result = tu.run(query)

Boltz_delete_adme_data (Type: BoltzAPITool)#

Permanently delete retained input and output data for one official Boltz ADME prediction job whil…

Boltz_delete_adme_data tool specification

Tool Information:

  • Name: Boltz_delete_adme_data

  • Type: BoltzAPITool

  • Description: Permanently delete retained input and output data for one official Boltz ADME prediction job while preserving its metadata record. This is irreversible and requires explicit confirmation.

Parameters:

  • id (string) (required) Account-scoped job or prediction ID returned by the matching start or list tool.

  • confirm (boolean) (required) confirm=true is required because retained input/output data will be permanently deleted

Example Usage:

query = {
    "name": "Boltz_delete_adme_data",
    "arguments": {
        "id": "example_value",
        "confirm": true
    }
}
result = tu.run(query)

Boltz_delete_protein_design_data (Type: BoltzAPITool)#

Permanently delete retained input and output data for one official Boltz protein-design pipeline …

Boltz_delete_protein_design_data tool specification

Tool Information:

  • Name: Boltz_delete_protein_design_data

  • Type: BoltzAPITool

  • Description: Permanently delete retained input and output data for one official Boltz protein-design pipeline job while preserving its metadata record. This is irreversible and requires explicit confirmation.

Parameters:

  • id (string) (required) Account-scoped job or prediction ID returned by the matching start or list tool.

  • confirm (boolean) (required) confirm=true is required because retained input/output data will be permanently deleted

Example Usage:

query = {
    "name": "Boltz_delete_protein_design_data",
    "arguments": {
        "id": "example_value",
        "confirm": true
    }
}
result = tu.run(query)

Boltz_delete_protein_library_screen_data (Type: BoltzAPITool)#

Permanently delete retained input and output data for one official Boltz protein-library screen j…

Boltz_delete_protein_library_screen_data tool specification

Tool Information:

  • Name: Boltz_delete_protein_library_screen_data

  • Type: BoltzAPITool

  • Description: Permanently delete retained input and output data for one official Boltz protein-library screen job while preserving its metadata record. This is irreversible and requires explicit confirmation.

Parameters:

  • id (string) (required) Account-scoped job or prediction ID returned by the matching start or list tool.

  • confirm (boolean) (required) confirm=true is required because retained input/output data will be permanently deleted

Example Usage:

query = {
    "name": "Boltz_delete_protein_library_screen_data",
    "arguments": {
        "id": "example_value",
        "confirm": true
    }
}
result = tu.run(query)

Boltz_delete_protein_sequence_redesign_data (Type: BoltzAPITool)#

Permanently delete retained input and output data for one official Boltz protein sequence-redesig…

Boltz_delete_protein_sequence_redesign_data tool specification

Tool Information:

  • Name: Boltz_delete_protein_sequence_redesign_data

  • Type: BoltzAPITool

  • Description: Permanently delete retained input and output data for one official Boltz protein sequence-redesign pipeline job while preserving its metadata record. This is irreversible and requires explicit confirmation.

Parameters:

  • id (string) (required) Account-scoped job or prediction ID returned by the matching start or list tool.

  • confirm (boolean) (required) confirm=true is required because retained input/output data will be permanently deleted

Example Usage:

query = {
    "name": "Boltz_delete_protein_sequence_redesign_data",
    "arguments": {
        "id": "example_value",
        "confirm": true
    }
}
result = tu.run(query)

Boltz_delete_small_molecule_design_data (Type: BoltzAPITool)#

Permanently delete retained input and output data for one official Boltz small-molecule design pi…

Boltz_delete_small_molecule_design_data tool specification

Tool Information:

  • Name: Boltz_delete_small_molecule_design_data

  • Type: BoltzAPITool

  • Description: Permanently delete retained input and output data for one official Boltz small-molecule design pipeline job while preserving its metadata record. This is irreversible and requires explicit confirmation.

Parameters:

  • id (string) (required) Account-scoped job or prediction ID returned by the matching start or list tool.

  • confirm (boolean) (required) confirm=true is required because retained input/output data will be permanently deleted

Example Usage:

query = {
    "name": "Boltz_delete_small_molecule_design_data",
    "arguments": {
        "id": "example_value",
        "confirm": true
    }
}
result = tu.run(query)

Boltz_delete_small_molecule_library_screen_data (Type: BoltzAPITool)#

Permanently delete retained input and output data for one official Boltz small-molecule library s…

Boltz_delete_small_molecule_library_screen_data tool specification

Tool Information:

  • Name: Boltz_delete_small_molecule_library_screen_data

  • Type: BoltzAPITool

  • Description: Permanently delete retained input and output data for one official Boltz small-molecule library screen job while preserving its metadata record. This is irreversible and requires explicit confirmation.

Parameters:

  • id (string) (required) Account-scoped job or prediction ID returned by the matching start or list tool.

  • confirm (boolean) (required) confirm=true is required because retained input/output data will be permanently deleted

Example Usage:

query = {
    "name": "Boltz_delete_small_molecule_library_screen_data",
    "arguments": {
        "id": "example_value",
        "confirm": true
    }
}
result = tu.run(query)

Boltz_delete_structure_binding_data (Type: BoltzAPITool)#

Permanently delete retained input and output data for one official Boltz structure-and-binding pr…

Boltz_delete_structure_binding_data tool specification

Tool Information:

  • Name: Boltz_delete_structure_binding_data

  • Type: BoltzAPITool

  • Description: Permanently delete retained input and output data for one official Boltz structure-and-binding prediction job while preserving its metadata record. This is irreversible and requires explicit confirmation.

Parameters:

  • id (string) (required) Account-scoped job or prediction ID returned by the matching start or list tool.

  • confirm (boolean) (required) confirm=true is required because retained input/output data will be permanently deleted

Example Usage:

query = {
    "name": "Boltz_delete_structure_binding_data",
    "arguments": {
        "id": "example_value",
        "confirm": true
    }
}
result = tu.run(query)

Boltz_download_experiment_results (Type: BoltzAPITool)#

Resume polling and download results for an existing official Boltz job ID or local experiment dir…

Boltz_download_experiment_results tool specification

Tool Information:

  • Name: Boltz_download_experiment_results

  • Type: BoltzAPITool

  • Description: Resume polling and download results for an existing official Boltz job ID or local experiment directory. This is the recovery path after an interrupted start/run call and returns the local experiment directory.

Parameters:

  • id (string) (optional) Account-scoped job or prediction ID returned by the matching start or list tool.

  • run_dir (string) (optional) Existing local experiment directory created by an official Boltz run or start helper.

  • name (string) (optional) Experiment directory name under root_dir.

  • root_dir (string) (optional) Local directory where the official SDK creates the experiment folder and persists downloaded results.

  • quiet (boolean) (optional) Suppress official SDK progress output while waiting for the run to finish.

  • download_mode ([‘string’, ‘null’]) (optional) Result download mode for design and screening runs: everything or metadata_only.

  • poll_interval_seconds (number) (optional) Seconds between official SDK status polls while waiting for completion; must be greater than zero.

  • workspace_id ([‘string’, ‘null’]) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

Example Usage:

query = {
    "name": "Boltz_download_experiment_results",
    "arguments": {
    }
}
result = tu.run(query)

Boltz_estimate_adme_cost (Type: BoltzAPITool)#

Estimate the authoritative USD cost of an official Boltz ADME prediction without creating a compu…

Boltz_estimate_adme_cost tool specification

Tool Information:

  • Name: Boltz_estimate_adme_cost

  • Type: BoltzAPITool

  • Description: Estimate the authoritative USD cost of an official Boltz ADME prediction without creating a compute job. Use the matching start tool only after reviewing this estimate.

Parameters:

  • input (unknown) (required) Official application-specific request object; follow the nested schema and discriminator fields exactly.

  • model (string) (required) Official model identifier accepted by this endpoint.

  • idempotency_key (string) (optional) Stable caller-generated key used to prevent duplicate submissions and duplicate billing.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

Example Usage:

query = {
    "name": "Boltz_estimate_adme_cost",
    "arguments": {
        "input": "example_value",
        "model": "example_value"
    }
}
result = tu.run(query)

Boltz_estimate_protein_design_cost (Type: BoltzAPITool)#

Estimate the authoritative USD cost of an official Boltz protein-design pipeline without creating…

Boltz_estimate_protein_design_cost tool specification

Tool Information:

  • Name: Boltz_estimate_protein_design_cost

  • Type: BoltzAPITool

  • Description: Estimate the authoritative USD cost of an official Boltz protein-design pipeline without creating a compute job. Use the matching start tool only after reviewing this estimate.

Parameters:

  • binder_specification (unknown) (required) Protein binder specification: no-template, structure-template, or Boltz-curated mode, following the nested discriminator schema.

  • num_proteins (integer) (required) Number of protein candidates to generate or price, within the endpoint’s official limits.

  • target (unknown) (required) Application-specific target definition, including sequences, structures, chains, bonds, or constraints as described by the nested schema.

  • idempotency_key (string) (optional) Stable caller-generated key used to prevent duplicate submissions and duplicate billing.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

Example Usage:

query = {
    "name": "Boltz_estimate_protein_design_cost",
    "arguments": {
        "binder_specification": "example_value",
        "num_proteins": 10,
        "target": "example_value"
    }
}
result = tu.run(query)

Boltz_estimate_protein_library_screen_cost (Type: BoltzAPITool)#

Estimate the authoritative USD cost of an official Boltz protein-library screen without creating …

Boltz_estimate_protein_library_screen_cost tool specification

Tool Information:

  • Name: Boltz_estimate_protein_library_screen_cost

  • Type: BoltzAPITool

  • Description: Estimate the authoritative USD cost of an official Boltz protein-library screen without creating a compute job. Use the matching start tool only after reviewing this estimate.

Parameters:

  • proteins (array) (required) Protein candidates to screen, expressed in the official sequence or structure input format.

  • target (unknown) (required) Application-specific target definition, including sequences, structures, chains, bonds, or constraints as described by the nested schema.

  • idempotency_key (string) (optional) Stable caller-generated key used to prevent duplicate submissions and duplicate billing.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

Example Usage:

query = {
    "name": "Boltz_estimate_protein_library_screen_cost",
    "arguments": {
        "proteins": ["item1", "item2"],
        "target": "example_value"
    }
}
result = tu.run(query)

Boltz_estimate_protein_sequence_redesign_cost (Type: BoltzAPITool)#

Estimate the authoritative USD cost of an official Boltz protein sequence-redesign pipeline witho…

Boltz_estimate_protein_sequence_redesign_cost tool specification

Tool Information:

  • Name: Boltz_estimate_protein_sequence_redesign_cost

  • Type: BoltzAPITool

  • Description: Estimate the authoritative USD cost of an official Boltz protein sequence-redesign pipeline without creating a compute job. Use the matching start tool only after reviewing this estimate.

Parameters:

  • entities (unknown) (required) Protein sequence-redesign entities and their designable motifs, following the selected binder or generic request type.

  • num_proteins (integer) (required) Number of protein candidates to generate or price, within the endpoint’s official limits.

  • structure (unknown) (required) URL or base64 structure input used for protein sequence redesign.

  • type (unknown) (required) Official request discriminator; its allowed literal values determine the matching nested input shape.

  • global_design_filters (unknown) (optional) Optional global amino-acid, motif, or hydrophobicity filters applied to generated proteins.

  • idempotency_key (string) (optional) Stable caller-generated key used to prevent duplicate submissions and duplicate billing.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

Example Usage:

query = {
    "name": "Boltz_estimate_protein_sequence_redesign_cost",
    "arguments": {
        "entities": "example_value",
        "num_proteins": 10,
        "structure": "example_value",
        "type": "example_value"
    }
}
result = tu.run(query)

Boltz_estimate_small_molecule_design_cost (Type: BoltzAPITool)#

Estimate the authoritative USD cost of an official Boltz small-molecule design pipeline without c…

Boltz_estimate_small_molecule_design_cost tool specification

Tool Information:

  • Name: Boltz_estimate_small_molecule_design_cost

  • Type: BoltzAPITool

  • Description: Estimate the authoritative USD cost of an official Boltz small-molecule design pipeline without creating a compute job. Use the matching start tool only after reviewing this estimate.

Parameters:

  • num_molecules (integer) (required) Number of small molecules to generate or price, within the endpoint’s official limits.

  • target (unknown) (required) Application-specific target definition, including sequences, structures, chains, bonds, or constraints as described by the nested schema.

  • chemical_space (string) (optional) Chemical-space constraint: Enamine REAL or none, when supported by the endpoint.

  • idempotency_key (string) (optional) Stable caller-generated key used to prevent duplicate submissions and duplicate billing.

  • molecule_filters (unknown) (optional) Optional built-in or custom molecular filters, including Lipinski, RDKit descriptor, SMARTS, or SMILES-regex rules.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

Example Usage:

query = {
    "name": "Boltz_estimate_small_molecule_design_cost",
    "arguments": {
        "num_molecules": 10,
        "target": "example_value"
    }
}
result = tu.run(query)

Boltz_estimate_small_molecule_library_screen_cost (Type: BoltzAPITool)#

Estimate the authoritative USD cost of an official Boltz small-molecule library screen without cr…

Boltz_estimate_small_molecule_library_screen_cost tool specification

Tool Information:

  • Name: Boltz_estimate_small_molecule_library_screen_cost

  • Type: BoltzAPITool

  • Description: Estimate the authoritative USD cost of an official Boltz small-molecule library screen without creating a compute job. Use the matching start tool only after reviewing this estimate.

Parameters:

  • molecules (array) (required) Small molecules to screen, represented using the official SMILES-based input objects.

  • target (unknown) (required) Application-specific target definition, including sequences, structures, chains, bonds, or constraints as described by the nested schema.

  • idempotency_key (string) (optional) Stable caller-generated key used to prevent duplicate submissions and duplicate billing.

  • molecule_filters (unknown) (optional) Optional built-in or custom molecular filters, including Lipinski, RDKit descriptor, SMARTS, or SMILES-regex rules.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

Example Usage:

query = {
    "name": "Boltz_estimate_small_molecule_library_screen_cost",
    "arguments": {
        "molecules": ["item1", "item2"],
        "target": "example_value"
    }
}
result = tu.run(query)

Boltz_estimate_structure_binding_cost (Type: BoltzAPITool)#

Estimate the authoritative USD cost of an official Boltz structure-and-binding prediction without…

Boltz_estimate_structure_binding_cost tool specification

Tool Information:

  • Name: Boltz_estimate_structure_binding_cost

  • Type: BoltzAPITool

  • Description: Estimate the authoritative USD cost of an official Boltz structure-and-binding prediction without creating a compute job. Use the matching start tool only after reviewing this estimate.

Parameters:

  • input (unknown) (required) Official application-specific request object; follow the nested schema and discriminator fields exactly.

  • model (string) (optional) Official model identifier accepted by this endpoint.

  • idempotency_key (string) (optional) Stable caller-generated key used to prevent duplicate submissions and duplicate billing.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

Example Usage:

query = {
    "name": "Boltz_estimate_structure_binding_cost",
    "arguments": {
        "input": "example_value"
    }
}
result = tu.run(query)

Boltz_get_adme (Type: BoltzAPITool)#

Retrieve one official Boltz ADME prediction by its account-scoped ID, including lifecycle status,…

Boltz_get_adme tool specification

Tool Information:

  • Name: Boltz_get_adme

  • Type: BoltzAPITool

  • Description: Retrieve one official Boltz ADME prediction by its account-scoped ID, including lifecycle status, failure details, inputs, outputs, metrics, and temporary artifact URLs when available.

Parameters:

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

  • id (string) (required) Account-scoped job or prediction ID returned by the matching start or list tool.

Example Usage:

query = {
    "name": "Boltz_get_adme",
    "arguments": {
        "id": "example_value"
    }
}
result = tu.run(query)

Boltz_get_auth_context (Type: BoltzAPITool)#

Inspect the official Boltz authentication context for the current credential, including principal…

Boltz_get_auth_context tool specification

Tool Information:

  • Name: Boltz_get_auth_context

  • Type: BoltzAPITool

  • Description: Inspect the official Boltz authentication context for the current credential, including principal type, live/test mode, organization selection, and workspace scope when applicable.

Parameters:

No parameters required.

Example Usage:

query = {
    "name": "Boltz_get_auth_context",
    "arguments": {
    }
}
result = tu.run(query)

Boltz_get_cli_version (Type: BoltzAPITool)#

Check an installed Boltz CLI version and platform against the latest and minimum supported offici…

Boltz_get_cli_version tool specification

Tool Information:

  • Name: Boltz_get_cli_version

  • Type: BoltzAPITool

  • Description: Check an installed Boltz CLI version and platform against the latest and minimum supported official releases. Returns update availability, requirements, and install commands.

Parameters:

  • current (string) (optional) Currently installed Boltz CLI version string.

  • platform (string) (optional) Current operating-system/platform identifier used for installation guidance.

Example Usage:

query = {
    "name": "Boltz_get_cli_version",
    "arguments": {
    }
}
result = tu.run(query)

Boltz_get_protein_design (Type: BoltzAPITool)#

Retrieve one official Boltz protein-design pipeline by its account-scoped ID, including lifecycle…

Boltz_get_protein_design tool specification

Tool Information:

  • Name: Boltz_get_protein_design

  • Type: BoltzAPITool

  • Description: Retrieve one official Boltz protein-design pipeline by its account-scoped ID, including lifecycle status, failure details, inputs, outputs, metrics, and temporary artifact URLs when available.

Parameters:

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

  • id (string) (required) Account-scoped job or prediction ID returned by the matching start or list tool.

Example Usage:

query = {
    "name": "Boltz_get_protein_design",
    "arguments": {
        "id": "example_value"
    }
}
result = tu.run(query)

Boltz_get_protein_library_screen (Type: BoltzAPITool)#

Retrieve one official Boltz protein-library screen by its account-scoped ID, including lifecycle …

Boltz_get_protein_library_screen tool specification

Tool Information:

  • Name: Boltz_get_protein_library_screen

  • Type: BoltzAPITool

  • Description: Retrieve one official Boltz protein-library screen by its account-scoped ID, including lifecycle status, failure details, inputs, outputs, metrics, and temporary artifact URLs when available.

Parameters:

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

  • id (string) (required) Account-scoped job or prediction ID returned by the matching start or list tool.

Example Usage:

query = {
    "name": "Boltz_get_protein_library_screen",
    "arguments": {
        "id": "example_value"
    }
}
result = tu.run(query)

Boltz_get_protein_sequence_redesign (Type: BoltzAPITool)#

Retrieve one official Boltz protein sequence-redesign pipeline by its account-scoped ID, includin…

Boltz_get_protein_sequence_redesign tool specification

Tool Information:

  • Name: Boltz_get_protein_sequence_redesign

  • Type: BoltzAPITool

  • Description: Retrieve one official Boltz protein sequence-redesign pipeline by its account-scoped ID, including lifecycle status, failure details, inputs, outputs, metrics, and temporary artifact URLs when available.

Parameters:

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

  • id (string) (required) Account-scoped job or prediction ID returned by the matching start or list tool.

Example Usage:

query = {
    "name": "Boltz_get_protein_sequence_redesign",
    "arguments": {
        "id": "example_value"
    }
}
result = tu.run(query)

Boltz_get_small_molecule_design (Type: BoltzAPITool)#

Retrieve one official Boltz small-molecule design pipeline by its account-scoped ID, including li…

Boltz_get_small_molecule_design tool specification

Tool Information:

  • Name: Boltz_get_small_molecule_design

  • Type: BoltzAPITool

  • Description: Retrieve one official Boltz small-molecule design pipeline by its account-scoped ID, including lifecycle status, failure details, inputs, outputs, metrics, and temporary artifact URLs when available.

Parameters:

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

  • id (string) (required) Account-scoped job or prediction ID returned by the matching start or list tool.

Example Usage:

query = {
    "name": "Boltz_get_small_molecule_design",
    "arguments": {
        "id": "example_value"
    }
}
result = tu.run(query)

Boltz_get_small_molecule_library_screen (Type: BoltzAPITool)#

Retrieve one official Boltz small-molecule library screen by its account-scoped ID, including lif…

Boltz_get_small_molecule_library_screen tool specification

Tool Information:

  • Name: Boltz_get_small_molecule_library_screen

  • Type: BoltzAPITool

  • Description: Retrieve one official Boltz small-molecule library screen by its account-scoped ID, including lifecycle status, failure details, inputs, outputs, metrics, and temporary artifact URLs when available.

Parameters:

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

  • id (string) (required) Account-scoped job or prediction ID returned by the matching start or list tool.

Example Usage:

query = {
    "name": "Boltz_get_small_molecule_library_screen",
    "arguments": {
        "id": "example_value"
    }
}
result = tu.run(query)

Boltz_get_structure_binding (Type: BoltzAPITool)#

Retrieve one official Boltz structure-and-binding prediction by its account-scoped ID, including …

Boltz_get_structure_binding tool specification

Tool Information:

  • Name: Boltz_get_structure_binding

  • Type: BoltzAPITool

  • Description: Retrieve one official Boltz structure-and-binding prediction by its account-scoped ID, including lifecycle status, failure details, inputs, outputs, metrics, and temporary artifact URLs when available.

Parameters:

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

  • id (string) (required) Account-scoped job or prediction ID returned by the matching start or list tool.

Example Usage:

query = {
    "name": "Boltz_get_structure_binding",
    "arguments": {
        "id": "example_value"
    }
}
result = tu.run(query)

Boltz_get_workspace (Type: BoltzAPITool)#

Retrieve one official Boltz workspace by workspace ID, including its name, archive state, default…

Boltz_get_workspace tool specification

Tool Information:

  • Name: Boltz_get_workspace

  • Type: BoltzAPITool

  • Description: Retrieve one official Boltz workspace by workspace ID, including its name, archive state, default status, timestamps, and configured data-retention policy. Requires an admin API key.

Parameters:

  • workspace_id (string) (required) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

Example Usage:

query = {
    "name": "Boltz_get_workspace",
    "arguments": {
        "workspace_id": "example_value"
    }
}
result = tu.run(query)

Boltz_get_workspace_spending_limit (Type: BoltzAPITool)#

Retrieve the lifetime spending limit currently configured for an official Boltz workspace. Requir…

Boltz_get_workspace_spending_limit tool specification

Tool Information:

  • Name: Boltz_get_workspace_spending_limit

  • Type: BoltzAPITool

  • Description: Retrieve the lifetime spending limit currently configured for an official Boltz workspace. Requires an admin API key; returns null when no limit is configured.

Parameters:

  • workspace_id (string) (required) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

Example Usage:

query = {
    "name": "Boltz_get_workspace_spending_limit",
    "arguments": {
        "workspace_id": "example_value"
    }
}
result = tu.run(query)

Boltz_list_adme (Type: BoltzAPITool)#

List official Boltz ADME prediction jobs visible to the current credential with cursor pagination…

Boltz_list_adme tool specification

Tool Information:

  • Name: Boltz_list_adme

  • Type: BoltzAPITool

  • Description: List official Boltz ADME prediction jobs visible to the current credential with cursor pagination and optional workspace filtering. Use returned IDs with the matching get or results tool.

Parameters:

  • after_id (string) (optional) Return the page after this cursor ID; mutually exclusive with before_id.

  • before_id (string) (optional) Return the page before this cursor ID; mutually exclusive with after_id.

  • limit (integer) (optional) Maximum number of records in this page, subject to the official API limit.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

Example Usage:

query = {
    "name": "Boltz_list_adme",
    "arguments": {
    }
}
result = tu.run(query)

Boltz_list_api_keys (Type: BoltzAPITool)#

List official Boltz API-key metadata with cursor pagination and optional workspace filtering. Req…

Boltz_list_api_keys tool specification

Tool Information:

  • Name: Boltz_list_api_keys

  • Type: BoltzAPITool

  • Description: List official Boltz API-key metadata with cursor pagination and optional workspace filtering. Requires an admin key and never returns existing full secret values.

Parameters:

  • after_id (string) (optional) Return the page after this cursor ID; mutually exclusive with before_id.

  • before_id (string) (optional) Return the page before this cursor ID; mutually exclusive with after_id.

  • limit (integer) (optional) Maximum number of records in this page, subject to the official API limit.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

Example Usage:

query = {
    "name": "Boltz_list_api_keys",
    "arguments": {
    }
}
result = tu.run(query)

Boltz_list_protein_design (Type: BoltzAPITool)#

List official Boltz protein-design pipeline jobs visible to the current credential with cursor pa…

Boltz_list_protein_design tool specification

Tool Information:

  • Name: Boltz_list_protein_design

  • Type: BoltzAPITool

  • Description: List official Boltz protein-design pipeline jobs visible to the current credential with cursor pagination and optional workspace filtering. Use returned IDs with the matching get or results tool.

Parameters:

  • after_id (string) (optional) Return the page after this cursor ID; mutually exclusive with before_id.

  • before_id (string) (optional) Return the page before this cursor ID; mutually exclusive with after_id.

  • limit (integer) (optional) Maximum number of records in this page, subject to the official API limit.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

Example Usage:

query = {
    "name": "Boltz_list_protein_design",
    "arguments": {
    }
}
result = tu.run(query)

Boltz_list_protein_design_results (Type: BoltzAPITool)#

List generated results for one official Boltz protein-design pipeline job with cursor pagination …

Boltz_list_protein_design_results tool specification

Tool Information:

  • Name: Boltz_list_protein_design_results

  • Type: BoltzAPITool

  • Description: List generated results for one official Boltz protein-design pipeline job with cursor pagination and optional result-ID filtering. The parent job ID comes from start or list.

Parameters:

  • after_id (string) (optional) Return the page after this cursor ID; mutually exclusive with before_id.

  • before_id (string) (optional) Return the page before this cursor ID; mutually exclusive with after_id.

  • ids (string) (optional) Optional comma-separated result IDs to select.

  • limit (integer) (optional) Maximum number of records in this page, subject to the official API limit.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

  • id (string) (required) Account-scoped job or prediction ID returned by the matching start or list tool.

Example Usage:

query = {
    "name": "Boltz_list_protein_design_results",
    "arguments": {
        "id": "example_value"
    }
}
result = tu.run(query)

Boltz_list_protein_library_screen (Type: BoltzAPITool)#

List official Boltz protein-library screen jobs visible to the current credential with cursor pag…

Boltz_list_protein_library_screen tool specification

Tool Information:

  • Name: Boltz_list_protein_library_screen

  • Type: BoltzAPITool

  • Description: List official Boltz protein-library screen jobs visible to the current credential with cursor pagination and optional workspace filtering. Use returned IDs with the matching get or results tool.

Parameters:

  • after_id (string) (optional) Return the page after this cursor ID; mutually exclusive with before_id.

  • before_id (string) (optional) Return the page before this cursor ID; mutually exclusive with after_id.

  • limit (integer) (optional) Maximum number of records in this page, subject to the official API limit.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

Example Usage:

query = {
    "name": "Boltz_list_protein_library_screen",
    "arguments": {
    }
}
result = tu.run(query)

Boltz_list_protein_library_screen_results (Type: BoltzAPITool)#

List generated results for one official Boltz protein-library screen job with cursor pagination a…

Boltz_list_protein_library_screen_results tool specification

Tool Information:

  • Name: Boltz_list_protein_library_screen_results

  • Type: BoltzAPITool

  • Description: List generated results for one official Boltz protein-library screen job with cursor pagination and optional result-ID filtering. The parent job ID comes from start or list.

Parameters:

  • after_id (string) (optional) Return the page after this cursor ID; mutually exclusive with before_id.

  • before_id (string) (optional) Return the page before this cursor ID; mutually exclusive with after_id.

  • ids (string) (optional) Optional comma-separated result IDs to select.

  • limit (integer) (optional) Maximum number of records in this page, subject to the official API limit.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

  • id (string) (required) Account-scoped job or prediction ID returned by the matching start or list tool.

Example Usage:

query = {
    "name": "Boltz_list_protein_library_screen_results",
    "arguments": {
        "id": "example_value"
    }
}
result = tu.run(query)

Boltz_list_protein_sequence_redesign (Type: BoltzAPITool)#

List official Boltz protein sequence-redesign pipeline jobs visible to the current credential wit…

Boltz_list_protein_sequence_redesign tool specification

Tool Information:

  • Name: Boltz_list_protein_sequence_redesign

  • Type: BoltzAPITool

  • Description: List official Boltz protein sequence-redesign pipeline jobs visible to the current credential with cursor pagination and optional workspace filtering. Use returned IDs with the matching get or results tool.

Parameters:

  • after_id (string) (optional) Return the page after this cursor ID; mutually exclusive with before_id.

  • before_id (string) (optional) Return the page before this cursor ID; mutually exclusive with after_id.

  • limit (integer) (optional) Maximum number of records in this page, subject to the official API limit.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

Example Usage:

query = {
    "name": "Boltz_list_protein_sequence_redesign",
    "arguments": {
    }
}
result = tu.run(query)

Boltz_list_protein_sequence_redesign_results (Type: BoltzAPITool)#

List generated results for one official Boltz protein sequence-redesign pipeline job with cursor …

Boltz_list_protein_sequence_redesign_results tool specification

Tool Information:

  • Name: Boltz_list_protein_sequence_redesign_results

  • Type: BoltzAPITool

  • Description: List generated results for one official Boltz protein sequence-redesign pipeline job with cursor pagination and optional result-ID filtering. The parent job ID comes from start or list.

Parameters:

  • after_id (string) (optional) Return the page after this cursor ID; mutually exclusive with before_id.

  • before_id (string) (optional) Return the page before this cursor ID; mutually exclusive with after_id.

  • ids (string) (optional) Optional comma-separated result IDs to select.

  • limit (integer) (optional) Maximum number of records in this page, subject to the official API limit.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

  • id (string) (required) Account-scoped job or prediction ID returned by the matching start or list tool.

Example Usage:

query = {
    "name": "Boltz_list_protein_sequence_redesign_results",
    "arguments": {
        "id": "example_value"
    }
}
result = tu.run(query)

Boltz_list_small_molecule_design (Type: BoltzAPITool)#

List official Boltz small-molecule design pipeline jobs visible to the current credential with cu…

Boltz_list_small_molecule_design tool specification

Tool Information:

  • Name: Boltz_list_small_molecule_design

  • Type: BoltzAPITool

  • Description: List official Boltz small-molecule design pipeline jobs visible to the current credential with cursor pagination and optional workspace filtering. Use returned IDs with the matching get or results tool.

Parameters:

  • after_id (string) (optional) Return the page after this cursor ID; mutually exclusive with before_id.

  • before_id (string) (optional) Return the page before this cursor ID; mutually exclusive with after_id.

  • limit (integer) (optional) Maximum number of records in this page, subject to the official API limit.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

Example Usage:

query = {
    "name": "Boltz_list_small_molecule_design",
    "arguments": {
    }
}
result = tu.run(query)

Boltz_list_small_molecule_design_results (Type: BoltzAPITool)#

List generated results for one official Boltz small-molecule design pipeline job with cursor pagi…

Boltz_list_small_molecule_design_results tool specification

Tool Information:

  • Name: Boltz_list_small_molecule_design_results

  • Type: BoltzAPITool

  • Description: List generated results for one official Boltz small-molecule design pipeline job with cursor pagination and optional result-ID filtering. The parent job ID comes from start or list.

Parameters:

  • after_id (string) (optional) Return the page after this cursor ID; mutually exclusive with before_id.

  • before_id (string) (optional) Return the page before this cursor ID; mutually exclusive with after_id.

  • ids (string) (optional) Optional comma-separated result IDs to select.

  • limit (integer) (optional) Maximum number of records in this page, subject to the official API limit.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

  • id (string) (required) Account-scoped job or prediction ID returned by the matching start or list tool.

Example Usage:

query = {
    "name": "Boltz_list_small_molecule_design_results",
    "arguments": {
        "id": "example_value"
    }
}
result = tu.run(query)

Boltz_list_small_molecule_library_screen (Type: BoltzAPITool)#

List official Boltz small-molecule library screen jobs visible to the current credential with cur…

Boltz_list_small_molecule_library_screen tool specification

Tool Information:

  • Name: Boltz_list_small_molecule_library_screen

  • Type: BoltzAPITool

  • Description: List official Boltz small-molecule library screen jobs visible to the current credential with cursor pagination and optional workspace filtering. Use returned IDs with the matching get or results tool.

Parameters:

  • after_id (string) (optional) Return the page after this cursor ID; mutually exclusive with before_id.

  • before_id (string) (optional) Return the page before this cursor ID; mutually exclusive with after_id.

  • limit (integer) (optional) Maximum number of records in this page, subject to the official API limit.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

Example Usage:

query = {
    "name": "Boltz_list_small_molecule_library_screen",
    "arguments": {
    }
}
result = tu.run(query)

Boltz_list_small_molecule_library_screen_results (Type: BoltzAPITool)#

List generated results for one official Boltz small-molecule library screen job with cursor pagin…

Boltz_list_small_molecule_library_screen_results tool specification

Tool Information:

  • Name: Boltz_list_small_molecule_library_screen_results

  • Type: BoltzAPITool

  • Description: List generated results for one official Boltz small-molecule library screen job with cursor pagination and optional result-ID filtering. The parent job ID comes from start or list.

Parameters:

  • after_id (string) (optional) Return the page after this cursor ID; mutually exclusive with before_id.

  • before_id (string) (optional) Return the page before this cursor ID; mutually exclusive with after_id.

  • ids (string) (optional) Optional comma-separated result IDs to select.

  • limit (integer) (optional) Maximum number of records in this page, subject to the official API limit.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

  • id (string) (required) Account-scoped job or prediction ID returned by the matching start or list tool.

Example Usage:

query = {
    "name": "Boltz_list_small_molecule_library_screen_results",
    "arguments": {
        "id": "example_value"
    }
}
result = tu.run(query)

Boltz_list_structure_binding (Type: BoltzAPITool)#

List official Boltz structure-and-binding prediction jobs visible to the current credential with …

Boltz_list_structure_binding tool specification

Tool Information:

  • Name: Boltz_list_structure_binding

  • Type: BoltzAPITool

  • Description: List official Boltz structure-and-binding prediction jobs visible to the current credential with cursor pagination and optional workspace filtering. Use returned IDs with the matching get or results tool.

Parameters:

  • after_id (string) (optional) Return the page after this cursor ID; mutually exclusive with before_id.

  • before_id (string) (optional) Return the page before this cursor ID; mutually exclusive with after_id.

  • limit (integer) (optional) Maximum number of records in this page, subject to the official API limit.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

Example Usage:

query = {
    "name": "Boltz_list_structure_binding",
    "arguments": {
    }
}
result = tu.run(query)

Boltz_list_usage (Type: BoltzAPITool)#

Query official Boltz usage over a required time range and hourly or daily window, optionally filt…

Boltz_list_usage tool specification

Tool Information:

  • Name: Boltz_list_usage

  • Type: BoltzAPITool

  • Description: Query official Boltz usage over a required time range and hourly or daily window, optionally filtering applications/workspaces and grouping results. Requires an admin API key.

Parameters:

  • ending_at (unknown) (required) Exclusive usage-window end as an ISO 8601 timestamp.

  • starting_at (unknown) (required) Inclusive usage-window start as an ISO 8601 timestamp.

  • window_size (string) (required) Usage aggregation window: HOUR or DAY.

  • applications (unknown) (optional) Optional application name or list of application names to include in usage totals.

  • group_by (unknown) (optional) Optional grouping dimension or dimensions: workspace_id and/or application.

  • limit (integer) (optional) Maximum number of records in this page, subject to the official API limit.

  • page (string) (optional) Opaque usage-pagination cursor returned by the previous page.

  • workspace_ids (unknown) (optional) Optional workspace ID or list of workspace IDs to include in usage totals.

Example Usage:

query = {
    "name": "Boltz_list_usage",
    "arguments": {
        "ending_at": "example_value",
        "starting_at": "example_value",
        "window_size": "example_value"
    }
}
result = tu.run(query)

Boltz_list_workspaces (Type: BoltzAPITool)#

List official Boltz workspaces using cursor pagination and optional exact-name filtering. Require…

Boltz_list_workspaces tool specification

Tool Information:

  • Name: Boltz_list_workspaces

  • Type: BoltzAPITool

  • Description: List official Boltz workspaces using cursor pagination and optional exact-name filtering. Requires an admin API key and returns workspace IDs for subsequent management operations.

Parameters:

  • after_id (string) (optional) Return the page after this cursor ID; mutually exclusive with before_id.

  • before_id (string) (optional) Return the page before this cursor ID; mutually exclusive with after_id.

  • limit (integer) (optional) Maximum number of records in this page, subject to the official API limit.

  • name (string) (optional) Human-readable workspace or API-key name, depending on the operation.

Example Usage:

query = {
    "name": "Boltz_list_workspaces",
    "arguments": {
    }
}
result = tu.run(query)

Boltz_resume_protein_design (Type: BoltzAPITool)#

Resume a stopped official Boltz protein-design pipeline job. This changes remote compute state an…

Boltz_resume_protein_design tool specification

Tool Information:

  • Name: Boltz_resume_protein_design

  • Type: BoltzAPITool

  • Description: Resume a stopped official Boltz protein-design pipeline job. This changes remote compute state and may continue billable work, so explicit confirmation is required.

Parameters:

  • id (string) (required) Account-scoped job or prediction ID returned by the matching start or list tool.

  • confirm (boolean) (required) confirm=true is required because resuming changes remote compute state and may continue billable work

Example Usage:

query = {
    "name": "Boltz_resume_protein_design",
    "arguments": {
        "id": "example_value",
        "confirm": true
    }
}
result = tu.run(query)

Boltz_resume_protein_library_screen (Type: BoltzAPITool)#

Resume a stopped official Boltz protein-library screen job. This changes remote compute state and…

Boltz_resume_protein_library_screen tool specification

Tool Information:

  • Name: Boltz_resume_protein_library_screen

  • Type: BoltzAPITool

  • Description: Resume a stopped official Boltz protein-library screen job. This changes remote compute state and may continue billable work, so explicit confirmation is required.

Parameters:

  • id (string) (required) Account-scoped job or prediction ID returned by the matching start or list tool.

  • confirm (boolean) (required) confirm=true is required because resuming changes remote compute state and may continue billable work

Example Usage:

query = {
    "name": "Boltz_resume_protein_library_screen",
    "arguments": {
        "id": "example_value",
        "confirm": true
    }
}
result = tu.run(query)

Boltz_resume_protein_sequence_redesign (Type: BoltzAPITool)#

Resume a stopped official Boltz protein sequence-redesign pipeline job. This changes remote compu…

Boltz_resume_protein_sequence_redesign tool specification

Tool Information:

  • Name: Boltz_resume_protein_sequence_redesign

  • Type: BoltzAPITool

  • Description: Resume a stopped official Boltz protein sequence-redesign pipeline job. This changes remote compute state and may continue billable work, so explicit confirmation is required.

Parameters:

  • id (string) (required) Account-scoped job or prediction ID returned by the matching start or list tool.

  • confirm (boolean) (required) confirm=true is required because resuming changes remote compute state and may continue billable work

Example Usage:

query = {
    "name": "Boltz_resume_protein_sequence_redesign",
    "arguments": {
        "id": "example_value",
        "confirm": true
    }
}
result = tu.run(query)

Boltz_resume_small_molecule_design (Type: BoltzAPITool)#

Resume a stopped official Boltz small-molecule design pipeline job. This changes remote compute s…

Boltz_resume_small_molecule_design tool specification

Tool Information:

  • Name: Boltz_resume_small_molecule_design

  • Type: BoltzAPITool

  • Description: Resume a stopped official Boltz small-molecule design pipeline job. This changes remote compute state and may continue billable work, so explicit confirmation is required.

Parameters:

  • id (string) (required) Account-scoped job or prediction ID returned by the matching start or list tool.

  • confirm (boolean) (required) confirm=true is required because resuming changes remote compute state and may continue billable work

Example Usage:

query = {
    "name": "Boltz_resume_small_molecule_design",
    "arguments": {
        "id": "example_value",
        "confirm": true
    }
}
result = tu.run(query)

Boltz_resume_small_molecule_library_screen (Type: BoltzAPITool)#

Resume a stopped official Boltz small-molecule library screen job. This changes remote compute st…

Boltz_resume_small_molecule_library_screen tool specification

Tool Information:

  • Name: Boltz_resume_small_molecule_library_screen

  • Type: BoltzAPITool

  • Description: Resume a stopped official Boltz small-molecule library screen job. This changes remote compute state and may continue billable work, so explicit confirmation is required.

Parameters:

  • id (string) (required) Account-scoped job or prediction ID returned by the matching start or list tool.

  • confirm (boolean) (required) confirm=true is required because resuming changes remote compute state and may continue billable work

Example Usage:

query = {
    "name": "Boltz_resume_small_molecule_library_screen",
    "arguments": {
        "id": "example_value",
        "confirm": true
    }
}
result = tu.run(query)

Boltz_revoke_api_key (Type: BoltzAPITool)#

Revoke an official Boltz API key by its key ID, immediately disabling that credential. Requires a…

Boltz_revoke_api_key tool specification

Tool Information:

  • Name: Boltz_revoke_api_key

  • Type: BoltzAPITool

  • Description: Revoke an official Boltz API key by its key ID, immediately disabling that credential. Requires an admin key and explicit confirmation; pass the metadata ID, not the secret.

Parameters:

  • api_key_id (string) (required) API key ID returned by the key creation or listing tool; this is not the secret key value.

  • confirm (boolean) (required) confirm=true is required because revoking an API key is irreversible

Example Usage:

query = {
    "name": "Boltz_revoke_api_key",
    "arguments": {
        "api_key_id": "example_value",
        "confirm": true
    }
}
result = tu.run(query)

Boltz_run_adme (Type: BoltzAPITool)#

Run an official Boltz ADME prediction end to end: submit the job, poll until completion, and pers…

Boltz_run_adme tool specification

Tool Information:

  • Name: Boltz_run_adme

  • Type: BoltzAPITool

  • Description: Run an official Boltz ADME prediction end to end: submit the job, poll until completion, and persist downloaded results in a named local experiment directory. Reuse the required stable name when retrying to prevent duplicate paid submissions. Returns that directory path.

Parameters:

  • input (unknown) (required) Official application-specific request object; follow the nested schema and discriminator fields exactly.

  • model (string) (required) Official model identifier accepted by this endpoint.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

  • root_dir (string) (optional) Local directory where the official SDK creates the experiment folder and persists downloaded results.

  • name (string) (required) Stable experiment directory name. Reuse the same name when retrying this request so the SDK reuses its persisted idempotency key instead of submitting duplicate paid work.

  • quiet (boolean) (optional) Suppress official SDK progress output while waiting for the run to finish.

  • poll_interval_seconds (number) (optional) Seconds between official SDK status polls while waiting for completion; must be greater than zero.

Example Usage:

query = {
    "name": "Boltz_run_adme",
    "arguments": {
        "input": "example_value",
        "model": "example_value",
        "name": "example_value"
    }
}
result = tu.run(query)

Boltz_run_protein_design (Type: BoltzAPITool)#

Run an official Boltz protein-design pipeline end to end: submit the job, poll until completion, …

Boltz_run_protein_design tool specification

Tool Information:

  • Name: Boltz_run_protein_design

  • Type: BoltzAPITool

  • Description: Run an official Boltz protein-design pipeline end to end: submit the job, poll until completion, and persist downloaded results in a named local experiment directory. Reuse the required stable name when retrying to prevent duplicate paid submissions. Returns that directory path.

Parameters:

  • binder_specification (unknown) (required) Protein binder specification: no-template, structure-template, or Boltz-curated mode, following the nested discriminator schema.

  • num_proteins (integer) (required) Number of protein candidates to generate or price, within the endpoint’s official limits.

  • target (unknown) (required) Application-specific target definition, including sequences, structures, chains, bonds, or constraints as described by the nested schema.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

  • root_dir (string) (optional) Local directory where the official SDK creates the experiment folder and persists downloaded results.

  • name (string) (required) Stable experiment directory name. Reuse the same name when retrying this request so the SDK reuses its persisted idempotency key instead of submitting duplicate paid work.

  • quiet (boolean) (optional) Suppress official SDK progress output while waiting for the run to finish.

  • poll_interval_seconds (number) (optional) Seconds between official SDK status polls while waiting for completion; must be greater than zero.

  • download_mode ([‘string’, ‘null’]) (optional) Result download mode for design and screening runs: everything or metadata_only.

Example Usage:

query = {
    "name": "Boltz_run_protein_design",
    "arguments": {
        "binder_specification": "example_value",
        "num_proteins": 10,
        "target": "example_value",
        "name": "example_value"
    }
}
result = tu.run(query)

Boltz_run_protein_library_screen (Type: BoltzAPITool)#

Run an official Boltz protein-library screen end to end: submit the job, poll until completion, a…

Boltz_run_protein_library_screen tool specification

Tool Information:

  • Name: Boltz_run_protein_library_screen

  • Type: BoltzAPITool

  • Description: Run an official Boltz protein-library screen end to end: submit the job, poll until completion, and persist downloaded results in a named local experiment directory. Reuse the required stable name when retrying to prevent duplicate paid submissions. Returns that directory path.

Parameters:

  • proteins (array) (required) Protein candidates to screen, expressed in the official sequence or structure input format.

  • target (unknown) (required) Application-specific target definition, including sequences, structures, chains, bonds, or constraints as described by the nested schema.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

  • root_dir (string) (optional) Local directory where the official SDK creates the experiment folder and persists downloaded results.

  • name (string) (required) Stable experiment directory name. Reuse the same name when retrying this request so the SDK reuses its persisted idempotency key instead of submitting duplicate paid work.

  • quiet (boolean) (optional) Suppress official SDK progress output while waiting for the run to finish.

  • poll_interval_seconds (number) (optional) Seconds between official SDK status polls while waiting for completion; must be greater than zero.

  • download_mode ([‘string’, ‘null’]) (optional) Result download mode for design and screening runs: everything or metadata_only.

Example Usage:

query = {
    "name": "Boltz_run_protein_library_screen",
    "arguments": {
        "proteins": ["item1", "item2"],
        "target": "example_value",
        "name": "example_value"
    }
}
result = tu.run(query)

Boltz_run_small_molecule_design (Type: BoltzAPITool)#

Run an official Boltz small-molecule design pipeline end to end: submit the job, poll until compl…

Boltz_run_small_molecule_design tool specification

Tool Information:

  • Name: Boltz_run_small_molecule_design

  • Type: BoltzAPITool

  • Description: Run an official Boltz small-molecule design pipeline end to end: submit the job, poll until completion, and persist downloaded results in a named local experiment directory. Reuse the required stable name when retrying to prevent duplicate paid submissions. Returns that directory path.

Parameters:

  • num_molecules (integer) (required) Number of small molecules to generate or price, within the endpoint’s official limits.

  • target (unknown) (required) Application-specific target definition, including sequences, structures, chains, bonds, or constraints as described by the nested schema.

  • chemical_space (string) (optional) Chemical-space constraint: Enamine REAL or none, when supported by the endpoint.

  • molecule_filters (unknown) (optional) Optional built-in or custom molecular filters, including Lipinski, RDKit descriptor, SMARTS, or SMILES-regex rules.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

  • root_dir (string) (optional) Local directory where the official SDK creates the experiment folder and persists downloaded results.

  • name (string) (required) Stable experiment directory name. Reuse the same name when retrying this request so the SDK reuses its persisted idempotency key instead of submitting duplicate paid work.

  • quiet (boolean) (optional) Suppress official SDK progress output while waiting for the run to finish.

  • poll_interval_seconds (number) (optional) Seconds between official SDK status polls while waiting for completion; must be greater than zero.

  • download_mode ([‘string’, ‘null’]) (optional) Result download mode for design and screening runs: everything or metadata_only.

Example Usage:

query = {
    "name": "Boltz_run_small_molecule_design",
    "arguments": {
        "num_molecules": 10,
        "target": "example_value",
        "name": "example_value"
    }
}
result = tu.run(query)

Boltz_run_small_molecule_library_screen (Type: BoltzAPITool)#

Run an official Boltz small-molecule library screen end to end: submit the job, poll until comple…

Boltz_run_small_molecule_library_screen tool specification

Tool Information:

  • Name: Boltz_run_small_molecule_library_screen

  • Type: BoltzAPITool

  • Description: Run an official Boltz small-molecule library screen end to end: submit the job, poll until completion, and persist downloaded results in a named local experiment directory. Reuse the required stable name when retrying to prevent duplicate paid submissions. Returns that directory path.

Parameters:

  • molecules (array) (required) Small molecules to screen, represented using the official SMILES-based input objects.

  • target (unknown) (required) Application-specific target definition, including sequences, structures, chains, bonds, or constraints as described by the nested schema.

  • molecule_filters (unknown) (optional) Optional built-in or custom molecular filters, including Lipinski, RDKit descriptor, SMARTS, or SMILES-regex rules.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

  • root_dir (string) (optional) Local directory where the official SDK creates the experiment folder and persists downloaded results.

  • name (string) (required) Stable experiment directory name. Reuse the same name when retrying this request so the SDK reuses its persisted idempotency key instead of submitting duplicate paid work.

  • quiet (boolean) (optional) Suppress official SDK progress output while waiting for the run to finish.

  • poll_interval_seconds (number) (optional) Seconds between official SDK status polls while waiting for completion; must be greater than zero.

  • download_mode ([‘string’, ‘null’]) (optional) Result download mode for design and screening runs: everything or metadata_only.

Example Usage:

query = {
    "name": "Boltz_run_small_molecule_library_screen",
    "arguments": {
        "molecules": ["item1", "item2"],
        "target": "example_value",
        "name": "example_value"
    }
}
result = tu.run(query)

Boltz_run_structure_binding (Type: BoltzAPITool)#

Run an official Boltz structure-and-binding prediction end to end: submit the job, poll until com…

Boltz_run_structure_binding tool specification

Tool Information:

  • Name: Boltz_run_structure_binding

  • Type: BoltzAPITool

  • Description: Run an official Boltz structure-and-binding prediction end to end: submit the job, poll until completion, and persist downloaded results in a named local experiment directory. Reuse the required stable name when retrying to prevent duplicate paid submissions. Returns that directory path.

Parameters:

  • input (unknown) (required) Official application-specific request object; follow the nested schema and discriminator fields exactly.

  • model (string) (required) Official model identifier accepted by this endpoint.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

  • root_dir (string) (optional) Local directory where the official SDK creates the experiment folder and persists downloaded results.

  • name (string) (required) Stable experiment directory name. Reuse the same name when retrying this request so the SDK reuses its persisted idempotency key instead of submitting duplicate paid work.

  • quiet (boolean) (optional) Suppress official SDK progress output while waiting for the run to finish.

  • poll_interval_seconds (number) (optional) Seconds between official SDK status polls while waiting for completion; must be greater than zero.

Example Usage:

query = {
    "name": "Boltz_run_structure_binding",
    "arguments": {
        "input": "example_value",
        "model": "example_value",
        "name": "example_value"
    }
}
result = tu.run(query)

Boltz_set_workspace_spending_limit (Type: BoltzAPITool)#

Set the official Boltz workspace lifetime spending limit. Requires an admin API key and explicit …

Boltz_set_workspace_spending_limit tool specification

Tool Information:

  • Name: Boltz_set_workspace_spending_limit

  • Type: BoltzAPITool

  • Description: Set the official Boltz workspace lifetime spending limit. Requires an admin API key and explicit confirmation; pass the official limit object and type=’lifetime’.

Parameters:

  • limit (unknown) (required) Maximum number of records in this page, subject to the official API limit.

  • type (string) (required) Official request discriminator; its allowed literal values determine the matching nested input shape.

  • workspace_id (string) (required) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

  • confirm (boolean) (required) confirm=true is required because this changes the workspace spending limit

Example Usage:

query = {
    "name": "Boltz_set_workspace_spending_limit",
    "arguments": {
        "limit": "example_value",
        "type": "example_value",
        "workspace_id": "example_value",
        "confirm": true
    }
}
result = tu.run(query)

Boltz_start_adme (Type: BoltzAPITool)#

Submit a paid asynchronous official Boltz ADME prediction. Requires a stable idempotency key to p…

Boltz_start_adme tool specification

Tool Information:

  • Name: Boltz_start_adme

  • Type: BoltzAPITool

  • Description: Submit a paid asynchronous official Boltz ADME prediction. Requires a stable idempotency key to prevent duplicate billing; returns the account-scoped job ID and initial status.

Parameters:

  • input (unknown) (required) Official application-specific request object; follow the nested schema and discriminator fields exactly.

  • model (string) (required) Official model identifier accepted by this endpoint.

  • idempotency_key (string) (required) Stable caller-generated key used to prevent duplicate submissions and duplicate billing.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

Example Usage:

query = {
    "name": "Boltz_start_adme",
    "arguments": {
        "input": "example_value",
        "model": "example_value",
        "idempotency_key": "example_value"
    }
}
result = tu.run(query)

Boltz_start_protein_design (Type: BoltzAPITool)#

Submit a paid asynchronous official Boltz protein-design pipeline. Requires a stable idempotency …

Boltz_start_protein_design tool specification

Tool Information:

  • Name: Boltz_start_protein_design

  • Type: BoltzAPITool

  • Description: Submit a paid asynchronous official Boltz protein-design pipeline. Requires a stable idempotency key to prevent duplicate billing; returns the account-scoped job ID and initial status.

Parameters:

  • binder_specification (unknown) (required) Protein binder specification: no-template, structure-template, or Boltz-curated mode, following the nested discriminator schema.

  • num_proteins (integer) (required) Number of protein candidates to generate or price, within the endpoint’s official limits.

  • target (unknown) (required) Application-specific target definition, including sequences, structures, chains, bonds, or constraints as described by the nested schema.

  • idempotency_key (string) (required) Stable caller-generated key used to prevent duplicate submissions and duplicate billing.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

Example Usage:

query = {
    "name": "Boltz_start_protein_design",
    "arguments": {
        "binder_specification": "example_value",
        "num_proteins": 10,
        "target": "example_value",
        "idempotency_key": "example_value"
    }
}
result = tu.run(query)

Boltz_start_protein_library_screen (Type: BoltzAPITool)#

Submit a paid asynchronous official Boltz protein-library screen. Requires a stable idempotency k…

Boltz_start_protein_library_screen tool specification

Tool Information:

  • Name: Boltz_start_protein_library_screen

  • Type: BoltzAPITool

  • Description: Submit a paid asynchronous official Boltz protein-library screen. Requires a stable idempotency key to prevent duplicate billing; returns the account-scoped job ID and initial status.

Parameters:

  • proteins (array) (required) Protein candidates to screen, expressed in the official sequence or structure input format.

  • target (unknown) (required) Application-specific target definition, including sequences, structures, chains, bonds, or constraints as described by the nested schema.

  • idempotency_key (string) (required) Stable caller-generated key used to prevent duplicate submissions and duplicate billing.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

Example Usage:

query = {
    "name": "Boltz_start_protein_library_screen",
    "arguments": {
        "proteins": ["item1", "item2"],
        "target": "example_value",
        "idempotency_key": "example_value"
    }
}
result = tu.run(query)

Boltz_start_protein_sequence_redesign (Type: BoltzAPITool)#

Submit a paid asynchronous official Boltz protein sequence-redesign pipeline. Requires a stable i…

Boltz_start_protein_sequence_redesign tool specification

Tool Information:

  • Name: Boltz_start_protein_sequence_redesign

  • Type: BoltzAPITool

  • Description: Submit a paid asynchronous official Boltz protein sequence-redesign pipeline. Requires a stable idempotency key to prevent duplicate billing; returns the account-scoped job ID and initial status.

Parameters:

  • entities (unknown) (required) Protein sequence-redesign entities and their designable motifs, following the selected binder or generic request type.

  • num_proteins (integer) (required) Number of protein candidates to generate or price, within the endpoint’s official limits.

  • structure (unknown) (required) URL or base64 structure input used for protein sequence redesign.

  • type (unknown) (required) Official request discriminator; its allowed literal values determine the matching nested input shape.

  • global_design_filters (unknown) (optional) Optional global amino-acid, motif, or hydrophobicity filters applied to generated proteins.

  • idempotency_key (string) (required) Stable caller-generated key used to prevent duplicate submissions and duplicate billing.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

Example Usage:

query = {
    "name": "Boltz_start_protein_sequence_redesign",
    "arguments": {
        "entities": "example_value",
        "num_proteins": 10,
        "structure": "example_value",
        "type": "example_value",
        "idempotency_key": "example_value"
    }
}
result = tu.run(query)

Boltz_start_small_molecule_design (Type: BoltzAPITool)#

Submit a paid asynchronous official Boltz small-molecule design pipeline. Requires a stable idemp…

Boltz_start_small_molecule_design tool specification

Tool Information:

  • Name: Boltz_start_small_molecule_design

  • Type: BoltzAPITool

  • Description: Submit a paid asynchronous official Boltz small-molecule design pipeline. Requires a stable idempotency key to prevent duplicate billing; returns the account-scoped job ID and initial status.

Parameters:

  • num_molecules (integer) (required) Number of small molecules to generate or price, within the endpoint’s official limits.

  • target (unknown) (required) Application-specific target definition, including sequences, structures, chains, bonds, or constraints as described by the nested schema.

  • chemical_space (string) (optional) Chemical-space constraint: Enamine REAL or none, when supported by the endpoint.

  • idempotency_key (string) (required) Stable caller-generated key used to prevent duplicate submissions and duplicate billing.

  • molecule_filters (unknown) (optional) Optional built-in or custom molecular filters, including Lipinski, RDKit descriptor, SMARTS, or SMILES-regex rules.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

Example Usage:

query = {
    "name": "Boltz_start_small_molecule_design",
    "arguments": {
        "num_molecules": 10,
        "target": "example_value",
        "idempotency_key": "example_value"
    }
}
result = tu.run(query)

Boltz_start_small_molecule_library_screen (Type: BoltzAPITool)#

Submit a paid asynchronous official Boltz small-molecule library screen. Requires a stable idempo…

Boltz_start_small_molecule_library_screen tool specification

Tool Information:

  • Name: Boltz_start_small_molecule_library_screen

  • Type: BoltzAPITool

  • Description: Submit a paid asynchronous official Boltz small-molecule library screen. Requires a stable idempotency key to prevent duplicate billing; returns the account-scoped job ID and initial status.

Parameters:

  • molecules (array) (required) Small molecules to screen, represented using the official SMILES-based input objects.

  • target (unknown) (required) Application-specific target definition, including sequences, structures, chains, bonds, or constraints as described by the nested schema.

  • idempotency_key (string) (required) Stable caller-generated key used to prevent duplicate submissions and duplicate billing.

  • molecule_filters (unknown) (optional) Optional built-in or custom molecular filters, including Lipinski, RDKit descriptor, SMARTS, or SMILES-regex rules.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

Example Usage:

query = {
    "name": "Boltz_start_small_molecule_library_screen",
    "arguments": {
        "molecules": ["item1", "item2"],
        "target": "example_value",
        "idempotency_key": "example_value"
    }
}
result = tu.run(query)

Boltz_start_structure_binding (Type: BoltzAPITool)#

Submit a paid asynchronous official Boltz structure-and-binding prediction. Requires a stable ide…

Boltz_start_structure_binding tool specification

Tool Information:

  • Name: Boltz_start_structure_binding

  • Type: BoltzAPITool

  • Description: Submit a paid asynchronous official Boltz structure-and-binding prediction. Requires a stable idempotency key to prevent duplicate billing; returns the account-scoped job ID and initial status.

Parameters:

  • input (unknown) (required) Official application-specific request object; follow the nested schema and discriminator fields exactly.

  • model (string) (optional) Official model identifier accepted by this endpoint.

  • idempotency_key (string) (required) Stable caller-generated key used to prevent duplicate submissions and duplicate billing.

  • workspace_id (string) (optional) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

Example Usage:

query = {
    "name": "Boltz_start_structure_binding",
    "arguments": {
        "input": "example_value",
        "idempotency_key": "example_value"
    }
}
result = tu.run(query)

Boltz_stop_experiment (Type: BoltzAPITool)#

Stop the remote pipeline recorded in an existing local official Boltz experiment directory. This …

Boltz_stop_experiment tool specification

Tool Information:

  • Name: Boltz_stop_experiment

  • Type: BoltzAPITool

  • Description: Stop the remote pipeline recorded in an existing local official Boltz experiment directory. This changes remote compute state and requires explicit confirmation.

Parameters:

  • run_dir (string) (optional) Existing local experiment directory created by an official Boltz run or start helper.

  • name (string) (optional) Experiment directory name under root_dir.

  • root_dir (string) (optional) Local directory where the official SDK creates the experiment folder and persists downloaded results.

  • quiet (boolean) (optional) Suppress official SDK progress output while waiting for the run to finish.

  • confirm (boolean) (required) confirm=true is required because stopping the local experiment changes remote compute state

Example Usage:

query = {
    "name": "Boltz_stop_experiment",
    "arguments": {
        "confirm": true
    }
}
result = tu.run(query)

Boltz_stop_protein_design (Type: BoltzAPITool)#

Stop an active official Boltz protein-design pipeline job. This changes remote compute state and …

Boltz_stop_protein_design tool specification

Tool Information:

  • Name: Boltz_stop_protein_design

  • Type: BoltzAPITool

  • Description: Stop an active official Boltz protein-design pipeline job. This changes remote compute state and requires explicit confirmation; already generated results remain queryable when supported.

Parameters:

  • id (string) (required) Account-scoped job or prediction ID returned by the matching start or list tool.

  • confirm (boolean) (required) confirm=true is required because stopping changes remote compute state

Example Usage:

query = {
    "name": "Boltz_stop_protein_design",
    "arguments": {
        "id": "example_value",
        "confirm": true
    }
}
result = tu.run(query)

Boltz_stop_protein_library_screen (Type: BoltzAPITool)#

Stop an active official Boltz protein-library screen job. This changes remote compute state and r…

Boltz_stop_protein_library_screen tool specification

Tool Information:

  • Name: Boltz_stop_protein_library_screen

  • Type: BoltzAPITool

  • Description: Stop an active official Boltz protein-library screen job. This changes remote compute state and requires explicit confirmation; already generated results remain queryable when supported.

Parameters:

  • id (string) (required) Account-scoped job or prediction ID returned by the matching start or list tool.

  • confirm (boolean) (required) confirm=true is required because stopping changes remote compute state

Example Usage:

query = {
    "name": "Boltz_stop_protein_library_screen",
    "arguments": {
        "id": "example_value",
        "confirm": true
    }
}
result = tu.run(query)

Boltz_stop_protein_sequence_redesign (Type: BoltzAPITool)#

Stop an active official Boltz protein sequence-redesign pipeline job. This changes remote compute…

Boltz_stop_protein_sequence_redesign tool specification

Tool Information:

  • Name: Boltz_stop_protein_sequence_redesign

  • Type: BoltzAPITool

  • Description: Stop an active official Boltz protein sequence-redesign pipeline job. This changes remote compute state and requires explicit confirmation; already generated results remain queryable when supported.

Parameters:

  • id (string) (required) Account-scoped job or prediction ID returned by the matching start or list tool.

  • confirm (boolean) (required) confirm=true is required because stopping changes remote compute state

Example Usage:

query = {
    "name": "Boltz_stop_protein_sequence_redesign",
    "arguments": {
        "id": "example_value",
        "confirm": true
    }
}
result = tu.run(query)

Boltz_stop_small_molecule_design (Type: BoltzAPITool)#

Stop an active official Boltz small-molecule design pipeline job. This changes remote compute sta…

Boltz_stop_small_molecule_design tool specification

Tool Information:

  • Name: Boltz_stop_small_molecule_design

  • Type: BoltzAPITool

  • Description: Stop an active official Boltz small-molecule design pipeline job. This changes remote compute state and requires explicit confirmation; already generated results remain queryable when supported.

Parameters:

  • id (string) (required) Account-scoped job or prediction ID returned by the matching start or list tool.

  • confirm (boolean) (required) confirm=true is required because stopping changes remote compute state

Example Usage:

query = {
    "name": "Boltz_stop_small_molecule_design",
    "arguments": {
        "id": "example_value",
        "confirm": true
    }
}
result = tu.run(query)

Boltz_stop_small_molecule_library_screen (Type: BoltzAPITool)#

Stop an active official Boltz small-molecule library screen job. This changes remote compute stat…

Boltz_stop_small_molecule_library_screen tool specification

Tool Information:

  • Name: Boltz_stop_small_molecule_library_screen

  • Type: BoltzAPITool

  • Description: Stop an active official Boltz small-molecule library screen job. This changes remote compute state and requires explicit confirmation; already generated results remain queryable when supported.

Parameters:

  • id (string) (required) Account-scoped job or prediction ID returned by the matching start or list tool.

  • confirm (boolean) (required) confirm=true is required because stopping changes remote compute state

Example Usage:

query = {
    "name": "Boltz_stop_small_molecule_library_screen",
    "arguments": {
        "id": "example_value",
        "confirm": true
    }
}
result = tu.run(query)

Boltz_update_workspace (Type: BoltzAPITool)#

Update an official Boltz workspace name or data-retention policy. Requires an admin API key and e…

Boltz_update_workspace tool specification

Tool Information:

  • Name: Boltz_update_workspace

  • Type: BoltzAPITool

  • Description: Update an official Boltz workspace name or data-retention policy. Requires an admin API key and explicit confirmation; omitted fields remain unchanged.

Parameters:

  • data_retention (unknown) (optional) Workspace result-retention duration using the official hours/days object.

  • name (unknown) (optional) Human-readable workspace or API-key name, depending on the operation.

  • workspace_id (string) (required) Workspace ID. Required as a path identifier for workspace operations; otherwise only needed with an admin key.

  • confirm (boolean) (required) confirm=true is required because this changes workspace configuration

Example Usage:

query = {
    "name": "Boltz_update_workspace",
    "arguments": {
        "workspace_id": "example_value",
        "confirm": true
    }
}
result = tu.run(query)

Boltz_wait_and_download_experiment (Type: BoltzAPITool)#

Resume an existing local official Boltz experiment, poll its remote job to a terminal state, and …

Boltz_wait_and_download_experiment tool specification

Tool Information:

  • Name: Boltz_wait_and_download_experiment

  • Type: BoltzAPITool

  • Description: Resume an existing local official Boltz experiment, poll its remote job to a terminal state, and download pending results. Identify the experiment with run_dir or with name plus optional root_dir.

Parameters:

  • run_dir (string) (optional) Existing local experiment directory created by an official Boltz run or start helper.

  • name (string) (optional) Experiment directory name under root_dir.

  • root_dir (string) (optional) Local directory where the official SDK creates the experiment folder and persists downloaded results.

  • quiet (boolean) (optional) Suppress official SDK progress output while waiting for the run to finish.

  • download_mode ([‘string’, ‘null’]) (optional) Result download mode for design and screening runs: everything or metadata_only.

  • poll_interval_seconds (number) (optional) Seconds between official SDK status polls while waiting for completion; must be greater than zero.

Example Usage:

query = {
    "name": "Boltz_wait_and_download_experiment",
    "arguments": {
    }
}
result = tu.run(query)