List small molecule design runs

client.SmallMolecule.Design.List(ctx, query) (*CursorPage[SmallMoleculeDesignListResponse], error)

GET/compute/v1/small-molecule/design

List small molecule design runs, optionally filtered by workspace

ParametersExpand Collapse

query SmallMoleculeDesignListParams

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

Summary of a small molecule design engine run (excludes input)

ID string

Unique SmDesignRunSummary 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 BoltzSmDesign

Engine used for small molecule design

EngineVersion string

Engine version used for small molecule design

Error SmallMoleculeDesignListResponseError

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 SmallMoleculeDesignListResponseProgress

NumMoleculesGenerated int64

Number of molecules generated so far

minimum0

TotalMoleculesToGenerate int64

Total number of molecules requested

minimum1

LatestResultID stringoptional

ID of the most recently generated result

StartedAt Time

formatdate-time

Status SmallMoleculeDesignListResponseStatus

Accepts one of the following:

const SmallMoleculeDesignListResponseStatusPending SmallMoleculeDesignListResponseStatus = "pending"

const SmallMoleculeDesignListResponseStatusRunning SmallMoleculeDesignListResponseStatus = "running"

const SmallMoleculeDesignListResponseStatusSucceeded SmallMoleculeDesignListResponseStatus = "succeeded"

const SmallMoleculeDesignListResponseStatusFailed SmallMoleculeDesignListResponseStatus = "failed"

const SmallMoleculeDesignListResponseStatusStopped SmallMoleculeDesignListResponseStatus = "stopped"

StoppedAt Time

formatdate-time

WorkspaceID string

Workspace ID

IdempotencyKey stringoptional

Client-provided idempotency key

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

  })
  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-design",
      "engine_version": "engine_version",
      "error": {
        "code": "code",
        "message": "message",
        "details": {}
      },
      "livemode": true,
      "progress": {
        "num_molecules_generated": 0,
        "total_molecules_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-sm-design",
      "engine_version": "engine_version",
      "error": {
        "code": "code",
        "message": "message",
        "details": {}
      },
      "livemode": true,
      "progress": {
        "num_molecules_generated": 0,
        "total_molecules_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"
}