## Retrieve

`client.Protein.LibraryScreen.Get(ctx, id, query) (*ProteinLibraryScreenGetResponse, error)`

**get** `/compute/v1/protein/library-screen/{id}`

Retrieve a library screen by ID, including progress and status

### Parameters

- `id string`

- `query ProteinLibraryScreenGetParams`

  - `WorkspaceID param.Field[string]`

    Workspace ID. Only used with admin API keys. Ignored (or validated) for workspace-scoped keys.

### Returns

- `type ProteinLibraryScreenGetResponse struct{…}`

  A protein library screening engine run

  - `ID string`

    Unique ProteinLibraryScreen identifier

  - `CompletedAt Time`

  - `CreatedAt Time`

  - `DataDeletedAt Time`

    When the input, output, and result data was permanently deleted. Null if data has not been deleted.

  - `Engine BoltzProteinScreen`

    Engine used for protein library screen

    - `const BoltzProteinScreenBoltzProteinScreen BoltzProteinScreen = "boltz-protein-screen"`

  - `EngineVersion string`

    Engine version used for protein library screen

  - `Error ProteinLibraryScreenGetResponseError`

    - `Code string`

      Machine-readable error code

    - `Message string`

      Human-readable error message

    - `Details any`

      Additional field-level error details keyed by input path, when available.

  - `Input ProteinLibraryScreenGetResponseInput`

    Pipeline input (null if data deleted)

    - `Proteins ProteinLibraryScreenGetResponseInputProteins`

      - `URL string`

        URL to download the file

      - `URLExpiresAt Time`

        When the presigned URL expires

    - `Target ProteinLibraryScreenGetResponseInputTargetUnion`

      Target specification (structure template or template-free)

      - `type ProteinLibraryScreenGetResponseInputTargetStructureTemplateTargetResponse struct{…}`

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

        - `ChainSelection map[string, ProteinLibraryScreenGetResponseInputTargetStructureTemplateTargetResponseChainSelectionUnion]`

          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.

          - `type ProteinLibraryScreenGetResponseInputTargetStructureTemplateTargetResponseChainSelectionStructureTemplateTargetPolymerChainSpec struct{…}`

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

            - `ChainType Polymer`

              - `const PolymerPolymer Polymer = "polymer"`

            - `CropResidues ProteinLibraryScreenGetResponseInputTargetStructureTemplateTargetResponseChainSelectionStructureTemplateTargetPolymerChainSpecCropResiduesUnion`

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

              - `type ProteinLibraryScreenGetResponseInputTargetStructureTemplateTargetResponseChainSelectionStructureTemplateTargetPolymerChainSpecCropResiduesArray []int64`

                0-indexed residue indices to keep

              - `type All string`

                - `const AllAll All = "all"`

            - `EpitopeResidues []int64`

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

            - `FlexibleResidues []int64`

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

          - `type ProteinLibraryScreenGetResponseInputTargetStructureTemplateTargetResponseChainSelectionStructureTemplateTargetLigandChainSpec struct{…}`

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

            - `ChainType Ligand`

              - `const LigandLigand Ligand = "ligand"`

        - `Structure ProteinLibraryScreenGetResponseInputTargetStructureTemplateTargetResponseStructure`

          - `URL string`

            URL to download the file

          - `URLExpiresAt Time`

            When the presigned URL expires

        - `Type StructureTemplate`

          - `const StructureTemplateStructureTemplate StructureTemplate = "structure_template"`

      - `type ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponse struct{…}`

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

        - `Entities []ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseEntityUnion`

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

          - `type ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseEntityProteinEntityResponse struct{…}`

            - `ChainIDs []string`

              Chain IDs for this entity

            - `Type Protein`

              - `const ProteinProtein Protein = "protein"`

            - `Value string`

              Amino acid sequence (one-letter codes)

            - `Cyclic bool`

              Whether the sequence is cyclic

            - `Modifications []ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseEntityProteinEntityResponseModificationUnion`

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

              - `type ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseEntityProteinEntityResponseModificationCcdModificationResponse struct{…}`

                - `ResidueIndex int64`

                  0-based index of the residue to modify

                - `Type Ccd`

                  - `const CcdCcd Ccd = "ccd"`

                - `Value string`

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

              - `type ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseEntityProteinEntityResponseModificationSmilesModificationResponse struct{…}`

                - `ResidueIndex int64`

                  0-based index of the residue to modify

                - `Type Smiles`

                  - `const SmilesSmiles Smiles = "smiles"`

                - `Value string`

                  SMILES string for the modification

          - `type ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseEntityRnaEntityResponse struct{…}`

            - `ChainIDs []string`

              Chain IDs for this entity

            - `Type Rna`

              - `const RnaRna Rna = "rna"`

            - `Value string`

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

            - `Cyclic bool`

              Whether the sequence is cyclic

            - `Modifications []ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseEntityRnaEntityResponseModificationUnion`

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

              - `type ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseEntityRnaEntityResponseModificationCcdModificationResponse struct{…}`

                - `ResidueIndex int64`

                  0-based index of the residue to modify

                - `Type Ccd`

                  - `const CcdCcd Ccd = "ccd"`

                - `Value string`

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

              - `type ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseEntityRnaEntityResponseModificationSmilesModificationResponse struct{…}`

                - `ResidueIndex int64`

                  0-based index of the residue to modify

                - `Type Smiles`

                  - `const SmilesSmiles Smiles = "smiles"`

                - `Value string`

                  SMILES string for the modification

          - `type ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseEntityDnaEntityResponse struct{…}`

            - `ChainIDs []string`

              Chain IDs for this entity

            - `Type Dna`

              - `const DnaDna Dna = "dna"`

            - `Value string`

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

            - `Cyclic bool`

              Whether the sequence is cyclic

            - `Modifications []ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseEntityDnaEntityResponseModificationUnion`

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

              - `type ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseEntityDnaEntityResponseModificationCcdModificationResponse struct{…}`

                - `ResidueIndex int64`

                  0-based index of the residue to modify

                - `Type Ccd`

                  - `const CcdCcd Ccd = "ccd"`

                - `Value string`

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

              - `type ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseEntityDnaEntityResponseModificationSmilesModificationResponse struct{…}`

                - `ResidueIndex int64`

                  0-based index of the residue to modify

                - `Type Smiles`

                  - `const SmilesSmiles Smiles = "smiles"`

                - `Value string`

                  SMILES string for the modification

          - `type ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseEntityLigandCcdEntityResponse struct{…}`

            - `ChainIDs []string`

              Chain IDs for this ligand

            - `Type LigandCcd`

              - `const LigandCcdLigandCcd LigandCcd = "ligand_ccd"`

            - `Value string`

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

          - `type ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseEntityLigandSmilesEntityResponse struct{…}`

            - `ChainIDs []string`

              Chain IDs for this ligand

            - `Type LigandSmiles`

              - `const LigandSmilesLigandSmiles LigandSmiles = "ligand_smiles"`

            - `Value string`

              SMILES string representing the ligand

        - `Type NoTemplate`

          - `const NoTemplateNoTemplate NoTemplate = "no_template"`

        - `Bonds []ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseBond`

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

          - `Atom1 ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseBondAtom1Union`

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

            - `type ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseBondAtom1LigandAtomResponse struct{…}`

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

              - `AtomName string`

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

              - `ChainID string`

                Chain ID containing the atom

              - `Type LigandAtom`

                - `const LigandAtomLigandAtom LigandAtom = "ligand_atom"`

            - `type ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseBondAtom1PolymerAtomResponse struct{…}`

              - `AtomName string`

                Standardized atom name (verifiable in CIF file on RCSB)

              - `ChainID string`

                Chain ID containing the atom

              - `ResidueIndex int64`

                0-based residue index

              - `Type PolymerAtom`

                - `const PolymerAtomPolymerAtom PolymerAtom = "polymer_atom"`

          - `Atom2 ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseBondAtom2Union`

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

            - `type ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseBondAtom2LigandAtomResponse struct{…}`

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

              - `AtomName string`

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

              - `ChainID string`

                Chain ID containing the atom

              - `Type LigandAtom`

                - `const LigandAtomLigandAtom LigandAtom = "ligand_atom"`

            - `type ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseBondAtom2PolymerAtomResponse struct{…}`

              - `AtomName string`

                Standardized atom name (verifiable in CIF file on RCSB)

              - `ChainID string`

                Chain ID containing the atom

              - `ResidueIndex int64`

                0-based residue index

              - `Type PolymerAtom`

                - `const PolymerAtomPolymerAtom PolymerAtom = "polymer_atom"`

        - `Constraints []ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseConstraintUnion`

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

          - `type ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseConstraintPocketConstraintResponse struct{…}`

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

            - `BinderChainID string`

              Chain ID of the binder molecule

            - `ContactResidues map[string, []int64]`

              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.

            - `MaxDistanceAngstrom float64`

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

            - `Type Pocket`

              - `const PocketPocket Pocket = "pocket"`

            - `Force bool`

              Whether to force the constraint

          - `type ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseConstraintContactConstraintResponse struct{…}`

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

            - `MaxDistanceAngstrom float64`

              Maximum distance in Angstroms

            - `Token1 ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseConstraintContactConstraintResponseToken1Union`

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

              - `type ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseConstraintContactConstraintResponseToken1PolymerContactTokenResponse struct{…}`

                - `ChainID string`

                  Chain ID

                - `ResidueIndex int64`

                  0-based residue index

                - `Type PolymerContact`

                  - `const PolymerContactPolymerContact PolymerContact = "polymer_contact"`

              - `type ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseConstraintContactConstraintResponseToken1LigandContactTokenResponse struct{…}`

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

                - `AtomName string`

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

                - `ChainID string`

                  Chain ID

                - `Type LigandContact`

                  - `const LigandContactLigandContact LigandContact = "ligand_contact"`

            - `Token2 ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseConstraintContactConstraintResponseToken2Union`

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

              - `type ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseConstraintContactConstraintResponseToken2PolymerContactTokenResponse struct{…}`

                - `ChainID string`

                  Chain ID

                - `ResidueIndex int64`

                  0-based residue index

                - `Type PolymerContact`

                  - `const PolymerContactPolymerContact PolymerContact = "polymer_contact"`

              - `type ProteinLibraryScreenGetResponseInputTargetNoTemplateTargetResponseConstraintContactConstraintResponseToken2LigandContactTokenResponse struct{…}`

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

                - `AtomName string`

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

                - `ChainID string`

                  Chain ID

                - `Type LigandContact`

                  - `const LigandContactLigandContact LigandContact = "ligand_contact"`

            - `Type Contact`

              - `const ContactContact Contact = "contact"`

            - `Force bool`

              Whether to force the constraint

        - `EpitopeLigandChains []string`

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

        - `EpitopeResidues map[string, []int64]`

          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.

  - `Livemode bool`

    Whether this resource was created with a live API key.

  - `Progress ProteinLibraryScreenGetResponseProgress`

    - `NumProteinsFailed int64`

      Number of accepted proteins that reached terminal failure during screening.

    - `NumProteinsScreened int64`

      Number of accepted proteins that produced usable screening results.

    - `TotalProteinsToScreen int64`

      Total number of proteins accepted into the screening run.

    - `LatestResultID string`

      ID of the latest result

  - `StartedAt Time`

  - `Status ProteinLibraryScreenGetResponseStatus`

    - `const ProteinLibraryScreenGetResponseStatusPending ProteinLibraryScreenGetResponseStatus = "pending"`

    - `const ProteinLibraryScreenGetResponseStatusRunning ProteinLibraryScreenGetResponseStatus = "running"`

    - `const ProteinLibraryScreenGetResponseStatusSucceeded ProteinLibraryScreenGetResponseStatus = "succeeded"`

    - `const ProteinLibraryScreenGetResponseStatusFailed ProteinLibraryScreenGetResponseStatus = "failed"`

    - `const ProteinLibraryScreenGetResponseStatusStopped ProteinLibraryScreenGetResponseStatus = "stopped"`

  - `StoppedAt Time`

  - `WorkspaceID string`

    Workspace ID

  - `IdempotencyKey string`

    Client-provided idempotency key

### Example

```go
package main

import (
  "context"
  "fmt"

  "github.com/boltz-bio/boltz-api-go"
  "github.com/boltz-bio/boltz-api-go/option"
)

func main() {
  client := boltzapi.NewClient(
    option.WithAPIKey("My API Key"),
  )
  libraryScreen, err := client.Protein.LibraryScreen.Get(
    context.TODO(),
    "id",
    boltzapi.ProteinLibraryScreenGetParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", libraryScreen.ID)
}
```