REST API documentation#
This section of our site provides documentation supporting our REST API.
Here, you can find an overview of our workflow offerings and information needed to get started with our Property Regression, PoET, Align, Fold, and Embeddings workflows via the REST API.
Another method for interacting with our API is by using our Python API.
Authentication and Jobs#
We recommend starting here for the fundamental steps for user authentication and the endpoints for jobs. On top of log in instructions, we describe how our job system is designed and how jobs can be tracked.
The endpoints include:
Login
Jobs
After authenticating, we recommend proceeding directly to the respective workflow pages:
Property Regression#
Kickoff your Property Regression by using the endpoints to enable analyzing datasets, training sequence-to-function prediction models, using those models to predict properties for new sequences, and designing optimized libraries of sequence variants.
The endpoints include:
Assaydata
Train
Predict
Design
Jobs
Embeddings
PoET#
Design de novo sequences using these endpoints, without functional measurements of the protein of interest. Our proprietary models enable generation of single substitution, combinatorial variant libraries, or a high-diversity library.
The endpoints include:
PoET
Foundation Models#
Learn more about the endpoints needed to calculate raw embeddings on protein sequences here. Our platform offers a range of endpoints that harness the power of both our proprietary and open-source models.
The endpoints include:
Embeddings
Svd
Align#
Learn more about the endpoints needed to align multiple sequences here. This forms the basis for PoET and certain Fold workflows.
The endpoints include:
Align
Structure Prediction#
Learn more about the endpoints needed to create structure predictions on protein sequences here. Our platform offers access to ESMFold and AlphaFold2.
The endpoints include:
Fold
Next steps#
To start accessing our suite of APIs, refer to these articles to get started: