Skip to content
Go to Boltz API

Resume a stopped protein design run

client.Protein.Design.Resume(ctx, id) (*ProteinDesignResumeResponse, error)
POST/compute/v1/protein/design/{id}/resume

Resume a stopped protein design run from its last checkpoint

ParametersExpand Collapse
id string
ReturnsExpand Collapse
type ProteinDesignResumeResponse struct{…}

A protein design pipeline run that generates novel protein binders

ID string

Unique ProteinDesignRun identifier

CompletedAt Time
formatdate-time
CreatedAt Time
formatdate-time
DataDeletedAt Time

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

formatdate-time
DeprecatedEngine Boltzprot
Use pipeline instead.

Deprecated. Use pipeline instead.

DeprecatedEngineVersion String1_0
Use pipeline_version instead.

Deprecated. Use pipeline_version instead.

Error ProteinDesignResumeResponseError
Code string

Machine-readable error code

Message string

Human-readable error message

Details anyOptional

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

Input ProteinDesignResumeResponseInput

Pipeline input (null if data deleted)

BinderSpecification ProteinDesignResumeResponseInputBinderSpecificationUnion

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 ProteinDesignResumeResponseInputBinderSpecificationStructureTemplateBinderSpecResponse 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, ProteinDesignResumeResponseInputBinderSpecificationStructureTemplateBinderSpecResponseChainSelectionUnion]

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 ProteinDesignResumeResponseInputBinderSpecificationStructureTemplateBinderSpecResponseChainSelectionStructureTemplatePolymerChainSpec struct{…}

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

ChainType Polymer
CropResidues ProteinDesignResumeResponseInputBinderSpecificationStructureTemplateBinderSpecResponseChainSelectionStructureTemplatePolymerChainSpecCropResiduesUnion

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 ProteinDesignResumeResponseInputBinderSpecificationStructureTemplateBinderSpecResponseChainSelectionStructureTemplatePolymerChainSpecCropResiduesArray []int64
type All string
DesignMotifs []ProteinDesignResumeResponseInputBinderSpecificationStructureTemplateBinderSpecResponseChainSelectionStructureTemplatePolymerChainSpecDesignMotifUnionOptional

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 ProteinDesignResumeResponseInputBinderSpecificationStructureTemplateBinderSpecResponseChainSelectionStructureTemplatePolymerChainSpecDesignMotifReplacementMotif 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 ProteinDesignResumeResponseInputBinderSpecificationStructureTemplateBinderSpecResponseChainSelectionStructureTemplatePolymerChainSpecDesignMotifReplacementMotifDesignLengthRange

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 ProteinDesignResumeResponseInputBinderSpecificationStructureTemplateBinderSpecResponseChainSelectionStructureTemplatePolymerChainSpecDesignMotifInsertionMotif 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 ProteinDesignResumeResponseInputBinderSpecificationStructureTemplateBinderSpecResponseChainSelectionStructureTemplatePolymerChainSpecDesignMotifInsertionMotifDesignLengthRange

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 ProteinDesignResumeResponseInputBinderSpecificationStructureTemplateBinderSpecResponseChainSelectionStructureTemplateLigandChainSpec struct{…}

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

ChainType Ligand
Modality ProteinDesignResumeResponseInputBinderSpecificationStructureTemplateBinderSpecResponseModality
One of the following:
const ProteinDesignResumeResponseInputBinderSpecificationStructureTemplateBinderSpecResponseModalityPeptide ProteinDesignResumeResponseInputBinderSpecificationStructureTemplateBinderSpecResponseModality = "peptide"
const ProteinDesignResumeResponseInputBinderSpecificationStructureTemplateBinderSpecResponseModalityAntibody ProteinDesignResumeResponseInputBinderSpecificationStructureTemplateBinderSpecResponseModality = "antibody"
const ProteinDesignResumeResponseInputBinderSpecificationStructureTemplateBinderSpecResponseModalityNanobody ProteinDesignResumeResponseInputBinderSpecificationStructureTemplateBinderSpecResponseModality = "nanobody"
const ProteinDesignResumeResponseInputBinderSpecificationStructureTemplateBinderSpecResponseModalityCustomProtein ProteinDesignResumeResponseInputBinderSpecificationStructureTemplateBinderSpecResponseModality = "custom_protein"
Structure ProteinDesignResumeResponseInputBinderSpecificationStructureTemplateBinderSpecResponseStructure
URL string

URL to download the file

formaturi
URLExpiresAt Time

When the presigned URL expires

formatdate-time
Type StructureTemplate
Rules ProteinDesignResumeResponseInputBinderSpecificationStructureTemplateBinderSpecResponseRulesOptional

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 ProteinDesignResumeResponseInputBinderSpecificationNoTemplateBinderSpecResponse struct{…}

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

Entities []ProteinDesignResumeResponseInputBinderSpecificationNoTemplateBinderSpecResponseEntityUnion

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 ProteinDesignResumeResponseInputBinderSpecificationNoTemplateBinderSpecResponseEntityDesignedProteinEntityResponse 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 []ProteinDesignResumeResponseInputBinderSpecificationNoTemplateBinderSpecResponseEntityDesignedProteinEntityResponseModificationOptional

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 ProteinDesignResumeResponseInputBinderSpecificationNoTemplateBinderSpecResponseEntityFixedProteinEntityResponse 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 []ProteinDesignResumeResponseInputBinderSpecificationNoTemplateBinderSpecResponseEntityFixedProteinEntityResponseModificationOptional

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 ProteinDesignResumeResponseInputBinderSpecificationNoTemplateBinderSpecResponseEntityFixedRnaEntityResponse 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 []ProteinDesignResumeResponseInputBinderSpecificationNoTemplateBinderSpecResponseEntityFixedRnaEntityResponseModificationOptional

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 ProteinDesignResumeResponseInputBinderSpecificationNoTemplateBinderSpecResponseEntityFixedDnaEntityResponse 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 []ProteinDesignResumeResponseInputBinderSpecificationNoTemplateBinderSpecResponseEntityFixedDnaEntityResponseModificationOptional

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 ProteinDesignResumeResponseInputBinderSpecificationNoTemplateBinderSpecResponseEntityFixedLigandSmilesEntityResponse struct{…}
ChainIDs []string

Chain IDs to assign to this entity

Type LigandSmiles
Value string

SMILES string representing the ligand

type ProteinDesignResumeResponseInputBinderSpecificationNoTemplateBinderSpecResponseEntityFixedLigandCcdEntityResponse struct{…}
ChainIDs []string

Chain IDs to assign to this entity

Type LigandCcd
Value string

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

Modality ProteinDesignResumeResponseInputBinderSpecificationNoTemplateBinderSpecResponseModality
One of the following:
const ProteinDesignResumeResponseInputBinderSpecificationNoTemplateBinderSpecResponseModalityPeptide ProteinDesignResumeResponseInputBinderSpecificationNoTemplateBinderSpecResponseModality = "peptide"
const ProteinDesignResumeResponseInputBinderSpecificationNoTemplateBinderSpecResponseModalityAntibody ProteinDesignResumeResponseInputBinderSpecificationNoTemplateBinderSpecResponseModality = "antibody"
const ProteinDesignResumeResponseInputBinderSpecificationNoTemplateBinderSpecResponseModalityNanobody ProteinDesignResumeResponseInputBinderSpecificationNoTemplateBinderSpecResponseModality = "nanobody"
const ProteinDesignResumeResponseInputBinderSpecificationNoTemplateBinderSpecResponseModalityCustomProtein ProteinDesignResumeResponseInputBinderSpecificationNoTemplateBinderSpecResponseModality = "custom_protein"
Type NoTemplate
Bonds []ProteinDesignResumeResponseInputBinderSpecificationNoTemplateBinderSpecResponseBondOptional

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 ProteinDesignResumeResponseInputBinderSpecificationNoTemplateBinderSpecResponseBondAtom1Union

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

One of the following:
type ProteinDesignResumeResponseInputBinderSpecificationNoTemplateBinderSpecResponseBondAtom1LigandAtomResponse 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 ProteinDesignResumeResponseInputBinderSpecificationNoTemplateBinderSpecResponseBondAtom1PolymerAtomResponse 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 ProteinDesignResumeResponseInputBinderSpecificationNoTemplateBinderSpecResponseBondAtom2Union

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

One of the following:
type ProteinDesignResumeResponseInputBinderSpecificationNoTemplateBinderSpecResponseBondAtom2LigandAtomResponse 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 ProteinDesignResumeResponseInputBinderSpecificationNoTemplateBinderSpecResponseBondAtom2PolymerAtomResponse 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 ProteinDesignResumeResponseInputBinderSpecificationNoTemplateBinderSpecResponseRulesOptional

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 ProteinDesignResumeResponseInputBinderSpecificationBoltzCuratedBinderSpecResponse 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 ProteinDesignResumeResponseInputBinderSpecificationBoltzCuratedBinderSpecResponseBinder

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

One of the following:
const ProteinDesignResumeResponseInputBinderSpecificationBoltzCuratedBinderSpecResponseBinderBoltzNanobody ProteinDesignResumeResponseInputBinderSpecificationBoltzCuratedBinderSpecResponseBinder = "boltz_nanobody"
const ProteinDesignResumeResponseInputBinderSpecificationBoltzCuratedBinderSpecResponseBinderBoltzAntibody ProteinDesignResumeResponseInputBinderSpecificationBoltzCuratedBinderSpecResponseBinder = "boltz_antibody"
Type BoltzCurated
Rules ProteinDesignResumeResponseInputBinderSpecificationBoltzCuratedBinderSpecResponseRulesOptional

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 ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponse 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 []ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationUnion

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 ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationStructureTemplateBinderSpecResponse 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, ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationStructureTemplateBinderSpecResponseChainSelectionUnion]

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 ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationStructureTemplateBinderSpecResponseChainSelectionStructureTemplatePolymerChainSpec struct{…}

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

ChainType Polymer
CropResidues ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationStructureTemplateBinderSpecResponseChainSelectionStructureTemplatePolymerChainSpecCropResiduesUnion

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 ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationStructureTemplateBinderSpecResponseChainSelectionStructureTemplatePolymerChainSpecCropResiduesArray []int64
type All string
DesignMotifs []ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationStructureTemplateBinderSpecResponseChainSelectionStructureTemplatePolymerChainSpecDesignMotifUnionOptional

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 ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationStructureTemplateBinderSpecResponseChainSelectionStructureTemplatePolymerChainSpecDesignMotifReplacementMotif 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 ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationStructureTemplateBinderSpecResponseChainSelectionStructureTemplatePolymerChainSpecDesignMotifReplacementMotifDesignLengthRange

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 ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationStructureTemplateBinderSpecResponseChainSelectionStructureTemplatePolymerChainSpecDesignMotifInsertionMotif 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 ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationStructureTemplateBinderSpecResponseChainSelectionStructureTemplatePolymerChainSpecDesignMotifInsertionMotifDesignLengthRange

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 ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationStructureTemplateBinderSpecResponseChainSelectionStructureTemplateLigandChainSpec struct{…}

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

ChainType Ligand
Modality ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationStructureTemplateBinderSpecResponseModality
One of the following:
const ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationStructureTemplateBinderSpecResponseModalityPeptide ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationStructureTemplateBinderSpecResponseModality = "peptide"
const ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationStructureTemplateBinderSpecResponseModalityAntibody ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationStructureTemplateBinderSpecResponseModality = "antibody"
const ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationStructureTemplateBinderSpecResponseModalityNanobody ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationStructureTemplateBinderSpecResponseModality = "nanobody"
const ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationStructureTemplateBinderSpecResponseModalityCustomProtein ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationStructureTemplateBinderSpecResponseModality = "custom_protein"
Structure ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationStructureTemplateBinderSpecResponseStructure
URL string

URL to download the file

formaturi
URLExpiresAt Time

When the presigned URL expires

formatdate-time
Type StructureTemplate
Rules ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationStructureTemplateBinderSpecResponseRulesOptional

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 ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationNoTemplateBinderSpecResponse struct{…}

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

Entities []ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationNoTemplateBinderSpecResponseEntityUnion

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 ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationNoTemplateBinderSpecResponseEntityDesignedProteinEntityResponse 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 []ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationNoTemplateBinderSpecResponseEntityDesignedProteinEntityResponseModificationOptional

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 ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationNoTemplateBinderSpecResponseEntityFixedProteinEntityResponse 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 []ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationNoTemplateBinderSpecResponseEntityFixedProteinEntityResponseModificationOptional

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 ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationNoTemplateBinderSpecResponseEntityFixedRnaEntityResponse 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 []ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationNoTemplateBinderSpecResponseEntityFixedRnaEntityResponseModificationOptional

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 ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationNoTemplateBinderSpecResponseEntityFixedDnaEntityResponse 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 []ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationNoTemplateBinderSpecResponseEntityFixedDnaEntityResponseModificationOptional

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 ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationNoTemplateBinderSpecResponseEntityFixedLigandSmilesEntityResponse struct{…}
ChainIDs []string

Chain IDs to assign to this entity

Type LigandSmiles
Value string

SMILES string representing the ligand

type ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationNoTemplateBinderSpecResponseEntityFixedLigandCcdEntityResponse struct{…}
ChainIDs []string

Chain IDs to assign to this entity

Type LigandCcd
Value string

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

Modality ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationNoTemplateBinderSpecResponseModality
One of the following:
const ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationNoTemplateBinderSpecResponseModalityPeptide ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationNoTemplateBinderSpecResponseModality = "peptide"
const ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationNoTemplateBinderSpecResponseModalityAntibody ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationNoTemplateBinderSpecResponseModality = "antibody"
const ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationNoTemplateBinderSpecResponseModalityNanobody ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationNoTemplateBinderSpecResponseModality = "nanobody"
const ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationNoTemplateBinderSpecResponseModalityCustomProtein ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationNoTemplateBinderSpecResponseModality = "custom_protein"
Type NoTemplate
Bonds []ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationNoTemplateBinderSpecResponseBondOptional

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 ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationNoTemplateBinderSpecResponseBondAtom1Union

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

One of the following:
type ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationNoTemplateBinderSpecResponseBondAtom1LigandAtomResponse 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 ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationNoTemplateBinderSpecResponseBondAtom1PolymerAtomResponse 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 ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationNoTemplateBinderSpecResponseBondAtom2Union

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

One of the following:
type ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationNoTemplateBinderSpecResponseBondAtom2LigandAtomResponse 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 ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationNoTemplateBinderSpecResponseBondAtom2PolymerAtomResponse 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 ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationNoTemplateBinderSpecResponseRulesOptional

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 ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationBoltzCuratedBinderSpecResponse 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 ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationBoltzCuratedBinderSpecResponseBinder

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

One of the following:
const ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationBoltzCuratedBinderSpecResponseBinderBoltzNanobody ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationBoltzCuratedBinderSpecResponseBinder = "boltz_nanobody"
const ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationBoltzCuratedBinderSpecResponseBinderBoltzAntibody ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationBoltzCuratedBinderSpecResponseBinder = "boltz_antibody"
Type BoltzCurated
Rules ProteinDesignResumeResponseInputBinderSpecificationUniformlySampledBinderSpecResponseBinderSpecificationBoltzCuratedBinderSpecResponseRulesOptional

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
NumProteins int64

Number of protein designs to generate. Must be between 10 and 1,000,000.

minimum10
maximum1000000
Target ProteinDesignResumeResponseInputTargetUnion

Target specification (structure template or template-free)

One of the following:
type ProteinDesignResumeResponseInputTargetStructureTemplateTargetResponse struct{…}

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

ChainSelection map[string, ProteinDesignResumeResponseInputTargetStructureTemplateTargetResponseChainSelectionUnion]

Chains selected from the uploaded 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, which are epitope residues, which are non-binding residues, and which are flexible.

One of the following:
type ProteinDesignResumeResponseInputTargetStructureTemplateTargetResponseChainSelectionStructureTemplateTargetPolymerChainSpec struct{…}

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

ChainType Polymer
CropResidues ProteinDesignResumeResponseInputTargetStructureTemplateTargetResponseChainSelectionStructureTemplateTargetPolymerChainSpecCropResiduesUnion

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

One of the following:
type ProteinDesignResumeResponseInputTargetStructureTemplateTargetResponseChainSelectionStructureTemplateTargetPolymerChainSpecCropResiduesArray []int64

0-indexed residue indices to keep

type All string
EpitopeResidues []int64Optional

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

FlexibleResidues []int64Optional

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

NonBindingResidues []int64Optional

0-indexed residue indices where binder contact should be discouraged. All indices must be present in crop_residues and must not overlap epitope_residues.

type ProteinDesignResumeResponseInputTargetStructureTemplateTargetResponseChainSelectionStructureTemplateTargetLigandChainSpec struct{…}

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

ChainType Ligand
Structure ProteinDesignResumeResponseInputTargetStructureTemplateTargetResponseStructure
URL string

URL to download the file

formaturi
URLExpiresAt Time

When the presigned URL expires

formatdate-time
Type StructureTemplate
type ProteinDesignResumeResponseInputTargetNoTemplateTargetResponse struct{…}

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

Entities []ProteinDesignResumeResponseInputTargetNoTemplateTargetResponseEntityUnion

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

One of the following:
type ProteinDesignResumeResponseInputTargetNoTemplateTargetResponseEntityProteinEntityResponse struct{…}
ChainIDs []string

Chain IDs for this entity

Type Protein
Value string

Amino acid sequence (one-letter codes)

Cyclic boolOptional

Whether the sequence is cyclic

Modifications []ProteinDesignResumeResponseInputTargetNoTemplateTargetResponseEntityProteinEntityResponseModificationOptional

CCD post-translational modifications. Optional; defaults to an empty list 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 ProteinDesignResumeResponseInputTargetNoTemplateTargetResponseEntityRnaEntityResponse struct{…}
ChainIDs []string

Chain IDs for this entity

Type Rna
Value string

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

Cyclic boolOptional

Whether the sequence is cyclic

Modifications []ProteinDesignResumeResponseInputTargetNoTemplateTargetResponseEntityRnaEntityResponseModificationOptional

CCD chemical modifications. Optional; defaults to an empty list 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 ProteinDesignResumeResponseInputTargetNoTemplateTargetResponseEntityDnaEntityResponse struct{…}
ChainIDs []string

Chain IDs for this entity

Type Dna
Value string

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

Cyclic boolOptional

Whether the sequence is cyclic

Modifications []ProteinDesignResumeResponseInputTargetNoTemplateTargetResponseEntityDnaEntityResponseModificationOptional

CCD chemical modifications. Optional; defaults to an empty list 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 ProteinDesignResumeResponseInputTargetNoTemplateTargetResponseEntityLigandCcdEntityResponse struct{…}
ChainIDs []string

Chain IDs for this ligand

Type LigandCcd
Value string

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

type ProteinDesignResumeResponseInputTargetNoTemplateTargetResponseEntityLigandSmilesEntityResponse struct{…}
ChainIDs []string

Chain IDs for this ligand

Type LigandSmiles
Value string

SMILES string representing the ligand

Type NoTemplate
Bonds []ProteinDesignResumeResponseInputTargetNoTemplateTargetResponseBondOptional

Covalent bond constraints between atoms in the target complex. Ligand atom references support CCD atom names and explicitly atom-mapped SMILES atoms.

Atom1 ProteinDesignResumeResponseInputTargetNoTemplateTargetResponseBondAtom1Union

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

One of the following:
type ProteinDesignResumeResponseInputTargetNoTemplateTargetResponseBondAtom1LigandAtomResponse 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 ProteinDesignResumeResponseInputTargetNoTemplateTargetResponseBondAtom1PolymerAtomResponse 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 ProteinDesignResumeResponseInputTargetNoTemplateTargetResponseBondAtom2Union

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

One of the following:
type ProteinDesignResumeResponseInputTargetNoTemplateTargetResponseBondAtom2LigandAtomResponse 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 ProteinDesignResumeResponseInputTargetNoTemplateTargetResponseBondAtom2PolymerAtomResponse 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
Constraints []ProteinDesignResumeResponseInputTargetNoTemplateTargetResponseConstraintUnionOptional

Structural constraints (pocket and contact). Ligand atom references support CCD atom names and explicitly atom-mapped SMILES atoms.

One of the following:
type ProteinDesignResumeResponseInputTargetNoTemplateTargetResponseConstraintPocketConstraintResponse 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
Force boolOptional

Whether to force the constraint

type ProteinDesignResumeResponseInputTargetNoTemplateTargetResponseConstraintContactConstraintResponse struct{…}

Maximum-distance contact constraint between two polymer residues or ligand atoms.

MaxDistanceAngstrom float64

Maximum distance in Angstroms

Token1 ProteinDesignResumeResponseInputTargetNoTemplateTargetResponseConstraintContactConstraintResponseToken1Union

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

One of the following:
type ProteinDesignResumeResponseInputTargetNoTemplateTargetResponseConstraintContactConstraintResponseToken1PolymerContactTokenResponse struct{…}
ChainID string

Chain ID

ResidueIndex int64

0-based residue index

minimum0
Type PolymerContact
type ProteinDesignResumeResponseInputTargetNoTemplateTargetResponseConstraintContactConstraintResponseToken1LigandContactTokenResponse struct{…}

Ligand contact token 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

Type LigandContact
Token2 ProteinDesignResumeResponseInputTargetNoTemplateTargetResponseConstraintContactConstraintResponseToken2Union

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

One of the following:
type ProteinDesignResumeResponseInputTargetNoTemplateTargetResponseConstraintContactConstraintResponseToken2PolymerContactTokenResponse struct{…}
ChainID string

Chain ID

ResidueIndex int64

0-based residue index

minimum0
Type PolymerContact
type ProteinDesignResumeResponseInputTargetNoTemplateTargetResponseConstraintContactConstraintResponseToken2LigandContactTokenResponse struct{…}

Ligand contact token 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

Type LigandContact
Type Contact
Force boolOptional

Whether to force the constraint

EpitopeLigandChains []stringOptional

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]Optional

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. Residues must not overlap non_binding_residues on the same chain.

NonBindingResidues map[string, []int64]Optional

Polymer chain residues where binder contact should be discouraged. Each key is a chain ID of a polymer entity, each value is an array of 0-indexed residue indices. Residues must not overlap epitope_residues on the same chain.

IdempotencyKey stringOptional

Client-provided key to prevent duplicate submissions on retries

maxLength255
WorkspaceID stringOptional

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

Livemode bool

Whether this resource was created with a live API key.

Pipeline Boltzprot

Pipeline used for protein design

PipelineVersion String1_0

Pipeline version used for protein design

Progress ProteinDesignResumeResponseProgress
NumProteinsGenerated int64

Number of protein binders generated so far

minimum0
TotalProteinsToGenerate int64

Total number of protein binders requested

minimum1
LatestResultID stringOptional

ID of the most recently generated result

StartedAt Time
formatdate-time
Status ProteinDesignResumeResponseStatus
One of the following:
const ProteinDesignResumeResponseStatusPending ProteinDesignResumeResponseStatus = "pending"
const ProteinDesignResumeResponseStatusRunning ProteinDesignResumeResponseStatus = "running"
const ProteinDesignResumeResponseStatusSucceeded ProteinDesignResumeResponseStatus = "succeeded"
const ProteinDesignResumeResponseStatusFailed ProteinDesignResumeResponseStatus = "failed"
const ProteinDesignResumeResponseStatusStopped ProteinDesignResumeResponseStatus = "stopped"
StoppedAt Time
formatdate-time
WorkspaceID string

Workspace ID

IdempotencyKey stringOptional

Client-provided idempotency key

Resume a stopped protein design run

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.Resume(context.TODO(), "id")
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", response.ID)
}
{
  "id": "id",
  "completed_at": "2019-12-27T18:11:19.117Z",
  "created_at": "2019-12-27T18:11:19.117Z",
  "data_deleted_at": "2019-12-27T18:11:19.117Z",
  "engine": "boltzprot",
  "engine_version": "1.0",
  "error": {
    "code": "code",
    "message": "message",
    "details": {}
  },
  "input": {
    "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": {
        "url": "https://example.com",
        "url_expires_at": "2019-12-27T18:11:19.117Z"
      },
      "type": "structure_template",
      "rules": {
        "excluded_amino_acids": [
          "x"
        ],
        "excluded_sequence_motifs": [
          "string"
        ],
        "max_hydrophobic_fraction": 0
      }
    },
    "num_proteins": 10,
    "target": {
      "chain_selection": {
        "A": {
          "chain_type": "polymer",
          "crop_residues": [
            0,
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8,
            9,
            10,
            11,
            12
          ],
          "epitope_residues": [
            10,
            11,
            12
          ],
          "flexible_residues": [
            5,
            6,
            7
          ],
          "non_binding_residues": [
            0,
            1,
            2
          ]
        }
      },
      "structure": {
        "url": "https://example.com",
        "url_expires_at": "2019-12-27T18:11:19.117Z"
      },
      "type": "structure_template"
    },
    "idempotency_key": "idempotency_key",
    "workspace_id": "workspace_id"
  },
  "livemode": true,
  "pipeline": "boltzprot",
  "pipeline_version": "1.0",
  "progress": {
    "num_proteins_generated": 0,
    "total_proteins_to_generate": 1,
    "latest_result_id": "latest_result_id"
  },
  "started_at": "2019-12-27T18:11:19.117Z",
  "status": "pending",
  "stopped_at": "2019-12-27T18:11:19.117Z",
  "workspace_id": "workspace_id",
  "idempotency_key": "idempotency_key"
}
Returns Examples
{
  "id": "id",
  "completed_at": "2019-12-27T18:11:19.117Z",
  "created_at": "2019-12-27T18:11:19.117Z",
  "data_deleted_at": "2019-12-27T18:11:19.117Z",
  "engine": "boltzprot",
  "engine_version": "1.0",
  "error": {
    "code": "code",
    "message": "message",
    "details": {}
  },
  "input": {
    "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": {
        "url": "https://example.com",
        "url_expires_at": "2019-12-27T18:11:19.117Z"
      },
      "type": "structure_template",
      "rules": {
        "excluded_amino_acids": [
          "x"
        ],
        "excluded_sequence_motifs": [
          "string"
        ],
        "max_hydrophobic_fraction": 0
      }
    },
    "num_proteins": 10,
    "target": {
      "chain_selection": {
        "A": {
          "chain_type": "polymer",
          "crop_residues": [
            0,
            1,
            2,
            3,
            4,
            5,
            6,
            7,
            8,
            9,
            10,
            11,
            12
          ],
          "epitope_residues": [
            10,
            11,
            12
          ],
          "flexible_residues": [
            5,
            6,
            7
          ],
          "non_binding_residues": [
            0,
            1,
            2
          ]
        }
      },
      "structure": {
        "url": "https://example.com",
        "url_expires_at": "2019-12-27T18:11:19.117Z"
      },
      "type": "structure_template"
    },
    "idempotency_key": "idempotency_key",
    "workspace_id": "workspace_id"
  },
  "livemode": true,
  "pipeline": "boltzprot",
  "pipeline_version": "1.0",
  "progress": {
    "num_proteins_generated": 0,
    "total_proteins_to_generate": 1,
    "latest_result_id": "latest_result_id"
  },
  "started_at": "2019-12-27T18:11:19.117Z",
  "status": "pending",
  "stopped_at": "2019-12-27T18:11:19.117Z",
  "workspace_id": "workspace_id",
  "idempotency_key": "idempotency_key"
}