Get protein sequence redesign run status

client.Protein.SequenceRedesign.Get(ctx, id, query) (*ProteinSequenceRedesignGetResponse, error)

GET/compute/v1/protein/sequence-redesign/{id}

Retrieve a sequence redesign run by ID, including progress and status

ParametersExpand Collapse

id string

query ProteinSequenceRedesignGetParams

WorkspaceID param.Field[string]Optional

Workspace ID. Only used with admin API keys. Ignored (or validated) for workspace-scoped keys.

ReturnsExpand Collapse

type ProteinSequenceRedesignGetResponse 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 ProteinSequenceRedesignGetResponseError

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 ProteinSequenceRedesignGetResponseInputUnion

Pipeline input (null if data deleted)

One of the following:

type ProteinSequenceRedesignGetResponseInputBinderProteinSequenceRedesignRunInputResponse struct{…}

Entities []ProteinSequenceRedesignGetResponseInputBinderProteinSequenceRedesignRunInputResponseEntityUnion

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

One of the following:

type ProteinSequenceRedesignGetResponseInputBinderProteinSequenceRedesignRunInputResponseEntityBinderSequenceRedesignTargetEntityResponse struct{…}

A fixed target chain from the input CIF.

ChainID string

minLength1

Role Target

Type FromTemplate

type ProteinSequenceRedesignGetResponseInputBinderProteinSequenceRedesignRunInputResponseEntityBinderSequenceRedesignBinderEntityResponse struct{…}

ChainID string

minLength1

Role Binder

Type FromTemplate

DesignMotifs []ProteinSequenceRedesignGetResponseInputBinderProteinSequenceRedesignRunInputResponseEntityBinderSequenceRedesignBinderEntityResponseDesignMotifOptional

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

Filters []ProteinSequenceRedesignGetResponseInputBinderProteinSequenceRedesignRunInputResponseEntityBinderSequenceRedesignBinderEntityResponseDesignMotifFilterUnion

Filters applied to this motif in addition to global_design_filters.

One of the following:

type ProteinSequenceRedesignGetResponseInputBinderProteinSequenceRedesignRunInputResponseEntityBinderSequenceRedesignBinderEntityResponseDesignMotifFilterExcludedAminoAcidsDesignFilterResponse 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 ProteinSequenceRedesignGetResponseInputBinderProteinSequenceRedesignRunInputResponseStructure

URL string

URL to download the file

formaturi

URLExpiresAt Time

When the presigned URL expires

formatdate-time

Type Binder

GlobalDesignFilters []ProteinSequenceRedesignGetResponseInputBinderProteinSequenceRedesignRunInputResponseGlobalDesignFilterUnionOptional

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

One of the following:

type ProteinSequenceRedesignGetResponseInputBinderProteinSequenceRedesignRunInputResponseGlobalDesignFilterExcludedAminoAcidsDesignFilterResponse struct{…}

AminoAcids []string

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

Type ExcludedAminoAcids

type ProteinSequenceRedesignGetResponseInputBinderProteinSequenceRedesignRunInputResponseGlobalDesignFilterMaxHydrophobicFractionDesignFilterResponse struct{…}

MaxFraction float64

minimum0

maximum1

Type MaxHydrophobicFraction

type ProteinSequenceRedesignGetResponseInputBinderProteinSequenceRedesignRunInputResponseGlobalDesignFilterExcludedSequenceMotifsDesignFilterResponse 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 ProteinSequenceRedesignGetResponseInputGenericProteinSequenceRedesignRunInputResponse struct{…}

Entities []ProteinSequenceRedesignGetResponseInputGenericProteinSequenceRedesignRunInputResponseEntity

Every chain in the input CIF, assigned exactly once.

ChainID string

minLength1

Type FromTemplate

DesignMotifs []ProteinSequenceRedesignGetResponseInputGenericProteinSequenceRedesignRunInputResponseEntityDesignMotifOptional

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

Filters []ProteinSequenceRedesignGetResponseInputGenericProteinSequenceRedesignRunInputResponseEntityDesignMotifFilterUnion

Filters applied to this motif in addition to global_design_filters.

One of the following:

type ProteinSequenceRedesignGetResponseInputGenericProteinSequenceRedesignRunInputResponseEntityDesignMotifFilterExcludedAminoAcidsDesignFilterResponse struct{…}

AminoAcids []string

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

Type ExcludedAminoAcids

type ProteinSequenceRedesignGetResponseInputGenericProteinSequenceRedesignRunInputResponseEntityDesignMotifFilterMaxHydrophobicFractionDesignFilterResponse struct{…}

MaxFraction float64

minimum0

maximum1

Type MaxHydrophobicFraction

type ProteinSequenceRedesignGetResponseInputGenericProteinSequenceRedesignRunInputResponseEntityDesignMotifFilterExcludedSequenceMotifsDesignFilterResponse 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 ProteinSequenceRedesignGetResponseInputGenericProteinSequenceRedesignRunInputResponseStructure

URL string

URL to download the file

formaturi

URLExpiresAt Time

When the presigned URL expires

formatdate-time

Type Generic

GlobalDesignFilters []ProteinSequenceRedesignGetResponseInputGenericProteinSequenceRedesignRunInputResponseGlobalDesignFilterUnionOptional

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

One of the following:

type ProteinSequenceRedesignGetResponseInputGenericProteinSequenceRedesignRunInputResponseGlobalDesignFilterExcludedAminoAcidsDesignFilterResponse struct{…}

AminoAcids []string

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

Type ExcludedAminoAcids

type ProteinSequenceRedesignGetResponseInputGenericProteinSequenceRedesignRunInputResponseGlobalDesignFilterMaxHydrophobicFractionDesignFilterResponse struct{…}

MaxFraction float64

minimum0

maximum1

Type MaxHydrophobicFraction

type ProteinSequenceRedesignGetResponseInputGenericProteinSequenceRedesignRunInputResponseGlobalDesignFilterExcludedSequenceMotifsDesignFilterResponse 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 ProteinSequenceRedesignGetResponseProgress

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 ProteinSequenceRedesignGetResponseStatus

One of the following:

const ProteinSequenceRedesignGetResponseStatusPending ProteinSequenceRedesignGetResponseStatus = "pending"

const ProteinSequenceRedesignGetResponseStatusRunning ProteinSequenceRedesignGetResponseStatus = "running"

const ProteinSequenceRedesignGetResponseStatusSucceeded ProteinSequenceRedesignGetResponseStatus = "succeeded"

const ProteinSequenceRedesignGetResponseStatusFailed ProteinSequenceRedesignGetResponseStatus = "failed"

const ProteinSequenceRedesignGetResponseStatusStopped ProteinSequenceRedesignGetResponseStatus = "stopped"

StoppedAt Time

formatdate-time

WorkspaceID string

Workspace ID

IdempotencyKey stringOptional

Client-provided idempotency key

Get protein sequence redesign run status

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"),
  )
  sequenceRedesign, err := client.Protein.SequenceRedesign.Get(
    context.TODO(),
    "id",
    boltzapi.ProteinSequenceRedesignGetParams{

    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", sequenceRedesign.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"
}