openprotein.APISession#

Create an authorized session to OpenProtein.AI backend.

class openprotein.OpenProtein(username=None, password=None, backend='https://api.openprotein.ai/api/', timeout=180)[source]#

The base class for accessing OpenProtein API functionality.

Parameters:
  • username (str | None)

  • password (str | None)

  • backend (str)

  • timeout (int)

property data: DataAPI#

The data submodule gives access to functionality for uploading and accessing user data.

property jobs: JobsAPI#

The jobs submodule gives access to functionality for listing jobs and checking their status.

property align: AlignAPI#

The Align submodule gives access to the sequence alignment capabilities by building MSAs and prompts that can be used with PoET.

property prompt: PromptAPI#

The Align submodule gives access to the sequence alignment capabilities by building MSAs and prompts that can be used with PoET.

property embedding: EmbeddingsAPI#

The embedding submodule gives access to protein embedding models and their inference endpoints.

property embeddings: EmbeddingsAPI#

The embedding submodule gives access to protein embedding models and their inference endpoints.

property svd: SVDAPI#

The embedding submodule gives access to protein embedding models and their inference endpoints.

property umap: UMAPAPI#

The embedding submodule gives access to protein embedding models and their inference endpoints.

property predictor: PredictorAPI#

The predictor submodule gives access to training and predicting with predictors built on top of embeddings.

property design: DesignAPI#

The designer submodule gives access to functionality for designing new sequences using models from predictor train.

property fold: FoldAPI#

The fold submodule gives access to functionality for folding sequences and returning PDBs.

property models: ModelsAPI#

The models submodule provides a unified entry point to all protein models.