> ## 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 OpenFold run > Predicts the 3D structure of a complex that can mix proteins, DNA, RNA and small molecules (OpenFold3, in the AlphaFold 3 family). Several complexes can go in one run; each structure comes with confidence scores. Alignments, and templates from the PDB when asked for, are found inside Revilico. Starts a run and returns it with status `queued`; poll GET /v1/runs/{runId} until it finishes. Runs spend credits. **Limits:** `maxQueries`: 20, `maxChainsPerQuery`: 20, `maxResiduesPerQuery`: 2000. How the engine works and how to read its results: [OpenFold documentation](/docs/alphafold-openfold). **Scope:** `runs:write`. ## OpenAPI ````yaml /api-reference/openapi.json post /v1/engines/openfold/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/openfold/runs: post: tags: - Engine runs summary: Start a OpenFold run description: >- Predicts the 3D structure of a complex that can mix proteins, DNA, RNA and small molecules (OpenFold3, in the AlphaFold 3 family). Several complexes can go in one run; each structure comes with confidence scores. Alignments, and templates from the PDB when asked for, are found inside Revilico. Starts a run and returns it with status `queued`; poll GET /v1/runs/{runId} until it finishes. Runs spend credits. **Limits:** `maxQueries`: 20, `maxChainsPerQuery`: 20, `maxResiduesPerQuery`: 2000. How the engine works and how to read its results: [OpenFold documentation](/docs/alphafold-openfold). **Scope:** `runs:write`. operationId: engineRuns.openfold 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: queries: minItems: 1 maxItems: 20 type: array items: type: object properties: name: type: string pattern: ^[A-Za-z0-9_-]{1,64}$ description: >- A name for this complex, unique within the run, e.g. kinase_atp. Results and files are labelled with it. chains: minItems: 1 maxItems: 20 type: array items: oneOf: - type: object properties: type: type: string const: protein chain_ids: minItems: 1 maxItems: 10 type: array items: type: string pattern: ^[A-Za-z0-9]{1,4}$ description: >- Chain id for each copy of this molecule, e.g. ["A"], or ["A", "B"] for two identical copies. Up to 10; unique within the query. sequence: type: string minLength: 4 maxLength: 2000 pattern: ^[ACDEFGHIKLMNPQRSTVWYX]+$ description: >- The protein sequence in one-letter codes (ACDEFGHIKLMNPQRSTVWYX). required: - type - chain_ids - sequence additionalProperties: false - type: object properties: type: type: string const: dna chain_ids: minItems: 1 maxItems: 10 type: array items: type: string pattern: ^[A-Za-z0-9]{1,4}$ description: >- Chain id for each copy of this molecule, e.g. ["A"], or ["A", "B"] for two identical copies. Up to 10; unique within the query. sequence: type: string minLength: 4 maxLength: 2000 pattern: ^[ACGT]+$ description: >- The DNA sequence in one-letter codes (ACGT). modifications: description: >- Modified nucleotides by position, e.g. [{ "position": 3, "ccd": "PSU" }] for a pseudouridine at position 3. maxItems: 100 type: array items: type: object properties: position: type: integer minimum: 1 maximum: 9007199254740991 description: 1-based position in the sequence. ccd: type: string pattern: ^[A-Z0-9]{1,5}$ description: >- CCD code of the modified residue, e.g. PSU or 5MC. required: - position - ccd additionalProperties: false required: - type - chain_ids - sequence additionalProperties: false - type: object properties: type: type: string const: rna chain_ids: minItems: 1 maxItems: 10 type: array items: type: string pattern: ^[A-Za-z0-9]{1,4}$ description: >- Chain id for each copy of this molecule, e.g. ["A"], or ["A", "B"] for two identical copies. Up to 10; unique within the query. sequence: type: string minLength: 4 maxLength: 2000 pattern: ^[ACGU]+$ description: >- The RNA sequence in one-letter codes (ACGU). modifications: description: >- Modified nucleotides by position, e.g. [{ "position": 3, "ccd": "PSU" }] for a pseudouridine at position 3. maxItems: 100 type: array items: type: object properties: position: type: integer minimum: 1 maximum: 9007199254740991 description: 1-based position in the sequence. ccd: type: string pattern: ^[A-Z0-9]{1,5}$ description: >- CCD code of the modified residue, e.g. PSU or 5MC. required: - position - ccd additionalProperties: false required: - type - chain_ids - sequence additionalProperties: false - type: object properties: type: type: string const: ligand chain_ids: minItems: 1 maxItems: 10 type: array items: type: string pattern: ^[A-Za-z0-9]{1,4}$ description: >- Chain id for each copy of this molecule, e.g. ["A"], or ["A", "B"] for two identical copies. Up to 10; unique within the query. ccd: description: >- Chemical Component Dictionary code of a known molecule, e.g. ATP, HEM, NAD. Give this or smiles. type: string pattern: ^[A-Z0-9]{1,5}$ smiles: description: >- The molecule as SMILES. Give this or ccd. type: string minLength: 1 maxLength: 500 pattern: ^[A-Za-z0-9@+\-[\]()=#$:%/\\.*]+$ required: - type - chain_ids additionalProperties: false description: >- The molecules in the complex: proteins, DNA or RNA chains, and ligands. required: - name - chains additionalProperties: false description: >- The complexes to predict, 1–20. Each is predicted separately. alignment: default: local description: >- Whether to build an alignment of related proteins for each protein chain, which usually makes predictions much more accurate. "local" (default) searches UniRef30 inside Revilico; if that search fails, the run fails. "none" builds no alignment, at the cost of accuracy. type: string enum: - local - none templates: default: none description: >- Whether to guide protein chains with solved structures of similar proteins. "pdb" searches a copy of the Protein Data Bank (PDB) kept inside Revilico, as part of the alignment search, so it needs alignment "local" and at least one protein chain; if preparing them fails, the run fails. "none" (default) uses no templates. type: string enum: - none - pdb diffusion_samples: default: 5 description: >- Structures generated per seed. More gives more candidates to rank and takes longer. type: integer minimum: 1 maximum: 50 model_seeds: default: 1 description: >- Random seeds. Each seed runs the model again and adds diffusion_samples structures. type: integer minimum: 1 maximum: 10 required: - queries additionalProperties: false inputs: type: object properties: {} 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: - parameters additionalProperties: false examples: defaults: summary: Predict one protein on its own. value: name: Ubiquitin structure parameters: queries: - name: ubiquitin chains: - type: protein chain_ids: - A sequence: >- MQIFVKTLTGKTITLEVEPSDTIENVKAKIQDKEGIPPDQQRLIFAGKQLEDGRTLSDYNIQKESTLHLVLRLRGG inputs: {} protein-with-ligand: summary: >- Predict a kinase fragment with ATP bound, and the same fragment with a ligand given as SMILES, in one run. value: name: CDK2 fragment with ligands parameters: queries: - name: cdk2_atp chains: - type: protein chain_ids: - A sequence: >- MENFQKVEKIGEGTYGVVYKARNKLTGEVVALKKIRLDTETEGVPSTAIREISLLKELNHPNIVKLLDVIHTENKLYLVFEFLHQDLKKFMDASA - type: ligand chain_ids: - B ccd: ATP - name: cdk2_smiles_ligand chains: - type: protein chain_ids: - A sequence: >- MENFQKVEKIGEGTYGVVYKARNKLTGEVVALKKIRLDTETEGVPSTAIREISLLKELNHPNIVKLLDVIHTENKLYLVFEFLHQDLKKFMDASA - type: ligand chain_ids: - B smiles: Nc1ncnc2[nH]cnc12 diffusion_samples: 10 inputs: {} homodimer: summary: >- Two identical protein chains folded together: one chain entry with two chain ids. value: name: Ubiquitin dimer parameters: queries: - name: ubiquitin_dimer chains: - type: protein chain_ids: - A - B sequence: >- MQIFVKTLTGKTITLEVEPSDTIENVKAKIQDKEGIPPDQQRLIFAGKQLEDGRTLSDYNIQKESTLHLVLRLRGG inputs: {} pdb-templates: summary: >- Guide a protein with solved structures of similar proteins from the PDB, found inside Revilico. value: name: Ubiquitin with PDB templates parameters: queries: - name: ubiquitin chains: - type: protein chain_ids: - A sequence: >- MQIFVKTLTGKTITLEVEPSDTIENVKAKIQDKEGIPPDQQRLIFAGKQLEDGRTLSDYNIQKESTLHLVLRLRGG templates: pdb inputs: {} no-alignment: summary: >- Skip the alignment for a faster prediction, at the cost of accuracy. value: name: Ubiquitin, no alignment parameters: queries: - name: ubiquitin chains: - type: protein chain_ids: - A sequence: >- MQIFVKTLTGKTITLEVEPSDTIENVKAKIQDKEGIPPDQQRLIFAGKQLEDGRTLSDYNIQKESTLHLVLRLRGG alignment: none inputs: {} 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.