Skip to main content
Each tool matches a REST endpoint and needs the same scope. An app only sees the tools for the permissions you allowed when you connected it, or for the scopes of its API key. Tools return JSON in the same shape as the REST API, and errors in the same format, so an app can read error.code and error.message and recover.

​
Engines

​
list_engines

List engines. Lists the Revilico computational engines you can run (slug, name, family, description). Start here. Read-only · Scope: engines:read No arguments.

​
get_engine

Describe an engine. Describes one engine: its parameters as JSON Schema (with defaults), the input files it takes, limits, outputs and example requests. Read this before create_run. Read-only · Scope: engines:read

​
validate_parameters

Validate run parameters. Checks parameters against the engine schema without running anything, and returns them with defaults filled in. Read-only · Scope: engines:read

​
Files

​
upload_file_content

Upload a small text file. Uploads a text input file (e.g. SDF, MOL, XYZ or CSV of SMILES, up to 1 MB) and returns its file id for create_run. The name must end with the format extension, e.g. “ligands.sdf”. Makes changes · Scope: files:write

​
create_upload

Start a large file upload. For files you can send over HTTP yourself: returns a file id and a pre-signed URL. PUT the bytes there with the returned headers within 15 minutes, then use the file id in create_run. Makes changes · Scope: files:write

​
get_file

Check an uploaded file. Shows an uploaded file. Not found means the upload has not finished. Read-only · Scope: files:write

​
Runs

​
create_run

Start an engine run. Starts a run and returns it with status “queued”. Runs take minutes to hours and spend credits; check progress with get_run. parameters must match the engine schema from get_engine; inputs maps each input key to a file id. Pass projectId to add the run to a project. Makes changes · Scope: runs:write

​
get_run

Check a run. Status (queued, running, succeeded, failed, cancelled), progress, timestamps, credits used and any error. Read-only · Scope: runs:read

​
get_run_inputs

Show what a run was given. The parameters and input files a run was submitted with. Read-only · Scope: runs:read

​
list_runs

List runs. Your runs, newest first. Filter by engine and status; pass nextCursor back for more. Read-only · Scope: runs:read

​
cancel_run

Cancel a run. Stops a queued or running run. This cannot be undone. Makes changes · Scope: runs:write

​
Results and outputs

​
get_results

Read run results. Headline results of a succeeded run as JSON rows (one per molecule or chain), plus run-level facts. Per-atom data (charges, indices, sites) and structures are not in these rows: use get_result_detail with a row’s index. Pass nextCursor back for more rows. Read-only · Scope: data:read

​
get_result_detail

Read one result in full. Everything the engine produced for one row of get_results (the row’s index): its full result document (e.g. atomic charges, spin densities, gradients), per-atom or per-site tables parsed from CSV, and the row’s file paths for read_run_file. Read-only · Scope: data:read

​
list_run_files

List all files of a run. Every file the engine wrote for a run (reports, structures, per-molecule results…), with sizes and whether read_run_file can return the content inline. Narrow with prefix, e.g. “molecules/00001_”. Read-only · Scope: data:read

​
read_run_file

Read a run file. One file of a run by its path from list_run_files: the content of text files up to 256 KB (JSON, CSV, TXT, XYZ, SDF, PDB…), plus a download URL valid for 15 minutes for any file. Read-only · Scope: data:read

​
list_outputs

List output files. The files a run produces and the formats each is available in. Read-only · Scope: data:read

​
get_output

Get a download link. A pre-signed download URL for one output file, valid for 15 minutes. Read-only · Scope: data:read

​
Projects

​
list_projects

List projects. Projects (named groups of runs, also used as campaigns) you own or are a member of, with your role and run count. Read-only · Scope: runs:read

​
get_project

Show a project. One project: name, description, your role, owner and run count. Read-only · Scope: runs:read

​
list_project_runs

List runs in a project. Runs in a project, newest first, including other members’ runs. Filter by engine and status. Read-only · Scope: runs:read

​
create_project

Create a project. Creates a project you own, to group related runs (a campaign). Pass its id as projectId to create_run, or use add_run_to_project. Makes changes · Scope: runs:write

​
add_run_to_project

Add a run to a project. Adds one of your runs to a project where you are an editor or owner. Makes changes · Scope: runs:write

​
remove_run_from_project

Remove a run from a project. Removes a run from a project (the run itself is kept). Needs editor or owner. Makes changes · Scope: runs:write

​
Account

​
get_credit_balance

Check credits. The organization’s credit pool: available, total and used. Credits are shared by everyone in the organization. Read-only · Scope: account:read No arguments.

​
get_usage

Credit usage by run. Credits used by your runs, one row per run, most recent first, with the total for the period. Filter by engine and by from/to (ISO dates; to is exclusive). Read-only · Scope: account:read