curl --request POST \
--url https://public-api.revilico.bio/v1/engines/revied/runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Water dimer",
"parameters": {},
"inputs": {
"structure": "file_…"
}
}
'{
"id": "<string>",
"engine": "<string>",
"name": "<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": {},
"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 RevIED run
Interaction energy decomposition (SAPT0/jun-cc-pVDZ) of a two-fragment complex into electrostatics, exchange, induction and dispersion.
Starts a run and returns it with status queued; poll GET /v1/runs/ until it finishes. Runs spend credits.
Limits: maxAtoms: 200, minCharge: -10, maxCharge: 10.
How the engine works and how to read its results: RevIED documentation.
Scope: runs:write.
curl --request POST \
--url https://public-api.revilico.bio/v1/engines/revied/runs \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '
{
"name": "Water dimer",
"parameters": {},
"inputs": {
"structure": "file_…"
}
}
'{
"id": "<string>",
"engine": "<string>",
"name": "<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": {},
"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
A name for the run, shown in the web app.
200Show child attributes
Show child attributes
Most 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.
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, results, outputs, files.
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.