Skip to content
Go to Boltz API

List structure and binding predictions

$ boltz-api predictions:structure-and-binding list
GET/compute/v1/predictions/structure-and-binding

List structure and binding predictions, optionally filtered by workspace

ParametersExpand Collapse
--after-id: optional string

Return results after this ID

--before-id: optional string

Return results before this ID

--limit: optional number

Max items to return. Defaults to 100.

minimum1
maximum100
--workspace-id: optional string

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
ListBoltz2PredictionsResponse: object { data, first_id, has_more, last_id }
data: array of object { id, completed_at, created_at, 10 more }
id: string

Unique prediction identifier

completed_at: string
formatdate-time
created_at: string
formatdate-time
data_deleted_at: string

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

formatdate-time
error: object { code, message, details }

Error details when failed

code: string

Machine-readable error code

message: string

Human-readable error message

details: optional unknown

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

expires_at: string

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

formatdate-time
livemode: boolean

Whether this resource was created with a live API key.

model: "boltz-2.1"

Model used for prediction

started_at: string
formatdate-time
status: "pending" or "running" or "succeeded" or "failed"
Accepts one of the following:
"pending"
"running"
"succeeded"
"failed"
version: string

Model version used for prediction

workspace_id: string

Workspace ID

idempotency_key: optional string

Client-provided idempotency key

first_id: string

ID of the first item. Use as before_id for the previous page.

has_more: boolean
last_id: string

ID of the last item. Use as after_id for the next page.

List structure and binding predictions

boltz-api predictions:structure-and-binding list
{
  "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"
}