List pipeline results from a share link

client.ShareLinks.ListPipelineResults(ctx, pipelineID, params) (*CursorPage[ShareLinkListPipelineResultsResponse], error)

GET/compute/v1/share/{id}/pipelines/{pipelineId}/results

Paginated results for one pipeline exposed by a share link. The response shape matches the authed pipeline-results endpoints exactly. Access is gated by the share-link ID and — for email-mode links — a signed compute-API JWT. Pipeline IDs not covered by the link return 404 indistinguishably from unknown links.

ParametersExpand Collapse

pipelineID string

params ShareLinkListPipelineResultsParams

ID param.Field[string]

Path param: Share link ID. Treat as a secret — it is the bearer credential.

AfterID param.Field[string]Optional

Query param: Return results after this ID

BeforeID param.Field[string]Optional

Query param: Return results before this ID

IDs param.Field[string]Optional

Query param: Comma-separated list of result IDs to filter by (max 200). Only results whose ID matches one of these is returned; missing IDs are silently skipped. Composes with limit, after_id, and before_id — the filter is applied before pagination.

Limit param.Field[int64]Optional

Query param: Max results to return. Defaults to 100.

minimum1

maximum1000

ReturnsExpand Collapse

type ShareLinkListPipelineResultsResponse struct{…}

A single generated protein design

ID string

Unique result ID.

Artifacts ShareLinkListPipelineResultsResponseArtifacts

Archive ShareLinkListPipelineResultsResponseArtifactsArchive

URL string

URL to download the file

formaturi

URLExpiresAt Time

When the presigned URL expires

formatdate-time

Structure ShareLinkListPipelineResultsResponseArtifactsStructureOptional

URL string

URL to download the file

formaturi

URLExpiresAt Time

When the presigned URL expires

formatdate-time

CreatedAt Time

formatdate-time

Entities []ShareLinkListPipelineResultsResponseEntityUnion

Entities in the designed complex, including designed and fixed input entities.

One of the following:

type ShareLinkListPipelineResultsResponseEntityProteinEntity 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 []ShareLinkListPipelineResultsResponseEntityProteinEntityModificationOptional

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 ShareLinkListPipelineResultsResponseEntityRnaEntity 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 []ShareLinkListPipelineResultsResponseEntityRnaEntityModificationOptional

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 ShareLinkListPipelineResultsResponseEntityDnaEntity 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 []ShareLinkListPipelineResultsResponseEntityDnaEntityModificationOptional

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

ChainIDs []string

Chain IDs for this ligand

Type LigandCcd

Value string

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

type ShareLinkListPipelineResultsResponseEntityLigandSmilesEntity struct{…}

ChainIDs []string

Chain IDs for this ligand

Type LigandSmiles

Value string

SMILES string representing the ligand

Metrics ShareLinkListPipelineResultsResponseMetrics

Structural and binding quality metrics for a designed protein binder

BindingConfidence float64

Confidence that the designed binder binds the target (0-1). Primary metric for hit discovery.

HelixFraction float64

Fraction of the designed sequence forming alpha helices (0-1).

minimum0

maximum1

Iptm float64

Interface predicted TM score (0-1). Confidence in the protein-protein interface.

LoopFraction float64

Fraction of the designed sequence in coil/loop regions (0-1).

minimum0

maximum1

MinInteractionPae float64

Minimum predicted aligned error at the interface (Angstroms). Lower values indicate higher confidence.

SheetFraction float64

Fraction of the designed sequence forming beta sheets (0-1).

minimum0

maximum1

StructureConfidence float64

Confidence in the predicted 3D structure (0-1).

Warnings []ShareLinkListPipelineResultsResponseWarningOptional

Warnings about potential quality issues with this result.

Code string

Machine-readable warning code (e.g. “low_confidence”, “unusual_geometry”)

Message string

Human-readable description of the warning

List pipeline results from a share link

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"),
  )
  page, err := client.ShareLinks.ListPipelineResults(
    context.TODO(),
    "pipelineId",
    boltzapi.ShareLinkListPipelineResultsParams{
      ID: "id",
    },
  )
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "data": [
    {
      "id": "id",
      "artifacts": {
        "archive": {
          "url": "https://example.com",
          "url_expires_at": "2019-12-27T18:11:19.117Z"
        },
        "structure": {
          "url": "https://example.com",
          "url_expires_at": "2019-12-27T18:11:19.117Z"
        }
      },
      "created_at": "2019-12-27T18:11:19.117Z",
      "entities": [
        {
          "chain_ids": [
            "string"
          ],
          "type": "protein",
          "value": "value",
          "cyclic": true,
          "modifications": [
            {
              "residue_index": 0,
              "type": "ccd",
              "value": "value"
            }
          ]
        }
      ],
      "metrics": {
        "binding_confidence": 0,
        "helix_fraction": 0,
        "iptm": 0,
        "loop_fraction": 0,
        "min_interaction_pae": 0,
        "sheet_fraction": 0,
        "structure_confidence": 0
      },
      "warnings": [
        {
          "code": "code",
          "message": "message"
        }
      ]
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id"
}

Returns Examples

{
  "data": [
    {
      "id": "id",
      "artifacts": {
        "archive": {
          "url": "https://example.com",
          "url_expires_at": "2019-12-27T18:11:19.117Z"
        },
        "structure": {
          "url": "https://example.com",
          "url_expires_at": "2019-12-27T18:11:19.117Z"
        }
      },
      "created_at": "2019-12-27T18:11:19.117Z",
      "entities": [
        {
          "chain_ids": [
            "string"
          ],
          "type": "protein",
          "value": "value",
          "cyclic": true,
          "modifications": [
            {
              "residue_index": 0,
              "type": "ccd",
              "value": "value"
            }
          ]
        }
      ],
      "metrics": {
        "binding_confidence": 0,
        "helix_fraction": 0,
        "iptm": 0,
        "loop_fraction": 0,
        "min_interaction_pae": 0,
        "sheet_fraction": 0,
        "structure_confidence": 0
      },
      "warnings": [
        {
          "code": "code",
          "message": "message"
        }
      ]
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id"
}