Getting Started
API Introduction
Programmatic access to Adaptyv Bio’s protein testing platform
The Adaptyv Bio API provides programmatic access to our cloud laboratory platform, enabling you to integrate protein testing workflows directly into your computational pipelines.
The Foundry API is currently in alpha. Features and endpoints may change significantly. To request API access, please email support@adaptyvbio.com.
Current Capabilities
Based on the OpenAPI specification, the alpha API currently supports:
Experiments
- Create experiments - Submit new protein sequences for testing
- List experiments - Track all your experiments and their status
- Get experiment details - Monitor progress and access configuration
Results
- List results - Browse completed experiment results
- Download results - Access detailed data packages and analysis
Targets
- Browse catalog - Search available antigen targets from ACROBiosystems
- Get target details - View specifications and pricing
- Request new targets - Submit requests for antigens not in the catalog
Organizations
- View organization - Check credits and usage metrics
- Monitor balance - Track credit consumption over time
Authentication
All API requests require a bearer token. Contact us to receive your API credentials during the alpha period.
Base URL
Getting Started
- Request Access - Email support@adaptyvbio.com to join the alpha program
- Receive Credentials - We’ll provide your API token and organization ID
- Explore Endpoints - Use the API Endpoints section to explore available operations
- Integration Support - Our team will help you integrate the API into your workflows
Example Usage
Important Notes
- Alpha Limitations - Not all platform features are available via API yet
- Breaking Changes - Expect frequent updates and changes during alpha
- Manual Approval - All API access requests are manually reviewed
- Support Priority - Alpha users receive priority support for integration
For detailed endpoint documentation, explore the API Endpoints section below.