List curated protein design specifications
List binder-side protein design specifications from Boltz-managed curated nanobody or antibody libraries.
ParametersExpand Collapse
query ProteinDesignListCuratedSpecificationsParams
Type param.Field[ProteinDesignListCuratedSpecificationsParamsType]Curated binder library to retrieve.
Curated binder library to retrieve.
ReturnsExpand Collapse
type ProteinDesignListCuratedSpecificationsResponse struct{…}
Data []ProteinDesignListCuratedSpecificationsResponseData
BinderSpecification ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUnionBinder 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.
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.
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.
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.
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.
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpecChainSelectionStructureTemplatePolymerChainSpec struct{…}Per-chain crop and design specification for a polymer chain in structure_template mode.
Per-chain crop and design specification for a polymer chain in structure_template mode.
CropResidues ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpecChainSelectionStructureTemplatePolymerChainSpecCropResiduesUnion0-indexed residue indices to retain from this chain, or ‘all’ to keep all residues. Residues not listed are removed before design.
0-indexed residue indices to retain from this chain, or ‘all’ to keep all residues. Residues not listed are removed before design.
DesignMotifs []ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpecChainSelectionStructureTemplatePolymerChainSpecDesignMotifUnionOptionalOptional motifs (replacement or insertion) defining which regions to redesign on this chain. Omit this field to include the chain as fixed scaffold context.
Optional motifs (replacement or insertion) defining which regions to redesign on this chain. Omit this field to include the chain as fixed scaffold context.
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.
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.
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpecChainSelectionStructureTemplatePolymerChainSpecDesignMotifInsertionMotif struct{…}Insert a designed segment at a specific position in the sequence.
Insert a designed segment at a specific position in the sequence.
0-indexed position after which to insert. Use -1 to insert before the first residue.
Modality ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpecModality
Structure ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpecStructureUnionHow to provide a CIF structure file. URLs are auto-detected; base64 uploads must use chemical/x-cif media type.
How to provide a CIF structure file. URLs are auto-detected; base64 uploads must use chemical/x-cif media type.
Rules ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationStructureTemplateBinderSpecRulesOptionalConstraints applied during sequence design
Constraints applied during sequence design
Single-letter amino acid codes to exclude from design (e.g. [‘C’, ‘P’] to exclude cysteine and proline)
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.
Binder specification without a structural template. Define the binder from sequence components (fixed and designed segments) without providing a starting 3D structure.
Entities []ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecEntityUnionBinder 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.
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.
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecEntityDesignedProteinEntity struct{…}Protein binder entity with designed and/or fixed segments.
Protein binder entity with designed and/or fixed segments.
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.
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecEntityFixedProteinEntity struct{…}A fixed protein entity whose sequence is not redesigned.
A fixed protein entity whose sequence is not redesigned.
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecEntityFixedRnaEntity struct{…}
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecEntityFixedDnaEntity struct{…}
Modality ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecModality
Bonds []ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecBondOptionalCovalent 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.
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 ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecBondAtom1UnionLigand atom reference for a CCD atom or an explicitly atom-mapped SMILES atom.
Ligand atom reference for a CCD atom or an explicitly atom-mapped SMILES atom.
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecBondAtom1LigandAtom struct{…}Ligand atom reference for a CCD atom or an explicitly atom-mapped SMILES atom.
Ligand atom reference for a CCD atom or an explicitly atom-mapped SMILES atom.
Atom2 ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecBondAtom2UnionLigand atom reference for a CCD atom or an explicitly atom-mapped SMILES atom.
Ligand atom reference for a CCD atom or an explicitly atom-mapped SMILES atom.
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecBondAtom2LigandAtom struct{…}Ligand atom reference for a CCD atom or an explicitly atom-mapped SMILES atom.
Ligand atom reference for a CCD atom or an explicitly atom-mapped SMILES atom.
Rules ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationNoTemplateBinderSpecRulesOptionalConstraints applied during sequence design
Constraints applied during sequence design
Single-letter amino acid codes to exclude from design (e.g. [‘C’, ‘P’] to exclude cysteine and proline)
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.
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 ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationBoltzCuratedBinderSpecBinderBoltz-managed curated binder family. Boltz maintains and may update the underlying template lists on behalf of customers.
Boltz-managed curated binder family. Boltz maintains and may update the underlying template lists on behalf of customers.
Rules ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationBoltzCuratedBinderSpecRulesOptionalConstraints applied during sequence design
Constraints applied during sequence design
Single-letter amino acid codes to exclude from design (e.g. [‘C’, ‘P’] to exclude cysteine and proline)
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.
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 []ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationUnionBinder specifications to sample uniformly when generating designs. Each generation samples one specification from this list; over larger runs this gives roughly equal representation.
Binder specifications to sample uniformly when generating designs. Each generation samples one specification from this list; over larger runs this gives roughly equal representation.
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.
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.
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.
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecChainSelectionStructureTemplatePolymerChainSpec struct{…}Per-chain crop and design specification for a polymer chain in structure_template mode.
Per-chain crop and design specification for a polymer chain in structure_template mode.
CropResidues ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecChainSelectionStructureTemplatePolymerChainSpecCropResiduesUnion0-indexed residue indices to retain from this chain, or ‘all’ to keep all residues. Residues not listed are removed before design.
0-indexed residue indices to retain from this chain, or ‘all’ to keep all residues. Residues not listed are removed before design.
DesignMotifs []ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecChainSelectionStructureTemplatePolymerChainSpecDesignMotifUnionOptionalOptional motifs (replacement or insertion) defining which regions to redesign on this chain. Omit this field to include the chain as fixed scaffold context.
Optional motifs (replacement or insertion) defining which regions to redesign on this chain. Omit this field to include the chain as fixed scaffold context.
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.
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 ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecChainSelectionStructureTemplatePolymerChainSpecDesignMotifReplacementMotifDesignLengthRangeAllowed sequence length range for designed regions
Allowed sequence length range for designed regions
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecChainSelectionStructureTemplatePolymerChainSpecDesignMotifInsertionMotif struct{…}Insert a designed segment at a specific position in the sequence.
Insert a designed segment at a specific position in the sequence.
0-indexed position after which to insert. Use -1 to insert before the first residue.
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecChainSelectionStructureTemplateLigandChainSpec struct{…}Per-chain specification for a ligand chain in structure_template mode. The full ligand is always included.
Per-chain specification for a ligand chain in structure_template mode. The full ligand is always included.
Modality ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecModality
Structure ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecStructureUnionHow to provide a CIF structure file. URLs are auto-detected; base64 uploads must use chemical/x-cif media type.
How to provide a CIF structure file. URLs are auto-detected; base64 uploads must use chemical/x-cif media type.
Rules ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationStructureTemplateBinderSpecRulesOptionalConstraints applied during sequence design
Constraints applied during sequence design
Single-letter amino acid codes to exclude from design (e.g. [‘C’, ‘P’] to exclude cysteine and proline)
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.
Binder specification without a structural template. Define the binder from sequence components (fixed and designed segments) without providing a starting 3D structure.
Entities []ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecEntityUnionBinder 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.
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.
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecEntityDesignedProteinEntity struct{…}Protein binder entity with designed and/or fixed segments.
Protein binder entity with designed and/or fixed segments.
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.
Modifications []ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecEntityDesignedProteinEntityModificationOptionalOptional CCD polymer modifications. Defaults to [] when omitted. SMILES modifications are not supported.
Optional CCD polymer modifications. Defaults to [] when omitted. SMILES modifications are not supported.
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecEntityFixedProteinEntity struct{…}A fixed protein entity whose sequence is not redesigned.
A fixed protein entity whose sequence is not redesigned.
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecEntityFixedRnaEntity struct{…}
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecEntityFixedDnaEntity struct{…}
Modality ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecModality
Bonds []ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecBondOptionalCovalent 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.
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 ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecBondAtom1UnionLigand atom reference for a CCD atom or an explicitly atom-mapped SMILES atom.
Ligand atom reference for a CCD atom or an explicitly atom-mapped SMILES atom.
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecBondAtom1LigandAtom struct{…}Ligand atom reference for a CCD atom or an explicitly atom-mapped SMILES atom.
Ligand atom reference for a CCD atom or an explicitly atom-mapped SMILES atom.
Atom2 ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecBondAtom2UnionLigand atom reference for a CCD atom or an explicitly atom-mapped SMILES atom.
Ligand atom reference for a CCD atom or an explicitly atom-mapped SMILES atom.
type ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecBondAtom2LigandAtom struct{…}Ligand atom reference for a CCD atom or an explicitly atom-mapped SMILES atom.
Ligand atom reference for a CCD atom or an explicitly atom-mapped SMILES atom.
Rules ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationNoTemplateBinderSpecRulesOptionalConstraints applied during sequence design
Constraints applied during sequence design
Single-letter amino acid codes to exclude from design (e.g. [‘C’, ‘P’] to exclude cysteine and proline)
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.
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 ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationBoltzCuratedBinderSpecBinderBoltz-managed curated binder family. Boltz maintains and may update the underlying template lists on behalf of customers.
Boltz-managed curated binder family. Boltz maintains and may update the underlying template lists on behalf of customers.
Rules ProteinDesignListCuratedSpecificationsResponseDataBinderSpecificationUniformlySampledBinderSpecBinderSpecificationBoltzCuratedBinderSpecRulesOptionalConstraints applied during sequence design
Constraints applied during sequence design
Single-letter amino acid codes to exclude from design (e.g. [‘C’, ‘P’] to exclude cysteine and proline)
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"
}
]
}