Start a protein sequence redesign run

client.Protein.SequenceRedesign.Start(ctx, body) (*ProteinSequenceRedesignStartResponse, error)

POST/compute/v1/protein/sequence-redesign

Create a protein sequence redesign run from selected residues in a fixed input structure

ParametersExpand Collapse

body ProteinSequenceRedesignStartParams

Entities param.Field[[]ProteinSequenceRedesignStartParamsBinderProteinSequenceRedesignRunInputEntityUnion]

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

ProteinSequenceRedesignStartParamsBinderProteinSequenceRedesignRunInputEntityBinderSequenceRedesignTargetEntity

ChainID string

minLength1

Role Target

Type FromTemplate

ProteinSequenceRedesignStartParamsBinderProteinSequenceRedesignRunInputEntityBinderSequenceRedesignBinderEntity

ChainID string

minLength1

Role Binder

Type FromTemplate

DesignMotifs []ProteinSequenceRedesignStartParamsBinderProteinSequenceRedesignRunInputEntityBinderSequenceRedesignBinderEntityDesignMotifOptional

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

Filters []ProteinSequenceRedesignStartParamsBinderProteinSequenceRedesignRunInputEntityBinderSequenceRedesignBinderEntityDesignMotifFilterUnion

Filters applied to this motif in addition to global_design_filters.

One of the following:

ProteinSequenceRedesignStartParamsBinderProteinSequenceRedesignRunInputEntityBinderSequenceRedesignBinderEntityDesignMotifFilterExcludedAminoAcidsDesignFilter

AminoAcids []string

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

Type ExcludedAminoAcids

ProteinSequenceRedesignStartParamsBinderProteinSequenceRedesignRunInputEntityBinderSequenceRedesignBinderEntityDesignMotifFilterMaxHydrophobicFractionDesignFilter

MaxFraction float64

minimum0

maximum1

Type MaxHydrophobicFraction

ProteinSequenceRedesignStartParamsBinderProteinSequenceRedesignRunInputEntityBinderSequenceRedesignBinderEntityDesignMotifFilterExcludedSequenceMotifsDesignFilter

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 param.Field[int64]

Number of unique filter-passing redesigned proteins to generate.

minimum1

maximum1000

Structure param.Field[ProteinSequenceRedesignStartParamsBinderProteinSequenceRedesignRunInputStructureUnion]

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

ProteinSequenceRedesignStartParamsBinderProteinSequenceRedesignRunInputStructureURLSource

Type URL

URL string

formaturi

ProteinSequenceRedesignStartParamsBinderProteinSequenceRedesignRunInputStructureCifBase64Source

Data string

Base64-encoded CIF file contents

MediaType ChemicalXCif

Must be chemical/x-cif for CIF files

Type Base64

Type param.Field[Binder]

const BinderBinder Binder = "binder"

GlobalDesignFilters param.Field[[]ProteinSequenceRedesignStartParamsBinderProteinSequenceRedesignRunInputGlobalDesignFilterUnion]Optional

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

ProteinSequenceRedesignStartParamsBinderProteinSequenceRedesignRunInputGlobalDesignFilterExcludedAminoAcidsDesignFilter

AminoAcids []string

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

Type ExcludedAminoAcids

ProteinSequenceRedesignStartParamsBinderProteinSequenceRedesignRunInputGlobalDesignFilterMaxHydrophobicFractionDesignFilter

MaxFraction float64

minimum0

maximum1

Type MaxHydrophobicFraction

ProteinSequenceRedesignStartParamsBinderProteinSequenceRedesignRunInputGlobalDesignFilterExcludedSequenceMotifsDesignFilter

Motifs []string

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

Type ExcludedSequenceMotifs

IdempotencyKey param.Field[string]Optional

maxLength255

WorkspaceID param.Field[string]Optional

Workspace to run this redesign in.

ReturnsExpand Collapse

type ProteinSequenceRedesignStartResponse 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 ProteinSequenceRedesignStartResponseError

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 ProteinSequenceRedesignStartResponseInputUnion

Pipeline input (null if data deleted)

One of the following:

type ProteinSequenceRedesignStartResponseInputBinderProteinSequenceRedesignRunInputResponse struct{…}

Entities []ProteinSequenceRedesignStartResponseInputBinderProteinSequenceRedesignRunInputResponseEntityUnion

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

One of the following:

type ProteinSequenceRedesignStartResponseInputBinderProteinSequenceRedesignRunInputResponseEntityBinderSequenceRedesignTargetEntityResponse struct{…}

A fixed target chain from the input CIF.

ChainID string

minLength1

Role Target

Type FromTemplate

type ProteinSequenceRedesignStartResponseInputBinderProteinSequenceRedesignRunInputResponseEntityBinderSequenceRedesignBinderEntityResponse struct{…}

ChainID string

minLength1

Role Binder

Type FromTemplate

DesignMotifs []ProteinSequenceRedesignStartResponseInputBinderProteinSequenceRedesignRunInputResponseEntityBinderSequenceRedesignBinderEntityResponseDesignMotifOptional

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

Filters []ProteinSequenceRedesignStartResponseInputBinderProteinSequenceRedesignRunInputResponseEntityBinderSequenceRedesignBinderEntityResponseDesignMotifFilterUnion

Filters applied to this motif in addition to global_design_filters.

One of the following:

type ProteinSequenceRedesignStartResponseInputBinderProteinSequenceRedesignRunInputResponseEntityBinderSequenceRedesignBinderEntityResponseDesignMotifFilterExcludedAminoAcidsDesignFilterResponse struct{…}

AminoAcids []string

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

Type ExcludedAminoAcids

MaxFraction float64

minimum0

maximum1

Type MaxHydrophobicFraction

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 ProteinSequenceRedesignStartResponseInputBinderProteinSequenceRedesignRunInputResponseStructure

URL string

URL to download the file

formaturi

URLExpiresAt Time

When the presigned URL expires

formatdate-time

Type Binder

GlobalDesignFilters []ProteinSequenceRedesignStartResponseInputBinderProteinSequenceRedesignRunInputResponseGlobalDesignFilterUnionOptional

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

One of the following:

type ProteinSequenceRedesignStartResponseInputBinderProteinSequenceRedesignRunInputResponseGlobalDesignFilterExcludedAminoAcidsDesignFilterResponse struct{…}

AminoAcids []string

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

Type ExcludedAminoAcids

type ProteinSequenceRedesignStartResponseInputBinderProteinSequenceRedesignRunInputResponseGlobalDesignFilterMaxHydrophobicFractionDesignFilterResponse struct{…}

MaxFraction float64

minimum0

maximum1

Type MaxHydrophobicFraction

type ProteinSequenceRedesignStartResponseInputBinderProteinSequenceRedesignRunInputResponseGlobalDesignFilterExcludedSequenceMotifsDesignFilterResponse 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 ProteinSequenceRedesignStartResponseInputGenericProteinSequenceRedesignRunInputResponse struct{…}

Entities []ProteinSequenceRedesignStartResponseInputGenericProteinSequenceRedesignRunInputResponseEntity

Every chain in the input CIF, assigned exactly once.

ChainID string

minLength1

Type FromTemplate

DesignMotifs []ProteinSequenceRedesignStartResponseInputGenericProteinSequenceRedesignRunInputResponseEntityDesignMotifOptional

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

Filters []ProteinSequenceRedesignStartResponseInputGenericProteinSequenceRedesignRunInputResponseEntityDesignMotifFilterUnion

Filters applied to this motif in addition to global_design_filters.

One of the following:

type ProteinSequenceRedesignStartResponseInputGenericProteinSequenceRedesignRunInputResponseEntityDesignMotifFilterExcludedAminoAcidsDesignFilterResponse struct{…}

AminoAcids []string

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

Type ExcludedAminoAcids

type ProteinSequenceRedesignStartResponseInputGenericProteinSequenceRedesignRunInputResponseEntityDesignMotifFilterMaxHydrophobicFractionDesignFilterResponse struct{…}

MaxFraction float64

minimum0

maximum1

Type MaxHydrophobicFraction

type ProteinSequenceRedesignStartResponseInputGenericProteinSequenceRedesignRunInputResponseEntityDesignMotifFilterExcludedSequenceMotifsDesignFilterResponse 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 ProteinSequenceRedesignStartResponseInputGenericProteinSequenceRedesignRunInputResponseStructure

URL string

URL to download the file

formaturi

URLExpiresAt Time

When the presigned URL expires

formatdate-time

Type Generic

GlobalDesignFilters []ProteinSequenceRedesignStartResponseInputGenericProteinSequenceRedesignRunInputResponseGlobalDesignFilterUnionOptional

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

One of the following:

type ProteinSequenceRedesignStartResponseInputGenericProteinSequenceRedesignRunInputResponseGlobalDesignFilterExcludedAminoAcidsDesignFilterResponse struct{…}

AminoAcids []string

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

Type ExcludedAminoAcids

type ProteinSequenceRedesignStartResponseInputGenericProteinSequenceRedesignRunInputResponseGlobalDesignFilterMaxHydrophobicFractionDesignFilterResponse struct{…}

MaxFraction float64

minimum0

maximum1

Type MaxHydrophobicFraction

type ProteinSequenceRedesignStartResponseInputGenericProteinSequenceRedesignRunInputResponseGlobalDesignFilterExcludedSequenceMotifsDesignFilterResponse 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 ProteinSequenceRedesignStartResponseProgress

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 ProteinSequenceRedesignStartResponseStatus

One of the following:

const ProteinSequenceRedesignStartResponseStatusPending ProteinSequenceRedesignStartResponseStatus = "pending"

const ProteinSequenceRedesignStartResponseStatusRunning ProteinSequenceRedesignStartResponseStatus = "running"

const ProteinSequenceRedesignStartResponseStatusSucceeded ProteinSequenceRedesignStartResponseStatus = "succeeded"

const ProteinSequenceRedesignStartResponseStatusFailed ProteinSequenceRedesignStartResponseStatus = "failed"

const ProteinSequenceRedesignStartResponseStatusStopped ProteinSequenceRedesignStartResponseStatus = "stopped"

StoppedAt Time

formatdate-time

WorkspaceID string

Workspace ID

IdempotencyKey stringOptional

Client-provided idempotency key

Start a 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.Start(context.TODO(), boltzapi.ProteinSequenceRedesignStartParams{
    OfBinderProteinSequenceRedesignRunInput: &boltzapi.ProteinSequenceRedesignStartParamsBodyBinderProteinSequenceRedesignRunInput{
      Entities: []boltzapi.ProteinSequenceRedesignStartParamsBodyBinderProteinSequenceRedesignRunInputEntityUnion{boltzapi.ProteinSequenceRedesignStartParamsBodyBinderProteinSequenceRedesignRunInputEntityUnion{
        OfProteinSequenceRedesignStartsBodyBinderProteinSequenceRedesignRunInputEntityBinderSequenceRedesignTargetEntity: &boltzapi.ProteinSequenceRedesignStartParamsBodyBinderProteinSequenceRedesignRunInputEntityBinderSequenceRedesignTargetEntity{
          ChainID: "x",
        },
      }, boltzapi.ProteinSequenceRedesignStartParamsBodyBinderProteinSequenceRedesignRunInputEntityUnion{
        OfProteinSequenceRedesignStartsBodyBinderProteinSequenceRedesignRunInputEntityBinderSequenceRedesignTargetEntity: &boltzapi.ProteinSequenceRedesignStartParamsBodyBinderProteinSequenceRedesignRunInputEntityBinderSequenceRedesignTargetEntity{
          ChainID: "x",
        },
      }},
      NumProteins: 1,
      Structure: boltzapi.ProteinSequenceRedesignStartParamsBodyBinderProteinSequenceRedesignRunInputStructureUnion{
        OfProteinSequenceRedesignStartsBodyBinderProteinSequenceRedesignRunInputStructureURLSource: &boltzapi.ProteinSequenceRedesignStartParamsBodyBinderProteinSequenceRedesignRunInputStructureURLSource{
          URL: "https://example.com",
        },
      },
    },
  })
  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"
}