> ## Documentation Index > Fetch the complete documentation index at: https://docs.revilico.bio/llms.txt > Use this file to discover all available pages before exploring further. # Start a RevRisk run > Scores one person’s genome (a VCF) against published genetic risk scores and reports, per disease, where they rank against a reference population (a percentile, from European allele frequencies) and a risk band. Uses a built-in panel of 35 diseases, or scores from the PGS Catalog. An imputed array VCF takes 1–3 minutes. Starts a run and returns it with status `queued`; poll GET /v1/runs/{runId} until it finishes. Runs spend credits. **Limits:** `builtInDiseases`: 35, `categories`: 7, `maxPgsScores`: 20, `samplesScored`: 1. How the engine works and how to read its results: [RevRisk documentation](/docs/revrisk). **Scope:** `runs:write`. ## OpenAPI ````yaml /api-reference/openapi.json post /v1/engines/revrisk/runs openapi: 3.1.0 info: title: Revilico API version: 1.0.0 description: >- Run Revilico's computational chemistry and biology engines from your own code: upload input files, start runs, follow them and read their results. servers: - url: https://public-api.revilico.bio security: - bearerAuth: [] tags: - name: Account description: Who you are, your credits and what your runs have used. - name: Engines description: The engines you can run, their parameter schemas and examples. - name: Files description: 'Upload input files: create an upload, then PUT the bytes.' - name: Runs description: Start, follow and cancel engine runs. - name: Results and outputs description: 'Read what a run produced: results, files and outputs.' - name: Projects description: Group runs into the projects you see in the web app. - name: Sharing description: >- Share runs with people in your organization, as in the web app's Pipeline sharing. - name: Notes description: >- RevNotes: read, write and share the rich-text notes and note folders of the web app's RevNotes panel, in markdown or HTML. - name: Drive description: >- Your RevDrive files and shared drives, as in the web app: browse, read, use files as run inputs, save outputs, and organize. Ids: `dfile_…` and `dfld_…` in a personal Drive, `drive_…` for a shared drive, `sdfile_…` and `sdfld_…` in one. - name: Engine runs description: >- Start a run of one engine, with that engine's parameters and input files. Same endpoint as **Start a run**. - name: Health description: Service status. Needs no API key. paths: /v1/engines/revrisk/runs: post: tags: - Engine runs summary: Start a RevRisk run description: >- Scores one person’s genome (a VCF) against published genetic risk scores and reports, per disease, where they rank against a reference population (a percentile, from European allele frequencies) and a risk band. Uses a built-in panel of 35 diseases, or scores from the PGS Catalog. An imputed array VCF takes 1–3 minutes. Starts a run and returns it with status `queued`; poll GET /v1/runs/{runId} until it finishes. Runs spend credits. **Limits:** `builtInDiseases`: 35, `categories`: 7, `maxPgsScores`: 20, `samplesScored`: 1. How the engine works and how to read its results: [RevRisk documentation](/docs/revrisk). **Scope:** `runs:write`. operationId: engineRuns.revrisk 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 parameters: type: object properties: categories: default: [] description: >- Disease groups to score from the built-in panel of 35 diseases. Empty scores all 35. cardiovascular: coronary artery disease, atrial fibrillation, heart failure, stroke, hypertension, venous thromboembolism; neurological: Alzheimer’s, macular degeneration, Parkinson’s, multiple sclerosis, epilepsy, migraine; metabolic: type 1 and type 2 diabetes, obesity, hypothyroidism, polycystic ovary syndrome; oncology: prostate, breast, colorectal, lung and pancreatic cancer, melanoma; inflammatory: inflammatory bowel disease, rheumatoid arthritis, lupus, psoriasis, coeliac disease; respiratory: asthma, COPD, chronic kidney disease; psychiatric: schizophrenia, bipolar disorder, depression, ADHD. Each built-in score uses only 4–8 of the strongest published variants. maxItems: 7 type: array items: type: string enum: - cardiovascular - neurological - metabolic - oncology - inflammatory - respiratory - psychiatric pgs_scores: default: [] description: >- Published scores from the PGS Catalog (pgscatalog.org) to use instead of the built-in panel; each is downloaded in full when the run starts. An id the built-in panel already uses is not downloaded: it gets the panel’s short version and the panel’s disease name. Leave out categories when you send these. maxItems: 20 type: array items: type: object properties: pgs_id: type: string pattern: ^PGS\d{6}$ description: >- PGS Catalog score id: "PGS" and six digits, e.g. PGS000018. label: description: >- Name to show for this score, e.g. "Breast cancer". Defaults to the id. type: string pattern: ^[\p{L}\p{N} .,:;'’()/+-]{1,100}$ required: - pgs_id additionalProperties: false additionalProperties: false inputs: type: object properties: vcf: type: string description: >- One person’s genotypes as a VCF, plain or gzipped (name it .vcf, .vcf.gz or .vcf.bgz). Positions are read as GRCh38; variants are matched by rsID first. Only the first sample column is scored. BCF is not supported. A file id: an upload (`file_…`) or a Drive file (`dfile_…`, `sdfile_…`). Formats: vcf, gz, bgz; up to 100 MB. required: - vcf additionalProperties: false budget: description: Most credits the run may spend; it is stopped beyond that. type: number exclusiveMinimum: 0 projectId: description: >- Add the run to this project (`proj_…`); needs editor or owner on it. type: string required: - inputs additionalProperties: false examples: defaults: summary: >- Score one genome against all 35 diseases of the built-in panel. value: name: Sample 0042 parameters: {} inputs: vcf: file_… categories: summary: Only the heart and metabolic diseases of the built-in panel. value: name: Sample 0042, cardiometabolic parameters: categories: - cardiovascular - metabolic inputs: vcf: file_… pgs-catalog: summary: >- Published PGS Catalog scores instead of the built-in panel, the first with a display name. value: name: Sample 0042, custom scores parameters: pgs_scores: - pgs_id: PGS000001 label: Breast cancer - pgs_id: PGS000337 inputs: vcf: file_… responses: '202': description: OK content: application/json: schema: $ref: '#/components/schemas/Run' '400': $ref: '#/components/responses/400' '401': $ref: '#/components/responses/401' '402': $ref: '#/components/responses/402' '403': $ref: '#/components/responses/403' '404': $ref: '#/components/responses/404' '422': $ref: '#/components/responses/422' '500': $ref: '#/components/responses/500' '502': $ref: '#/components/responses/502' components: schemas: Run: type: object properties: id: type: string description: Run id, `run_…`. engine: type: string description: Engine slug, e.g. `revredox`. name: type: - 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. owner: type: object properties: name: type: - string - 'null' email: type: string required: - name - email description: Who started the run. status: type: string enum: - queued - running - succeeded - failed - cancelled description: >- queued until the engine picks the run up; succeeded, failed and cancelled are final. statusReason: description: >- Why a cancelled run stopped: `user`, `insufficient_credits` or `budget_exceeded`. Null otherwise. type: - string - 'null' progress: type: number description: Progress the engine reports; 0 until it reports any. createdAt: type: string format: date-time startedAt: anyOf: - type: string format: date-time - type: 'null' endedAt: anyOf: - type: string format: date-time - type: 'null' budget: description: Most credits the run may spend, if one was set. type: - number - 'null' creditsUsed: type: number description: Credits charged to the run so far. error: anyOf: - type: object properties: message: type: string required: - message - type: 'null' description: Set when status is failed. children: type: object properties: total: type: number queued: type: number running: type: number succeeded: type: number failed: type: number cancelled: type: 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. links: type: object propertyNames: type: string additionalProperties: type: string description: >- Related endpoints: self, inputs (owner only), results, outputs, files. 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 required: - id - engine - name - access - owner - status - statusReason - progress - createdAt - startedAt - endedAt - budget - creditsUsed - error - links Error: 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. message: type: string description: Readable explanation, for people. details: description: >- Extra context, e.g. `issues` ({ path, message }[]) for validation errors. type: object propertyNames: type: string additionalProperties: {} required: - code - message required: - error responses: '400': description: >- The request is malformed. `error.code` is one of `VALIDATION_FAILED`, `INVALID_ID`. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: VALIDATION_FAILED message: The request is malformed. '401': 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: $ref: '#/components/schemas/Error' example: error: code: MISSING_CREDENTIALS message: The API key is missing or not valid. '402': description: >- Your organization doesn't have enough credits. `error.code` is one of `INSUFFICIENT_CREDITS`. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: INSUFFICIENT_CREDITS message: Your organization doesn't have enough credits. '403': 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: $ref: '#/components/schemas/Error' example: error: code: INSUFFICIENT_SCOPE message: The key may not do this. '404': description: Not found, or not visible to you. `error.code` is one of `NOT_FOUND`. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: NOT_FOUND message: Not found, or not visible to you. '422': 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: $ref: '#/components/schemas/Error' example: error: code: INVALID_PARAMETERS message: The parameters or input files don't fit the engine. '500': description: >- Something went wrong on our side. `error.code` is one of `INTERNAL_ERROR`. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: INTERNAL_ERROR message: Something went wrong on our side. '502': description: >- The engine service rejected or failed the request. `error.code` is one of `ENGINE_SUBMIT_FAILED`. content: application/json: schema: $ref: '#/components/schemas/Error' example: error: code: ENGINE_SUBMIT_FAILED message: The engine service rejected or failed the request. securitySchemes: bearerAuth: type: http scheme: bearer description: >- An API key from the web app (**Settings → Developer**), sent as `Authorization: Bearer rvl_live_…`. ```` This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.