## List

`client.Protein.Design.List(ctx, query) (*CursorPage[ProteinDesignListResponse], error)`

**get** `/compute/v1/protein/design`

List protein design runs, optionally filtered by workspace

### Parameters

- `query ProteinDesignListParams`

  - `AfterID param.Field[string]`

    Return results after this ID

  - `BeforeID param.Field[string]`

    Return results before this ID

  - `Limit param.Field[int64]`

    Max items to return. Defaults to 100.

  - `WorkspaceID param.Field[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.

### Returns

- `type ProteinDesignListResponse struct{…}`

  Summary of a protein design engine run (excludes input)

  - `ID string`

    Unique ProteinDesignRunSummary identifier

  - `CompletedAt Time`

  - `CreatedAt Time`

  - `DataDeletedAt Time`

    When the input, output, and result data was permanently deleted. Null if data has not been deleted.

  - `Engine BoltzProteinDesign`

    Engine used for protein design

    - `const BoltzProteinDesignBoltzProteinDesign BoltzProteinDesign = "boltz-protein-design"`

  - `EngineVersion string`

    Engine version used for protein design

  - `Error ProteinDesignListResponseError`

    - `Code string`

      Machine-readable error code

    - `Message string`

      Human-readable error message

    - `Details any`

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

  - `Livemode bool`

    Whether this resource was created with a live API key.

  - `Progress ProteinDesignListResponseProgress`

    - `NumProteinsGenerated int64`

      Number of protein binders generated so far

    - `TotalProteinsToGenerate int64`

      Total number of protein binders requested

    - `LatestResultID string`

      ID of the most recently generated result

  - `StartedAt Time`

  - `Status ProteinDesignListResponseStatus`

    - `const ProteinDesignListResponseStatusPending ProteinDesignListResponseStatus = "pending"`

    - `const ProteinDesignListResponseStatusRunning ProteinDesignListResponseStatus = "running"`

    - `const ProteinDesignListResponseStatusSucceeded ProteinDesignListResponseStatus = "succeeded"`

    - `const ProteinDesignListResponseStatusFailed ProteinDesignListResponseStatus = "failed"`

    - `const ProteinDesignListResponseStatusStopped ProteinDesignListResponseStatus = "stopped"`

  - `StoppedAt Time`

  - `WorkspaceID string`

    Workspace ID

  - `IdempotencyKey string`

    Client-provided idempotency key

### Example

```go
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.Protein.Design.List(context.TODO(), boltzapi.ProteinDesignListParams{

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