{
"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."
}
}
Engine runs
Start a RevPhore run
Maps the contacts between a protein and the molecule bound to it (hydrogen bonds, charged, stacking and greasy contacts), lists the residues involved and estimates the binding energy. Takes complexes with protein and molecule in one file, up to 50 per run. When a file holds several molecules, name the one to analyse with ligand_residue.
Starts a run and returns it with status queued; poll GET /v1/runs/ until it finishes. Runs spend credits.
Set when the run was created but a follow-up step, such as adding it to a project, failed.
{"docsConfig":{"theme":"mint","$schema":"https://mintlify.com/docs.json","name":"Revilico","colors":{"primary":"#1371e4","light":"#1371e4","dark":"#1371e4"},"logo":{"light":"https://mintcdn.com/revilicoinc/cWUeZVkzU4GxUaNk/logo/revilico-dark.avif?fit=max\u0026auto=format\u0026n=cWUeZVkzU4GxUaNk\u0026q=85\u0026s=d4e1bd31a297855ce0ceab937fc59f32","dark":"https://mintcdn.com/revilicoinc/cWUeZVkzU4GxUaNk/logo/revilico-light.webp?fit=max\u0026auto=format\u0026n=cWUeZVkzU4GxUaNk\u0026q=85\u0026s=293f90a9713455aac48b52ee7b196fb4"},"favicon":"https://mintcdn.com/revilicoinc/cWUeZVkzU4GxUaNk/favicon_dark.png?fit=max\u0026auto=format\u0026n=cWUeZVkzU4GxUaNk\u0026q=85\u0026s=475f780a1363335a4f8228bbdef2c234","navbar":{"links":[{"href":"https://calendly.com/christopher-korban/support-meeting","label":"Support"}],"primary":{"type":"button","label":"Dashboard","href":"https://app.revilico.bio"}},"footer":{"socials":{"linkedin":"https://www.linkedin.com/company/revilicoinc"}},"integrations":{"posthog":{"apiKey":"phc_8LIOEWt3bsIwQSI7zbVnUn2oys0WPaZGuITi5fJGJho","apiHost":"https://us.i.posthog.com","sessionRecording":true}},"contextual":{"options":["copy","view","chatgpt","claude","perplexity"],"display":"header"},"styling":{"latex":true},"navigation":{"pages":[]}},"deployment":{"deploymentMetadataValue":{"subdomain":"revilicoinc","hasAudioNarration":false,"actualSubdomain":"revilicoinc","customDomains":["docs.revilico.bio"],"gitSource":{"type":"github","owner":"nexabio-venture-solutions","repo":"docs","deployBranch":"main","contentDirectory":"","isPrivate":true,"mountPath":"","label":""},"chroma":{"liveDeploymentHistoryId":"6ae34d29b905b386f71687bf","collectionId":"97d163a0-d61f-4f44-812b-5821fe763c9c","schemaVersion":"v3","latestBuiltDeploymentHistoryId":"6ae34d29b905b386f71687bf"},"entitlements":{"AI_CHAT":{"status":"ENABLED"},"WEB_MCP":{"status":"ENABLED"},"NARRATION":{"status":"ENABLED"}},"buildId":"6ae34dc19ee4546ca4eaf9e6","clientVersion":"0.0.4006","searchFilterCounts":[{"language":"default","tag":"Developers","count":119},{"language":"default","tag":"Endpoints","count":106},{"language":"default","tag":"Engines","count":61},{"language":"default","tag":"Documentation","count":57},{"language":"default","tag":"Engine runs","count":45},{"language":"default","tag":"Solutions","count":28},{"language":"default","tag":"RevQuant","count":22},{"language":"default","tag":"RevBind","count":14},{"language":"default","tag":"Notes","count":14},{"language":"default","tag":"Benchmarks","count":13}]},"assistantConfig":{"enableAskAiButton":false,"enableStarterQuestions":false,"enableAskAiSearchBar":true,"deflection":{"enabled":true,"email":"inquiries@revilico.bio","showHelpButton":true}},"basePath":"","hasChatPermissions":true,"hasWebMcpPermissions":true,"toggles":[{"name":"kill-isr","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-mintlify-slack","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"agent-integrations-settings","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-pr-grouping","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"custom-prefix","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"analytics-v7","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"user-flows-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"no-publish-flow","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-onboarding","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"llms-txt-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"pause-universal-search-reconcile","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving-live","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"stripTemperatureMiddleware","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"per-site-search-delta","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"support-platform-pylon-zendesk","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"snapshot-serving","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"instant-rollback","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications-server","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"granular-notifications","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-private-page-search","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automations-fable","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fixed-ai-action-pricing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"automation-resolve-merge-conflict","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"scoped-publishing","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"mintql","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"page-level-analytics","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"editor-version-history-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-page-v2","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workspace-projects","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"assistant-v5","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"byok-sep-25","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"fork-pr-previews","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"revalidation-jwt","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"vite-origin","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"billing-updated-9-15","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-sso-scim","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"hobby-abuse-scan","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"dashboard-inbox","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-signup","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false},{"name":"workos-enabled","enabled":true,"variant":{"name":"disabled","enabled":false,"feature_enabled":true},"impressionData":false}],"googleFontsInlined":false},"customCss":[{"filePath":"benchmarks.css","content":"@media (min-width:1280px){.fep-wide{width:calc(100vw - 440px);max-width:1380px}}.fep-wide table{display:table;width:100%}"}],"page":{"pagePath":"api-reference/engine-runs/start-a-revphore-run","slug":"/api-reference/engine-runs/start-a-revphore-run","pageMetadata":{"title":"Start a RevPhore run","description":"Maps the contacts between a protein and the molecule bound to it (hydrogen bonds, charged, stacking and greasy contacts), lists the residues involved and estimates the binding energy. Takes complexes with protein and molecule in one file, up to 50 per run. When a file holds several molecules, name the one to analyse with ligand_residue.\n\nStarts a run and returns it with status `queued`; poll GET /v1/runs/{runId} until it finishes. Runs spend credits.\n\n**Limits:** `maxComplexes`: 50.\n\nHow the engine works and how to read its results: [RevPhore documentation](/docs/revphore).\n\n**Scope:** `runs:write`.","deprecated":null,"version":null,"sidebarTitle":"RevPhore","openapi":"/api-reference/openapi.json post /v1/engines/revphore/runs","href":"/api-reference/engine-runs/start-a-revphore-run","autogeneratedByOpenApi":true},"description":{"compiledSource":"\"use strict\";\nconst {Fragment: _Fragment, jsx: _jsx, jsxs: _jsxs} = arguments[0];\nconst {useMDXComponents: _provideComponents} = arguments[0];\nfunction _createMdxContent(props) {\n const _components = {\n a: \"a\",\n code: \"code\",\n p: \"p\",\n strong: \"strong\",\n ..._provideComponents(),\n ...props.components\n };\n return _jsxs(_Fragment, {\n children: [_jsx(_components.p, {\n children: \"Maps the contacts between a protein and the molecule bound to it (hydrogen bonds, charged, stacking and greasy contacts), lists the residues involved and estimates the binding energy. Takes complexes with protein and molecule in one file, up to 50 per run. When a file holds several molecules, name the one to analyse with ligand_residue.\"\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"Starts a run and returns it with status \", _jsx(_components.code, {\n children: \"queued\"\n }), \"; poll GET /v1/runs/\", \" until it finishes. Runs spend credits.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Limits:\"\n }), \" \", _jsx(_components.code, {\n children: \"maxComplexes\"\n }), \": 50.\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [\"How the engine works and how to read its results: \", _jsx(_components.a, {\n href: \"/docs/revphore\",\n children: \"RevPhore documentation\"\n }), \".\"]\n }), \"\\n\", _jsxs(_components.p, {\n children: [_jsx(_components.strong, {\n children: \"Scope:\"\n }), \" \", _jsx(_components.code, {\n children: \"runs:write\"\n }), \".\"]\n })]\n });\n}\nfunction MDXContent(props = {}) {\n const {wrapper: MDXLayout} = {\n ..._provideComponents(),\n ...props.components\n };\n return MDXLayout ? _jsx(MDXLayout, {\n ...props,\n children: _jsx(_createMdxContent, {\n ...props\n })\n }) : _createMdxContent(props);\n}\nreturn {\n default: MDXContent\n};\n","frontmatter":{},"scope":{}},"pageType":"default","mdx":{"mdxSource":{"compiledSource":"\"use strict\";const{Fragment:_Fragment,jsx:_jsx}=arguments[0];const{useMDXComponents:_provideComponents}=arguments[0];function _createMdxContent(props){return _jsx(_Fragment,{})}function MDXContent(props={}){const{wrapper:MDXLayout}={..._provideComponents(),...props.components};return MDXLayout?_jsx(MDXLayout,{...props,children:_jsx(_createMdxContent,{...props})}):_createMdxContent(props)}return{default:MDXContent}","frontmatter":{},"scope":{"config":{},"pageMetadata":{"title":"Start a RevPhore run","description":"Maps the contacts between a protein and the molecule bound to it (hydrogen bonds, charged, stacking and greasy contacts), lists the residues involved and estimates the binding energy. Takes complexes with protein and molecule in one file, up to 50 per run. When a file holds several molecules, name the one to analyse with ligand_residue.\n\nStarts a run and returns it with status `queued`; poll GET /v1/runs/{runId} until it finishes. Runs spend credits.\n\n**Limits:** `maxComplexes`: 50.\n\nHow the engine works and how to read its results: [RevPhore documentation](/docs/revphore).\n\n**Scope:** `runs:write`.","deprecated":null,"version":null,"sidebarTitle":"RevPhore","openapi":"/api-reference/openapi.json post /v1/engines/revphore/runs","href":"/api-reference/engine-runs/start-a-revphore-run","autogeneratedByOpenApi":true}}},"mdxSourceWithNoJs":null},"mdxExtracts":{"tableOfContents":[],"codeExamples":{}},"jsLinks":[],"openApiReferenceData":{"operation":{"operationId":"engineRuns.revphore","summary":"Start a RevPhore run","description":"Maps the contacts between a protein and the molecule bound to it (hydrogen bonds, charged, stacking and greasy contacts), lists the residues involved and estimates the binding energy. Takes complexes with protein and molecule in one file, up to 50 per run. When a file holds several molecules, name the one to analyse with ligand_residue.\n\nStarts a run and returns it with status `queued`; poll GET /v1/runs/{runId} until it finishes. Runs spend credits.\n\n**Limits:** `maxComplexes`: 50.\n\nHow the engine works and how to read its results: [RevPhore documentation](/docs/revphore).\n\n**Scope:** `runs:write`.","tags":["Engine runs"],"x-mint":{"metadata":{"sidebarTitle":"RevPhore"}},"requestBody":"eb044f88-6c4f-4ace-b62e-cf6a28192efd","responses":{"202":"9f3a8f05-7013-4c0f-b718-5739cbaa97db","400":"df75ffd8-1539-408d-a12c-201523fdb291","401":"aaca0db2-8094-4f69-9608-fbae42400ce0","402":"b3712e59-e2ab-47b2-86a7-5d454b3cf3da","403":"d3971d8f-5143-4d01-88ab-33c8db53f50a","404":"f56738f3-8d56-4b9f-ab5d-26ffbaeceeee","422":"98d96736-7ae8-42b6-bfed-cada46c00a23","500":"0b748820-4990-410c-b757-d7896ee70981","502":"46bce20e-cd2a-4b59-a931-4089fcf5c8ca"},"method":"post","type":"path","servers":["76ce0e69-bccf-48e7-93f8-9d02ccdfb096"],"security":["d717e6d1-fba0-4f7f-96d5-129436291fe4"],"path":"/v1/engines/revphore/runs","baseUrlOptions":["https://public-api.revilico.bio"],"title":"Start a RevPhore run","codeSamples":[],"requiredOnlyExamples":false,"requestExampleType":"generated","responseExampleType":"generated"},"dependencies":{"parameters":{},"requestBody":{"required":true,"content":{"application/json":{"schema":{"type":"object","properties":{"name":{"description":"A name for the run, shown in the web app.","type":"string","maxLength":200,"uniqueKey":"name","typeLabel":"string"},"parameters":{"type":"object","properties":{"ligand_residue":{"type":"string","pattern":"^[A-Z0-9]{1,3}$","description":"Residue name of the molecule to analyse, as written on its HETATM lines in the PDB file (e.g. \"STI\" for imatinib). Leave out to analyse the largest group that is not protein, water, an ion or a buffer; that can be a helper molecule such as heme (HEM) or NAD rather than the drug. The ligand field of each result row shows which molecule was analysed. PDB files only: for mmCIF files this is ignored and the largest group is used.","uniqueKey":"parameters.ligand_residue","typeLabel":"string"},"map_2d":{"default":true,"description":"Draw a 2D map of the contacts for each complex (PNG).","type":"boolean","uniqueKey":"parameters.map_2d","typeLabel":"boolean"},"view_3d":{"default":true,"description":"Build an interactive 3D view of each complex with its contacts (HTML).","type":"boolean","uniqueKey":"parameters.view_3d","typeLabel":"boolean"},"view_width":{"default":800,"description":"Width of the 3D view, in pixels.","type":"integer","minimum":400,"maximum":2000,"uniqueKey":"parameters.view_width","typeLabel":"integer"},"view_height":{"default":600,"description":"Height of the 3D view, in pixels.","type":"integer","minimum":400,"maximum":2000,"uniqueKey":"parameters.view_height","typeLabel":"integer"},"show_surface":{"default":true,"description":"Show the protein surface in the 3D view.","type":"boolean","uniqueKey":"parameters.show_surface","typeLabel":"boolean"}},"additionalProperties":false,"uniqueKey":"parameters","typeLabel":"object"},"inputs":{"type":"object","properties":{"complex":{"type":"string","description":"One complex: protein and bound molecule in one PDB or mmCIF file (e.g. a crystal structure or a Boltz2 prediction). Give this or complex_list. A file id: an upload (`file_…`) or a Drive file (`dfile_…`, `sdfile_…`). Formats: pdb, cif; up to 50 MB.","uniqueKey":"inputs.complex","typeLabel":"string"},"complex_list":{"type":"string","description":"Several complexes: a CSV with one uploaded file id per line (PDB or mmCIF complexes, up to 50), optionally followed by the molecule's residue name for PDB files, e.g. \"file_…,LIG\". A header line \"file_id,ligand_residue\" is allowed. Give this or complex. A file id: an upload (`file_…`) or a Drive file (`dfile_…`, `sdfile_…`). Formats: csv, txt; up to 64 KB.","uniqueKey":"inputs.complex_list","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"inputs","typeLabel":"object"},"budget":{"description":"Most credits the run may spend; it is stopped beyond that.","type":"number","exclusiveMinimum":0,"uniqueKey":"budget","typeLabel":"number"},"projectId":{"description":"Add the run to this project (`proj_…`); needs editor or owner on it.","type":"string","uniqueKey":"projectId","typeLabel":"string"}},"additionalProperties":false,"uniqueKey":"","typeLabel":"object"},"examples":{"defaults":{"title":"defaults","value":{"name":"EGFR with erlotinib","parameters":{},"inputs":{"complex":"file_…"}}},"named-ligand":{"title":"named-ligand","value":{"name":"ABL kinase with imatinib","parameters":{"ligand_residue":"STI"},"inputs":{"complex":"file_…"}}},"batch":{"title":"batch","value":{"name":"Series A predicted complexes","parameters":{"view_3d":false},"inputs":{"complex_list":"file_…"}}}},"exampleType":"examples"}},"exampleType":"examples"},"responses":{"9f3a8f05-7013-4c0f-b718-5739cbaa97db":{"description":"OK","content":{"application/json":{"schema":{"type":"object","properties":{"id":{"type":"string","description":"Run id, `run_…`.","isRequired":true,"uniqueKey":"id","typeLabel":"string"},"engine":{"type":"string","description":"Engine slug, e.g. `revredox`.","isRequired":true,"uniqueKey":"engine","typeLabel":"string"},"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"name","typeLabel":"string | null"},"access":{"type":"string","enum":["owner","shared","project"],"description":"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.","isRequired":true,"uniqueKey":"access","typeLabel":"enum\u003cstring>"},"owner":{"type":"object","properties":{"name":{"oneOf":[{"type":"string","isRequired":true,"uniqueKey":"owner.name.oneOf.0","typeLabel":"string"},{"type":"null","isRequired":true,"uniqueKey":"owner.name.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"owner.name","typeLabel":"string | null"},"email":{"type":"string","isRequired":true,"uniqueKey":"owner.email","typeLabel":"string"}},"required":["name","email"],"description":"Who started the run.","isRequired":true,"uniqueKey":"owner","typeLabel":"object"},"status":{"type":"string","enum":["queued","running","succeeded","failed","cancelled"],"description":"queued until the engine picks the run up; succeeded, failed and cancelled are final.","isRequired":true,"uniqueKey":"status","typeLabel":"enum\u003cstring>"},"statusReason":{"oneOf":[{"description":"Why a cancelled run stopped: `user`, `insufficient_credits` or `budget_exceeded`. Null otherwise.","type":"string","isRequired":true,"uniqueKey":"statusReason.oneOf.0","typeLabel":"string"},{"description":"Why a cancelled run stopped: `user`, `insufficient_credits` or `budget_exceeded`. Null otherwise.","type":"null","isRequired":true,"uniqueKey":"statusReason.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"statusReason","typeLabel":"string | null"},"progress":{"type":"number","description":"Progress the engine reports; 0 until it reports any.","isRequired":true,"uniqueKey":"progress","typeLabel":"number"},"createdAt":{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"createdAt","typeLabel":"string\u003cdate-time>"},"startedAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"startedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"startedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"startedAt","typeLabel":"string\u003cdate-time> | null"},"endedAt":{"oneOf":[{"type":"string","format":"date-time","isRequired":true,"uniqueKey":"endedAt.oneOf.0","typeLabel":"string\u003cdate-time>"},{"type":"null","isRequired":true,"uniqueKey":"endedAt.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"endedAt","typeLabel":"string\u003cdate-time> | null"},"budget":{"oneOf":[{"description":"Most credits the run may spend, if one was set.","type":"number","isRequired":true,"uniqueKey":"budget.oneOf.0","typeLabel":"number"},{"description":"Most credits the run may spend, if one was set.","type":"null","isRequired":true,"uniqueKey":"budget.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"budget","typeLabel":"number | null"},"creditsUsed":{"type":"number","description":"Credits charged to the run so far.","isRequired":true,"uniqueKey":"creditsUsed","typeLabel":"number"},"error":{"oneOf":[{"type":"object","description":"Set when status is failed.","required":["message"],"properties":{"message":{"type":"string","isRequired":true,"uniqueKey":"error.oneOf.0.message","typeLabel":"string"}},"isRequired":true,"uniqueKey":"error.oneOf.0","typeLabel":"object"},{"type":"null","description":"Set when status is failed.","isRequired":true,"uniqueKey":"error.oneOf.1","typeLabel":"null"}],"isRequired":true,"uniqueKey":"error","typeLabel":"object | null"},"links":{"type":"object","propertyNames":{"type":"string"},"additionalProperties":{"type":"string","uniqueKey":"links.additionalProperties","typeLabel":"string"},"description":"Related endpoints: self, inputs (owner only), results, outputs, files.","isRequired":true,"uniqueKey":"links","typeLabel":"object"},"children":{"type":"object","properties":{"total":{"type":"number","isRequired":true,"uniqueKey":"children.total","typeLabel":"number"},"queued":{"type":"number","isRequired":true,"uniqueKey":"children.queued","typeLabel":"number"},"running":{"type":"number","isRequired":true,"uniqueKey":"children.running","typeLabel":"number"},"succeeded":{"type":"number","isRequired":true,"uniqueKey":"children.succeeded","typeLabel":"number"},"failed":{"type":"number","isRequired":true,"uniqueKey":"children.failed","typeLabel":"number"},"cancelled":{"type":"number","isRequired":true,"uniqueKey":"children.cancelled","typeLabel":"number"}},"required":["total","queued","running","succeeded","failed","cancelled"],"description":"For engines that run each input as its own job: how many children are in each status. GET /v1/runs/{runId}/children lists them.","uniqueKey":"children","typeLabel":"object"},"warnings":{"description":"Set when the run was created but a follow-up step, such as adding it to a project, failed.","type":"array","items":{"type":"string","uniqueKey":"warnings.items.[INDEX]","typeLabel":"string"},"uniqueKey":"warnings","typeLabel":"string[]"}},"required":["id","engine","name","access","owner","status","statusReason","progress","createdAt","startedAt","endedAt","budget","creditsUsed","error","links"],"uniqueKey":"","typeLabel":"object"},"examples":{"Example":{"title":"Example","value":{"id":"\u003cstring>","engine":"\u003cstring>","name":"\u003cstring>","access":"owner","owner":{"name":"\u003cstring>","email":"\u003cstring>"},"status":"queued","statusReason":"\u003cstring>","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":"\u003cstring>"},"links":{},"children":{"total":123,"queued":123,"running":123,"succeeded":123,"failed":123,"cancelled":123},"warnings":["\u003cstring>"]}}},"exampleType":"generated"}},"exampleType":"generated"},"df75ffd8-1539-408d-a12c-201523fdb291":{"description":"The request is malformed. `error.code` is one of `VALIDATION_FAILED`, `INVALID_ID`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_FAILED","INVALID_ID","INVALID_PARAMETERS","INPUT_LIMIT_EXCEEDED","NOT_FOUND","FORBIDDEN","METHOD_NOT_ALLOWED","CONFLICT","PAYLOAD_TOO_LARGE","MISSING_CREDENTIALS","INVALID_CREDENTIALS","WRONG_ENVIRONMENT","CREDENTIALS_EXPIRED","CREDENTIALS_REVOKED","ACCOUNT_INACTIVE","API_ACCESS_NOT_ENABLED","INSUFFICIENT_SCOPE","SESSION_REQUIRED","TOO_MANY_AUTH_FAILURES","API_KEY_LIMIT_REACHED","ENGINE_NOT_ENABLED","DOCS_NOT_AVAILABLE","INSUFFICIENT_CREDITS","RUN_NOT_COMPLETE","ENGINE_SUBMIT_FAILED","RATE_LIMITED","SERVICE_UNAVAILABLE","INTERNAL_ERROR"],"description":"Stable within /v1; branch on this, not on the message.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Readable explanation, for people.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"description":"Extra context, e.g. `issues` ({ path, message }[]) for validation errors.","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"error.details.additionalProperties","typeLabel":"any"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"VALIDATION_FAILED","message":"The request is malformed."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"VALIDATION_FAILED","message":"The request is malformed."}}}},"exampleType":"examples"}},"exampleType":"examples"},"aaca0db2-8094-4f69-9608-fbae42400ce0":{"description":"The API key is missing or not valid. `error.code` is one of `MISSING_CREDENTIALS`, `INVALID_CREDENTIALS`, `WRONG_ENVIRONMENT`, `CREDENTIALS_EXPIRED`, `CREDENTIALS_REVOKED`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_FAILED","INVALID_ID","INVALID_PARAMETERS","INPUT_LIMIT_EXCEEDED","NOT_FOUND","FORBIDDEN","METHOD_NOT_ALLOWED","CONFLICT","PAYLOAD_TOO_LARGE","MISSING_CREDENTIALS","INVALID_CREDENTIALS","WRONG_ENVIRONMENT","CREDENTIALS_EXPIRED","CREDENTIALS_REVOKED","ACCOUNT_INACTIVE","API_ACCESS_NOT_ENABLED","INSUFFICIENT_SCOPE","SESSION_REQUIRED","TOO_MANY_AUTH_FAILURES","API_KEY_LIMIT_REACHED","ENGINE_NOT_ENABLED","DOCS_NOT_AVAILABLE","INSUFFICIENT_CREDITS","RUN_NOT_COMPLETE","ENGINE_SUBMIT_FAILED","RATE_LIMITED","SERVICE_UNAVAILABLE","INTERNAL_ERROR"],"description":"Stable within /v1; branch on this, not on the message.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Readable explanation, for people.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"description":"Extra context, e.g. `issues` ({ path, message }[]) for validation errors.","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"error.details.additionalProperties","typeLabel":"any"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"MISSING_CREDENTIALS","message":"The API key is missing or not valid."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"MISSING_CREDENTIALS","message":"The API key is missing or not valid."}}}},"exampleType":"examples"}},"exampleType":"examples"},"b3712e59-e2ab-47b2-86a7-5d454b3cf3da":{"description":"Your organization doesn't have enough credits. `error.code` is one of `INSUFFICIENT_CREDITS`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_FAILED","INVALID_ID","INVALID_PARAMETERS","INPUT_LIMIT_EXCEEDED","NOT_FOUND","FORBIDDEN","METHOD_NOT_ALLOWED","CONFLICT","PAYLOAD_TOO_LARGE","MISSING_CREDENTIALS","INVALID_CREDENTIALS","WRONG_ENVIRONMENT","CREDENTIALS_EXPIRED","CREDENTIALS_REVOKED","ACCOUNT_INACTIVE","API_ACCESS_NOT_ENABLED","INSUFFICIENT_SCOPE","SESSION_REQUIRED","TOO_MANY_AUTH_FAILURES","API_KEY_LIMIT_REACHED","ENGINE_NOT_ENABLED","DOCS_NOT_AVAILABLE","INSUFFICIENT_CREDITS","RUN_NOT_COMPLETE","ENGINE_SUBMIT_FAILED","RATE_LIMITED","SERVICE_UNAVAILABLE","INTERNAL_ERROR"],"description":"Stable within /v1; branch on this, not on the message.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Readable explanation, for people.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"description":"Extra context, e.g. `issues` ({ path, message }[]) for validation errors.","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"error.details.additionalProperties","typeLabel":"any"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"INSUFFICIENT_CREDITS","message":"Your organization doesn't have enough credits."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INSUFFICIENT_CREDITS","message":"Your organization doesn't have enough credits."}}}},"exampleType":"examples"}},"exampleType":"examples"},"d3971d8f-5143-4d01-88ab-33c8db53f50a":{"description":"The key may not do this. `error.code` is one of `INSUFFICIENT_SCOPE`, `API_ACCESS_NOT_ENABLED`, `ENGINE_NOT_ENABLED`, `ACCOUNT_INACTIVE`, `FORBIDDEN`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_FAILED","INVALID_ID","INVALID_PARAMETERS","INPUT_LIMIT_EXCEEDED","NOT_FOUND","FORBIDDEN","METHOD_NOT_ALLOWED","CONFLICT","PAYLOAD_TOO_LARGE","MISSING_CREDENTIALS","INVALID_CREDENTIALS","WRONG_ENVIRONMENT","CREDENTIALS_EXPIRED","CREDENTIALS_REVOKED","ACCOUNT_INACTIVE","API_ACCESS_NOT_ENABLED","INSUFFICIENT_SCOPE","SESSION_REQUIRED","TOO_MANY_AUTH_FAILURES","API_KEY_LIMIT_REACHED","ENGINE_NOT_ENABLED","DOCS_NOT_AVAILABLE","INSUFFICIENT_CREDITS","RUN_NOT_COMPLETE","ENGINE_SUBMIT_FAILED","RATE_LIMITED","SERVICE_UNAVAILABLE","INTERNAL_ERROR"],"description":"Stable within /v1; branch on this, not on the message.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Readable explanation, for people.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"description":"Extra context, e.g. `issues` ({ path, message }[]) for validation errors.","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"error.details.additionalProperties","typeLabel":"any"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"INSUFFICIENT_SCOPE","message":"The key may not do this."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INSUFFICIENT_SCOPE","message":"The key may not do this."}}}},"exampleType":"examples"}},"exampleType":"examples"},"f56738f3-8d56-4b9f-ab5d-26ffbaeceeee":{"description":"Not found, or not visible to you. `error.code` is one of `NOT_FOUND`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_FAILED","INVALID_ID","INVALID_PARAMETERS","INPUT_LIMIT_EXCEEDED","NOT_FOUND","FORBIDDEN","METHOD_NOT_ALLOWED","CONFLICT","PAYLOAD_TOO_LARGE","MISSING_CREDENTIALS","INVALID_CREDENTIALS","WRONG_ENVIRONMENT","CREDENTIALS_EXPIRED","CREDENTIALS_REVOKED","ACCOUNT_INACTIVE","API_ACCESS_NOT_ENABLED","INSUFFICIENT_SCOPE","SESSION_REQUIRED","TOO_MANY_AUTH_FAILURES","API_KEY_LIMIT_REACHED","ENGINE_NOT_ENABLED","DOCS_NOT_AVAILABLE","INSUFFICIENT_CREDITS","RUN_NOT_COMPLETE","ENGINE_SUBMIT_FAILED","RATE_LIMITED","SERVICE_UNAVAILABLE","INTERNAL_ERROR"],"description":"Stable within /v1; branch on this, not on the message.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Readable explanation, for people.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"description":"Extra context, e.g. `issues` ({ path, message }[]) for validation errors.","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"error.details.additionalProperties","typeLabel":"any"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"NOT_FOUND","message":"Not found, or not visible to you."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"NOT_FOUND","message":"Not found, or not visible to you."}}}},"exampleType":"examples"}},"exampleType":"examples"},"98d96736-7ae8-42b6-bfed-cada46c00a23":{"description":"The parameters or input files don't fit the engine. `error.code` is one of `INVALID_PARAMETERS`, `INPUT_LIMIT_EXCEEDED`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_FAILED","INVALID_ID","INVALID_PARAMETERS","INPUT_LIMIT_EXCEEDED","NOT_FOUND","FORBIDDEN","METHOD_NOT_ALLOWED","CONFLICT","PAYLOAD_TOO_LARGE","MISSING_CREDENTIALS","INVALID_CREDENTIALS","WRONG_ENVIRONMENT","CREDENTIALS_EXPIRED","CREDENTIALS_REVOKED","ACCOUNT_INACTIVE","API_ACCESS_NOT_ENABLED","INSUFFICIENT_SCOPE","SESSION_REQUIRED","TOO_MANY_AUTH_FAILURES","API_KEY_LIMIT_REACHED","ENGINE_NOT_ENABLED","DOCS_NOT_AVAILABLE","INSUFFICIENT_CREDITS","RUN_NOT_COMPLETE","ENGINE_SUBMIT_FAILED","RATE_LIMITED","SERVICE_UNAVAILABLE","INTERNAL_ERROR"],"description":"Stable within /v1; branch on this, not on the message.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Readable explanation, for people.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"description":"Extra context, e.g. `issues` ({ path, message }[]) for validation errors.","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"error.details.additionalProperties","typeLabel":"any"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"INVALID_PARAMETERS","message":"The parameters or input files don't fit the engine."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INVALID_PARAMETERS","message":"The parameters or input files don't fit the engine."}}}},"exampleType":"examples"}},"exampleType":"examples"},"0b748820-4990-410c-b757-d7896ee70981":{"description":"Something went wrong on our side. `error.code` is one of `INTERNAL_ERROR`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_FAILED","INVALID_ID","INVALID_PARAMETERS","INPUT_LIMIT_EXCEEDED","NOT_FOUND","FORBIDDEN","METHOD_NOT_ALLOWED","CONFLICT","PAYLOAD_TOO_LARGE","MISSING_CREDENTIALS","INVALID_CREDENTIALS","WRONG_ENVIRONMENT","CREDENTIALS_EXPIRED","CREDENTIALS_REVOKED","ACCOUNT_INACTIVE","API_ACCESS_NOT_ENABLED","INSUFFICIENT_SCOPE","SESSION_REQUIRED","TOO_MANY_AUTH_FAILURES","API_KEY_LIMIT_REACHED","ENGINE_NOT_ENABLED","DOCS_NOT_AVAILABLE","INSUFFICIENT_CREDITS","RUN_NOT_COMPLETE","ENGINE_SUBMIT_FAILED","RATE_LIMITED","SERVICE_UNAVAILABLE","INTERNAL_ERROR"],"description":"Stable within /v1; branch on this, not on the message.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Readable explanation, for people.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"description":"Extra context, e.g. `issues` ({ path, message }[]) for validation errors.","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"error.details.additionalProperties","typeLabel":"any"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"INTERNAL_ERROR","message":"Something went wrong on our side."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"INTERNAL_ERROR","message":"Something went wrong on our side."}}}},"exampleType":"examples"}},"exampleType":"examples"},"46bce20e-cd2a-4b59-a931-4089fcf5c8ca":{"description":"The engine service rejected or failed the request. `error.code` is one of `ENGINE_SUBMIT_FAILED`.","content":{"application/json":{"schema":{"type":"object","properties":{"error":{"type":"object","properties":{"code":{"type":"string","enum":["VALIDATION_FAILED","INVALID_ID","INVALID_PARAMETERS","INPUT_LIMIT_EXCEEDED","NOT_FOUND","FORBIDDEN","METHOD_NOT_ALLOWED","CONFLICT","PAYLOAD_TOO_LARGE","MISSING_CREDENTIALS","INVALID_CREDENTIALS","WRONG_ENVIRONMENT","CREDENTIALS_EXPIRED","CREDENTIALS_REVOKED","ACCOUNT_INACTIVE","API_ACCESS_NOT_ENABLED","INSUFFICIENT_SCOPE","SESSION_REQUIRED","TOO_MANY_AUTH_FAILURES","API_KEY_LIMIT_REACHED","ENGINE_NOT_ENABLED","DOCS_NOT_AVAILABLE","INSUFFICIENT_CREDITS","RUN_NOT_COMPLETE","ENGINE_SUBMIT_FAILED","RATE_LIMITED","SERVICE_UNAVAILABLE","INTERNAL_ERROR"],"description":"Stable within /v1; branch on this, not on the message.","isRequired":true,"uniqueKey":"error.code","typeLabel":"enum\u003cstring>"},"message":{"type":"string","description":"Readable explanation, for people.","isRequired":true,"uniqueKey":"error.message","typeLabel":"string"},"details":{"description":"Extra context, e.g. `issues` ({ path, message }[]) for validation errors.","type":"object","propertyNames":{"type":"string"},"additionalProperties":{"oneOf":[{}],"uniqueKey":"error.details.additionalProperties","typeLabel":"any"},"uniqueKey":"error.details","typeLabel":"object"}},"required":["code","message"],"isRequired":true,"uniqueKey":"error","typeLabel":"object"}},"required":["error"],"uniqueKey":"","typeLabel":"object"},"example":{"error":{"code":"ENGINE_SUBMIT_FAILED","message":"The engine service rejected or failed the request."}},"examples":{"Example":{"title":"Example","value":{"error":{"code":"ENGINE_SUBMIT_FAILED","message":"The engine service rejected or failed the request."}}}},"exampleType":"examples"}},"exampleType":"examples"}},"security":{"d717e6d1-fba0-4f7f-96d5-129436291fe4":{"bearerAuth":{"type":"http","scheme":"bearer","description":"An API key from the web app (**Settings → Developer**), sent as `Authorization: Bearer rvl_live_…`.","scopes":[],"schemeName":"bearerAuth"}}},"servers":{"76ce0e69-bccf-48e7-93f8-9d02ccdfb096":{"url":"https://public-api.revilico.bio"}},"processedSecurityOptions":[{"schemes":[{"scheme":{"type":"http","scheme":"bearer","description":"An API key from the web app (**Settings → Developer**), sent as `Authorization: Bearer rvl_live_…`.","scopes":[],"schemeName":"bearerAuth"},"schema":{"title":"Bearer Auth","type":"string","isRequired":true,"description":"An API key from the web app (**Settings → Developer**), sent as `Authorization: Bearer rvl_live_…`.","format":"bearer","typeLabel":"string\u003cbearer>","deprecated":false},"schemeName":"bearerAuth","name":"Authorization"}],"title":"bearerAuth"}]},"originalFileLocation":"api-reference/openapi.json"},"subdomain":"revilicoinc","siteName":"Revilico","title":"Start a RevPhore run - Revilico","navMaps":{"firstHrefInVersion":{},"firstHrefInLanguage":{}},"lastModified":"2026-10-29T13:44:47.323Z","originalFileLocation":"api-reference/engine-runs/start-a-revphore-run.mdx"},"headHtml":"\u003cscript data-mint-head>(function(){var d=document.documentElement,p=null;if(!p){try{p=localStorage.getItem(\"isDarkMode\")}catch(e){}if(p==='true')p='dark';else if(p==='false')p='light';if(p!=='light'\u0026\u0026p!=='dark'\u0026\u0026p!=='system')p=\"system\"}var r=p==='system'?(matchMedia(\"(prefers-color-scheme: dark)\").matches?'dark':'light'):p;d.classList.remove(r==='dark'?'light':'dark');d.classList.add(r);d.setAttribute(\"data-theme-preference\",p)})();\u003c/script>\u003cmeta data-mint-head name=\"description\" content=\"Maps the contacts between a protein and the molecule bound to it (hydrogen bonds, charged, stacking and greasy contacts), lists the residues involved and estimates the binding energy. Takes complexes with protein and molecule in one file, up to 50 per run. When a file holds several molecules, name the one to analyse with ligand_residue. Starts a run and returns it with status queued; poll GET /v1/runs/{runId} until it finishes. Runs spend credits. Limits: maxComplexes: 50. How the engine works and how to read its results: RevPhore documentation. Scope: runs:write.\">\u003cmeta data-mint-head name=\"application-name\" content=\"Revilico\">\u003cmeta data-mint-head name=\"generator\" content=\"Mintlify\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/revilicoinc/XuDhYK1TrVRjKN2O/_generated/favicon/android-chrome-192x192.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"apple-touch-icon\" type=\"image/png\" sizes=\"180x180\" href=\"/mintlify-assets/_mintlify/favicons/revilicoinc/XuDhYK1TrVRjKN2O/_generated/favicon/apple-touch-icon.png\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/revilicoinc/XuDhYK1TrVRjKN2O/_generated/favicon/favicon-16x16.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/revilicoinc/XuDhYK1TrVRjKN2O/_generated/favicon/favicon-32x32.png\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/revilicoinc/XuDhYK1TrVRjKN2O/_generated/favicon/favicon.ico\" media=\"(prefers-color-scheme: light)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"192x192\" href=\"/mintlify-assets/_mintlify/favicons/revilicoinc/XuDhYK1TrVRjKN2O/_generated/favicon-dark/android-chrome-192x192.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"16x16\" href=\"/mintlify-assets/_mintlify/favicons/revilicoinc/XuDhYK1TrVRjKN2O/_generated/favicon-dark/favicon-16x16.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"icon\" type=\"image/png\" sizes=\"32x32\" href=\"/mintlify-assets/_mintlify/favicons/revilicoinc/XuDhYK1TrVRjKN2O/_generated/favicon-dark/favicon-32x32.png\" media=\"(prefers-color-scheme: dark)\">\u003clink data-mint-head rel=\"shortcut icon\" type=\"image/x-icon\" href=\"/mintlify-assets/_mintlify/favicons/revilicoinc/XuDhYK1TrVRjKN2O/_generated/favicon-dark/favicon.ico\" media=\"(prefers-color-scheme: dark)\">\u003cmeta data-mint-head property=\"og:title\" content=\"Start a RevPhore run - Revilico\">\u003cmeta data-mint-head property=\"og:description\" content=\"Maps the contacts between a protein and the molecule bound to it (hydrogen bonds, charged, stacking and greasy contacts), lists the residues involved and estimates the binding energy. Takes complexes with protein and molecule in one file, up to 50 per run. When a file holds several molecules, name the one to analyse with ligand_residue. Starts a run and returns it with status queued; poll GET /v1/runs/{runId} until it finishes. Runs spend credits. Limits: maxComplexes: 50. How the engine works and how to read its results: RevPhore documentation. Scope: runs:write.\">\u003cmeta data-mint-head property=\"og:site_name\" content=\"Revilico\">\u003cmeta data-mint-head property=\"og:url\" content=\"https://docs.revilico.bio/api-reference/engine-runs/start-a-revphore-run\">\u003cmeta data-mint-head property=\"og:type\" content=\"website\">\u003cmeta data-mint-head property=\"og:image\" content=\"https://revilicoinc.mintlify.app/_mintlify/api/og/v2?division=Engine+runs\u0026amp;title=Start+a+RevPhore+run\u0026amp;description=Maps+the+contacts+between+a+protein+and+the+molecule+bound+to+it+%28hydrogen+bonds%2C+charged%2C+stacking+and+greasy+contacts%29%2C+lists+the+residues+involved+and+estima\u0026amp;theme=be735b651301653c27b26fa1\u0026amp;signature=4ff6641da9679d9fa687bb4c34ab37036b20d25b82269902bbd8a8b13184f5a2\">\u003cmeta data-mint-head property=\"og:image:width\" content=\"1200\">\u003cmeta data-mint-head property=\"og:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"twitter:card\" content=\"summary_large_image\">\u003cmeta data-mint-head name=\"twitter:title\" content=\"Start a RevPhore run - Revilico\">\u003cmeta data-mint-head name=\"twitter:description\" content=\"Maps the contacts between a protein and the molecule bound to it (hydrogen bonds, charged, stacking and greasy contacts), lists the residues involved and estimates the binding energy. Takes complexes with protein and molecule in one file, up to 50 per run. When a file holds several molecules, name the one to analyse with ligand_residue. Starts a run and returns it with status queued; poll GET /v1/runs/{runId} until it finishes. Runs spend credits. Limits: maxComplexes: 50. How the engine works and how to read its results: RevPhore documentation. Scope: runs:write.\">\u003cmeta data-mint-head name=\"twitter:image\" content=\"https://revilicoinc.mintlify.app/_mintlify/api/og/v2?division=Engine+runs\u0026amp;title=Start+a+RevPhore+run\u0026amp;description=Maps+the+contacts+between+a+protein+and+the+molecule+bound+to+it+%28hydrogen+bonds%2C+charged%2C+stacking+and+greasy+contacts%29%2C+lists+the+residues+involved+and+estima\u0026amp;theme=be735b651301653c27b26fa1\u0026amp;signature=4ff6641da9679d9fa687bb4c34ab37036b20d25b82269902bbd8a8b13184f5a2\">\u003cmeta data-mint-head name=\"twitter:image:width\" content=\"1200\">\u003cmeta data-mint-head name=\"twitter:image:height\" content=\"630\">\u003cmeta data-mint-head name=\"msapplication-config\" content=\"/mintlify-assets/_mintlify/favicons/revilicoinc/XuDhYK1TrVRjKN2O/_generated/favicon/browserconfig.xml\">\u003cmeta data-mint-head name=\"apple-mobile-web-app-title\" content=\"Revilico\">\u003cmeta data-mint-head name=\"msapplication-TileColor\" content=\"#1371e4\">\u003clink data-mint-head rel=\"canonical\" href=\"https://docs.revilico.bio/api-reference/engine-runs/start-a-revphore-run\">\u003clink data-mint-head rel=\"alternate\" type=\"application/xml\" href=\"/sitemap.xml\">\u003clink data-mint-head rel=\"alternate\" type=\"text/markdown\" href=\"/api-reference/engine-runs/start-a-revphore-run.md\">\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@graph\":[{\"@type\":\"Organization\",\"@id\":\"https://docs.revilico.bio/#organization\",\"name\":\"Revilico\",\"url\":\"https://docs.revilico.bio\",\"logo\":{\"@type\":\"ImageObject\",\"url\":\"https://mintcdn.com/revilicoinc/cWUeZVkzU4GxUaNk/logo/revilico-dark.avif?fit=max\u0026auto=format\u0026n=cWUeZVkzU4GxUaNk\u0026q=85\u0026s=d4e1bd31a297855ce0ceab937fc59f32\"}},{\"@type\":\"WebSite\",\"@id\":\"https://docs.revilico.bio#website\",\"name\":\"Revilico\",\"url\":\"https://docs.revilico.bio\",\"publisher\":{\"@id\":\"https://docs.revilico.bio/#organization\"}},{\"@type\":\"WebPage\",\"@id\":\"https://docs.revilico.bio/api-reference/engine-runs/start-a-revphore-run#webpage\",\"url\":\"https://docs.revilico.bio/api-reference/engine-runs/start-a-revphore-run\",\"name\":\"Start a RevPhore run\",\"description\":\"Maps the contacts between a protein and the molecule bound to it (hydrogen bonds, charged, stacking and greasy contacts), lists the residues involved and estimates the binding energy. Takes complexes with protein and molecule in one file, up to 50 per run. When a file holds several molecules, name the one to analyse with ligand_residue. Starts a run and returns it with status queued; poll GET /v1/runs/{runId} until it finishes. Runs spend credits. Limits: maxComplexes: 50. How the engine works and how to read its results: RevPhore documentation. Scope: runs:write.\",\"dateModified\":\"2026-10-29T13:44:47.323Z\",\"isPartOf\":{\"@id\":\"https://docs.revilico.bio#website\"},\"breadcrumb\":{\"@id\":\"https://docs.revilico.bio/api-reference/engine-runs/start-a-revphore-run#breadcrumb\"}},{\"@type\":\"BreadcrumbList\",\"@id\":\"https://docs.revilico.bio/api-reference/engine-runs/start-a-revphore-run#breadcrumb\",\"itemListElement\":[{\"@type\":\"ListItem\",\"position\":1,\"name\":\"Endpoints\",\"item\":\"https://docs.revilico.bio/api-reference/account/get-the-current-account\"},{\"@type\":\"ListItem\",\"position\":2,\"name\":\"Engine runs\",\"item\":\"https://docs.revilico.bio/api-reference/engine-runs/start-a-revenergy-run\"},{\"@type\":\"ListItem\",\"position\":3,\"name\":\"Start a RevPhore run\",\"item\":\"https://docs.revilico.bio/api-reference/engine-runs/start-a-revphore-run\"}]},{\"@type\":[\"TechArticle\",\"APIReference\"],\"@id\":\"https://docs.revilico.bio/api-reference/engine-runs/start-a-revphore-run#apireference\",\"headline\":\"Start a RevPhore run\",\"name\":\"Start a RevPhore run\",\"description\":\"Maps the contacts between a protein and the molecule bound to it (hydrogen bonds, charged, stacking and greasy contacts), lists the residues involved and estimates the binding energy. Takes complexes with protein and molecule in one file, up to 50 per run. When a file holds several molecules, name the one to analyse with ligand_residue. Starts a run and returns it with status queued; poll GET /v1/runs/{runId} until it finishes. Runs spend credits. Limits: maxComplexes: 50. How the engine works and how to read its results: RevPhore documentation. Scope: runs:write.\",\"url\":\"https://docs.revilico.bio/api-reference/engine-runs/start-a-revphore-run\",\"mainEntityOfPage\":{\"@id\":\"https://docs.revilico.bio/api-reference/engine-runs/start-a-revphore-run#webpage\"},\"dateModified\":\"2026-10-29T13:44:47.323Z\",\"publisher\":{\"@id\":\"https://docs.revilico.bio/#organization\"},\"isPartOf\":{\"@id\":\"https://docs.revilico.bio#website\"}}]}\u003c/script>\u003cscript data-mint-head type=\"application/ld+json\">{\"@context\":\"https://schema.org\",\"@type\":\"WebSite\",\"name\":\"Revilico\",\"creator\":{\"@type\":\"Organization\",\"name\":\"Mintlify\",\"url\":\"https://mintlify.com\"}}\u003c/script>","siteName":"Revilico","nav":{"global":null,"tabs":[{"tab":"Home","pages":[{"title":"Home","href":""}]},{"tab":"Documentation","pages":[{"title":"Documentation","href":"/docs/revsinglecell"}]},{"tab":"Developers","groups":[{"group":"Get started","pages":[{"title":"Developer platform","href":"/developers/overview"},{"title":"Quickstart","href":"/developers/quickstart"},{"title":"Authentication","href":"/developers/authentication"},{"title":"Errors and conventions","href":"/developers/errors"}]},{"group":"Guides","pages":[{"title":"Sharing runs","href":"/developers/sharing"},{"title":"RevNotes","href":"/developers/notes"},{"title":"RevDrive","href":"/developers/drive"}]},{"group":"MCP server","pages":[{"title":"Use Revilico from AI apps with the MCP server","sidebarTitle":"MCP server","href":"/developers/mcp/overview"},{"title":"Connect Claude","href":"/developers/mcp/claude"},{"title":"Connect ChatGPT","href":"/developers/mcp/chatgpt"},{"title":"Other apps and API keys","href":"/developers/mcp/api-key"},{"title":"Tools reference","href":"/developers/mcp/tools"}]},{"group":"API reference","pages":[{"title":"Revilico REST API reference: base URL and auth","sidebarTitle":"API reference","href":"/api-reference/introduction"}]},{"group":"Endpoints","pages":[{"group":"Account","pages":[{"title":"Get the current account","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/me","href":"/api-reference/account/get-the-current-account"},{"title":"Get the credit balance","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/credits/balance","href":"/api-reference/account/get-the-credit-balance"},{"title":"Get credit usage","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/usage","href":"/api-reference/account/get-credit-usage"}]},{"group":"Engines","pages":[{"title":"List engines","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/engines","href":"/api-reference/engines/list-engines"},{"title":"Get an engine","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/engines/{engine}","href":"/api-reference/engines/get-an-engine"},{"title":"Get engine examples","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/engines/{engine}/examples","href":"/api-reference/engines/get-engine-examples"},{"title":"Validate parameters","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/engines/{engine}/validate","href":"/api-reference/engines/validate-parameters"}]},{"group":"Files","pages":[{"title":"List files","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/files","href":"/api-reference/files/list-files"},{"title":"Create an upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/files","href":"/api-reference/files/create-an-upload"},{"title":"Get a file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/files/{fileId}","href":"/api-reference/files/get-a-file"}]},{"group":"Runs","pages":[{"title":"Start a run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/engines/{engine}/runs","href":"/api-reference/runs/start-a-run"},{"title":"List runs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/runs","href":"/api-reference/runs/list-runs"},{"title":"Get a run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/runs/{runId}","href":"/api-reference/runs/get-a-run"},{"title":"Get run inputs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/runs/{runId}/inputs","href":"/api-reference/runs/get-run-inputs"},{"title":"List run children","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/runs/{runId}/children","href":"/api-reference/runs/list-run-children"},{"title":"Cancel a run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/runs/{runId}/cancel","href":"/api-reference/runs/cancel-a-run"}]},{"group":"Results and outputs","pages":[{"title":"Get results","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/runs/{runId}/results","href":"/api-reference/results-and-outputs/get-results"},{"title":"Get a result row in full","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/runs/{runId}/results/{index}","href":"/api-reference/results-and-outputs/get-a-result-row-in-full"},{"title":"Get a child's results","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/runs/{runId}/children/{childIndex}/results","href":"/api-reference/results-and-outputs/get-a-childs-results"},{"title":"List run files","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/runs/{runId}/files","href":"/api-reference/results-and-outputs/list-run-files"},{"title":"Read a run file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/runs/{runId}/files/read","href":"/api-reference/results-and-outputs/read-a-run-file"},{"title":"List outputs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/runs/{runId}/outputs","href":"/api-reference/results-and-outputs/list-outputs"},{"title":"Download an output","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/runs/{runId}/outputs/{outputId}","href":"/api-reference/results-and-outputs/download-an-output"},{"title":"Download a child's output","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/runs/{runId}/outputs/{child}/{outputId}","href":"/api-reference/results-and-outputs/download-a-childs-output"}]},{"group":"Projects","pages":[{"title":"List projects","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects","href":"/api-reference/projects/list-projects"},{"title":"Create a project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects","href":"/api-reference/projects/create-a-project"},{"title":"Get a project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}","href":"/api-reference/projects/get-a-project"},{"title":"Update a project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/projects/{projectId}","href":"/api-reference/projects/update-a-project"},{"title":"List project runs","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/projects/{projectId}/runs","href":"/api-reference/projects/list-project-runs"},{"title":"Add a run to a project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/projects/{projectId}/runs/{runId}","href":"/api-reference/projects/add-a-run-to-a-project"},{"title":"Remove a run from a project","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/projects/{projectId}/runs/{runId}","href":"/api-reference/projects/remove-a-run-from-a-project"}]},{"group":"Sharing","pages":[{"title":"List who a run is shared with","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/runs/{runId}/shares","href":"/api-reference/sharing/list-who-a-run-is-shared-with"},{"title":"Share a run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/runs/{runId}/shares","href":"/api-reference/sharing/share-a-run"},{"title":"Stop sharing a run","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/runs/{runId}/shares/{shareId}","href":"/api-reference/sharing/stop-sharing-a-run"},{"title":"List people you can share with","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/org/members","href":"/api-reference/sharing/list-people-you-can-share-with"}]},{"group":"Notes","pages":[{"title":"List notes","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/notes","href":"/api-reference/notes/list-notes"},{"title":"Create a note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/notes","href":"/api-reference/notes/create-a-note"},{"title":"Get a note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/notes/{noteId}","href":"/api-reference/notes/get-a-note"},{"title":"Delete a note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/notes/{noteId}","href":"/api-reference/notes/delete-a-note"},{"title":"Change a note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/notes/{noteId}","href":"/api-reference/notes/change-a-note"},{"title":"List who a note is shared with","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/notes/{noteId}/shares","href":"/api-reference/notes/list-who-a-note-is-shared-with"},{"title":"Share a note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/notes/{noteId}/shares","href":"/api-reference/notes/share-a-note"},{"title":"Stop sharing a note","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/notes/{noteId}/shares/{noteShareId}","href":"/api-reference/notes/stop-sharing-a-note"},{"title":"List note folders","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/note-folders","href":"/api-reference/notes/list-note-folders"},{"title":"Create a note folder","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/note-folders","href":"/api-reference/notes/create-a-note-folder"},{"title":"Rename a note folder","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/note-folders/{noteFolderId}","href":"/api-reference/notes/rename-a-note-folder"},{"title":"List who a note folder is shared with","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/note-folders/{noteFolderId}/shares","href":"/api-reference/notes/list-who-a-note-folder-is-shared-with"},{"title":"Share a note folder","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/note-folders/{noteFolderId}/shares","href":"/api-reference/notes/share-a-note-folder"},{"title":"Stop sharing a note folder","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/note-folders/{noteFolderId}/shares/{noteShareId}","href":"/api-reference/notes/stop-sharing-a-note-folder"}]},{"group":"Drive","pages":[{"title":"List Drive folders and files","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/drive/items","href":"/api-reference/drive/list-drive-folders-and-files"},{"title":"List your shared drives","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/drive/shared-drives","href":"/api-reference/drive/list-your-shared-drives"},{"title":"Get a Drive file","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/drive/files/{driveFileId}","href":"/api-reference/drive/get-a-drive-file"},{"title":"Read a Drive file's content","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/drive/files/{driveFileId}/content","href":"/api-reference/drive/read-a-drive-files-content"},{"title":"Create a Drive folder","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/drive/folders","href":"/api-reference/drive/create-a-drive-folder"},{"title":"Upload a file into Drive","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/drive/files","href":"/api-reference/drive/upload-a-file-into-drive"},{"title":"Finish a Drive upload","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/drive/files/{driveFileId}/complete","href":"/api-reference/drive/finish-a-drive-upload"},{"title":"Save an upload or run output to Drive","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json post /v1/drive/import","href":"/api-reference/drive/save-an-upload-or-run-output-to-drive"},{"title":"Move a Drive item to the trash","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json delete /v1/drive/items/{itemId}","href":"/api-reference/drive/move-a-drive-item-to-the-trash"},{"title":"Rename or move a Drive item","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json patch /v1/drive/items/{itemId}","href":"/api-reference/drive/rename-or-move-a-drive-item"}]},{"group":"Engine runs","pages":[{"title":"Start a RevEnergy run","deprecated":null,"version":null,"sidebarTitle":"RevEnergy","openapi":"/api-reference/openapi.json post /v1/engines/revenergy/runs","href":"/api-reference/engine-runs/start-a-revenergy-run"},{"title":"Start a RevHBond run","deprecated":null,"version":null,"sidebarTitle":"RevHBond","openapi":"/api-reference/openapi.json post /v1/engines/revhbond/runs","href":"/api-reference/engine-runs/start-a-revhbond-run"},{"title":"Start a RevStrain run","deprecated":null,"version":null,"sidebarTitle":"RevStrain","openapi":"/api-reference/openapi.json post /v1/engines/revstrain/runs","href":"/api-reference/engine-runs/start-a-revstrain-run"},{"title":"Start a RevFukui run","deprecated":null,"version":null,"sidebarTitle":"RevFukui","openapi":"/api-reference/openapi.json post /v1/engines/revfukui/runs","href":"/api-reference/engine-runs/start-a-revfukui-run"},{"title":"Start a RevMSA run","deprecated":null,"version":null,"sidebarTitle":"RevMSA","openapi":"/api-reference/openapi.json post /v1/engines/revmsa/runs","href":"/api-reference/engine-runs/start-a-revmsa-run"},{"title":"Start a RevTorsion run","deprecated":null,"version":null,"sidebarTitle":"RevTorsion","openapi":"/api-reference/openapi.json post /v1/engines/revtorsion/runs","href":"/api-reference/engine-runs/start-a-revtorsion-run"},{"title":"Start a RevPath run","deprecated":null,"version":null,"sidebarTitle":"RevPath","openapi":"/api-reference/openapi.json post /v1/engines/revpath/runs","href":"/api-reference/engine-runs/start-a-revpath-run"},{"title":"Start a RevSaddle run","deprecated":null,"version":null,"sidebarTitle":"RevSaddle","openapi":"/api-reference/openapi.json post /v1/engines/revsaddle/runs","href":"/api-reference/engine-runs/start-a-revsaddle-run"},{"title":"Start a RevIED run","deprecated":null,"version":null,"sidebarTitle":"RevIED","openapi":"/api-reference/openapi.json post /v1/engines/revied/runs","href":"/api-reference/engine-runs/start-a-revied-run"},{"title":"Start a RevBDE run","deprecated":null,"version":null,"sidebarTitle":"RevBDE","openapi":"/api-reference/openapi.json post /v1/engines/revbde/runs","href":"/api-reference/engine-runs/start-a-revbde-run"},{"title":"Start a RevpKa run","deprecated":null,"version":null,"sidebarTitle":"RevpKa","openapi":"/api-reference/openapi.json post /v1/engines/revpka/runs","href":"/api-reference/engine-runs/start-a-revpka-run"},{"title":"Start a RevTaut run","deprecated":null,"version":null,"sidebarTitle":"RevTaut","openapi":"/api-reference/openapi.json post /v1/engines/revtaut/runs","href":"/api-reference/engine-runs/start-a-revtaut-run"},{"title":"Start a RevRelax run","deprecated":null,"version":null,"sidebarTitle":"RevRelax","openapi":"/api-reference/openapi.json post /v1/engines/revrelax/runs","href":"/api-reference/engine-runs/start-a-revrelax-run"},{"title":"Start a RevOrbitals run","deprecated":null,"version":null,"sidebarTitle":"RevOrbitals","openapi":"/api-reference/openapi.json post /v1/engines/revorbitals/runs","href":"/api-reference/engine-runs/start-a-revorbitals-run"},{"title":"Start a RevADMET run","deprecated":null,"version":null,"sidebarTitle":"RevADMET","openapi":"/api-reference/openapi.json post /v1/engines/revadmet/runs","href":"/api-reference/engine-runs/start-a-revadmet-run"},{"title":"Start a RevConformer run","deprecated":null,"version":null,"sidebarTitle":"RevConformer","openapi":"/api-reference/openapi.json post /v1/engines/revconformer/runs","href":"/api-reference/engine-runs/start-a-revconformer-run"},{"title":"Start a RevSol run","deprecated":null,"version":null,"sidebarTitle":"RevSol","openapi":"/api-reference/openapi.json post /v1/engines/revsol/runs","href":"/api-reference/engine-runs/start-a-revsol-run"},{"title":"Start a RevRetro run","deprecated":null,"version":null,"sidebarTitle":"RevRetro","openapi":"/api-reference/openapi.json post /v1/engines/revretro/runs","href":"/api-reference/engine-runs/start-a-revretro-run"},{"title":"Start a RevRedox run","deprecated":null,"version":null,"sidebarTitle":"RevRedox","openapi":"/api-reference/openapi.json post /v1/engines/revredox/runs","href":"/api-reference/engine-runs/start-a-revredox-run"},{"title":"Start a RevGeometry run","deprecated":null,"version":null,"sidebarTitle":"RevGeometry","openapi":"/api-reference/openapi.json post /v1/engines/revgeometry/runs","href":"/api-reference/engine-runs/start-a-revgeometry-run"},{"title":"Start a RevQS run","deprecated":null,"version":null,"sidebarTitle":"RevQS","openapi":"/api-reference/openapi.json post /v1/engines/revqs/runs","href":"/api-reference/engine-runs/start-a-revqs-run"},{"title":"Start a RevSpin run","deprecated":null,"version":null,"sidebarTitle":"RevSpin","openapi":"/api-reference/openapi.json post /v1/engines/revspin/runs","href":"/api-reference/engine-runs/start-a-revspin-run"},{"title":"Start a RevTS run","deprecated":null,"version":null,"sidebarTitle":"RevTS","openapi":"/api-reference/openapi.json post /v1/engines/revts/runs","href":"/api-reference/engine-runs/start-a-revts-run"},{"title":"Start a RevCryptic run","deprecated":null,"version":null,"sidebarTitle":"RevCryptic","openapi":"/api-reference/openapi.json post /v1/engines/revcryptic/runs","href":"/api-reference/engine-runs/start-a-revcryptic-run"},{"title":"Start a Boltz2 run","deprecated":null,"version":null,"sidebarTitle":"Boltz2","openapi":"/api-reference/openapi.json post /v1/engines/boltz2/runs","href":"/api-reference/engine-runs/start-a-boltz2-run"},{"title":"Start a BoltzGen run","deprecated":null,"version":null,"sidebarTitle":"BoltzGen","openapi":"/api-reference/openapi.json post /v1/engines/boltzgen/runs","href":"/api-reference/engine-runs/start-a-boltzgen-run"},{"title":"Start a RevScreen run","deprecated":null,"version":null,"sidebarTitle":"RevScreen","openapi":"/api-reference/openapi.json post /v1/engines/revscreen/runs","href":"/api-reference/engine-runs/start-a-revscreen-run"},{"title":"Start a RevTrain run","deprecated":null,"version":null,"sidebarTitle":"RevTrain","openapi":"/api-reference/openapi.json post /v1/engines/revtrain/runs","href":"/api-reference/engine-runs/start-a-revtrain-run"},{"title":"Start a RevDenovo run","deprecated":null,"version":null,"sidebarTitle":"RevDenovo","openapi":"/api-reference/openapi.json post /v1/engines/revdenovo/runs","href":"/api-reference/engine-runs/start-a-revdenovo-run"},{"title":"Start a RevOptimization run","description":"Generates molecules while steering the generator, stage by stage, towards goals you set: a property range (weight, solubility, polarity, rings…), similarity to reference molecules, a wanted or unwanted substructure, or strong docking into a protein. Each stage optimises one goal and starts from the generator the previous stage left. Can start from a model you trained with RevTrain.\n\nStarts a run and returns it with status `queued`; poll GET /v1/runs/{runId} until it finishes. Runs spend credits.\n\n**Limits:** `maxStages`: 5, `maxStepsPerStage`: 1000, `maxMoleculesSampled`: 250000, `maxBatchSize`: 1024, `maxInputMolecules`: 1000.\n\nHow the engine works and how to read its results: [RevOptimization documentation](/docs/revoptimization).\n\n**Scope:** `runs:write`.","deprecated":null,"version":null,"sidebarTitle":"RevOptimization","openapi":"/api-reference/openapi.json post /v1/engines/revoptimization/runs","href":"/api-reference/engine-runs/start-a-revoptimization-run"},{"title":"Start a RevPhore run","deprecated":null,"version":null,"sidebarTitle":"RevPhore","openapi":"/api-reference/openapi.json post /v1/engines/revphore/runs","href":"/api-reference/engine-runs/start-a-revphore-run"},{"title":"Start a RevFEP run","description":"Ranks a series of related drug-like molecules by how strongly each binds a protein, by simulating the change from one molecule into another (relative binding free energy, OpenFE). Gives the difference in binding free energy (kcal/mol) for every planned pair of molecules and a relative value per molecule. Slow and accurate: hours of GPU time per pair. The inputs are checked before the run starts. Runs cannot be cancelled once submitted.\n\nStarts a run and returns it with status `queued`; poll GET /v1/runs/{runId} until it finishes. Runs spend credits.\n\n**Limits:** `minLigands`: 2, `maxLigands`: 201, `maxLigandHeavyAtoms`: 200, `maxEstimatedGpuHours`: 2000.\n\nHow the engine works and how to read its results: [RevFEP documentation](/docs/revfep).\n\n**Scope:** `runs:write`.","deprecated":null,"version":null,"sidebarTitle":"RevFEP","openapi":"/api-reference/openapi.json post /v1/engines/revfep/runs","href":"/api-reference/engine-runs/start-a-revfep-run"},{"title":"Start a RevMut-PMX run","deprecated":null,"version":null,"sidebarTitle":"RevMut-PMX","openapi":"/api-reference/openapi.json post /v1/engines/revmut-pmx/runs","href":"/api-reference/engine-runs/start-a-revmut-pmx-run"},{"title":"Start a RevRisk run","deprecated":null,"version":null,"sidebarTitle":"RevRisk","openapi":"/api-reference/openapi.json post /v1/engines/revrisk/runs","href":"/api-reference/engine-runs/start-a-revrisk-run"},{"title":"Start a RevMethyl run","deprecated":null,"version":null,"sidebarTitle":"RevMethyl","openapi":"/api-reference/openapi.json post /v1/engines/revmethyl/runs","href":"/api-reference/engine-runs/start-a-revmethyl-run"},{"title":"Start a RevPocket run","deprecated":null,"version":null,"sidebarTitle":"RevPocket","openapi":"/api-reference/openapi.json post /v1/engines/revpocket/runs","href":"/api-reference/engine-runs/start-a-revpocket-run"},{"title":"Start a RevMD-Aqua run","deprecated":null,"version":null,"sidebarTitle":"RevMD-Aqua","openapi":"/api-reference/openapi.json post /v1/engines/revmd-aqua/runs","href":"/api-reference/engine-runs/start-a-revmd-aqua-run"},{"title":"Start a RevMD-Bind run","deprecated":null,"version":null,"sidebarTitle":"RevMD-Bind","openapi":"/api-reference/openapi.json post /v1/engines/revmd-bind/runs","href":"/api-reference/engine-runs/start-a-revmd-bind-run"},{"title":"Start a RevGRN run","deprecated":null,"version":null,"sidebarTitle":"RevGRN","openapi":"/api-reference/openapi.json post /v1/engines/revgrn/runs","href":"/api-reference/engine-runs/start-a-revgrn-run"},{"title":"Start a RevQSAR run","deprecated":null,"version":null,"sidebarTitle":"RevQSAR","openapi":"/api-reference/openapi.json post /v1/engines/revqsar/runs","href":"/api-reference/engine-runs/start-a-revqsar-run"},{"title":"Start a Rev SingleCell run","deprecated":null,"version":null,"sidebarTitle":"Rev SingleCell","openapi":"/api-reference/openapi.json post /v1/engines/revsinglecell/runs","href":"/api-reference/engine-runs/start-a-rev-singlecell-run"},{"title":"Start a RevFunction run","deprecated":null,"version":null,"sidebarTitle":"RevFunction","openapi":"/api-reference/openapi.json post /v1/engines/revfunction/runs","href":"/api-reference/engine-runs/start-a-revfunction-run"},{"title":"Start a RevMotion run","deprecated":null,"version":null,"sidebarTitle":"RevMotion","openapi":"/api-reference/openapi.json post /v1/engines/revmotion/runs","href":"/api-reference/engine-runs/start-a-revmotion-run"},{"title":"Start a AlphaFold run","deprecated":null,"version":null,"sidebarTitle":"AlphaFold","openapi":"/api-reference/openapi.json post /v1/engines/alphafold/runs","href":"/api-reference/engine-runs/start-a-alphafold-run"},{"title":"Start a OpenFold run","deprecated":null,"version":null,"sidebarTitle":"OpenFold","openapi":"/api-reference/openapi.json post /v1/engines/openfold/runs","href":"/api-reference/engine-runs/start-a-openfold-run"}]},{"group":"Health","pages":[{"title":"Check the API is up","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/health","href":"/api-reference/health/check-the-api-is-up"},{"title":"Check the API is ready","deprecated":null,"version":null,"openapi":"/api-reference/openapi.json get /v1/health/ready","href":"/api-reference/health/check-the-api-is-ready"}]}]}]},{"tab":"Benchmarks","pages":[{"title":"Benchmarks","href":"/benchmarks/overview"}]},{"tab":"Solutions","pages":[{"title":"Solutions","href":"/solutions/target-identification/Conducting-Multiomics-Analysis-on-Revilico-OS"}]},{"tab":"Changelog","pages":[{"title":"Changelog","href":"/changelog"}]},{"tab":"Guides","pages":[{"title":"Guides","href":"/high-throughput-screening"}]},{"tab":"Video Tutorials","pages":[{"title":"Video Tutorials","href":"/tutorials/rev-bind/static-flexible-docking"}]}]},"title":"Start a RevPhore run - Revilico","buildId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","deploymentId":"dpl_2xiSHD9XEvLsPGPcfoMtkLTB3dy9","dynamics":["c2aa737661","2b790eda92","b0f84f53ff","a9bb46feb3"],"chunks":["OpenApiReferenceProvider-DmVyH30O.js","utils-BHQqGGOd.js","cloneDeep-izs3Hzxb.js","_Uint8Array-BVIqJ90l.js","isObjectLike-C8vmzPEN.js","isArray-Dcu1dQ5t.js","utils-CD-E4BIt.js","toString-BX-iyh8G.js","isSymbol-CSH9U2Gm.js","addUniqueKeysToSchema-Bp5Lq9Ds.js","snippetPresets-C4xAVCFP.js","style-to-object-BY3JEAdk.js","v4-DIgz8zy6.js","ApiExamples-CgXVLxUC.js","isEqual-BfaiBbcl.js","usePlaygroundInputsStore-BF8I5oUf.js","shallow-Byd0lWnC.js","getApiPlaygroundDisplay-BGOZG1OK.js","CodeSnippet-CpvQL0CY.js","CodeSnippets-B8wkBKXa.js","Page-CBCH2P7b.js","getPastedJson-Ry3scI3Y.js","icon-D7a9HcdD.js","MethodPill-CJ8pmHhz.js","DuplicateIcon-rh1HJF0t.js","createIcon-DvGznqYs.js","DynamicMarkdown-Cc6AuSHS.js","SectionHeading-B4A0S-ep.js","axios-vUo_bRtp.js","Markdown-Cc16CX65.js","clsx-Cs6nMGht.js","lib-DuNMoZ05.js","lib-B8HbPgcC.js","html-void-elements-mCSPHezU.js","dist-zbf22OZA.js","katex-YMM-FMeD.js","marked.esm-CZWythHk.js","AssistantPageLink-C_fs-y5n.js"]}