curl --request POST \
--url https://public-api.revilico.bio/v1/engines/revqsar/runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "hERG pIC50 model",
"parameters": {
"smiles_column": "smiles",
"target_column": "pIC50"
},
"inputs": {
"training_data": "file_…"
}
}
'{
"id": "<string>",
"engine": "<string>",
"name": "<string>",
"access": "owner",
"owner": {
"name": "<string>",
"email": "<string>"
},
"status": "queued",
"statusReason": "<string>",
"progress": 123,
"createdAt": "2023-11-07T05:31:56Z",
"startedAt": "2023-11-07T05:31:56Z",
"endedAt": "2023-11-07T05:31:56Z",
"budget": 123,
"creditsUsed": 123,
"error": {
"message": "<string>"
},
"links": {},
"children": {
"total": 123,
"queued": 123,
"running": 123,
"succeeded": 123,
"failed": 123,
"cancelled": 123
},
"warnings": [
"<string>"
]
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "The request is malformed."
}
}{
"error": {
"code": "MISSING_CREDENTIALS",
"message": "The API key is missing or not valid."
}
}{
"error": {
"code": "INSUFFICIENT_CREDITS",
"message": "Your organization doesn't have enough credits."
}
}{
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "The key may not do this."
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Not found, or not visible to you."
}
}{
"error": {
"code": "INVALID_PARAMETERS",
"message": "The parameters or input files don't fit the engine."
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "Something went wrong on our side."
}
}{
"error": {
"code": "ENGINE_SUBMIT_FAILED",
"message": "The engine service rejected or failed the request."
}
}Start a RevQSAR run
Trains a model that predicts a measured property of molecules (potency, solubility, toxicity, active/inactive…) from their structure, using a CSV of molecules with known values. It computes about 200 molecular properties per molecule, drops redundant ones, tries several model types on repeated train/test splits, and keeps the best. Results rank the model types by score. Predicting new molecules with the trained model is not available through the API yet. The settings a run was submitted with are not recorded, so the run inputs endpoint returns none.
Starts a run and returns it with status queued; poll GET /v1/runs/ until it finishes. Runs spend credits.
Limits: minMolecules: 10, maxMolecules: 20000.
How the engine works and how to read its results: RevQSAR documentation.
Scope: runs:write.
curl --request POST \
--url https://public-api.revilico.bio/v1/engines/revqsar/runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "hERG pIC50 model",
"parameters": {
"smiles_column": "smiles",
"target_column": "pIC50"
},
"inputs": {
"training_data": "file_…"
}
}
'{
"id": "<string>",
"engine": "<string>",
"name": "<string>",
"access": "owner",
"owner": {
"name": "<string>",
"email": "<string>"
},
"status": "queued",
"statusReason": "<string>",
"progress": 123,
"createdAt": "2023-11-07T05:31:56Z",
"startedAt": "2023-11-07T05:31:56Z",
"endedAt": "2023-11-07T05:31:56Z",
"budget": 123,
"creditsUsed": 123,
"error": {
"message": "<string>"
},
"links": {},
"children": {
"total": 123,
"queued": 123,
"running": 123,
"succeeded": 123,
"failed": 123,
"cancelled": 123
},
"warnings": [
"<string>"
]
}{
"error": {
"code": "VALIDATION_FAILED",
"message": "The request is malformed."
}
}{
"error": {
"code": "MISSING_CREDENTIALS",
"message": "The API key is missing or not valid."
}
}{
"error": {
"code": "INSUFFICIENT_CREDITS",
"message": "Your organization doesn't have enough credits."
}
}{
"error": {
"code": "INSUFFICIENT_SCOPE",
"message": "The key may not do this."
}
}{
"error": {
"code": "NOT_FOUND",
"message": "Not found, or not visible to you."
}
}{
"error": {
"code": "INVALID_PARAMETERS",
"message": "The parameters or input files don't fit the engine."
}
}{
"error": {
"code": "INTERNAL_ERROR",
"message": "Something went wrong on our side."
}
}{
"error": {
"code": "ENGINE_SUBMIT_FAILED",
"message": "The engine service rejected or failed the request."
}
}Authorizations
An API key from the web app (Settings → Developer), sent as Authorization: Bearer rvl_live_….
Body
Show child attributes
Show child attributes
Show child attributes
Show child attributes
A name for the run, shown in the web app.
200Most credits the run may spend; it is stopped beyond that.
Add the run to this project (proj_…); needs editor or owner on it.
Response
OK
Run id, run_….
Engine slug, e.g. revredox.
Why you can see the run: you started it, it was shared with you, or it is in a project you belong to. Only the owner can cancel it or read its inputs.
owner, shared, project Who started the run.
Show child attributes
Show child attributes
queued until the engine picks the run up; succeeded, failed and cancelled are final.
queued, running, succeeded, failed, cancelled Why a cancelled run stopped: user, insufficient_credits or budget_exceeded. Null otherwise.
Progress the engine reports; 0 until it reports any.
Most credits the run may spend, if one was set.
Credits charged to the run so far.
Set when status is failed.
Show child attributes
Show child attributes
Related endpoints: self, inputs (owner only), results, outputs, files.
Show child attributes
Show child attributes
For engines that run each input as its own job: how many children are in each status. GET /v1/runs/{runId}/children lists them.
Show child attributes
Show child attributes
Set when the run was created but a follow-up step, such as adding it to a project, failed.