Skip to content
Boltz Boltz Boltz API Docs
Go to Boltz API
API Reference
Predictions
Structure And Binding

List structure and binding predictions

predictions.structure_and_binding.list(StructureAndBindingListParams**kwargs) -> SyncCursorPage[StructureAndBindingListResponse]
GET/compute/v1/predictions/structure-and-binding

List structure and binding predictions, optionally filtered by workspace

ParametersExpand Collapse
after_id: Optional[str]

Return results after this ID

before_id: Optional[str]

Return results before this ID

limit: Optional[int]

Max items to return. Defaults to 100.

minimum1
maximum100
workspace_id: Optional[str]

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
class StructureAndBindingListResponse: …
id: str

Unique prediction identifier

completed_at: Optional[datetime]
formatdate-time
created_at: datetime
formatdate-time
data_deleted_at: Optional[datetime]

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

formatdate-time
error: Optional[Error]

Error details when failed

code: str

Machine-readable error code

message: str

Human-readable error message

details: Optional[object]

Additional field-level error details keyed by input path, when available.

expires_at: Optional[datetime]

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: Literal["boltz-2.1"]

Model used for prediction

started_at: Optional[datetime]
formatdate-time
status: Literal["pending", "running", "succeeded", "failed"]
One of the following:
"pending"
"running"
"succeeded"
"failed"
version: str

Model version used for prediction

workspace_id: str

Workspace ID

idempotency_key: Optional[str]

Client-provided idempotency key

List structure and binding predictions

import os
from boltz_api import Boltz

client = Boltz(
    api_key=os.environ.get("BOLTZ_API_KEY"),  # This is the default and can be omitted
)
page = client.predictions.structure_and_binding.list()
page = page.data[0]
print(page.id)
{
  "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"
}