List small molecule library screens

client.SmallMolecule.LibraryScreen.List(ctx, query) (*CursorPage[SmallMoleculeLibraryScreenListResponse], error)

GET/compute/v1/small-molecule/library-screen

List small molecule library screens, optionally filtered by workspace

ParametersExpand Collapse

query SmallMoleculeLibraryScreenListParams

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

Summary of a small molecule library screening engine run (excludes input)

ID string

Unique SmScreenSummary 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 BoltzSmScreen

Engine used for small molecule library screen

EngineVersion string

Engine version used for small molecule library screen

Error SmallMoleculeLibraryScreenListResponseError

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 SmallMoleculeLibraryScreenListResponseProgress

NumMoleculesFailed int64

Number of accepted molecules that reached terminal failure during screening.

minimum0

NumMoleculesScreened int64

Number of accepted molecules that produced usable screening results.

minimum0

TotalMoleculesToScreen int64

Total number of molecules accepted into screening after server-side validation and filtering.

minimum0

LatestResultID stringoptional

ID of the most recently screened result

RejectionSummary SmallMoleculeLibraryScreenListResponseProgressRejectionSummaryoptional

FilteredCount int64

Number of submitted molecules removed by server-side filtering rules.

minimum0

InvalidCount int64

Number of submitted molecules rejected as invalid input.

minimum0

StartedAt Time

formatdate-time

Status SmallMoleculeLibraryScreenListResponseStatus

Accepts one of the following:

const SmallMoleculeLibraryScreenListResponseStatusPending SmallMoleculeLibraryScreenListResponseStatus = "pending"

const SmallMoleculeLibraryScreenListResponseStatusRunning SmallMoleculeLibraryScreenListResponseStatus = "running"

const SmallMoleculeLibraryScreenListResponseStatusSucceeded SmallMoleculeLibraryScreenListResponseStatus = "succeeded"

const SmallMoleculeLibraryScreenListResponseStatusFailed SmallMoleculeLibraryScreenListResponseStatus = "failed"

const SmallMoleculeLibraryScreenListResponseStatusStopped SmallMoleculeLibraryScreenListResponseStatus = "stopped"

StoppedAt Time

formatdate-time

WorkspaceID string

Workspace ID

IdempotencyKey stringoptional

Client-provided idempotency key

List small molecule 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.SmallMolecule.LibraryScreen.List(context.TODO(), boltzapi.SmallMoleculeLibraryScreenListParams{

  })
  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-sm-screen",
      "engine_version": "engine_version",
      "error": {
        "code": "code",
        "message": "message",
        "details": {}
      },
      "livemode": true,
      "progress": {
        "num_molecules_failed": 0,
        "num_molecules_screened": 0,
        "total_molecules_to_screen": 0,
        "latest_result_id": "latest_result_id",
        "rejection_summary": {
          "filtered_count": 0,
          "invalid_count": 0
        }
      },
      "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-sm-screen",
      "engine_version": "engine_version",
      "error": {
        "code": "code",
        "message": "message",
        "details": {}
      },
      "livemode": true,
      "progress": {
        "num_molecules_failed": 0,
        "num_molecules_screened": 0,
        "total_molecules_to_screen": 0,
        "latest_result_id": "latest_result_id",
        "rejection_summary": {
          "filtered_count": 0,
          "invalid_count": 0
        }
      },
      "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"
}