Superbio Python Client
Official Python client for the Superbio platform API. Access bioinformatics tools and AI models programmatically.
Installation
pip install superbio
Quick Start
from superbio import Client
# Initialize client
client = Client("your@email.com", "your_password")
# List available apps
apps = client.get_app_list()
# Get app parameters
app_params = client.get_app_parameters("app_id")
# Submit a job with local files
job = client.post_job(
app_id="app_id",
running_mode="cpu",
config={"param": "value"},
local_files={"file_key": "path/to/file"}
)
Submit a job with S3 files
job = client.post_job(
app_id="app_id",
running_mode="cpu",
config={"param": "value"},
remote_file_source_data={
"file_key": [{
"protocol": "s3",
"credentials": {
"aws_access_key_id": "YOUR_ACCESS_KEY",
"aws_secret_access_key": "YOUR_SECRET_KEY"
},
"path": "bucket/path/to/file.csv"
}]
}
)
Check job status
status = client.get_job_status("job_id")
Download results
client.download_job_results("job_id", "output_directory")
Features
- Browse and search available bioinformatics applications
- Get detailed app configurations and parameters
- Submit computational jobs with:
- Local files
- Remote files (S3)
- Files from Superbio DataHub
- Monitor job status and progress
- Download and manage results
- Track credit balances and usage
Authentication
You must first create an account at app.superbio.ai. Your email and password from the platform will be used to authenticate API requests.
Examples
Working with Apps
# Get list of all apps
apps = client.get_app_list()
# List apps with pagination and search
apps = client.get_app_list(
hits_per_page=10, # (optional) Number of results per page
page=1, # (optional) Page number
search_string="genomics" # (optional)Search by keyword
)
# Get app details and parameters
app_config = client.get_app_parameters("app_id")
Job Management
# List jobs with filters
jobs = client.get_jobs(
hits_per_page=100, # (optional) Number of jobs per page
page=1, # (optional) Page number
status="running", # (optional) Filter by status: "running", "completed", "failed", etc.
date_from="01/01/2024", # (optional) Filter by start date (dd/mm/yyyy)
date_to="31/01/2024", # Filter by end date (dd/mm/yyyy)
search_string="analysis" # Search job titles
)
# Download specific result files
client.download_job_result_file(
job_id="job_id",
file_path="path/to/result.csv", # Path of file in job results
path_to_download_to="output_dir", # Local directory to save file
)
# Download all results
client.download_all_job_results(
job_id="job_id",
path_to_download_to="output_dir", # Local directory to save files
)
# Delete a job
client.delete_job("job_id")
Uploading Large Files to the Data Hub
The browser accepts up to 10 GB at a time. For larger data, upload from your computer with the command line tool or the Python client. Files are sent directly to storage in parallel parts; if the upload is interrupted, run the same command again within 24 hours and it continues from where it stopped.
export SUPERBIO_EMAIL="your@email.com"
export SUPERBIO_PASSWORD="your_password"
# Upload a file to the Data Hub root
superbio upload sample.bam
# Upload a folder (recursively) into the "projects" folder
superbio upload ./run_42 projects
# Upload to your organisation's shared Data Hub
superbio upload sample.bam --org
client.upload_to_datahub(
path="projects", # Destination folder ("" for the root)
local_files={"reads": "run_42/"}, # Files or folders to upload
is_organisation=False, # (optional) Organisation Data Hub
concurrency=8, # (optional) Parallel parts per file
)
Uploads count toward your Data Hub storage quota. If your data is already in Amazon S3, connect the bucket in the Data Hub instead; its files are available without copying.
Credit Management
# Get credit balances and usage info
balances = client.get_balances()
# Returns:
# {
# "balances": {
# "available_credits": 6000,
# "credits": 6000,
# "runs_left": 400,
# "total_runs": 400,
# "runtime_left": 72000.0,
# "total_runtime": 72000,
# "runs_reset_time": "Feb 28 2025, 23:08:05",
# "runtime_reset_time": "Feb 28 2025, 23:08:05",
# "tier": "free_organisation"
# }
# }
Support
For support, contact dmason@superbio.ai.
Metadata
Release files for superbio 0.2.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| superbio-0.2.0.tar.gz | 1.6 MB | With provenance | Details for superbio-0.2.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| superbio-0.2.0-py3-none-any.whl | Python 3 | none | any | Details for superbio-0.2.0-py3-none-any.whl |
Total release size: 3.3 MB
Release files / superbio-0.2.0.tar.gz
| Download URL | superbio-0.2.0.tar.gz |
|---|---|
| Size | 1.6 MB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
9408fb05d17636dc17dea3de01cce3375db117ea9bacd61f37c97b8c8cc35747
|
|
BLAKE2b-256 checksum How to use checksums |
a9a4aadb20660a8f92f8ee5126a61887aef52d094d141a2b37a3c00b2c763450
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 12, 2026.
Transparency logRelease files / superbio-0.2.0-py3-none-any.whl
| Download URL | superbio-0.2.0-py3-none-any.whl |
|---|---|
| Size | 1.7 MB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
2f31f70a8c258d1c7d36c31cd0dbc98ef458e7002686c9bb1b95a3bdf9ebf5b5
|
|
BLAKE2b-256 checksum How to use checksums |
d1172dd874b76a430e45e7e62073b744ede6aa85452602a2fe872ca9a4634e15
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
Yes |
| Uploaded via |
twine/7.0.0 CPython/3.13.14
|
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 12, 2026.
Transparency logSecurity for superbio 0.2.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
Full provenance
Both files in this release have been uploaded with provenance metadata.
Attestation for superbio-0.2.0.tar.gz
PyPI Publish Attestation
PyPI verified that this artifact, at this checksum, originated from the publisher listed below.
Signed by GitHub Actions, verified by PyPI on Oct 12, 2026.
Transparency logA note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.