## Estimate Cost

`protein.library_screen.estimate_cost(LibraryScreenEstimateCostParams**kwargs)  -> LibraryScreenEstimateCostResponse`

**post** `/compute/v1/protein/library-screen/estimate-cost`

Estimate the cost of a protein library screen without creating any resource or consuming GPU.

### Parameters

- `proteins: Iterable[Protein]`

  List of protein entries to screen.

  - `entities: Iterable[ProteinEntity]`

    Entities that make up this protein complex

    - `class ProteinEntityProteinEntity: …`

      - `chain_ids: SequenceNotStr[str]`

        Chain IDs for this entity

      - `type: Literal["protein"]`

        - `"protein"`

      - `value: str`

        Amino acid sequence (one-letter codes)

      - `cyclic: Optional[bool]`

        Whether the sequence is cyclic

      - `modifications: Optional[Iterable[ProteinEntityProteinEntityModification]]`

        Post-translational modifications. Optional; defaults to an empty list when omitted.

        - `class ProteinEntityProteinEntityModificationCcdModification: …`

          - `residue_index: int`

            0-based index of the residue to modify

          - `type: Literal["ccd"]`

            - `"ccd"`

          - `value: str`

            CCD code from RCSB PDB (e.g. 'MSE' for selenomethionine, 'SEP' for phosphoserine)

        - `class ProteinEntityProteinEntityModificationSmilesModification: …`

          - `residue_index: int`

            0-based index of the residue to modify

          - `type: Literal["smiles"]`

            - `"smiles"`

          - `value: str`

            SMILES string for the modification

    - `class ProteinEntityRnaEntity: …`

      - `chain_ids: SequenceNotStr[str]`

        Chain IDs for this entity

      - `type: Literal["rna"]`

        - `"rna"`

      - `value: str`

        RNA nucleotide sequence (A, C, G, U, N)

      - `cyclic: Optional[bool]`

        Whether the sequence is cyclic

      - `modifications: Optional[Iterable[ProteinEntityRnaEntityModification]]`

        Chemical modifications. Optional; defaults to an empty list when omitted.

        - `class ProteinEntityRnaEntityModificationCcdModification: …`

          - `residue_index: int`

            0-based index of the residue to modify

          - `type: Literal["ccd"]`

            - `"ccd"`

          - `value: str`

            CCD code from RCSB PDB (e.g. 'MSE' for selenomethionine, 'SEP' for phosphoserine)

        - `class ProteinEntityRnaEntityModificationSmilesModification: …`

          - `residue_index: int`

            0-based index of the residue to modify

          - `type: Literal["smiles"]`

            - `"smiles"`

          - `value: str`

            SMILES string for the modification

    - `class ProteinEntityDnaEntity: …`

      - `chain_ids: SequenceNotStr[str]`

        Chain IDs for this entity

      - `type: Literal["dna"]`

        - `"dna"`

      - `value: str`

        DNA nucleotide sequence (A, C, G, T, N)

      - `cyclic: Optional[bool]`

        Whether the sequence is cyclic

      - `modifications: Optional[Iterable[ProteinEntityDnaEntityModification]]`

        Chemical modifications. Optional; defaults to an empty list when omitted.

        - `class ProteinEntityDnaEntityModificationCcdModification: …`

          - `residue_index: int`

            0-based index of the residue to modify

          - `type: Literal["ccd"]`

            - `"ccd"`

          - `value: str`

            CCD code from RCSB PDB (e.g. 'MSE' for selenomethionine, 'SEP' for phosphoserine)

        - `class ProteinEntityDnaEntityModificationSmilesModification: …`

          - `residue_index: int`

            0-based index of the residue to modify

          - `type: Literal["smiles"]`

            - `"smiles"`

          - `value: str`

            SMILES string for the modification

    - `class ProteinEntityLigandCcdEntity: …`

      - `chain_ids: SequenceNotStr[str]`

        Chain IDs for this ligand

      - `type: Literal["ligand_ccd"]`

        - `"ligand_ccd"`

      - `value: str`

        CCD code (e.g., ATP, ADP)

    - `class ProteinEntityLigandSmilesEntity: …`

      - `chain_ids: SequenceNotStr[str]`

        Chain IDs for this ligand

      - `type: Literal["ligand_smiles"]`

        - `"ligand_smiles"`

      - `value: str`

        SMILES string representing the ligand

  - `id: Optional[str]`

    Optional client-provided identifier for this entry

- `target: Target`

  Target specification (structure template or template-free)

  - `class TargetStructureTemplateTarget: …`

    Target defined by an uploaded 3D structure (CIF or PDB file). Only chains included in chain_selection are used.

    - `chain_selection: Dict[str, TargetStructureTemplateTargetChainSelection]`

      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 mapping are ignored. Each value defines which residues to keep, which are epitope residues, and which are flexible.

      - `class TargetStructureTemplateTargetChainSelectionStructureTemplateTargetPolymerChainSpec: …`

        Per-chain specification for a polymer (protein/RNA/DNA) chain in a structure template target.

        - `chain_type: Literal["polymer"]`

          - `"polymer"`

        - `crop_residues: Union[Iterable[int], Literal["all"]]`

          0-indexed residue indices to retain from this chain, or 'all' to keep all residues. Residues not listed are excluded from the engine run.

          - `Iterable[int]`

            0-indexed residue indices to keep

          - `Literal["all"]`

            - `"all"`

        - `epitope_residues: Optional[Iterable[int]]`

          0-indexed residue indices where binder contact is desired (the epitope). All indices must be present in crop_residues.

        - `flexible_residues: Optional[Iterable[int]]`

          0-indexed residue indices allowed to move during design (e.g. flexible loop regions). All indices must be present in crop_residues.

      - `class TargetStructureTemplateTargetChainSelectionStructureTemplateTargetLigandChainSpec: …`

        Per-chain specification for a ligand chain in a structure template target. The full ligand is always included.

        - `chain_type: Literal["ligand"]`

          - `"ligand"`

    - `structure: TargetStructureTemplateTargetStructure`

      How to provide a CIF structure file. URLs are auto-detected; base64 uploads must use chemical/x-cif media type.

      - `class TargetStructureTemplateTargetStructureURLSource: …`

        - `type: Literal["url"]`

          - `"url"`

        - `url: str`

      - `class TargetStructureTemplateTargetStructureCifBase64Source: …`

        - `data: str`

          Base64-encoded CIF file contents

        - `media_type: Literal["chemical/x-cif"]`

          Must be chemical/x-cif for CIF files

          - `"chemical/x-cif"`

        - `type: Literal["base64"]`

          - `"base64"`

    - `type: Literal["structure_template"]`

      - `"structure_template"`

  - `class TargetNoTemplateTarget: …`

    Target defined by sequences only, without a 3D structure template

    - `entities: Iterable[TargetNoTemplateTargetEntity]`

      Entities (proteins, RNA, DNA, ligands) defining the target complex.

      - `class TargetNoTemplateTargetEntityProteinEntity: …`

        - `chain_ids: SequenceNotStr[str]`

          Chain IDs for this entity

        - `type: Literal["protein"]`

          - `"protein"`

        - `value: str`

          Amino acid sequence (one-letter codes)

        - `cyclic: Optional[bool]`

          Whether the sequence is cyclic

        - `modifications: Optional[Iterable[TargetNoTemplateTargetEntityProteinEntityModification]]`

          Post-translational modifications. Optional; defaults to an empty list when omitted.

          - `class TargetNoTemplateTargetEntityProteinEntityModificationCcdModification: …`

            - `residue_index: int`

              0-based index of the residue to modify

            - `type: Literal["ccd"]`

              - `"ccd"`

            - `value: str`

              CCD code from RCSB PDB (e.g. 'MSE' for selenomethionine, 'SEP' for phosphoserine)

          - `class TargetNoTemplateTargetEntityProteinEntityModificationSmilesModification: …`

            - `residue_index: int`

              0-based index of the residue to modify

            - `type: Literal["smiles"]`

              - `"smiles"`

            - `value: str`

              SMILES string for the modification

      - `class TargetNoTemplateTargetEntityRnaEntity: …`

        - `chain_ids: SequenceNotStr[str]`

          Chain IDs for this entity

        - `type: Literal["rna"]`

          - `"rna"`

        - `value: str`

          RNA nucleotide sequence (A, C, G, U, N)

        - `cyclic: Optional[bool]`

          Whether the sequence is cyclic

        - `modifications: Optional[Iterable[TargetNoTemplateTargetEntityRnaEntityModification]]`

          Chemical modifications. Optional; defaults to an empty list when omitted.

          - `class TargetNoTemplateTargetEntityRnaEntityModificationCcdModification: …`

            - `residue_index: int`

              0-based index of the residue to modify

            - `type: Literal["ccd"]`

              - `"ccd"`

            - `value: str`

              CCD code from RCSB PDB (e.g. 'MSE' for selenomethionine, 'SEP' for phosphoserine)

          - `class TargetNoTemplateTargetEntityRnaEntityModificationSmilesModification: …`

            - `residue_index: int`

              0-based index of the residue to modify

            - `type: Literal["smiles"]`

              - `"smiles"`

            - `value: str`

              SMILES string for the modification

      - `class TargetNoTemplateTargetEntityDnaEntity: …`

        - `chain_ids: SequenceNotStr[str]`

          Chain IDs for this entity

        - `type: Literal["dna"]`

          - `"dna"`

        - `value: str`

          DNA nucleotide sequence (A, C, G, T, N)

        - `cyclic: Optional[bool]`

          Whether the sequence is cyclic

        - `modifications: Optional[Iterable[TargetNoTemplateTargetEntityDnaEntityModification]]`

          Chemical modifications. Optional; defaults to an empty list when omitted.

          - `class TargetNoTemplateTargetEntityDnaEntityModificationCcdModification: …`

            - `residue_index: int`

              0-based index of the residue to modify

            - `type: Literal["ccd"]`

              - `"ccd"`

            - `value: str`

              CCD code from RCSB PDB (e.g. 'MSE' for selenomethionine, 'SEP' for phosphoserine)

          - `class TargetNoTemplateTargetEntityDnaEntityModificationSmilesModification: …`

            - `residue_index: int`

              0-based index of the residue to modify

            - `type: Literal["smiles"]`

              - `"smiles"`

            - `value: str`

              SMILES string for the modification

      - `class TargetNoTemplateTargetEntityLigandCcdEntity: …`

        - `chain_ids: SequenceNotStr[str]`

          Chain IDs for this ligand

        - `type: Literal["ligand_ccd"]`

          - `"ligand_ccd"`

        - `value: str`

          CCD code (e.g., ATP, ADP)

      - `class TargetNoTemplateTargetEntityLigandSmilesEntity: …`

        - `chain_ids: SequenceNotStr[str]`

          Chain IDs for this ligand

        - `type: Literal["ligand_smiles"]`

          - `"ligand_smiles"`

        - `value: str`

          SMILES string representing the ligand

    - `type: Literal["no_template"]`

      - `"no_template"`

    - `bonds: Optional[Iterable[TargetNoTemplateTargetBond]]`

      Covalent bond constraints between atoms in the target complex. Atom-level ligand references currently support ligand_ccd only; ligand_smiles is unsupported.

      - `atom1: TargetNoTemplateTargetBondAtom1`

        Ligand atom reference. Atom-level ligand references currently support ligand_ccd entities only; ligand_smiles is unsupported.

        - `class TargetNoTemplateTargetBondAtom1LigandAtom: …`

          Ligand atom reference. Atom-level ligand references currently support ligand_ccd entities only; ligand_smiles is unsupported.

          - `atom_name: str`

            Standardized atom name (verifiable in CIF file on RCSB). Atom-level references to ligand_smiles entities are currently unsupported; use ligand_ccd instead.

          - `chain_id: str`

            Chain ID containing the atom

          - `type: Literal["ligand_atom"]`

            - `"ligand_atom"`

        - `class TargetNoTemplateTargetBondAtom1PolymerAtom: …`

          - `atom_name: str`

            Standardized atom name (verifiable in CIF file on RCSB)

          - `chain_id: str`

            Chain ID containing the atom

          - `residue_index: int`

            0-based residue index

          - `type: Literal["polymer_atom"]`

            - `"polymer_atom"`

      - `atom2: TargetNoTemplateTargetBondAtom2`

        Ligand atom reference. Atom-level ligand references currently support ligand_ccd entities only; ligand_smiles is unsupported.

        - `class TargetNoTemplateTargetBondAtom2LigandAtom: …`

          Ligand atom reference. Atom-level ligand references currently support ligand_ccd entities only; ligand_smiles is unsupported.

          - `atom_name: str`

            Standardized atom name (verifiable in CIF file on RCSB). Atom-level references to ligand_smiles entities are currently unsupported; use ligand_ccd instead.

          - `chain_id: str`

            Chain ID containing the atom

          - `type: Literal["ligand_atom"]`

            - `"ligand_atom"`

        - `class TargetNoTemplateTargetBondAtom2PolymerAtom: …`

          - `atom_name: str`

            Standardized atom name (verifiable in CIF file on RCSB)

          - `chain_id: str`

            Chain ID containing the atom

          - `residue_index: int`

            0-based residue index

          - `type: Literal["polymer_atom"]`

            - `"polymer_atom"`

    - `constraints: Optional[Iterable[TargetNoTemplateTargetConstraint]]`

      Structural constraints (pocket and contact). Atom-level ligand references currently support ligand_ccd only; ligand_smiles is unsupported.

      - `class TargetNoTemplateTargetConstraintPocketConstraint: …`

        Constrains the binder to interact with specific pocket residues on the target.

        - `binder_chain_id: str`

          Chain ID of the binder molecule

        - `contact_residues: Dict[str, Iterable[int]]`

          Binding pocket residues keyed by chain ID. Each key is a chain ID (e.g. "A") and the value is an array of 0-indexed residue indices that define the pocket on that chain.

        - `max_distance_angstrom: float`

          Maximum allowed distance in Angstroms between binder and pocket residues. Typical range: 4-8 A.

        - `type: Literal["pocket"]`

          - `"pocket"`

        - `force: Optional[bool]`

          Whether to force the constraint

      - `class TargetNoTemplateTargetConstraintContactConstraint: …`

        Contact constraint between two tokens. Atom-level ligand references currently support ligand_ccd entities only; ligand_smiles is unsupported.

        - `max_distance_angstrom: float`

          Maximum distance in Angstroms

        - `token1: TargetNoTemplateTargetConstraintContactConstraintToken1`

          Ligand contact token. Atom-level ligand references currently support ligand_ccd entities only; ligand_smiles is unsupported.

          - `class TargetNoTemplateTargetConstraintContactConstraintToken1PolymerContactToken: …`

            - `chain_id: str`

              Chain ID

            - `residue_index: int`

              0-based residue index

            - `type: Literal["polymer_contact"]`

              - `"polymer_contact"`

          - `class TargetNoTemplateTargetConstraintContactConstraintToken1LigandContactToken: …`

            Ligand contact token. Atom-level ligand references currently support ligand_ccd entities only; ligand_smiles is unsupported.

            - `atom_name: str`

              Atom name. Atom-level references to ligand_smiles entities are currently unsupported; use ligand_ccd instead.

            - `chain_id: str`

              Chain ID

            - `type: Literal["ligand_contact"]`

              - `"ligand_contact"`

        - `token2: TargetNoTemplateTargetConstraintContactConstraintToken2`

          Ligand contact token. Atom-level ligand references currently support ligand_ccd entities only; ligand_smiles is unsupported.

          - `class TargetNoTemplateTargetConstraintContactConstraintToken2PolymerContactToken: …`

            - `chain_id: str`

              Chain ID

            - `residue_index: int`

              0-based residue index

            - `type: Literal["polymer_contact"]`

              - `"polymer_contact"`

          - `class TargetNoTemplateTargetConstraintContactConstraintToken2LigandContactToken: …`

            Ligand contact token. Atom-level ligand references currently support ligand_ccd entities only; ligand_smiles is unsupported.

            - `atom_name: str`

              Atom name. Atom-level references to ligand_smiles entities are currently unsupported; use ligand_ccd instead.

            - `chain_id: str`

              Chain ID

            - `type: Literal["ligand_contact"]`

              - `"ligand_contact"`

        - `type: Literal["contact"]`

          - `"contact"`

        - `force: Optional[bool]`

          Whether to force the constraint

    - `epitope_ligand_chains: Optional[SequenceNotStr[str]]`

      Chain IDs of ligand entities that are part of the binding epitope. Ligands are marked as epitope in full (no residue-level selection).

    - `epitope_residues: Optional[Dict[str, Iterable[int]]]`

      Polymer chain residues where binder contact is desired (the epitope). Each key is a chain ID of a polymer entity, each value is an array of 0-indexed residue indices.

- `idempotency_key: Optional[str]`

  Client-provided key to prevent duplicate submissions on retries

- `workspace_id: Optional[str]`

  Target workspace ID (admin keys only; ignored for workspace keys)

### Returns

- `class LibraryScreenEstimateCostResponse: …`

  Estimate response with monetary values encoded as decimal strings to preserve precision.

  - `breakdown: Breakdown`

    Cost breakdown for the billed application.

    - `application: Literal["structure_and_binding", "small_molecule_design", "small_molecule_library_screen", 3 more]`

      - `"structure_and_binding"`

      - `"small_molecule_design"`

      - `"small_molecule_library_screen"`

      - `"protein_design"`

      - `"protein_library_screen"`

      - `"adme"`

    - `cost_per_unit_usd: str`

      Estimated cost per displayed unit as a decimal string, rounded up to 4 decimal places. This may include token-size multipliers or generation overhead; estimated_cost_usd is the authoritative total.

    - `num_units: int`

      Number of units shown for the estimate. For structure-and-binding, this is the requested number of samples. For protein and small-molecule design/screen endpoints, this is the requested number of proteins or molecules.

  - `disclaimer: str`

  - `estimated_cost_usd: str`

    Estimated total cost as a decimal string

### Example

```python
import os
from boltz_api import Boltz

client = Boltz(
    api_key=os.environ.get("BOLTZ_API_KEY"),  # This is the default and can be omitted
)
response = client.protein.library_screen.estimate_cost(
    proteins=[{
        "entities": [{
            "chain_ids": ["string"],
            "type": "protein",
            "value": "value",
        }]
    }],
    target={
        "chain_selection": {
            "A": {
                "chain_type": "polymer",
                "crop_residues": [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10, 11, 12],
            }
        },
        "structure": {
            "type": "url",
            "url": "https://example.com",
        },
        "type": "structure_template",
    },
)
print(response.breakdown)
```
