Skip to content
Go to Boltz API

List curated protein design specifications

client.Protein.Design.ListCuratedSpecifications(ctx, query) (*ProteinDesignListCuratedSpecificationsResponse, error)
GET/compute/v1/protein/design/curated-specifications

List binder-side protein design specifications from Boltz-managed curated nanobody or antibody libraries.

ParametersExpand Collapse
query ProteinDesignListCuratedSpecificationsParams

Curated binder library to retrieve.

const ProteinDesignListCuratedSpecificationsParamsTypeNanobody ProteinDesignListCuratedSpecificationsParamsType = "nanobody"
const ProteinDesignListCuratedSpecificationsParamsTypeAntibody ProteinDesignListCuratedSpecificationsParamsType = "antibody"
ReturnsExpand Collapse
type ProteinDesignListCuratedSpecificationsResponse struct{…}
Data []ProteinDesignListCuratedSpecificationsResponseData
BinderSpecification ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUnion

Binder specification for protein design. Use no_template for sequence-defined binders, structure_template for uploaded binder structures, boltz_curated for Boltz-managed nanobody and antibody defaults, or uniformly_sampled_specifications to sample uniformly across multiple binder specifications.

One of the following:
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpec struct{…}

Binder specification starting from an existing 3D structure. Upload a CIF/PDB file and select which chains to include, which residues to keep, and which regions to redesign. Only chains included in chain_selection are part of the pipeline run.

ChainSelection map[string, ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpecChainSelectionUnion]

Chains selected from the uploaded binder structure, keyed by chain ID. Only chains listed here are included in the pipeline run — any chains omitted from this mapping are ignored. Each value defines which residues to keep (crop_residues). Omit design_motifs to include the chain as fixed scaffold context.

One of the following:
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpecChainSelectionStructureTemplatePolymerChainSpec struct{…}

Per-chain crop and design specification for a polymer chain in structure_template mode.

ChainType Polymer
CropResidues ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpecChainSelectionStructureTemplatePolymerChainSpecCropResiduesUnion

0-indexed residue indices to retain from this chain, or ‘all’ to keep all residues. Residues not listed are removed before design.

One of the following:
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpecChainSelectionStructureTemplatePolymerChainSpecCropResiduesArray []int64
type All string
DesignMotifs []ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpecChainSelectionStructureTemplatePolymerChainSpecDesignMotifUnionOptional

Optional motifs (replacement or insertion) defining which regions to redesign on this chain. Omit this field to include the chain as fixed scaffold context.

One of the following:
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpecChainSelectionStructureTemplatePolymerChainSpecDesignMotifReplacementMotif struct{…}

Replace a contiguous region of the sequence with a designed segment. Residues from start_index to end_index (inclusive) are replaced with a new sequence of the specified length.

DesignLengthRange ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpecChainSelectionStructureTemplatePolymerChainSpecDesignMotifReplacementMotifDesignLengthRange

Allowed sequence length range for designed regions

Max int64

Maximum sequence length in residues. Must be >= min.

minimum0
Min int64

Minimum sequence length in residues

minimum0
EndIndex int64

0-indexed end residue (inclusive)

minimum0
StartIndex int64

0-indexed start residue (inclusive)

minimum0
Type Replacement
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpecChainSelectionStructureTemplatePolymerChainSpecDesignMotifInsertionMotif struct{…}

Insert a designed segment at a specific position in the sequence.

AfterResidueIndex int64

0-indexed position after which to insert. Use -1 to insert before the first residue.

minimum-1
DesignLengthRange ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpecChainSelectionStructureTemplatePolymerChainSpecDesignMotifInsertionMotifDesignLengthRange

Allowed sequence length range for designed regions

Max int64

Maximum sequence length in residues. Must be >= min.

minimum0
Min int64

Minimum sequence length in residues

minimum0
Type Insertion
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpecChainSelectionStructureTemplateLigandChainSpec struct{…}

Per-chain specification for a ligand chain in structure_template mode. The full ligand is always included.

ChainType Ligand
Modality ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpecModality
One of the following:
const ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpecModalityPeptide ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpecModality = "peptide"
const ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpecModalityAntibody ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpecModality = "antibody"
const ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpecModalityNanobody ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpecModality = "nanobody"
const ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpecModalityCustomProtein ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpecModality = "custom_protein"
Structure ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpecStructureUnion

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

One of the following:
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpecStructureURLSource struct{…}
Type URL
URL string
formaturi
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpecStructureCifBase64Source struct{…}
Data string

Base64-encoded CIF file contents

MediaType ChemicalXCif

Must be chemical/x-cif for CIF files

Type Base64
Type StructureTemplate
Rules ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpecRulesOptional

Constraints applied during sequence design

ExcludedAminoAcids []stringOptional

Single-letter amino acid codes to exclude from design (e.g. [‘C’, ‘P’] to exclude cysteine and proline)

ExcludedSequenceMotifs []stringOptional

Sequence motifs to exclude from designed regions. Designs containing any of these motifs are filtered out before scoring. Use X as a single-residue wildcard (e.g. “NGS”, “NXS”).

MaxHydrophobicFraction float64Optional

Maximum allowed fraction of hydrophobic residues (I, L, V, M, F, W, Y) in designed regions. Designs exceeding this threshold are filtered out before scoring. Leave empty to disable.

minimum0
maximum1
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpec struct{…}

Binder specification without a structural template. Define the binder from sequence components (fixed and designed segments) without providing a starting 3D structure.

Entities []ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecEntityUnion

Binder entities composing the design. At least one must be a designed_protein entity. Additional fixed entities (RNA, DNA, ligands) can be included as part of the complex.

One of the following:
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecEntityDesignedProteinEntity struct{…}

Protein binder entity with designed and/or fixed segments.

ChainIDs []string

Chain IDs to assign to this entity

Type DesignedProtein
Value string

Binder sequence specification. Fixed amino acids are written as literal single-letter codes. Designed regions are written as a length (fixed) or a length range (min..max). Example: “MKTAYI5..10VKSHFSRQ” means fixed MKTAYI, then 5-10 designed residues, then fixed VKSHFSRQ. “20” means 20 fully designed residues. “ACDE8GHI” means fixed ACDE, then 8 designed residues, then fixed GHI.

Cyclic boolOptional

Whether the sequence is cyclic

Modifications []ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecEntityDesignedProteinEntityModificationOptional

Optional CCD polymer modifications. Defaults to [] when omitted. SMILES modifications are not supported.

ResidueIndex int64

0-based index of the residue to modify

minimum0
Type Ccd

Modification format. Only CCD polymer modifications are supported.

Value string

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

type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecEntityFixedProteinEntity struct{…}

A fixed protein entity whose sequence is not redesigned.

ChainIDs []string

Chain IDs to assign to this entity

Type Protein
Value string

Amino acid sequence (one-letter codes)

Cyclic boolOptional

Whether the sequence is cyclic

Modifications []ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecEntityFixedProteinEntityModificationOptional

Optional CCD polymer modifications. Defaults to [] when omitted. SMILES modifications are not supported.

ResidueIndex int64

0-based index of the residue to modify

minimum0
Type Ccd

Modification format. Only CCD polymer modifications are supported.

Value string

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

type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecEntityFixedRnaEntity struct{…}
ChainIDs []string

Chain IDs to assign to this entity

Type Rna
Value string

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

Cyclic boolOptional

Whether the sequence is cyclic

Modifications []ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecEntityFixedRnaEntityModificationOptional

Optional CCD polymer modifications. Defaults to [] when omitted. SMILES modifications are not supported.

ResidueIndex int64

0-based index of the residue to modify

minimum0
Type Ccd

Modification format. Only CCD polymer modifications are supported.

Value string

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

type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecEntityFixedDnaEntity struct{…}
ChainIDs []string

Chain IDs to assign to this entity

Type Dna
Value string

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

Cyclic boolOptional

Whether the sequence is cyclic

Modifications []ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecEntityFixedDnaEntityModificationOptional

Optional CCD polymer modifications. Defaults to [] when omitted. SMILES modifications are not supported.

ResidueIndex int64

0-based index of the residue to modify

minimum0
Type Ccd

Modification format. Only CCD polymer modifications are supported.

Value string

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

type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecEntityFixedLigandSmilesEntity struct{…}
ChainIDs []string

Chain IDs to assign to this entity

Type LigandSmiles
Value string

SMILES string representing the ligand

type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecEntityFixedLigandCcdEntity struct{…}
ChainIDs []string

Chain IDs to assign to this entity

Type LigandCcd
Value string

CCD code from RCSB PDB (e.g. ‘ATP’, ‘ADP’)

Modality ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecModality
One of the following:
const ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecModalityPeptide ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecModality = "peptide"
const ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecModalityAntibody ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecModality = "antibody"
const ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecModalityNanobody ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecModality = "nanobody"
const ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecModalityCustomProtein ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecModality = "custom_protein"
Type NoTemplate
Bonds []ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecBondOptional

Covalent bond constraints between atoms in the binder complex. If defining bonds where an atom is part of a designed protein chain, assume residue indices count designed regions as the minimum length. Example: designed protein “1..3C1..2”, “C” is residue 1 (0-indexed) of the designed protein.

Atom1 ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecBondAtom1Union

Ligand atom reference for a CCD atom or an explicitly atom-mapped SMILES atom.

One of the following:
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecBondAtom1LigandAtom struct{…}

Ligand atom reference for a CCD atom or an explicitly atom-mapped SMILES atom.

AtomName string

Atom name. For ligand_ccd, use the standardized CIF atom name. For ligand_smiles, explicitly label the atom with numeric atom-map notation: [C:1] is referenced as C1 and [O:2] as O2. The resulting name must be unique within the molecule and at most four characters.

ChainID string

Chain ID containing the atom

Type LigandAtom
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecBondAtom1PolymerAtom 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

minimum0
Type PolymerAtom
Atom2 ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecBondAtom2Union

Ligand atom reference for a CCD atom or an explicitly atom-mapped SMILES atom.

One of the following:
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecBondAtom2LigandAtom struct{…}

Ligand atom reference for a CCD atom or an explicitly atom-mapped SMILES atom.

AtomName string

Atom name. For ligand_ccd, use the standardized CIF atom name. For ligand_smiles, explicitly label the atom with numeric atom-map notation: [C:1] is referenced as C1 and [O:2] as O2. The resulting name must be unique within the molecule and at most four characters.

ChainID string

Chain ID containing the atom

Type LigandAtom
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecBondAtom2PolymerAtom 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

minimum0
Type PolymerAtom
Rules ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecRulesOptional

Constraints applied during sequence design

ExcludedAminoAcids []stringOptional

Single-letter amino acid codes to exclude from design (e.g. [‘C’, ‘P’] to exclude cysteine and proline)

ExcludedSequenceMotifs []stringOptional

Sequence motifs to exclude from designed regions. Designs containing any of these motifs are filtered out before scoring. Use X as a single-residue wildcard (e.g. “NGS”, “NXS”).

MaxHydrophobicFraction float64Optional

Maximum allowed fraction of hydrophobic residues (I, L, V, M, F, W, Y) in designed regions. Designs exceeding this threshold are filtered out before scoring. Leave empty to disable.

minimum0
maximum1
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationBoltzCuratedBinderSpec struct{…}

Boltz-managed curated binder specification. Choose a curated nanobody or antibody family and Boltz will select from maintained template lists during design. The curated lists are managed by Boltz and may be updated over time to improve quality and coverage.

Binder ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationBoltzCuratedBinderSpecBinder

Boltz-managed curated binder family. Boltz maintains and may update the underlying template lists on behalf of customers.

One of the following:
const ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationBoltzCuratedBinderSpecBinderBoltzNanobody ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationBoltzCuratedBinderSpecBinder = "boltz_nanobody"
const ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationBoltzCuratedBinderSpecBinderBoltzAntibody ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationBoltzCuratedBinderSpecBinder = "boltz_antibody"
Type BoltzCurated
Rules ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationBoltzCuratedBinderSpecRulesOptional

Constraints applied during sequence design

ExcludedAminoAcids []stringOptional

Single-letter amino acid codes to exclude from design (e.g. [‘C’, ‘P’] to exclude cysteine and proline)

ExcludedSequenceMotifs []stringOptional

Sequence motifs to exclude from designed regions. Designs containing any of these motifs are filtered out before scoring. Use X as a single-residue wildcard (e.g. “NGS”, “NXS”).

MaxHydrophobicFraction float64Optional

Maximum allowed fraction of hydrophobic residues (I, L, V, M, F, W, Y) in designed regions. Designs exceeding this threshold are filtered out before scoring. Leave empty to disable.

minimum0
maximum1
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpec struct{…}

A collection of binder specifications sampled uniformly during protein design. This lets one run explore multiple binder definitions while keeping each generation request shape unchanged.

BinderSpecifications []ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationUnion

Binder specifications to sample uniformly when generating designs. Each generation samples one specification from this list; over larger runs this gives roughly equal representation.

One of the following:
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpec struct{…}

Binder specification starting from an existing 3D structure. Upload a CIF/PDB file and select which chains to include, which residues to keep, and which regions to redesign. Only chains included in chain_selection are part of the pipeline run.

ChainSelection map[string, ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecChainSelectionUnion]

Chains selected from the uploaded binder structure, keyed by chain ID. Only chains listed here are included in the pipeline run — any chains omitted from this mapping are ignored. Each value defines which residues to keep (crop_residues). Omit design_motifs to include the chain as fixed scaffold context.

One of the following:
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecChainSelectionStructureTemplatePolymerChainSpec struct{…}

Per-chain crop and design specification for a polymer chain in structure_template mode.

ChainType Polymer
CropResidues ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecChainSelectionStructureTemplatePolymerChainSpecCropResiduesUnion

0-indexed residue indices to retain from this chain, or ‘all’ to keep all residues. Residues not listed are removed before design.

One of the following:
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecChainSelectionStructureTemplatePolymerChainSpecCropResiduesArray []int64
type All string
DesignMotifs []ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecChainSelectionStructureTemplatePolymerChainSpecDesignMotifUnionOptional

Optional motifs (replacement or insertion) defining which regions to redesign on this chain. Omit this field to include the chain as fixed scaffold context.

One of the following:
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecChainSelectionStructureTemplatePolymerChainSpecDesignMotifReplacementMotif struct{…}

Replace a contiguous region of the sequence with a designed segment. Residues from start_index to end_index (inclusive) are replaced with a new sequence of the specified length.

DesignLengthRange ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecChainSelectionStructureTemplatePolymerChainSpecDesignMotifReplacementMotifDesignLengthRange

Allowed sequence length range for designed regions

Max int64

Maximum sequence length in residues. Must be >= min.

minimum0
Min int64

Minimum sequence length in residues

minimum0
EndIndex int64

0-indexed end residue (inclusive)

minimum0
StartIndex int64

0-indexed start residue (inclusive)

minimum0
Type Replacement
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecChainSelectionStructureTemplatePolymerChainSpecDesignMotifInsertionMotif struct{…}

Insert a designed segment at a specific position in the sequence.

AfterResidueIndex int64

0-indexed position after which to insert. Use -1 to insert before the first residue.

minimum-1
DesignLengthRange ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecChainSelectionStructureTemplatePolymerChainSpecDesignMotifInsertionMotifDesignLengthRange

Allowed sequence length range for designed regions

Max int64

Maximum sequence length in residues. Must be >= min.

minimum0
Min int64

Minimum sequence length in residues

minimum0
Type Insertion
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecChainSelectionStructureTemplateLigandChainSpec struct{…}

Per-chain specification for a ligand chain in structure_template mode. The full ligand is always included.

ChainType Ligand
Modality ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecModality
One of the following:
const ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecModalityPeptide ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecModality = "peptide"
const ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecModalityAntibody ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecModality = "antibody"
const ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecModalityNanobody ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecModality = "nanobody"
const ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecModalityCustomProtein ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecModality = "custom_protein"
Structure ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecStructureUnion

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

One of the following:
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecStructureURLSource struct{…}
Type URL
URL string
formaturi
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecStructureCifBase64Source struct{…}
Data string

Base64-encoded CIF file contents

MediaType ChemicalXCif

Must be chemical/x-cif for CIF files

Type Base64
Type StructureTemplate
Rules ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecRulesOptional

Constraints applied during sequence design

ExcludedAminoAcids []stringOptional

Single-letter amino acid codes to exclude from design (e.g. [‘C’, ‘P’] to exclude cysteine and proline)

ExcludedSequenceMotifs []stringOptional

Sequence motifs to exclude from designed regions. Designs containing any of these motifs are filtered out before scoring. Use X as a single-residue wildcard (e.g. “NGS”, “NXS”).

MaxHydrophobicFraction float64Optional

Maximum allowed fraction of hydrophobic residues (I, L, V, M, F, W, Y) in designed regions. Designs exceeding this threshold are filtered out before scoring. Leave empty to disable.

minimum0
maximum1
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpec struct{…}

Binder specification without a structural template. Define the binder from sequence components (fixed and designed segments) without providing a starting 3D structure.

Entities []ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecEntityUnion

Binder entities composing the design. At least one must be a designed_protein entity. Additional fixed entities (RNA, DNA, ligands) can be included as part of the complex.

One of the following:
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecEntityDesignedProteinEntity struct{…}

Protein binder entity with designed and/or fixed segments.

ChainIDs []string

Chain IDs to assign to this entity

Type DesignedProtein
Value string

Binder sequence specification. Fixed amino acids are written as literal single-letter codes. Designed regions are written as a length (fixed) or a length range (min..max). Example: “MKTAYI5..10VKSHFSRQ” means fixed MKTAYI, then 5-10 designed residues, then fixed VKSHFSRQ. “20” means 20 fully designed residues. “ACDE8GHI” means fixed ACDE, then 8 designed residues, then fixed GHI.

Cyclic boolOptional

Whether the sequence is cyclic

Modifications []ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecEntityDesignedProteinEntityModificationOptional

Optional CCD polymer modifications. Defaults to [] when omitted. SMILES modifications are not supported.

ResidueIndex int64

0-based index of the residue to modify

minimum0
Type Ccd

Modification format. Only CCD polymer modifications are supported.

Value string

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

type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecEntityFixedProteinEntity struct{…}

A fixed protein entity whose sequence is not redesigned.

ChainIDs []string

Chain IDs to assign to this entity

Type Protein
Value string

Amino acid sequence (one-letter codes)

Cyclic boolOptional

Whether the sequence is cyclic

Modifications []ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecEntityFixedProteinEntityModificationOptional

Optional CCD polymer modifications. Defaults to [] when omitted. SMILES modifications are not supported.

ResidueIndex int64

0-based index of the residue to modify

minimum0
Type Ccd

Modification format. Only CCD polymer modifications are supported.

Value string

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

type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecEntityFixedRnaEntity struct{…}
ChainIDs []string

Chain IDs to assign to this entity

Type Rna
Value string

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

Cyclic boolOptional

Whether the sequence is cyclic

Modifications []ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecEntityFixedRnaEntityModificationOptional

Optional CCD polymer modifications. Defaults to [] when omitted. SMILES modifications are not supported.

ResidueIndex int64

0-based index of the residue to modify

minimum0
Type Ccd

Modification format. Only CCD polymer modifications are supported.

Value string

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

type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecEntityFixedDnaEntity struct{…}
ChainIDs []string

Chain IDs to assign to this entity

Type Dna
Value string

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

Cyclic boolOptional

Whether the sequence is cyclic

Modifications []ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecEntityFixedDnaEntityModificationOptional

Optional CCD polymer modifications. Defaults to [] when omitted. SMILES modifications are not supported.

ResidueIndex int64

0-based index of the residue to modify

minimum0
Type Ccd

Modification format. Only CCD polymer modifications are supported.

Value string

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

type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecEntityFixedLigandSmilesEntity struct{…}
ChainIDs []string

Chain IDs to assign to this entity

Type LigandSmiles
Value string

SMILES string representing the ligand

type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecEntityFixedLigandCcdEntity struct{…}
ChainIDs []string

Chain IDs to assign to this entity

Type LigandCcd
Value string

CCD code from RCSB PDB (e.g. ‘ATP’, ‘ADP’)

Modality ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecModality
One of the following:
const ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecModalityPeptide ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecModality = "peptide"
const ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecModalityAntibody ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecModality = "antibody"
const ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecModalityNanobody ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecModality = "nanobody"
const ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecModalityCustomProtein ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecModality = "custom_protein"
Type NoTemplate
Bonds []ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecBondOptional

Covalent bond constraints between atoms in the binder complex. If defining bonds where an atom is part of a designed protein chain, assume residue indices count designed regions as the minimum length. Example: designed protein “1..3C1..2”, “C” is residue 1 (0-indexed) of the designed protein.

Atom1 ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecBondAtom1Union

Ligand atom reference for a CCD atom or an explicitly atom-mapped SMILES atom.

One of the following:
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecBondAtom1LigandAtom struct{…}

Ligand atom reference for a CCD atom or an explicitly atom-mapped SMILES atom.

AtomName string

Atom name. For ligand_ccd, use the standardized CIF atom name. For ligand_smiles, explicitly label the atom with numeric atom-map notation: [C:1] is referenced as C1 and [O:2] as O2. The resulting name must be unique within the molecule and at most four characters.

ChainID string

Chain ID containing the atom

Type LigandAtom
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecBondAtom1PolymerAtom 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

minimum0
Type PolymerAtom
Atom2 ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecBondAtom2Union

Ligand atom reference for a CCD atom or an explicitly atom-mapped SMILES atom.

One of the following:
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecBondAtom2LigandAtom struct{…}

Ligand atom reference for a CCD atom or an explicitly atom-mapped SMILES atom.

AtomName string

Atom name. For ligand_ccd, use the standardized CIF atom name. For ligand_smiles, explicitly label the atom with numeric atom-map notation: [C:1] is referenced as C1 and [O:2] as O2. The resulting name must be unique within the molecule and at most four characters.

ChainID string

Chain ID containing the atom

Type LigandAtom
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecBondAtom2PolymerAtom 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

minimum0
Type PolymerAtom
Rules ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecRulesOptional

Constraints applied during sequence design

ExcludedAminoAcids []stringOptional

Single-letter amino acid codes to exclude from design (e.g. [‘C’, ‘P’] to exclude cysteine and proline)

ExcludedSequenceMotifs []stringOptional

Sequence motifs to exclude from designed regions. Designs containing any of these motifs are filtered out before scoring. Use X as a single-residue wildcard (e.g. “NGS”, “NXS”).

MaxHydrophobicFraction float64Optional

Maximum allowed fraction of hydrophobic residues (I, L, V, M, F, W, Y) in designed regions. Designs exceeding this threshold are filtered out before scoring. Leave empty to disable.

minimum0
maximum1
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationBoltzCuratedBinderSpec struct{…}

Boltz-managed curated binder specification. Choose a curated nanobody or antibody family and Boltz will select from maintained template lists during design. The curated lists are managed by Boltz and may be updated over time to improve quality and coverage.

Binder ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationBoltzCuratedBinderSpecBinder

Boltz-managed curated binder family. Boltz maintains and may update the underlying template lists on behalf of customers.

One of the following:
const ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationBoltzCuratedBinderSpecBinderBoltzNanobody ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationBoltzCuratedBinderSpecBinder = "boltz_nanobody"
const ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationBoltzCuratedBinderSpecBinderBoltzAntibody ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationBoltzCuratedBinderSpecBinder = "boltz_antibody"
Type BoltzCurated
Rules ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationBoltzCuratedBinderSpecRulesOptional

Constraints applied during sequence design

ExcludedAminoAcids []stringOptional

Single-letter amino acid codes to exclude from design (e.g. [‘C’, ‘P’] to exclude cysteine and proline)

ExcludedSequenceMotifs []stringOptional

Sequence motifs to exclude from designed regions. Designs containing any of these motifs are filtered out before scoring. Use X as a single-residue wildcard (e.g. “NGS”, “NXS”).

MaxHydrophobicFraction float64Optional

Maximum allowed fraction of hydrophobic residues (I, L, V, M, F, W, Y) in designed regions. Designs exceeding this threshold are filtered out before scoring. Leave empty to disable.

minimum0
maximum1
Type UniformlySampledSpecifications
Name string

Human-readable name for this curated binder specification.

List curated protein design specifications

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"),
  )
  response, err := client.Protein.Design.ListCuratedSpecifications(context.TODO(), boltzapi.ProteinDesignListCuratedSpecificationsParams{
    Type: boltzapi.ProteinDesignListCuratedSpecificationsParamsTypeNanobody,
  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.Data)
}
{
  "data": [
    {
      "binder_specification": {
        "chain_selection": {
          "B": {
            "chain_type": "polymer",
            "crop_residues": [
              0,
              1,
              2,
              3,
              4,
              5,
              6,
              7,
              8,
              9
            ],
            "design_motifs": [
              {
                "design_length_range": {
                  "max": 8,
                  "min": 4
                },
                "end_index": 5,
                "start_index": 0,
                "type": "replacement"
              }
            ]
          }
        },
        "modality": "peptide",
        "structure": {
          "type": "url",
          "url": "https://example.com"
        },
        "type": "structure_template",
        "rules": {
          "excluded_amino_acids": [
            "x"
          ],
          "excluded_sequence_motifs": [
            "string"
          ],
          "max_hydrophobic_fraction": 0
        }
      },
      "name": "name"
    }
  ]
}
Returns Examples
{
  "data": [
    {
      "binder_specification": {
        "chain_selection": {
          "B": {
            "chain_type": "polymer",
            "crop_residues": [
              0,
              1,
              2,
              3,
              4,
              5,
              6,
              7,
              8,
              9
            ],
            "design_motifs": [
              {
                "design_length_range": {
                  "max": 8,
                  "min": 4
                },
                "end_index": 5,
                "start_index": 0,
                "type": "replacement"
              }
            ]
          }
        },
        "modality": "peptide",
        "structure": {
          "type": "url",
          "url": "https://example.com"
        },
        "type": "structure_template",
        "rules": {
          "excluded_amino_acids": [
            "x"
          ],
          "excluded_sequence_motifs": [
            "string"
          ],
          "max_hydrophobic_fraction": 0
        }
      },
      "name": "name"
    }
  ]
}