> ## 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 RevFunction run > Reads protein sequences and writes, for each one, a plain-language account of what the protein probably does: its likely activity, the processes it takes part in and where in the cell it works. Alongside it lists the known building blocks (domains) found in the sequence and predicted Gene Ontology terms (standard function labels). Each sequence is sent to a public service outside Revilico to find its domains, so the request must confirm that with share_sequences_outside_revilico. Runs take minutes to hours, mostly waiting on that service; progress jumps from 0 to 100, and a run cannot be cancelled once submitted. Starts a run and returns it with status `queued`; poll GET /v1/runs/{runId} until it finishes. Runs spend credits. **Limits:** `maxProteins`: 100, `maxResidues`: 2000, `maxIdLength`: 64. **Scope:** `runs:write`. ## OpenAPI ````yaml /api-reference/openapi.json post /v1/engines/revfunction/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/revfunction/runs: post: tags: - Engine runs summary: Start a RevFunction run description: >- Reads protein sequences and writes, for each one, a plain-language account of what the protein probably does: its likely activity, the processes it takes part in and where in the cell it works. Alongside it lists the known building blocks (domains) found in the sequence and predicted Gene Ontology terms (standard function labels). Each sequence is sent to a public service outside Revilico to find its domains, so the request must confirm that with share_sequences_outside_revilico. Runs take minutes to hours, mostly waiting on that service; progress jumps from 0 to 100, and a run cannot be cancelled once submitted. Starts a run and returns it with status `queued`; poll GET /v1/runs/{runId} until it finishes. Runs spend credits. **Limits:** `maxProteins`: 100, `maxResidues`: 2000, `maxIdLength`: 64. **Scope:** `runs:write`. operationId: engineRuns.revfunction 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: proteins: minItems: 1 maxItems: 100 type: array items: type: object properties: id: type: string pattern: ^[A-Za-z0-9_.-]{1,64}$ description: >- Your name for this protein, e.g. a UniProt accession or "hit_01". Must be unique within the run; results are keyed by it. organism: default: Homo sapiens (Human) description: >- The species the protein comes from, exactly as written in this list (the species the model was trained on). Use "" when the species is not listed. The model takes the species into account when it reasons about function. type: string enum: - - >- Aedes aegypti (Yellowfever mosquito) (Culex aegypti) - >- Agrobacterium fabrum (strain C58 / ATCC 33970) (Agrobacterium tumefaciens (strain C58)) - >- Aliivibrio fischeri (strain ATCC 700601 / ES114) (Vibrio fischeri) - Amycolatopsis orientalis (Nocardia orientalis) - Anaplasma phagocytophilum (strain HZ) - Anguilla japonica (Japanese eel) - Anopheles gambiae (African malaria mosquito) - Apis mellifera (Honeybee) - Aquifex aeolicus (strain VF5) - Arabidopsis thaliana (Mouse-ear cress) - >- Archaeoglobus fulgidus (strain ATCC 49558 / DSM 4304 / JCM 9628 / NBRC 100126 / VC-16) - >- Aspergillus fumigatus (strain ATCC MYA-4609 / CBS 101355 / FGSC A1100 / Af293) (Neosartorya fumigata) - Aspergillus niger - >- Aspergillus niger (strain ATCC MYA-4892 / CBS 513.88 / FGSC A1513) - >- Aspergillus oryzae (strain ATCC 42149 / RIB 40) (Yellow koji mold) - >- Aspergillus parasiticus (strain ATCC 56775 / NRRL 5862 / SRRC 143 / SU-1) - >- Autographa californica nuclear polyhedrosis virus (AcMNPV) - Bacillus anthracis - Bacillus phage phi29 (Bacteriophage phi-29) - Bacillus subtilis (strain 168) - >- Bacteroides thetaiotaomicron (strain ATCC 29148 / DSM 2079 / JCM 5827 / CCUG 10774 / NCTC 10582 / VPI-5482 / E50) - Bombyx mori (Silk moth) - >- Borreliella burgdorferi (strain ATCC 35210 / DSM 4680 / CIP 102532 / B31) (Borrelia burgdorferi) - Bos taurus (Bovine) - >- Bovine herpesvirus 1.1 (strain Cooper) (BoHV-1) (Infectious bovine rhinotracheitis virus) - Brucella abortus (strain 2308) - Caenorhabditis elegans - >- Campylobacter jejuni subsp. jejuni serotype O:2 (strain ATCC 700819 / NCTC 11168) - Candida albicans (Yeast) - >- Candida albicans (strain SC5314 / ATCC MYA-2876) (Yeast) - Candida auris (Yeast) - >- Candida glabrata (strain ATCC 2001 / BCRC 20586 / JCM 3761 / NBRC 0622 / - >- Candida glabrata (strain ATCC 2001 / BCRC 20586 / JCM 3761 / NBRC 0622 / NRRL Y-65 / CBS 138) (Yeast) (Nakaseomyces glabratus) - >- Candida parapsilosis (strain CDC 317 / ATCC MYA-4646) (Yeast) (Monilia parapsilosis) - Canis lupus familiaris (Dog) (Canis familiaris) - Capsicum annuum (Capsicum pepper) - >- Catharanthus roseus (Madagascar periwinkle) (Vinca rosea) - >- Caulobacter vibrioides (strain ATCC 19089 / CIP 103742 / CB 15) (Caulobacter crescentus) - Cavia porcellus (Guinea pig) - >- Cereibacter sphaeroides (strain ATCC 17023 / DSM 158 / JCM 6121 / CCUG 31486 / LMG 2827 / NBRC 12203 / NCIMB 8253 / ATH 2.4.1.) (Rhodobacter sphaeroides) - >- Chaetomium thermophilum (strain DSM 1495 / CBS 144.50 / IMI 039719) - >- Chaetomium thermophilum (strain DSM 1495 / CBS 144.50 / IMI 039719) (Thermochaetoides thermophila) - >- Chlamydomonas reinhardtii (Chlamydomonas smithii) - >- Clostridium acetobutylicum (strain ATCC 824 / DSM 792 / JCM 1419 / IAM 19013 / LMG 5710 / NBRC 13948 / NRRL B-527 / VKM B-1787 / 2291 / W) - >- Corynebacterium glutamicum (strain ATCC 13032 / DSM 20300 / JCM 1318 / BCRC 11384 / CCUG 27702 / LMG 3730 / NBRC 12168 / NCIMB 10025 / NRRL B-2784 / 534) - >- Coturnix japonica (Japanese quail) (Coturnix coturnix japonica) - >- Cricetulus griseus (Chinese hamster) (Cricetulus barabensis griseus) - >- Cryptococcus neoformans var. grubii serotype A (strain H99 / ATCC 208821 / CBS 10515 / FGSC 9487) (Filobasidiella neoformans var. grubii) - Danio rerio (Zebrafish) (Brachydanio rerio) - >- Deinococcus radiodurans (strain ATCC 13939 / DSM 20539 / JCM 16871 / CCUG 27074 / LMG 4051 / NBRC 15346 / NCIMB 9279 / VKM B-1422 / R1) - >- Dickeya dadantii (strain 3937) (Erwinia chrysanthemi (strain 3937)) - Dictyostelium discoideum (Social amoeba) - Drosophila melanogaster (Fruit fly) - Emericella nidulans (Aspergillus nidulans) - >- Emericella nidulans (strain FGSC A4 / ATCC 38163 / CBS 112.46 / NRRL 194 / M139) (Aspergillus nidulans) - >- Entamoeba histolytica (strain ATCC 30459 / HM-1:IMSS / ABRM) - Enterobacteria phage T4 (Bacteriophage T4) - >- Epstein-Barr virus (strain B95-8) (HHV-4) (Human herpesvirus 4) - Equus caballus (Horse) - Escherichia coli - Escherichia coli (strain K12) - Escherichia coli O157:H7 - Escherichia phage T5 (Enterobacteria phage T5) - Escherichia phage lambda (Bacteriophage lambda) - Eubacterium barkeri (Clostridium barkeri) - Gallus gallus (Chicken) - >- Geobacillus stearothermophilus (Bacillus stearothermophilus) - >- Giardia intestinalis (strain ATCC 50803 / WB clone C6) (Giardia lamblia) - Glycine max (Soybean) (Glycine hispida) - >- Gossypium hirsutum (Upland cotton) (Gossypium mexicanum) - >- Haemophilus influenzae (strain ATCC 51907 / DSM 11121 / KW20 / Rd) - >- Haloferax volcanii (strain ATCC 29605 / DSM 3757 / JCM 8879 / NBRC 14742 / NCIMB 2012 / VKM B-1768 / DS2) (Halobacterium volcanii) - >- Helicobacter pylori (strain ATCC 700392 / 26695) (Campylobacter pylori) - Homo sapiens (Human) - Hordeum vulgare (Barley) - >- Human adenovirus C serotype 2 (HAdV-2) (Human adenovirus 2) - >- Human adenovirus C serotype 5 (HAdV-5) (Human adenovirus 5) - >- Human cytomegalovirus (strain AD169) (HHV-5) (Human herpesvirus 5) - >- Human cytomegalovirus (strain Merlin) (HHV-5) (Human herpesvirus 5) - >- Human herpesvirus 1 (strain 17) (HHV-1) (Human herpes simplex virus 1) - >- Human herpesvirus 8 (HHV-8) (Kaposi's sarcoma-associated herpesvirus) - >- Human herpesvirus 8 type P (isolate GK18) (HHV-8) (Kaposi's sarcoma-associated herpesvirus) - Hypocrea jecorina (Trichoderma reesei) - >- Ictalurus punctatus (Channel catfish) (Silurus punctatus) - >- Influenza A virus (strain A/Puerto Rico/8/1934 H1N1) - >- Lactococcus lactis subsp. cremoris (strain MG1363) - >- Lactococcus lactis subsp. lactis (strain IL1403) (Streptococcus lactis) - >- Legionella pneumophila subsp. pneumophila (strain Philadelphia 1 / ATCC 33152 / DSM 7513) - Leishmania major - >- Listeria monocytogenes serovar 1/2a (strain ATCC BAA-679 / EGD-e) - >- Lotus japonicus (Lotus corniculatus var. japonicus) - >- Macaca fascicularis (Crab-eating macaque) (Cynomolgus monkey) - Macaca mulatta (Rhesus macaque) - Malus domestica (Apple) (Pyrus malus) - >- Manduca sexta (Tobacco hawkmoth) (Tobacco hornworm) - >- Medicago truncatula (Barrel medic) (Medicago tribuloides) - Meleagris gallopavo (Wild turkey) - Mesocricetus auratus (Golden hamster) - >- Methanocaldococcus jannaschii (strain ATCC 43067 / DSM 2661 / JAL-1 / JCM 10045 / NBRC 100440) (Methanococcus jannaschii) - >- Methanococcus maripaludis (strain DSM 14266 / JCM 13030 / NBRC 101832 / S2 / LL) - >- Methanothermobacter marburgensis (strain ATCC BAA-927 / DSM 2133 / JCM 14651 / NBRC 100331 / OCM 82 / Marburg) (Methanobacterium thermoautotrophicum) - Mus musculus (Mouse) - >- Mycobacterium bovis (strain ATCC BAA-935 / AF2122/97) - >- Mycobacterium tuberculosis (strain ATCC 25618 / H37Rv) - >- Mycobacterium tuberculosis (strain CDC 1551 / Oshkosh) - >- Mycolicibacterium smegmatis (strain ATCC 700084 / mc(2)155) (Mycobacterium smegmatis) - >- Mycoplasma pneumoniae (strain ATCC 29342 / M129 / Subtype 1) (Mycoplasmoides pneumoniae) - Myxococcus xanthus (strain DK1622) - Neisseria gonorrhoeae - >- Neisseria gonorrhoeae (strain ATCC 700825 / FA 1090) - >- Neisseria meningitidis serogroup B (strain ATCC BAA-335 / MC58) - Nematostella vectensis (Starlet sea anemone) - >- Neurospora crassa (strain ATCC 24698 / 74-OR23-1A / CBS 708.71 / DSM 1257 / FGSC 987) - Nicotiana tabacum (Common tobacco) - >- Nitratidesulfovibrio vulgaris (strain ATCC 29579 / DSM 644 / CCUG 34227 / NCIMB 8303 / VKM B-1760 / Hildenborough) (Desulfovibrio vulgaris) - >- Nostoc sp. (strain PCC 7120 / SAG 25.82 / UTEX 2576) - >- Oncorhynchus mykiss (Rainbow trout) (Salmo gairdneri) - Oryctolagus cuniculus (Rabbit) - >- Oryza nivara (Indian wild rice) (Oryza sativa f. spontanea) - Oryza sativa (Rice) - Oryza sativa subsp. indica (Rice) - Oryza sativa subsp. japonica (Rice) - >- Oryzias latipes (Japanese rice fish) (Japanese killifish) - Ovis aries (Sheep) - Panax ginseng (Korean ginseng) - Papaver somniferum (Opium poppy) - Penicillium brevicompactum - Penicillium expansum (Blue mold rot fungus) - Petunia hybrida (Petunia) - >- Physcomitrium patens (Spreading-leaved earth moss) (Physcomitrella patens) - >- Picea sitchensis (Sitka spruce) (Pinus sitchensis) - Pisum sativum (Garden pea) (Lathyrus oleraceus) - Plasmodium berghei (strain Anka) - Plasmodium falciparum (isolate 3D7) - Plasmodium falciparum (isolate HB3) - >- Porphyromonas gingivalis (strain ATCC 33277 / DSM 20709 / CIP 103683 / JCM 12257 / NCTC 11834 / 2561) - Pseudomonas aeruginosa - >- Pseudomonas aeruginosa (strain ATCC 15692 / DSM 22644 / CIP 104116 / JCM 14847 / LMG 12228 / 1C / PRS 101 / PAO1) - >- Pseudomonas fluorescens (strain ATCC BAA-477 / NRRL B-23932 / Pf-5) - >- Pseudomonas putida (Arthrobacter siderocapsulatus) - >- Pseudomonas putida (strain ATCC 47054 / DSM 6125 / CFBP 8728 / NCIMB 11950 / KT2440) - >- Pseudomonas syringae pv. tomato (strain ATCC BAA-871 / DC3000) - >- Pyricularia oryzae (strain 70-15 / ATCC MYA-4617 / FGSC 8958) (Rice blast fungus) (Magnaporthe oryzae) - Pyrococcus abyssi (strain GE5 / Orsay) - >- Pyrococcus furiosus (strain ATCC 43587 / DSM 3638 / JCM 8422 / Vc1) - >- Pyrococcus horikoshii (strain ATCC 700860 / DSM 12428 / JCM 9974 / NBRC 100139 / OT-3) - Ralstonia sp - Rattus norvegicus (Rat) - >- Rhizobium meliloti (strain 1021) (Ensifer meliloti) (Sinorhizobium meliloti) - >- Rhodobacter capsulatus (strain ATCC BAA-309 / NBRC 16581 / SB1003) - Ricinus communis (Castor bean) - >- Ruegeria pomeroyi (strain ATCC 700808 / DSM 15171 / DSS-3) (Silicibacter pomeroyi) - >- Saccharolobus solfataricus (strain ATCC 35092 / DSM 1617 / JCM 11322 / P2) (Sulfolobus solfataricus) - >- Saccharomyces cerevisiae (strain ATCC 204508 / S288c) (Baker's yeast) - Salmo salar (Atlantic salmon) - >- Salmonella typhimurium (strain 14028s / SGSC 2262) - >- Salmonella typhimurium (strain LT2 / SGSC1412 / ATCC 700720) - Salmonella typhimurium (strain SL1344) - >- Schizosaccharomyces pombe (strain 972 / ATCC 24843) (Fission yeast) - Serratia marcescens - >- Severe acute respiratory syndrome coronavirus (SARS-CoV) - >- Severe acute respiratory syndrome coronavirus 2 (2019-nCoV) (SARS-CoV-2) - >- Shewanella oneidensis (strain ATCC 700550 / JCM 31522 / CIP 106686 / LMG 19005 / NCIMB 14063 / MR-1) - Shigella flexneri - >- Solanum lycopersicum (Tomato) (Lycopersicon esculentum) - Solanum tuberosum (Potato) - Spinacia oleracea (Spinach) - Staphylococcus aureus - Staphylococcus aureus (strain NCTC 8325 / PS 47) - >- Streptococcus mutans serotype c (strain ATCC 700610 / UA159) - >- Streptococcus pneumoniae (strain ATCC BAA-255 / R6) - >- Streptococcus pneumoniae serotype 2 (strain D39 / NCTC 7466) - >- Streptococcus pneumoniae serotype 4 (strain ATCC BAA-334 / TIGR4) - >- Streptomyces coelicolor (strain ATCC BAA-471 / A3(2) / M145) - Streptomyces niveus (Streptomyces spheroides) - >- Sulfolobus acidocaldarius (strain ATCC 33909 / DSM 639 / JCM 8929 / NBRC 15157 / NCIMB 11770) - Sus scrofa (Pig) - >- Synechococcus elongatus (strain ATCC 33912 / PCC 7942 / FACHB-805) (Anacystis nidulans R2) - >- Synechocystis sp. (strain ATCC 27184 / PCC 6803 / Kazusa) - Tachypleus tridentatus (Japanese horseshoe crab) - >- Taeniopygia guttata (Zebra finch) (Poephila guttata) - Tetrahymena thermophila (strain SB210) - >- Thermococcus kodakarensis (strain ATCC BAA-918 / JCM 12380 / KOD1) (Pyrococcus kodakaraensis (strain KOD1)) - >- Thermoplasma acidophilum (strain ATCC 25905 / DSM 1728 / JCM 9062 / NBRC 15155 / AMRC-C165) - >- Thermotoga maritima (strain ATCC 43589 / DSM 3109 / JCM 10099 / NBRC 100826 / MSB8) - >- Thermus thermophilus (strain ATCC 27634 / DSM 579 / HB8) - >- Thermus thermophilus (strain ATCC BAA-163 / DSM 7039 / HB27) - Triticum aestivum (Wheat) - Trypanosoma brucei - Trypanosoma brucei brucei - >- Trypanosoma brucei brucei (strain 927/4 GUTat10.1) - >- Vaccinia virus (strain Western Reserve) (VACV) (Vaccinia virus (strain WR)) - >- Vibrio cholerae serotype O1 (strain ATCC 39315 / El Tor Inaba N16961) - >- Vibrio cholerae serotype O1 (strain ATCC 39541 / Classical Ogawa 395 / O395) - Vibrio vulnificus (strain YJ016) - >- Xanthomonas campestris pv. campestris (strain ATCC 33913 / DSM 3586 / NCPPB 528 / LMG 568 / P 25) - Xenopus laevis (African clawed frog) - >- Xenopus tropicalis (Western clawed frog) (Silurana tropicalis) - Yersinia pestis - Zea mays (Maize) sequence: type: string description: >- The protein as one-letter amino-acid codes (the 20 standard letters), one chain. Spaces, line breaks and lower case are accepted and cleaned up; a FASTA header line is not. At most 2000 residues. required: - id - sequence additionalProperties: false description: >- The proteins to describe, 1 to 100. Each gets its own description; they do not influence each other. model: default: rl description: >- Which version of the model writes the descriptions. rl (default): more accurate, sticks closer to what the evidence supports. sft: proposes more detailed mechanisms, but also invents more, so treat its claims as hypotheses. type: string enum: - rl - sft share_sequences_outside_revilico: type: boolean const: true description: >- Must be true. To find the known building blocks (domains) in each protein, RevFunction sends every sequence to a public service outside Revilico. Set this only when the user has agreed that the sequences are not confidential. required: - proteins - share_sequences_outside_revilico 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: one-protein: summary: Describe what one human protein does. value: name: Ubiquitin function parameters: proteins: - id: P0CG48_ubiquitin sequence: >- MQIFVKTLTGKTITLEVEPSDTIENVKAKIQDKEGIPPDQQRLIFAGKQLEDGRTLSDYNIQKESTLHLVLRLRGG share_sequences_outside_revilico: true inputs: {} several-organisms: summary: >- Describe proteins from two species in one run, with the more speculative model. value: name: Two proteins, sft model parameters: model: sft proteins: - id: hit_01 organism: Homo sapiens (Human) sequence: >- MQIFVKTLTGKTITLEVEPSDTIENVKAKIQDKEGIPPDQQRLIFAGKQLEDGRTLSDYNIQKESTLHLVLRLRGG - id: hit_02 organism: Escherichia coli (strain K12) sequence: >- MSDKIIHLTDDSFDTDVLKADGAILVDFWAEWCGPCKMIAPILDEIADEYQGKLTVAKLNIDQNPGTAPKYGIRGIPTLLLFKNGEVAASKVGALSKGQLKEFLDANLA share_sequences_outside_revilico: true 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.