# OLI API ## OLI API - [Welcome to the OLI API documentation](https://devdocs.olisystems.com/master.md) - [Basic workflow](https://devdocs.olisystems.com/basic-workflow.md) - [Authentication](https://devdocs.olisystems.com/authentication.md) - [Bearer Token](https://devdocs.olisystems.com/authentication/authentication.md) - [API Keys](https://devdocs.olisystems.com/authentication/api-keys.md) - [Generate a Key](https://devdocs.olisystems.com/authentication/api-keys/generate-a-key.md) - [List All Keys](https://devdocs.olisystems.com/authentication/api-keys/list-all-keys.md) - [Delete a Key](https://devdocs.olisystems.com/authentication/api-keys/delete-a-key.md) - [Generating chemistry model files](https://devdocs.olisystems.com/chemistry-model-files.md) - [ChemBuilder API](https://devdocs.olisystems.com/chemistry-model-files/chembuilder-api.md) - [Getting Started with ChemBuilder](https://devdocs.olisystems.com/chemistry-model-files/chembuilder-api/getting-started-with-chembuilder.md) - [Set Thermodynamic Framework](https://devdocs.olisystems.com/chemistry-model-files/chembuilder-api/getting-started-with-chembuilder/set-thermodynamic-framework.md) - [Include Private Databanks](https://devdocs.olisystems.com/chemistry-model-files/chembuilder-api/getting-started-with-chembuilder/include-private-databanks.md) - [Include Inflows](https://devdocs.olisystems.com/chemistry-model-files/chembuilder-api/getting-started-with-chembuilder/include-inflows.md) - [Include Assays](https://devdocs.olisystems.com/chemistry-model-files/chembuilder-api/getting-started-with-chembuilder/include-inflows/include-assays.md) - [Include Pseudocomponent](https://devdocs.olisystems.com/chemistry-model-files/chembuilder-api/getting-started-with-chembuilder/include-inflows/include-pseudocomponent.md) - [Choose Phases](https://devdocs.olisystems.com/chemistry-model-files/chembuilder-api/getting-started-with-chembuilder/choose-phases.md) - [Specify Model Name](https://devdocs.olisystems.com/chemistry-model-files/chembuilder-api/getting-started-with-chembuilder/specify-model-name.md) - [Choose Redox](https://devdocs.olisystems.com/chemistry-model-files/chembuilder-api/getting-started-with-chembuilder/choose-redox.md) - [Choose Solids](https://devdocs.olisystems.com/chemistry-model-files/chembuilder-api/getting-started-with-chembuilder/choose-solids.md) - [Add Kinetics](https://devdocs.olisystems.com/chemistry-model-files/chembuilder-api/getting-started-with-chembuilder/add-kinetics.md) - [ChemBuilder Query](https://devdocs.olisystems.com/chemistry-model-files/chembuilder-api/chembuilder-query.md) - [Species Query](https://devdocs.olisystems.com/chemistry-model-files/chembuilder-api/chembuilder-query/species-query.md) - [Redox Query](https://devdocs.olisystems.com/chemistry-model-files/chembuilder-api/chembuilder-query/redox-query.md) - [Solid Phase Query](https://devdocs.olisystems.com/chemistry-model-files/chembuilder-api/chembuilder-query/solid-phase-query.md) - [Databank Query](https://devdocs.olisystems.com/chemistry-model-files/chembuilder-api/chembuilder-query/databank-query.md) - [Kinetics Query](https://devdocs.olisystems.com/chemistry-model-files/chembuilder-api/chembuilder-query/kinetics-query.md) - [Query Output Results](https://devdocs.olisystems.com/chemistry-model-files/chembuilder-api/chembuilder-query/query-output-results.md) - [Supporting Information for ChemBuilder](https://devdocs.olisystems.com/chemistry-model-files/chembuilder-api/supporting-information-for-chembuilder.md) - [Add Comment](https://devdocs.olisystems.com/chemistry-model-files/chembuilder-api/supporting-information-for-chembuilder/add-comment.md) - ["enabled" Keyword](https://devdocs.olisystems.com/chemistry-model-files/chembuilder-api/supporting-information-for-chembuilder/enabled-keyword.md) - [ChemBuilder Errors](https://devdocs.olisystems.com/chemistry-model-files/chembuilder-api/supporting-information-for-chembuilder/chembuilder-errors.md) - [Chemistry Wizard](https://devdocs.olisystems.com/chemistry-model-files/chemistry-wizard.md): This page guides the user through the steps of generating a chemistry model file via the Chemistry Wizard Desktop product - [Uploading chemistry model files](https://devdocs.olisystems.com/uploading-oli-files.md) - [Get list of uploaded files](https://devdocs.olisystems.com/dbs-file-list.md) - [Quickstart example: Python](https://devdocs.olisystems.com/quickstart.md) - [Known issues and Limitations](https://devdocs.olisystems.com/knownissues-and-limitations.md) - [Main methods](https://devdocs.olisystems.com/group1/api-functions.md) - [API call blueprint](https://devdocs.olisystems.com/group1/api-functions/api-call-blueprint.md) - [Chemistry information](https://devdocs.olisystems.com/group1/api-functions/chemistry-info.md) - [Isothermal flash](https://devdocs.olisystems.com/group1/api-functions/isothermal.md) - [Isenthalpic flash](https://devdocs.olisystems.com/group1/api-functions/isenthalpic.md) - [Bubble point flash](https://devdocs.olisystems.com/group1/api-functions/bubblepoint.md) - [Dew point flash](https://devdocs.olisystems.com/group1/api-functions/dewpoint.md) - [Vapor amount flash](https://devdocs.olisystems.com/group1/api-functions/vapor-amount.md) - [Vapor fraction flash](https://devdocs.olisystems.com/group1/api-functions/vapor-fraction.md) - [Isochoric flash](https://devdocs.olisystems.com/group1/api-functions/isochoric.md) - [set pH flash](https://devdocs.olisystems.com/group1/api-functions/setph.md) - [Precipitation point flash](https://devdocs.olisystems.com/group1/api-functions/precipitation-point.md) - [Autoclave](https://devdocs.olisystems.com/group1/api-functions/autoclave.md) - [Custom flash](https://devdocs.olisystems.com/group1/api-functions/custom.md) - [Corrosion contact surfaces](https://devdocs.olisystems.com/group1/api-functions/corrosion-contact-surface.md) - [Corrosion rates](https://devdocs.olisystems.com/group1/api-functions/corrosion-rates.md) - [Water analysis](https://devdocs.olisystems.com/group1/api-functions/wateranalysis.md) - [Additional methods](https://devdocs.olisystems.com/additional-functions.md) - [Flash history - Chemistry model](https://devdocs.olisystems.com/additional-functions/flash-history-chemistry-model.md) - [Result - by jobId](https://devdocs.olisystems.com/additional-functions/result-by-jobid.md) - [delete file](https://devdocs.olisystems.com/additional-functions/delete-file.md) - [cancel run](https://devdocs.olisystems.com/additional-functions/cancel-run.md) - [Inflows input](https://devdocs.olisystems.com/inflows-input.md) - [Optional inputs](https://devdocs.olisystems.com/optional-inputs.md) - [Kinetic calculation inputs](https://devdocs.olisystems.com/kinetic-calculation-inputs.md) - [Kinetic calculation outputs](https://devdocs.olisystems.com/kinetic-calculation-outputs.md) - [Input units](https://devdocs.olisystems.com/input-unit-set.md) - [User defined output unit set](https://devdocs.olisystems.com/user-defined-output-unit-set.md) - [Survey calculation](https://devdocs.olisystems.com/survey-calculation.md) - [Stream output](https://devdocs.olisystems.com/stream-output-json.md) - [Error/Warning output](https://devdocs.olisystems.com/error-output.md) - [Definition of terms](https://devdocs.olisystems.com/terms-definition.md) - [Uploading a Process API package](https://devdocs.olisystems.com/group2/uploading-oli-files.md): A process API package that is exported from OLI Flowsheet, and needs to be uploaded into the users account. - [Creating a Process API package](https://devdocs.olisystems.com/group2/uploading-oli-files/creating-a-process-api-package.md): The Process API package needed to run a process using the API is created using OLI Flowsheet :ESP, the following steps explain how to create the package file. - [Get list of all uploaded ProcessAPI packages](https://devdocs.olisystems.com/group2/dbs-file-list.md) - [Get input specs for Process API package](https://devdocs.olisystems.com/group2/get-input-specs-for-process-api-package.md): Each ProcessAPI package has a unique set of input requirements based on the user design. This function will return the JSON input specification for the Process as it was uploaded to the cloud. - [Get output specs for ProcessAPI package](https://devdocs.olisystems.com/group2/get-output-specs-for-processapi-package.md): Each ProcessAPI package will have a unique set of output based on the user design. This function will return a JSON dummy output specification for the Process. - [Run a Process API calculation](https://devdocs.olisystems.com/group2/api-call-blueprint.md) - [Get calculation status and results](https://devdocs.olisystems.com/group2/api-call-blueprint-1.md) - [Deleting a process package](https://devdocs.olisystems.com/dbs-file-list-1.md) - [Undelete a process package](https://devdocs.olisystems.com/dbs-file-list-2.md) - [Process API input specification](https://devdocs.olisystems.com/process-api-input-specification.md) - ["data" object](https://devdocs.olisystems.com/process-api-input-specification/data-object.md) - ["flowsheet" object](https://devdocs.olisystems.com/process-api-input-specification/data-object/flowsheet-object.md) - ["chemical-info" object](https://devdocs.olisystems.com/process-api-input-specification/data-object/flowsheet-object/chemical-info-object.md) - ["general-info" object](https://devdocs.olisystems.com/process-api-input-specification/data-object/flowsheet-object/general-info-object.md) - ["properties" object](https://devdocs.olisystems.com/process-api-input-specification/data-object/flowsheet-object/properties-object.md): This section is supplied as the input when running a process API calculation - ["units\_set\_info" object](https://devdocs.olisystems.com/process-api-input-specification/data-object/flowsheet-object/units_set_info-object.md) - [Uploading chemistry model files for ScaleChem API](https://devdocs.olisystems.com/oli-scalechem-api/uploading-chemistry-model-files-for-scalechem-api.md): One or more chemistry model files (dbs files) need to are needed to process a scalechem API request. These files need to be zipped together and the zip file uploaded to the OLI cloud. - [Get list of uploaded ScaleChem model files](https://devdocs.olisystems.com/oli-scalechem-api/get-list-of-uploaded-scalechem-model-files.md): method returns a paginated list of all ScaleChem model files. - [Main methods](https://devdocs.olisystems.com/oli-scalechem-api/main-methods.md): This page summarizes all the methods supported by the OLI ScaleChem API and explains the basic input schema. - [Brine analysis](https://devdocs.olisystems.com/oli-scalechem-api/main-methods/brine-analysis.md): This function performs electroneutrality and property reconciliation calculations from incomplete and/or inaccurate water sample data based on ionic species input. - [Gas analysis](https://devdocs.olisystems.com/oli-scalechem-api/main-methods/gas-analysis.md) - [Oil analysis](https://devdocs.olisystems.com/oli-scalechem-api/main-methods/oil-analysis.md) - [Mixer calculation](https://devdocs.olisystems.com/oli-scalechem-api/main-methods/mixer-calculation.md): This function performs a mixer calculation to combine external streams and flash at an isothermal condition. - [Scale scenario](https://devdocs.olisystems.com/oli-scalechem-api/main-methods/scale-scenario.md): This calculation combines several streams and calculate the scale scenario at a series of locations of different conditions.