List protein library screens

client.Protein.LibraryScreen.List(ctx, query) (*CursorPage[ProteinLibraryScreenListResponse], error)

GET/compute/v1/protein/library-screen

List protein library screens, optionally filtered by workspace

ParametersExpand Collapse

query ProteinLibraryScreenListParams

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

Summary of a protein library screening engine run (excludes input)

ID string

Unique ProteinLibraryScreenSummary 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 BoltzProteinScreen

Engine used for protein library screen

EngineVersion string

Engine version used for protein library screen

Error ProteinLibraryScreenListResponseError

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 ProteinLibraryScreenListResponseProgress

NumProteinsFailed int64

Number of accepted proteins that reached terminal failure during screening.

minimum0

NumProteinsScreened int64

Number of accepted proteins that produced usable screening results.

minimum0

TotalProteinsToScreen int64

Total number of proteins accepted into the screening run.

minimum1

LatestResultID stringoptional

ID of the latest result

StartedAt Time

formatdate-time

Status ProteinLibraryScreenListResponseStatus

Accepts one of the following:

const ProteinLibraryScreenListResponseStatusPending ProteinLibraryScreenListResponseStatus = "pending"

const ProteinLibraryScreenListResponseStatusRunning ProteinLibraryScreenListResponseStatus = "running"

const ProteinLibraryScreenListResponseStatusSucceeded ProteinLibraryScreenListResponseStatus = "succeeded"

const ProteinLibraryScreenListResponseStatusFailed ProteinLibraryScreenListResponseStatus = "failed"

const ProteinLibraryScreenListResponseStatusStopped ProteinLibraryScreenListResponseStatus = "stopped"

StoppedAt Time

formatdate-time

WorkspaceID string

Workspace ID

IdempotencyKey stringoptional

Client-provided idempotency key

List protein library screens

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.LibraryScreen.List(context.TODO(), boltzapi.ProteinLibraryScreenListParams{

  })
  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-screen",
      "engine_version": "engine_version",
      "error": {
        "code": "code",
        "message": "message",
        "details": {}
      },
      "livemode": true,
      "progress": {
        "num_proteins_failed": 0,
        "num_proteins_screened": 0,
        "total_proteins_to_screen": 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-screen",
      "engine_version": "engine_version",
      "error": {
        "code": "code",
        "message": "message",
        "details": {}
      },
      "livemode": true,
      "progress": {
        "num_proteins_failed": 0,
        "num_proteins_screened": 0,
        "total_proteins_to_screen": 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"
}