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

Stop a running protein sequence redesign run

client.Protein.SequenceRedesign.Stop(ctx, id) (*ProteinSequenceRedesignStopResponse, error)
POST/compute/v1/protein/sequence-redesign/{id}/stop

Stop an in-progress protein sequence redesign run early

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

A fixed-structure protein sequence redesign run.

ID string

Unique ProteinSequenceRedesignRun 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 BoltzProteinRedesign
Use pipeline instead.

Deprecated. Use pipeline instead.

DeprecatedEngineVersion V2026_07_14
Use pipeline_version instead.

Deprecated. Use pipeline_version instead.

Error ProteinSequenceRedesignStopResponseError
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 ProteinSequenceRedesignStopResponseInputUnion

Pipeline input (null if data deleted)

One of the following:
type ProteinSequenceRedesignStopResponseInputBinderProteinSequenceRedesignRunInputResponse struct{…}
Entities []ProteinSequenceRedesignStopResponseInputBinderProteinSequenceRedesignRunInputResponseEntityUnion

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

One of the following:
type ProteinSequenceRedesignStopResponseInputBinderProteinSequenceRedesignRunInputResponseEntityBinderSequenceRedesignTargetEntityResponse struct{…}

A fixed target chain from the input CIF.

ChainID string
minLength1
Role Target
Type FromTemplate
type ProteinSequenceRedesignStopResponseInputBinderProteinSequenceRedesignRunInputResponseEntityBinderSequenceRedesignBinderEntityResponse struct{…}
ChainID string
minLength1
Role Binder
Type FromTemplate
DesignMotifs []ProteinSequenceRedesignStopResponseInputBinderProteinSequenceRedesignRunInputResponseEntityBinderSequenceRedesignBinderEntityResponseDesignMotifOptional

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

Filters []ProteinSequenceRedesignStopResponseInputBinderProteinSequenceRedesignRunInputResponseEntityBinderSequenceRedesignBinderEntityResponseDesignMotifFilterUnion

Filters applied to this motif in addition to global_design_filters.

One of the following:
type ProteinSequenceRedesignStopResponseInputBinderProteinSequenceRedesignRunInputResponseEntityBinderSequenceRedesignBinderEntityResponseDesignMotifFilterExcludedAminoAcidsDesignFilterResponse struct{…}
AminoAcids []string

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

Type ExcludedAminoAcids
type ProteinSequenceRedesignStopResponseInputBinderProteinSequenceRedesignRunInputResponseEntityBinderSequenceRedesignBinderEntityResponseDesignMotifFilterMaxHydrophobicFractionDesignFilterResponse struct{…}
MaxFraction float64
minimum0
maximum1
Type MaxHydrophobicFraction
type ProteinSequenceRedesignStopResponseInputBinderProteinSequenceRedesignRunInputResponseEntityBinderSequenceRedesignBinderEntityResponseDesignMotifFilterExcludedSequenceMotifsDesignFilterResponse struct{…}
Motifs []string

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

Type ExcludedSequenceMotifs
Residues []int64

0-indexed residues to redesign on this chain.

Type Residues
NumProteins int64

Number of unique filter-passing redesigned proteins to generate.

minimum1
maximum1000
Structure ProteinSequenceRedesignStopResponseInputBinderProteinSequenceRedesignRunInputResponseStructure
URL string

URL to download the file

formaturi
URLExpiresAt Time

When the presigned URL expires

formatdate-time
Type Binder
GlobalDesignFilters []ProteinSequenceRedesignStopResponseInputBinderProteinSequenceRedesignRunInputResponseGlobalDesignFilterUnionOptional

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

One of the following:
type ProteinSequenceRedesignStopResponseInputBinderProteinSequenceRedesignRunInputResponseGlobalDesignFilterExcludedAminoAcidsDesignFilterResponse struct{…}
AminoAcids []string

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

Type ExcludedAminoAcids
type ProteinSequenceRedesignStopResponseInputBinderProteinSequenceRedesignRunInputResponseGlobalDesignFilterMaxHydrophobicFractionDesignFilterResponse struct{…}
MaxFraction float64
minimum0
maximum1
Type MaxHydrophobicFraction
type ProteinSequenceRedesignStopResponseInputBinderProteinSequenceRedesignRunInputResponseGlobalDesignFilterExcludedSequenceMotifsDesignFilterResponse struct{…}
Motifs []string

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

Type ExcludedSequenceMotifs
IdempotencyKey stringOptional
maxLength255
WorkspaceID stringOptional

Workspace to run this redesign in.

type ProteinSequenceRedesignStopResponseInputGenericProteinSequenceRedesignRunInputResponse struct{…}
Entities []ProteinSequenceRedesignStopResponseInputGenericProteinSequenceRedesignRunInputResponseEntity

Every chain in the input CIF, assigned exactly once.

ChainID string
minLength1
Type FromTemplate
DesignMotifs []ProteinSequenceRedesignStopResponseInputGenericProteinSequenceRedesignRunInputResponseEntityDesignMotifOptional

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

Filters []ProteinSequenceRedesignStopResponseInputGenericProteinSequenceRedesignRunInputResponseEntityDesignMotifFilterUnion

Filters applied to this motif in addition to global_design_filters.

One of the following:
type ProteinSequenceRedesignStopResponseInputGenericProteinSequenceRedesignRunInputResponseEntityDesignMotifFilterExcludedAminoAcidsDesignFilterResponse struct{…}
AminoAcids []string

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

Type ExcludedAminoAcids
type ProteinSequenceRedesignStopResponseInputGenericProteinSequenceRedesignRunInputResponseEntityDesignMotifFilterMaxHydrophobicFractionDesignFilterResponse struct{…}
MaxFraction float64
minimum0
maximum1
Type MaxHydrophobicFraction
type ProteinSequenceRedesignStopResponseInputGenericProteinSequenceRedesignRunInputResponseEntityDesignMotifFilterExcludedSequenceMotifsDesignFilterResponse struct{…}
Motifs []string

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

Type ExcludedSequenceMotifs
Residues []int64

0-indexed residues to redesign on this chain.

Type Residues
NumProteins int64

Number of unique filter-passing redesigned proteins to generate.

minimum1
maximum1000
Structure ProteinSequenceRedesignStopResponseInputGenericProteinSequenceRedesignRunInputResponseStructure
URL string

URL to download the file

formaturi
URLExpiresAt Time

When the presigned URL expires

formatdate-time
Type Generic
GlobalDesignFilters []ProteinSequenceRedesignStopResponseInputGenericProteinSequenceRedesignRunInputResponseGlobalDesignFilterUnionOptional

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

One of the following:
type ProteinSequenceRedesignStopResponseInputGenericProteinSequenceRedesignRunInputResponseGlobalDesignFilterExcludedAminoAcidsDesignFilterResponse struct{…}
AminoAcids []string

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

Type ExcludedAminoAcids
type ProteinSequenceRedesignStopResponseInputGenericProteinSequenceRedesignRunInputResponseGlobalDesignFilterMaxHydrophobicFractionDesignFilterResponse struct{…}
MaxFraction float64
minimum0
maximum1
Type MaxHydrophobicFraction
type ProteinSequenceRedesignStopResponseInputGenericProteinSequenceRedesignRunInputResponseGlobalDesignFilterExcludedSequenceMotifsDesignFilterResponse struct{…}
Motifs []string

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

Type ExcludedSequenceMotifs
IdempotencyKey stringOptional
maxLength255
WorkspaceID stringOptional

Workspace to run this redesign in.

Livemode bool

Whether this resource was created with a live API key.

Pipeline BoltzProteinRedesign
PipelineVersion V2026_07_14
Progress ProteinSequenceRedesignStopResponseProgress
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 ProteinSequenceRedesignStopResponseStatus
One of the following:
const ProteinSequenceRedesignStopResponseStatusPending ProteinSequenceRedesignStopResponseStatus = "pending"
const ProteinSequenceRedesignStopResponseStatusRunning ProteinSequenceRedesignStopResponseStatus = "running"
const ProteinSequenceRedesignStopResponseStatusSucceeded ProteinSequenceRedesignStopResponseStatus = "succeeded"
const ProteinSequenceRedesignStopResponseStatusFailed ProteinSequenceRedesignStopResponseStatus = "failed"
const ProteinSequenceRedesignStopResponseStatusStopped ProteinSequenceRedesignStopResponseStatus = "stopped"
StoppedAt Time
formatdate-time
WorkspaceID string

Workspace ID

IdempotencyKey stringOptional

Client-provided idempotency key

Stop a running protein sequence redesign 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.SequenceRedesign.Stop(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": "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"
}