Skip to content
Boltz Boltz Boltz API Docs
Go to Boltz API
API Reference
Protein
Sequence Redesign

Stop a running protein sequence redesign run

protein.sequence_redesign.stop(strid) -> SequenceRedesignStopResponse
POST/compute/v1/protein/sequence-redesign/{id}/stop

Stop an in-progress protein sequence redesign run early

ParametersExpand Collapse
id: str
ReturnsExpand Collapse
class SequenceRedesignStopResponse: …

A fixed-structure protein sequence redesign run.

id: str

Unique ProteinSequenceRedesignRun identifier

completed_at: Optional[datetime]
formatdate-time
created_at: datetime
formatdate-time
data_deleted_at: Optional[datetime]

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

formatdate-time
Deprecatedengine: Literal["boltz-protein-redesign"]
Use pipeline instead.

Deprecated. Use pipeline instead.

Deprecatedengine_version: Literal["v2026-07-14"]
Use pipeline_version instead.

Deprecated. Use pipeline_version instead.

error: Optional[Error]
code: str

Machine-readable error code

message: str

Human-readable error message

details: Optional[object]

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

input: Optional[Input]

Pipeline input (null if data deleted)

One of the following:
class InputBinderProteinSequenceRedesignRunInputResponse: …
entities: List[InputBinderProteinSequenceRedesignRunInputResponseEntity]

Every chain in the input CIF, assigned exactly once as target or binder.

One of the following:
class InputBinderProteinSequenceRedesignRunInputResponseEntityBinderSequenceRedesignTargetEntityResponse: …

A fixed target chain from the input CIF.

chain_id: str
minLength1
role: Literal["target"]
type: Literal["from_template"]
class InputBinderProteinSequenceRedesignRunInputResponseEntityBinderSequenceRedesignBinderEntityResponse: …
chain_id: str
minLength1
role: Literal["binder"]
type: Literal["from_template"]
design_motifs: Optional[List[InputBinderProteinSequenceRedesignRunInputResponseEntityBinderSequenceRedesignBinderEntityResponseDesignMotif]]

Residues to redesign. Omit this field to keep the binder chain fixed.

filters: List[InputBinderProteinSequenceRedesignRunInputResponseEntityBinderSequenceRedesignBinderEntityResponseDesignMotifFilter]

Filters applied to this motif in addition to global_design_filters.

One of the following:
class InputBinderProteinSequenceRedesignRunInputResponseEntityBinderSequenceRedesignBinderEntityResponseDesignMotifFilterExcludedAminoAcidsDesignFilterResponse: …
amino_acids: List[str]

Single-letter amino-acid codes that must not occur in the filtered designed region.

type: Literal["excluded_amino_acids"]
class InputBinderProteinSequenceRedesignRunInputResponseEntityBinderSequenceRedesignBinderEntityResponseDesignMotifFilterMaxHydrophobicFractionDesignFilterResponse: …
max_fraction: float
minimum0
maximum1
type: Literal["max_hydrophobic_fraction"]
class InputBinderProteinSequenceRedesignRunInputResponseEntityBinderSequenceRedesignBinderEntityResponseDesignMotifFilterExcludedSequenceMotifsDesignFilterResponse: …
motifs: List[str]

Sequence motifs that must not occur. X matches any single residue.

type: Literal["excluded_sequence_motifs"]
residues: List[int]

0-indexed residues to redesign on this chain.

type: Literal["residues"]
num_proteins: int

Number of unique filter-passing redesigned proteins to generate.

minimum1
maximum1000
structure: InputBinderProteinSequenceRedesignRunInputResponseStructure
url: str

URL to download the file

formaturi
url_expires_at: datetime

When the presigned URL expires

formatdate-time
type: Literal["binder"]
global_design_filters: Optional[List[InputBinderProteinSequenceRedesignRunInputResponseGlobalDesignFilter]]

Filters applied to every redesigned region. When omitted, cysteine is excluded. Pass [] to disable global filters.

One of the following:
class InputBinderProteinSequenceRedesignRunInputResponseGlobalDesignFilterExcludedAminoAcidsDesignFilterResponse: …
amino_acids: List[str]

Single-letter amino-acid codes that must not occur in the filtered designed region.

type: Literal["excluded_amino_acids"]
class InputBinderProteinSequenceRedesignRunInputResponseGlobalDesignFilterMaxHydrophobicFractionDesignFilterResponse: …
max_fraction: float
minimum0
maximum1
type: Literal["max_hydrophobic_fraction"]
class InputBinderProteinSequenceRedesignRunInputResponseGlobalDesignFilterExcludedSequenceMotifsDesignFilterResponse: …
motifs: List[str]

Sequence motifs that must not occur. X matches any single residue.

type: Literal["excluded_sequence_motifs"]
idempotency_key: Optional[str]
maxLength255
workspace_id: Optional[str]

Workspace to run this redesign in.

class InputGenericProteinSequenceRedesignRunInputResponse: …
entities: List[InputGenericProteinSequenceRedesignRunInputResponseEntity]

Every chain in the input CIF, assigned exactly once.

chain_id: str
minLength1
type: Literal["from_template"]
design_motifs: Optional[List[InputGenericProteinSequenceRedesignRunInputResponseEntityDesignMotif]]

Residues to redesign. Omit this field to keep the chain fixed.

filters: List[InputGenericProteinSequenceRedesignRunInputResponseEntityDesignMotifFilter]

Filters applied to this motif in addition to global_design_filters.

One of the following:
class InputGenericProteinSequenceRedesignRunInputResponseEntityDesignMotifFilterExcludedAminoAcidsDesignFilterResponse: …
amino_acids: List[str]

Single-letter amino-acid codes that must not occur in the filtered designed region.

type: Literal["excluded_amino_acids"]
class InputGenericProteinSequenceRedesignRunInputResponseEntityDesignMotifFilterMaxHydrophobicFractionDesignFilterResponse: …
max_fraction: float
minimum0
maximum1
type: Literal["max_hydrophobic_fraction"]
class InputGenericProteinSequenceRedesignRunInputResponseEntityDesignMotifFilterExcludedSequenceMotifsDesignFilterResponse: …
motifs: List[str]

Sequence motifs that must not occur. X matches any single residue.

type: Literal["excluded_sequence_motifs"]
residues: List[int]

0-indexed residues to redesign on this chain.

type: Literal["residues"]
num_proteins: int

Number of unique filter-passing redesigned proteins to generate.

minimum1
maximum1000
structure: InputGenericProteinSequenceRedesignRunInputResponseStructure
url: str

URL to download the file

formaturi
url_expires_at: datetime

When the presigned URL expires

formatdate-time
type: Literal["generic"]
global_design_filters: Optional[List[InputGenericProteinSequenceRedesignRunInputResponseGlobalDesignFilter]]

Filters applied to every redesigned region. When omitted, cysteine is excluded. Pass [] to disable global filters.

One of the following:
class InputGenericProteinSequenceRedesignRunInputResponseGlobalDesignFilterExcludedAminoAcidsDesignFilterResponse: …
amino_acids: List[str]

Single-letter amino-acid codes that must not occur in the filtered designed region.

type: Literal["excluded_amino_acids"]
class InputGenericProteinSequenceRedesignRunInputResponseGlobalDesignFilterMaxHydrophobicFractionDesignFilterResponse: …
max_fraction: float
minimum0
maximum1
type: Literal["max_hydrophobic_fraction"]
class InputGenericProteinSequenceRedesignRunInputResponseGlobalDesignFilterExcludedSequenceMotifsDesignFilterResponse: …
motifs: List[str]

Sequence motifs that must not occur. X matches any single residue.

type: Literal["excluded_sequence_motifs"]
idempotency_key: Optional[str]
maxLength255
workspace_id: Optional[str]

Workspace to run this redesign in.

livemode: bool

Whether this resource was created with a live API key.

pipeline: Literal["boltz-protein-redesign"]
pipeline_version: Literal["v2026-07-14"]
progress: Optional[Progress]
num_proteins_generated: int

Number of protein binders generated so far

minimum0
total_proteins_to_generate: int

Total number of protein binders requested

minimum1
latest_result_id: Optional[str]

ID of the most recently generated result

started_at: Optional[datetime]
formatdate-time
status: Literal["pending", "running", "succeeded", 2 more]
One of the following:
"pending"
"running"
"succeeded"
"failed"
"stopped"
stopped_at: Optional[datetime]
formatdate-time
workspace_id: str

Workspace ID

idempotency_key: Optional[str]

Client-provided idempotency key

Stop a running protein sequence redesign run

import os
from boltz_api import Boltz

client = Boltz(
    api_key=os.environ.get("BOLTZ_API_KEY"),  # This is the default and can be omitted
)
response = client.protein.sequence_redesign.stop(
    "id",
)
print(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": "boltz-protein-redesign",
  "engine_version": "v2026-07-14",
  "error": {
    "code": "code",
    "message": "message",
    "details": {}
  },
  "input": {
    "entities": [
      {
        "chain_id": "x",
        "role": "target",
        "type": "from_template"
      },
      {
        "chain_id": "x",
        "role": "target",
        "type": "from_template"
      }
    ],
    "num_proteins": 1,
    "structure": {
      "url": "https://example.com",
      "url_expires_at": "2019-12-27T18:11:19.117Z"
    },
    "type": "binder",
    "global_design_filters": [
      {
        "amino_acids": [
          "x"
        ],
        "type": "excluded_amino_acids"
      }
    ],
    "idempotency_key": "idempotency_key",
    "workspace_id": "workspace_id"
  },
  "livemode": true,
  "pipeline": "boltz-protein-redesign",
  "pipeline_version": "v2026-07-14",
  "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": "boltz-protein-redesign",
  "engine_version": "v2026-07-14",
  "error": {
    "code": "code",
    "message": "message",
    "details": {}
  },
  "input": {
    "entities": [
      {
        "chain_id": "x",
        "role": "target",
        "type": "from_template"
      },
      {
        "chain_id": "x",
        "role": "target",
        "type": "from_template"
      }
    ],
    "num_proteins": 1,
    "structure": {
      "url": "https://example.com",
      "url_expires_at": "2019-12-27T18:11:19.117Z"
    },
    "type": "binder",
    "global_design_filters": [
      {
        "amino_acids": [
          "x"
        ],
        "type": "excluded_amino_acids"
      }
    ],
    "idempotency_key": "idempotency_key",
    "workspace_id": "workspace_id"
  },
  "livemode": true,
  "pipeline": "boltz-protein-redesign",
  "pipeline_version": "v2026-07-14",
  "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"
}