List protein design runs

client.Protein.Design.List(ctx, query) (*CursorPage[ProteinDesignListResponse], error)

GET/compute/v1/protein/design

List protein design runs, optionally filtered by workspace

ParametersExpand Collapse

query ProteinDesignListParams

AfterID param.Field[string]optional

Return results after this ID

BeforeID param.Field[string]optional

Return results before this ID

Limit param.Field[int64]optional

Max items to return. Defaults to 100.

minimum1

maximum100

WorkspaceID param.Field[string]optional

Filter by workspace ID. Only used with admin API keys. If not provided, defaults to the workspace associated with the API key, or the default workspace for admin keys.

ReturnsExpand Collapse

type ProteinDesignListResponse struct{…}

Summary of a protein design engine run (excludes input)

ID string

Unique ProteinDesignRunSummary 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

Engine BoltzProteinDesign

Engine used for protein design

EngineVersion string

Engine version used for protein design

Error ProteinDesignListResponseError

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.

Livemode bool

Whether this resource was created with a live API key.

Progress ProteinDesignListResponseProgress

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 ProteinDesignListResponseStatus

Accepts one of the following:

const ProteinDesignListResponseStatusPending ProteinDesignListResponseStatus = "pending"

const ProteinDesignListResponseStatusRunning ProteinDesignListResponseStatus = "running"

const ProteinDesignListResponseStatusSucceeded ProteinDesignListResponseStatus = "succeeded"

const ProteinDesignListResponseStatusFailed ProteinDesignListResponseStatus = "failed"

const ProteinDesignListResponseStatusStopped ProteinDesignListResponseStatus = "stopped"

StoppedAt Time

formatdate-time

WorkspaceID string

Workspace ID

IdempotencyKey stringoptional

Client-provided idempotency key

List protein design runs

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.Protein.Design.List(context.TODO(), boltzapi.ProteinDesignListParams{

  })
  if err != nil {
    panic(err.Error())
  }
  fmt.Printf("%+v\n", page)
}

{
  "data": [
    {
      "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-design",
      "engine_version": "engine_version",
      "error": {
        "code": "code",
        "message": "message",
        "details": {}
      },
      "livemode": true,
      "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"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id"
}

Returns Examples

{
  "data": [
    {
      "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-design",
      "engine_version": "engine_version",
      "error": {
        "code": "code",
        "message": "message",
        "details": {}
      },
      "livemode": true,
      "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"
    }
  ],
  "first_id": "first_id",
  "has_more": true,
  "last_id": "last_id"
}