Skip to main content
GET
Get an engine

Authorizations

Authorization
string
header
required

An API key from the web app (Settings → Developer), sent as Authorization: Bearer rvl_live_….

Path Parameters

engine
string
required

Engine slug, e.g. revredox. GET /v1/engines lists yours.

Response

OK

slug
string
required

Use it in engine paths, e.g. revredox. Never changes.

name
string
required

Display name, e.g. RevRedox.

family
string
required

revomics, revtarget, revbind, revquant or revsim.

group
string
required

Sub-group within the family.

description
string
required
mode
string
required
Allowed value: "run"
inputFiles
object[]
required

Files the engine takes. Upload each with POST /v1/files.

limits
object
required

Engine limits, such as the most molecules per run.

parameters
object
required

JSON Schema of the run's parameters, with defaults. Check a set of parameters with POST /v1/engines/{engine}/validate.

outputs
object[]
required

Named outputs a succeeded run has.

docs
string | null
required

The engine's page on docs.revilico.bio, if it has one.