List structure and binding predictions

client.Predictions.StructureAndBinding.List(ctx, query) (*CursorPage[PredictionStructureAndBindingListResponse], error)

GET/compute/v1/predictions/structure-and-binding

List structure and binding predictions, optionally filtered by workspace

ParametersExpand Collapse

query PredictionStructureAndBindingListParams

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

ID string

Unique prediction identifier

CompletedAt Time

formatdate-time

CreatedAt Time

formatdate-time

DataDeletedAt Time

When the input/output data was deleted, or null if still available

formatdate-time

Error PredictionStructureAndBindingListResponseError

Error details when failed

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.

ExpiresAt Time

When this resource and its associated data will be permanently deleted. Null while still in progress.

formatdate-time

Livemode bool

Whether this resource was created with a live API key.

Model Boltz2_1

Model used for prediction

StartedAt Time

formatdate-time

Status PredictionStructureAndBindingListResponseStatus

Accepts one of the following:

const PredictionStructureAndBindingListResponseStatusPending PredictionStructureAndBindingListResponseStatus = "pending"

const PredictionStructureAndBindingListResponseStatusRunning PredictionStructureAndBindingListResponseStatus = "running"

const PredictionStructureAndBindingListResponseStatusSucceeded PredictionStructureAndBindingListResponseStatus = "succeeded"

const PredictionStructureAndBindingListResponseStatusFailed PredictionStructureAndBindingListResponseStatus = "failed"

Version string

Model version used for prediction

WorkspaceID string

Workspace ID

IdempotencyKey stringoptional

Client-provided idempotency key

List structure and binding predictions

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.Predictions.StructureAndBinding.List(context.TODO(), boltzapi.PredictionStructureAndBindingListParams{

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

{
  "data": [
    {
      "id": "sab_pred_2X7Ab9Cd3Ef6Gh1JkLmN",
      "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",
      "error": {
        "code": "code",
        "message": "message",
        "details": {}
      },
      "expires_at": "2019-12-27T18:11:19.117Z",
      "livemode": true,
      "model": "boltz-2.1",
      "started_at": "2019-12-27T18:11:19.117Z",
      "status": "pending",
      "version": "version",
      "workspace_id": "workspace_id",
      "idempotency_key": "idempotency_key"
    }
  ],
  "first_id": "sab_pred_2X7Ab9Cd3Ef6Gh1JkLmN",
  "has_more": true,
  "last_id": "sab_pred_2X7Ab9Cd3Ef6Gh1JkLmN"
}

Returns Examples

{
  "data": [
    {
      "id": "sab_pred_2X7Ab9Cd3Ef6Gh1JkLmN",
      "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",
      "error": {
        "code": "code",
        "message": "message",
        "details": {}
      },
      "expires_at": "2019-12-27T18:11:19.117Z",
      "livemode": true,
      "model": "boltz-2.1",
      "started_at": "2019-12-27T18:11:19.117Z",
      "status": "pending",
      "version": "version",
      "workspace_id": "workspace_id",
      "idempotency_key": "idempotency_key"
    }
  ],
  "first_id": "sab_pred_2X7Ab9Cd3Ef6Gh1JkLmN",
  "has_more": true,
  "last_id": "sab_pred_2X7Ab9Cd3Ef6Gh1JkLmN"
}