Tool reference

Generated from the live tool list by scripts/gen_tool_reference.py; do not edit by hand. 68 tools.

Every result carries its qualifiers under caveats. Read them before quoting a number.

Start here

study_sequence

Fold one molecule with every engine that fits it.

  • Access: Starts work and uses your allowance
  • Takes: sequence (string, required), molecule_type (string), declared_fold (string), project (string)

compare_variants

Fold a wild type and its point variants, then compare them engine by engine.

  • Access: Starts work and uses your allowance
  • Takes: sequence (string, required), mutations (array, required), molecule_type (string), project (string), again (boolean)

wait_for_job

Wait for a fold, a pocket, docking or interface analysis, or a pipeline run, up to max_seconds (5 to 55), then report.

  • Access: Reads your account
  • Takes: job_id (string, required), max_seconds (integer)

fold_summary

A finished fold in about 4 KB: what ran, where the engines agree, how far apart they sit, the structural checks, and whether the sequence was in training.

  • Access: Reads your account
  • Takes: job_id (string, required)

get_structure

The coordinates one engine predicted for an analysis, as PDB text.

  • Access: Reads your account
  • Takes: job_id (string, required), engine (string, required), trace_only (boolean), max_chars (integer)

estimate_fold

What a fold WOULD do, before it is submitted.

  • Access: Free, runs on our CPU, no account needed
  • Takes: sequence (string), molecule_type (string), n_tokens (integer)

Free and instant: sequences, primers, codons, restriction

reverse_complement

The reverse complement of a DNA or RNA sequence.

  • Access: Free, runs on our CPU, no account needed
  • Takes: sequence (string, required)

translate_sequence

Translate DNA or RNA in one frame (1,2,3 forward; -1,-2,-3 reverse).

  • Access: Free, runs on our CPU, no account needed
  • Takes: sequence (string, required), frame (integer)

find_open_reading_frames

Open reading frames in all six frames, in your own numbering.

  • Access: Free, runs on our CPU, no account needed
  • Takes: sequence (string, required), min_aa (integer), require_atg (boolean)

sequence_properties

Length, composition, GC, molecular weight and melting estimates.

  • Access: Free, runs on our CPU, no account needed
  • Takes: sequence (string, required), salt_mM (number)

protein_properties

Molecular weight, pI, extinction coefficient and GRAVY.

  • Access: Free, runs on our CPU, no account needed
  • Takes: sequence (string, required)

primer_tm

Melting temperature by nearest-neighbour thermodynamics.

  • Access: Free, runs on our CPU, no account needed
  • Takes: primer (string, required), salt_mM (number), primer_nM (number)

design_primers

Candidate primer pairs flanking a target region.

  • Access: Free, runs on our CPU, no account needed
  • Takes: template (string, required), target_start (integer), target_end (integer), tm_min (number), tm_max (number), salt_mM (number), primer_nM (number)

find_restriction_sites

Locate restriction sites in a DNA sequence, with an expected count.

  • Access: Free, runs on our CPU, no account needed
  • Takes: sequence (string, required), circular (boolean)

digest_sequence

Cut a DNA sequence with restriction enzymes and return the fragments.

  • Access: Free, runs on our CPU, no account needed
  • Takes: sequence (string, required), enzymes (array/null), circular (boolean)

simulate_gel

Which fragments a gel would actually separate.

  • Access: Free, runs on our CPU, no account needed
  • Takes: fragment_lengths (array, required), ladder (string)

optimize_codons

Recode a coding sequence synonymously, without changing the protein.

  • Access: Free, runs on our CPU, no account needed
  • Takes: cds (string, required), strategy (string)

scan_vector_liabilities

Locate G-quadruplex motifs and sharp folding-energy transitions in a DNA construct or vector genome.

  • Access: Free, runs on our CPU, no account needed
  • Takes: sequence (string, required)

find_crispr_guides

List candidate CRISPR guides in a sequence, with their properties.

  • Access: Free, runs on our CPU, no account needed
  • Takes: sequence (string, required), nuclease (string), both_strands (boolean)

make_point_variants

Apply named point mutations (e.g.

  • Access: Free, runs on our CPU, no account needed
  • Takes: sequence (string, required), mutations (array, required)

align_sequences

Pairwise alignment of two sequences, with its parameters and ambiguity.

  • Access: Free, runs on our CPU, no account needed
  • Takes: a (string, required), b (string, required), mode (string), kind (string), match (number/null), mismatch (number/null), gap_open (number/null), gap_extend (number/null)

find_motifs

Locate a motif in DNA or RNA, with how many to expect by chance.

  • Access: Free, runs on our CPU, no account needed
  • Takes: sequence (string, required), pattern (string), preset (string), mirna (string), both_strands (boolean), max_mismatches (integer), circular (boolean), start (integer), end (integer), max_sites (integer)

Free and instant: RNA structure on a CPU

fold_rna

Secondary structure: MFE, ensemble free energy, centroid, entropy.

  • Access: Free, runs on our CPU, no account needed
  • Takes: sequence (string, required), temperature (number), dna (boolean)

rna_ensemble

The ensemble of structures an RNA samples, as clusters with occupancies.

  • Access: Free, runs on our CPU, no account needed
  • Takes: sequence (string, required), n_samples (integer), seed (integer), reactivities (array/null), include_pair_occupancy (boolean)

rna_accessibility

Probability that each window is unpaired — the ASO/siRNA question.

  • Access: Free, runs on our CPU, no account needed
  • Takes: sequence (string, required), oligo_len (integer), window (integer), span (integer), temperature (number)

rna_duplex

Hybridisation of an oligo with its target: structure and energy.

  • Access: Free, runs on our CPU, no account needed
  • Takes: oligo (string, required), target (string, required), temperature (number)

rna_pairing_from_structure

The base pairing a 3D structure actually contains.

  • Access: Free, runs on our CPU, no account needed
  • Takes: pdb (string, required), chain (string)

check_probing_agreement

Compare a structure's base-pairing against your own SHAPE/DMS data.

  • Access: Free, runs on our CPU, no account needed
  • Takes: pairing (any, required), reactivity (array, required)

Projects: filing your work in the workbench

list_projects

Your projects, newest activity first, and how much work is not in any project.

  • Access: Reads your account
  • Takes: none

get_project

What is in a project, in the order it was added, with each item's current state.

  • Access: Reads your account
  • Takes: project (string, required)

create_project

Start a project, or return the existing one with that name (case-insensitive).

  • Access: Saves data on your account
  • Takes: name (string, required), description (string)

add_to_project

File something under a project, or add a note to it.

  • Access: Saves data on your account
  • Takes: project (string, required), kind (string, required), id (string), text (string), label (string)

Free: reading a structure you already have

describe_structure

What is in a set of coordinates: chains, kinds, sequences, lengths.

  • Access: Free, runs on our CPU, no account needed
  • Takes: pdb (string, required)

radius_of_gyration

Radius of gyration, in angstroms, over all atoms or one chain.

  • Access: Free, runs on our CPU, no account needed
  • Takes: pdb (string, required), chain (string)

min_distance_between_chains

Closest heavy-atom approach between two chains, and which atoms.

  • Access: Free, runs on our CPU, no account needed
  • Takes: pdb (string, required), chain_a (string, required), chain_b (string, required)

residue_contacts

Which residues of one chain touch the others, by distance criterion.

  • Access: Free, runs on our CPU, no account needed
  • Takes: pdb (string, required), chain (string, required), partners (array/null)

chain_clashes

Steric clashes between two chains — the platform's own check.

  • Access: Free, runs on our CPU, no account needed
  • Takes: pdb (string, required), chain_a (string, required), chain_b (string, required)

Your groups, pipelines, saved templates and earlier results

analyse_interface

Describe the contact surface between the molecules of a complex fold, engine by engine.

  • Access: Starts work and uses your allowance
  • Takes: job_id (string, required), pair (array/null), project (string)

create_group

Make a set of complexes that analyses can be mapped over.

  • Access: Saves data on your account
  • Takes: name (string, required), bundles (array, required)

delete_group

Delete a group now, and any complex no other group still holds.

  • Access: Deletes data on your account
  • Takes: group_id (string, required)

delete_pipeline_template

Delete a template and all its versions now.

  • Access: Deletes data on your account
  • Takes: template_id (string, required)

dock_ligand

Place one ligand in a pocket that find_pockets found.

  • Access: Starts work and uses your allowance
  • Takes: job_id (string, required), ligand_smiles (string, required), pocket_rank (integer), project (string)

estimate_pipeline

Price a run as a ceiling.

  • Access: Reads your account
  • Takes: bindings (object, required), pipeline (object/null), template_id (string), version (string), settings (object/null)

find_pockets

Detect cavities on the structures of a fold you already have, engine by engine.

  • Access: Starts work and uses your allowance
  • Takes: job_id (string, required), project (string)

fold

Fold one sequence with every engine that fits it, and compare them.

  • Access: Starts work and uses your allowance
  • Takes: sequence (string, required), molecule_type (string), declared_fold (string)

fold_complex

Fold two or more molecules together, such as DNA with a ligand or a protein with RNA.

  • Access: Starts work and uses your allowance
  • Takes: components (array, required), project (string)

get_analysis

Fetch an analysis by id, with its engine agreement and provenance.

  • Access: Reads your account
  • Takes: job_id (string, required)

get_group

A group with each complex's components and every score on it.

  • Access: Reads your account
  • Takes: group_id (string, required)

get_job_schema

The fields one analysis takes and what it returns.

  • Access: Free, runs on our CPU, no account needed
  • Takes: analysis (string)

get_pipeline_run

The full record of a run.

  • Access: Reads your account
  • Takes: run_id (string, required)

get_pipeline_schema

The shape of a pipeline, with a worked example.

  • Access: Reads your account
  • Takes: none

get_pipeline_template

A template and its versions; with version, that version's graph.

  • Access: Reads your account
  • Takes: template_id (string, required), version (string)

get_pipeline_usage

What your runs count under the decided rule.

  • Access: Reads your account
  • Takes: none

list_analyses

List this account's analyses, most recent first.

  • Access: Reads your account
  • Takes: none

list_capabilities

What this deployment can run: engines, profiles and analyses.

  • Access: Free, runs on our CPU, no account needed
  • Takes: kind (string), molecule_type (string)

list_groups

This account's groups, newest first, with the caps for its tier.

  • Access: Reads your account
  • Takes: none

list_pipeline_runs

Your pipeline runs, newest first.

  • Access: Reads your account
  • Takes: none

list_pipeline_templates

Your saved templates.

  • Access: Reads your account
  • Takes: none

rank_group

Order a group by ONE measured metric from ONE tool version.

  • Access: Reads your account
  • Takes: group_id (string, required), tool (string, required), metric (string, required), version (string), descending (boolean)

save_pipeline_template

Save a graph as the next version of a template.

  • Access: Saves data on your account
  • Takes: id (string, required), pipeline (object, required), editable (object/null), note (string)

score_group

Run one scorer over every complex in a group it accepts.

  • Access: Starts work and uses your allowance
  • Takes: group_id (string, required), scorer (string, required)

set_template_default

Choose which version a run uses when it names none.

  • Access: Saves data on your account
  • Takes: template_id (string, required), version (string)

submit_ensemble

Run the ensemble occupancy analysis on the platform.

  • Access: Starts work and uses your allowance
  • Takes: sequence (string, required), n_samples (integer), seed (integer), reactivities (array/null)

submit_pipeline

Run a pipeline.

  • Access: Starts work and uses your allowance
  • Takes: bindings (object, required), idempotency_key (string, required), budget_seconds (number, required), pipeline (object/null), template_id (string), version (string), settings (object/null), run_name (string)

suggest_next_steps

Which tools can take what a tool (or a type) produces.

  • Access: Free, runs on our CPU, no account needed
  • Takes: after (string, required), kind (string)

usage

What is left of this account's allowance, and the per-engine length caps, so a submission can be sized before it is refused.

  • Access: Reads your account
  • Takes: none

validate_job

Check a submission before anything is queued, field by field.

  • Access: Free, runs on our CPU, no account needed
  • Takes: analysis (string), sequence (string), molecule_type (string), parent_id (string), structure_pdb (string), ligand_smiles (string)

validate_pipeline

Check a pipeline and the groups bound to it.

  • Access: Reads your account
  • Takes: bindings (object, required), pipeline (object/null), template_id (string), version (string), settings (object/null)

Last changed 2026-11-18